Test::Pod::Coverage::Permissive - Checks for pod coverage regression.
Version 0.05
Checks for POD coverage regressions in your code. This module is for large projects, which can't be covered by POD for a 5 minutes. If you have small module or your project is fully covered - use Test::Pod::Coverage instead.
After first run, this module creates data file, where saves all uncovered subroutines. If you create new uncovered subroutine, it will fail. If you create new package with uncovered subroutines, it will fail. Otherwise it will show diagnostic messages like these:
t/03podcoverage.t .. 2/? # YourProject::Controller::Root: naked 4 subroutine(s) # YourProject::Controller::NotRoot: naked 8 subroutine(s) # YorProject::Controller::AlsoNotRoot: naked 3 subroutine(s) ...
This module will help you to cover your project step-by-step. And your new code will be covered by POD.
Interface is like Test::Pod::Coverage:
use Test::Pod::Coverage::Permissive; use Test::More; eval "use Test::Pod::Coverage::Permissive"; plan skip_all => "Test::Pod::Coverage::Permissive required for testing POD coverage" if $@; all_pod_coverage_ok();
Checks that the POD code in all modules in the distro have proper POD coverage.
If the $parms hashref if passed in, they're passed into the Pod::Coverage object that the function uses. Check the Pod::Coverage manual for what those can be.
Pod::Coverage
The exception is the coverage_class parameter, which specifies a class to use for coverage testing. It defaults to Pod::Coverage.
coverage_class
Checks that the POD code in $module has proper POD coverage.
Returns a list of all modules in $dir and in directories below. If no directories are passed, it defaults to blib if blib exists, or lib if not.
Note that the modules are as "Foo::Bar", not "Foo/Bar.pm".
The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself.
Andrey Kostenko, <andrey at kostenko.name>
<andrey at kostenko.name>
Please report any bugs or feature requests to bug-test-pod-coverage-permissive at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Coverage-Permissive. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-test-pod-coverage-permissive at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Test::Pod::Coverage::Permissive
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Coverage-Permissive
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Test-Pod-Coverage-Permissive
CPAN Ratings
http://cpanratings.perl.org/d/Test-Pod-Coverage-Permissive
Search CPAN
http://search.cpan.org/dist/Test-Pod-Coverage-Permissive/
Thanks to author of Test::Pod::Coverage. 90% of this module is a copy-paste from Test::Pod::Coverage.
Copyright 2010 Andrey Kostenko, based on Andy Lester's Test::Pod::Coverage
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Test::Pod::Coverage::Permissive, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Test::Pod::Coverage::Permissive
CPAN shell
perl -MCPAN -e shell install Test::Pod::Coverage::Permissive
For more information on module installation, please visit the detailed CPAN module installation guide.