.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::Synopsis::Expectation 3pm"
.TH Test::Synopsis::Expectation 3pm "2022-10-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::Synopsis::Expectation \- Test that SYNOPSIS code produces expected results
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test::Synopsis::Expectation;
\&
\&    synopsis_ok(\*(Aqeg/sample.pod\*(Aq);
\&    done_testing;
.Ve
.PP
Following, \s-1SYNOPSIS\s0 of \fIeg/sample.pod\fR
.PP
.Vb 3
\&    my $num;
\&    $num = 1; # => 1
\&    ++$num;   # => is 2
\&
\&    use PPI::Tokenizer;
\&    my $tokenizer = PPI::Tokenizer\->new(\e\*(Aqcode\*(Aq); # => isa \*(AqPPI::Tokenizer\*(Aq
\&
\&    my $str = \*(AqHello, I love you\*(Aq; # => like qr/ove/
\&
\&    my $obj = {
\&        foo => ["bar", "baz"],
\&    }; # => is_deeply { foo => ["bar", "baz"] }
\&
\&    my $bool = 1; # => success
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module checks that a module's \s-1SYNOPSIS\s0 section is syntactically correct,
and will also check that it produces the expected results,
based on annotations you add in comments.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "\(bu" 4
synopsis_ok($files)
.Sp
This function tests \s-1SYNOPSIS\s0 codes of each files.
This function expects file names as an argument as \s-1ARRAYREF\s0 or \s-1SCALAR.\s0
(This function is exported)
.IP "\(bu" 4
\&\fBall_synopsis_ok()\fR
.Sp
This function tests \s-1SYNOPSIS\s0 codes of the all of library files.
This function uses \fI\s-1MANIFEST\s0\fR to list up the target files of testing.
(This function is exported)
.IP "\(bu" 4
prepare($code_str)
.Sp
Register the executable codes to prepare for evaluation.
.Sp
If you use like;
.Sp
.Vb 4
\&    use Test::Synopsis::Expectation;
\&    Test::Synopsis::Expectation::prepare(\*(Aqmy $foo = 1;\*(Aq);
\&    synopsis_ok(\*(Aqpath/to/target.pm\*(Aq);
\&    done_testing;
\&
\&    ### Following, SYNOPSIS of \`target.pm\`
\&    $foo; # => 1
.Ve
.Sp
Then, \s-1SYNOPSIS\s0 of \fItarget.pm\fR is the same as;
.Sp
.Vb 2
\&    my $foo = 1;
\&    $foo; # => 1
.Ve
.Sp
(This function is not exported)
.IP "\(bu" 4
set_ignorings
.Sp
Set the procedures which would like to ignore.
.Sp
.Vb 4
\&    use Test::Synopsis::Expectation;
\&    Test::Synopsis::Expectation::set_ignorings([\*(Aq++$num;\*(Aq]);
\&    synopsis_ok(*DATA);
\&    done_testing;
\&
\&    _\|_DATA_\|_
\&    =head1 SYNOPSIS
\&
\&        my $num;
\&        $num = 1; # => 1
\&        ++$num;
\&        $num; # => 1
.Ve
.Sp
In the above example, \f(CW\*(C`++$num;\*(C'\fR will be ignored.
.SH "NOTATION OF EXPECTATION"
.IX Header "NOTATION OF EXPECTATION"
Comment that starts at \f(CW\*(C`# =>\*(C'\fR then this module treats the comment as test statement.
.IP "\(bu" 4
# => is
.Sp
.Vb 1
\&    my $foo = 1; # => is 1
.Ve
.Sp
This way is equivalent to the next.
.Sp
.Vb 2
\&    my $foo = 1;
\&    is $foo, 1;
.Ve
.Sp
This carries out the same behavior as \f(CW\*(C`Test::More::is\*(C'\fR.
.IP "\(bu" 4
# =>
.Sp
.Vb 1
\&    my $foo = 1; # => 1
.Ve
.Sp
This notation is the same as \f(CW\*(C`# => is\*(C'\fR
.IP "\(bu" 4
# => isa
.Sp
.Vb 2
\&    use Foo::Bar;
\&    my $instance = Foo::Bar\->new; # => isa \*(AqFoo::Bar\*(Aq
.Ve
.Sp
This way is equivalent to the next.
.Sp
.Vb 3
\&    use Foo::Bar;
\&    my $instance = Foo::Bar\->new;
\&    isa_ok $instance, \*(AqFoo::Bar\*(Aq;
.Ve
.Sp
This carries out the same behavior as \f(CW\*(C`Test::More::isa_ok\*(C'\fR.
.IP "\(bu" 4
# => like
.Sp
.Vb 1
\&    my $str = \*(AqHello, I love you\*(Aq; # => like qr/ove/
.Ve
.Sp
This way is equivalent to the next.
.Sp
.Vb 2
\&    my $str = \*(AqHello, I love you\*(Aq;
\&    like $str, qr/ove/;
.Ve
.Sp
This carries out the same behavior as \f(CW\*(C`Test::More::like\*(C'\fR.
.IP "\(bu" 4
# => is_deeply
.Sp
.Vb 3
\&    my $obj = {
\&        foo => ["bar", "baz"],
\&    }; # => is_deeply { foo => ["bar", "baz"] }
.Ve
.Sp
This way is equivalent to the next.
.Sp
.Vb 4
\&    my $obj = {
\&        foo => ["bar", "baz"],
\&    };
\&    is_deeply $obj, { foo => ["bar", "baz"] };
.Ve
.Sp
This carries out the same behavior as \f(CW\*(C`Test::More::is_deeply\*(C'\fR.
.IP "\(bu" 4
# => success
.Sp
.Vb 2
\&    my $bool = 1;
\&    $bool; # => success
.Ve
.Sp
This way checks value as boolean.
If target value of testing is 0 then this test will fail. Otherwise, it will pass.
.SH "ANNOTATIONS"
.IX Header "ANNOTATIONS"
.IP "\(bu" 4
=for test_synopsis_expectation_no_test
.Sp
The code block behind this annotation will not be tested.
.Sp
.Vb 2
\&        my $sum;
\&        $sum = 1; # => 1
\&
\&    =for test_synopsis_expectation_no_test
\&
\&        my $sum;
\&        $sum = 1; # => 2
.Ve
.Sp
In this example, the first code block will be tested, but the second will not.
.SH "RESTRICTION"
.IX Header "RESTRICTION"
.SS "Test case must be one line"
.IX Subsection "Test case must be one line"
The following is valid;
.PP
.Vb 3
\&    my $obj = {
\&        foo => ["bar", "baz"],
\&    }; # => is_deeply { foo => ["bar", "baz"] }
.Ve
.PP
However, the following is invalid;
.PP
.Vb 5
\&    my $obj = {
\&        foo => ["bar", "baz"],
\&    }; # => is_deeply {
\&       #        foo => ["bar", "baz"]
\&       #    }
.Ve
.PP
So test case must be one line.
.SS "Not put test cases inside of for(each)"
.IX Subsection "Not put test cases inside of for(each)"
.Vb 4
\&    # Example of not working
\&    for (1..10) {
\&        my $foo = $_; # => 10
\&    }
.Ve
.PP
This example doesn't work. On the contrary, it will be error (Probably nobody uses such as this way... I think).
.SH "NOTES"
.IX Header "NOTES"
.SS "yada-yada operator"
.IX Subsection "yada-yada operator"
This module ignores yada-yada operators that is in \s-1SYNOPSIS\s0 code.
Thus, following code is runnable.
.PP
.Vb 3
\&    my $foo;
\&    ...
\&    $foo = 1; # => 1
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Synopsis \- simpler module, which just checks the syntax of your \s-1SYNOPSIS\s0 section.
.PP
Dist::Zilla::Plugin::Test::Synopsis \- a plugin for Dist::Zilla users, which adds a release test
to your distribution, based on Test::Synopsis.
.SH "REPOSITORY"
.IX Header "REPOSITORY"
<https://github.com/moznion/Test\-Synopsis\-Expectation>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) moznion.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
moznion <moznion@gmail.com>