File: README.md

package info (click to toggle)
libtest-synopsis-perl 0.15-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 344 kB
  • ctags: 24
  • sloc: perl: 220; makefile: 2
file content (200 lines) | stat: -rw-r--r-- 6,150 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# NAME

Test::Synopsis - Test your SYNOPSIS code

# SYNOPSIS

    # xt/synopsis.t (with Module::Install::AuthorTests)
    use Test::Synopsis;
    all_synopsis_ok();

    # Or, run safe without Test::Synopsis
    use Test::More;
    eval "use Test::Synopsis";
    plan skip_all => "Test::Synopsis required for testing" if $@;
    all_synopsis_ok();

# DESCRIPTION

Test::Synopsis is an (author) test module to find .pm or .pod files
under your _lib_ directory and then make sure the example snippet
code in your _SYNOPSIS_ section passes the perl compile check.

Note that this module only checks the perl syntax (by wrapping the
code with `sub`) and doesn't actually run the code, **UNLESS**
that code is a `BEGIN {}` block or a `use` statement.

Suppose you have the following POD in your module.

    =head1 NAME

    Awesome::Template - My awesome template

    =head1 SYNOPSIS

      use Awesome::Template;

      my $template = Awesome::Template->new;
      $tempalte->render("template.at");

    =head1 DESCRIPTION

An user of your module would try copy-paste this synopsis code and
find that this code doesn't compile because there's a typo in your
variable name _$tempalte_. Test::Synopsis will catch that error
before you ship it.

# VARIABLE DECLARATIONS

Sometimes you might want to put some undeclared variables in your
synopsis, like:

    =head1 SYNOPSIS

      use Data::Dumper::Names;
      print Dumper($scalar, \@array, \%hash);

This assumes these variables like _$scalar_ are defined elsewhere in
module user's code, but Test::Synopsis, by default, will complain that
these variables are not declared:

    Global symbol "$scalar" requires explicit package name at ...

In this case, you can add the following POD sequence elsewhere in your POD:

    =for test_synopsis
    no strict 'vars'

Or more explicitly,

    =for test_synopsis
    my($scalar, @array, %hash);

Test::Synopsis will find these `=for` blocks and these statements are
prepended before your SYNOPSIS code when being evaluated, so those
variable name errors will go away, without adding unnecessary bits in
SYNOPSIS which might confuse users.

# SKIPPING TEST FROM INSIDE THE POD

You can use a `BEGIN{}` block in the `=for test_synopsis` to check for
specific conditions (e.g. if a module is present), and possibly skip
the test.

If you `die()` inside the `BEGIN{}` block and the die message begins
with sequence `SKIP:` (note the colon at the end), the test
will be skipped for that document.

    =head1 SYNOPSIS

    =for test_synopsis BEGIN { die "SKIP: skip this pod, it's horrible!\n"; }

        $x; # undeclared variable, but we skipped the test!

    =end

# EXPORTED SUBROUTINES

## `all_synopsis_ok`

    all_synopsis_ok();

    all_synopsis_ok( dump_all_code_on_error => 1 );

Checks the SYNOPSIS code in all your modules. Takes **optional**
arguments as key/value pairs. Possible arguments are as follows:

### `dump_all_code_on_error`

    all_synopsis_ok( dump_all_code_on_error => 1 );

Takes true or false values as a value. **Defaults to:** false. When
set to a true value, if an error is discovered in the SYNOPSIS code,
the test will dump the entire snippet of code it tried to test. Use this
if you want to copy/paste and play around with the code until the error
is fixed.

The dumped code will include any of the `=for` code you specified (see
["VARIABLE DECLARATIONS"](#variable-declarations) section above) as well as a few internal bits
this test module uses to make SYNOPSIS code checking possible.

**Note:** you will likely have to remove the `#` and a space at the start
of each line (`perl -pi -e 's/^#\s//;' TEMP_FILE_WITH_CODE`)

## `synopsis_ok`

    use Test::More tests => 1;
    use Test::Synopsis;
    synopsis_ok("t/lib/NoPod.pm");
    synopsis_ok(qw/Pod1.pm  Pod2.pm  Pod3.pm/);

Lets you test a single file. **Note:** you must setup your own plan if
you use this subroutine (e.g. with `use Test::More tests => 1;`).
**Takes** a list of filenames for documents containing SYNOPSIS code to test.

# CAVEATS

This module will not check code past the `__END__` or
`__DATA__` tokens, if one is
present in the SYNOPSIS code.

This module will actually execute `use` statements and any code
you specify in the `BEGIN {}` blocks in the SYNOPSIS.

If you're using HEREDOCs in your SYNOPSIS, you will need to place
the ending of the HEREDOC at the same indent as the
first line of the code of your SYNOPSIS.

Redefinition warnings can be turned off with

    =for test_synopsis
    no warnings 'redefine';

# REPOSITORY

Fork this module on GitHub:
[https://github.com/miyagawa/Test-Synopsis](https://github.com/miyagawa/Test-Synopsis)

# BUGS

To report bugs or request features, please use
[https://github.com/miyagawa/Test-Synopsis/issues](https://github.com/miyagawa/Test-Synopsis/issues)

If you can't access GitHub, you can email your request
to `bug-Test-Synopsis at rt.cpan.org`

# AUTHOR

Tatsuhiko Miyagawa <miyagawa@bulknews.net>

Goro Fuji blogged about the original idea at
[http://d.hatena.ne.jp/gfx/20090224/1235449381](http://d.hatena.ne.jp/gfx/20090224/1235449381) based on the testing
code taken from [Test::Weaken](https://metacpan.org/pod/Test::Weaken).

# MAINTAINER

Zoffix Znet <cpan (at) zoffix.com>

# CONTRIBUTORS

- Dave Rolsky ([DROLSKY](https://metacpan.org/author/DROLSKY))
- Kevin Ryde ([KRYDE](https://metacpan.org/author/KRYDE))
- Marcel Grünauer ([MARCEL](https://metacpan.org/author/MARCEL))
- Mike Doherty ([DOHERTY](https://metacpan.org/author/DOHERTY))
- Patrice Clement ([monsieurp](https://github.com/monsieurp))
- Greg Sabino Mullane ([TURNSTEP](https://metacpan.org/author/TURNSTEP))
- Zoffix Znet ([ZOFFIX](https://metacpan.org/author/ZOFFIX))
- Olivier Mengué ([DOLMEN](https://metacpan.org/author/DOLMEN))

# LICENSE

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

# COPYRIGHT

This library is Copyright (c) Tatsuhiko Miyagawa

# SEE ALSO

[Test::Pod](https://metacpan.org/pod/Test::Pod), [Test::UseAllModules](https://metacpan.org/pod/Test::UseAllModules), [Test::Inline](https://metacpan.org/pod/Test::Inline)