Test::Pod::Snippets 0.02

Test::Pod::Snippets is a Perl module to generate tests from pod code snippets. SYNOPSIS use Test::Pod::Snippets; my $tps = Test::Pod::Snippets->new(); $tps->generate_snippets( @pm_and_pod_files ); Fact 1 In a perfect world, a modules full API should be covered by an extensive battery of testcases neatly tucked in the distributions t/ directory. But then, in a perfect world each backyard would have a marshmallow tree and postmen would consider their duty to circle all the real good deals in pamphlets before stuffing them in your mailbox. Obviously, were not living in a perfect world. Fact 2 Typos and minor errors in module documentation. Lets face it: it happens to everyone. And while its never the end of the world and is prone to rectify itself in time, its always kind of embarassing. A little bit like electronic zits on prepubescent docs, if you will. Test::Pod::Snippetss goal is to address those issues. Quite simply, it extracts verbatim text off pod documents -- which it assumes to be code snippets -- and generate test files out of them. HOW TO USE TEST::POD::SNIPPETS IN YOUR DISTRIBUTION If you are using Module::Build, add the following to your Build.PL: my $builder = Module::Build->new( # ... your M::B parameters PL_files => { script/test-pod-snippets.PL => q{} }, add_to_cleanup => [ t/pod-snippets-*.t ], ); Then create the file script/test-pod-snippets.PL, which should contains use Test::Pod::Snippets; my $tps = Test::Pod::Snippets->new; $tps->generate_snippets( qw# lib/your/module.pm lib/your/documentation.pod #); And youre set! Running Build should now generate one test file for each given module. If you prefer to generate the tests yourself, skip the modifications to Build.PL and call test-pod-snippets.PL from the distributions main directory..

Requirements:	No special requirements
Platforms:	Linux
Keyword:	Code,  Generate,  In A Perfect World,  Libraries,  Module,  Perl Module,  Pod,  Programming,  Testpodsnippets,  Tests,  World
Users rating:	0/10