package Test::Pod;
use strict;
=head1 NAME
Test::Pod - check for POD errors in files
=head1 VERSION
Version 1.48
=cut
our $VERSION = '1.48';
=head1 SYNOPSIS
C<Test::Pod> lets you check the validity of a POD file, and report
its results in standard C<Test::Simple> fashion.
use Test::Pod tests => $num_tests;
pod_file_ok( $file, "Valid POD file" );
Module authors can include the following in a F<t/pod.t> file and
have C<Test::Pod> automatically find and check all POD files in a
module distribution:
use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
all_pod_files_ok();
You can also specify a list of files to check, using the
C<all_pod_files()> function supplied:
use strict;
use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
my @poddirs = qw( blib script );
all_pod_files_ok( all_pod_files( @poddirs ) );
Or even (if you're running under L<Apache::Test>):
use strict;
use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
my @poddirs = qw( blib script );
use File::Spec::Functions qw( catdir updir );
all_pod_files_ok(
all_pod_files( map { catdir updir, $_ } @poddirs )
);
=head1 DESCRIPTION
Check POD files for errors or warnings in a test file, using
C<Pod::Simple> to do the heavy lifting.
=cut
use 5.008;
use Test::Builder;
use Pod::Simple;
our %ignore_dirs = (
'.bzr' => 'Bazaar',
'.git' => 'Git',
'.hg' => 'Mercurial',
'.pc' => 'quilt',
'.svn' => 'Subversion',
CVS => 'CVS',
RCS => 'RCS',
SCCS => 'SCCS',
_darcs => 'darcs',
_sgbak => 'Vault/Fortress',
);
my $Test = Test::Builder->new;
sub import {
my $self = shift;
my $caller = caller;
for my $func ( qw( pod_file_ok all_pod_files all_pod_files_ok ) ) {
no strict 'refs';
*{$caller."::".$func} = \&$func;
}
$Test->exported_to($caller);
$Test->plan(@_);
}
sub _additional_test_pod_specific_checks {
my ($ok, $errata, $file) = @_;
return $ok;
}
=head1 FUNCTIONS
=head2 pod_file_ok( FILENAME[, TESTNAME ] )
C<pod_file_ok()> will okay the test if the POD parses correctly. Certain
conditions are not reported yet, such as a file with no pod in it at all.
When it fails, C<pod_file_ok()> will show any pod checking errors as
diagnostics.
The optional second argument TESTNAME is the name of the test. If it
is omitted, C<pod_file_ok()> chooses a default test name "POD test
for FILENAME".
=cut
sub pod_file_ok {
my $file = shift;
my $name = @_ ? shift : "POD test for $file";
if ( !-f $file ) {
$Test->ok( 0, $name );
$Test->diag( "$file does not exist" );
return;
}
my $checker = Pod::Simple->new;
$checker->output_string( \my $trash ); # Ignore any output
$checker->parse_file( $file );
my $ok = !$checker->any_errata_seen;
$ok = _additional_test_pod_specific_checks( $ok, ($checker->{errata}||={}), $file );
$name .= ' (no pod)' if !$checker->content_seen;
$Test->ok( $ok, $name );
if ( !$ok ) {
my $lines = $checker->{errata};
for my $line ( sort { $a<=>$b } keys %$lines ) {
my $errors = $lines->{$line};
$Test->diag( "$file ($line): $_" ) for @$errors;
}
}
return $ok;
} # pod_file_ok
=head2 all_pod_files_ok( [@entries] )
Checks all the files under C<@entries> for valid POD. It runs
L<all_pod_files()> on directories and assumes everything else to be a file to
be tested. It calls the C<plan()> function for you (one test for each file),
so you can't have already called C<plan>.
If C<@entries> is empty or not passed, the function finds all POD files in
files in the F<blib> directory if it exists, or the F<lib> directory if not. A
POD file is one that ends with F<.pod>, F<.pl> and F<.pm>, or any file where
the first line looks like a shebang line.
If you're testing a module, just make a F<t/pod.t>:
use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
all_pod_files_ok();
Returns true if all pod files are ok, or false if any fail.
=cut
sub all_pod_files_ok {
my @args = @_ ? @_ : _starting_points();
my @files = map { -d $_ ? all_pod_files($_) : $_ } @args;
unless (@files) {
$Test->skip_all( "No files found in (@args)\n" );
return 1;
}
$Test->plan( tests => scalar @files );
my $ok = 1;
foreach my $file ( @files ) {
pod_file_ok( $file ) or undef $ok;
}
return $ok;
}
=head2 all_pod_files( [@dirs] )
Returns a list of all the Perl files in I<@dirs> and in directories below. If
no directories are passed, it defaults to F<blib> if F<blib> exists, or else
F<lib> if not. Skips any files in F<CVS>, F<.svn>, F<.git> and similar
directories. See C<%Test::Pod::ignore_dirs> for a list of them.
A Perl file is:
=over 4
=item * Any file that ends in F<.PL>, F<.pl>, F<.PL>, F<.pm>, F<.pod>, or F<.t>.
=item * Any file that has a first line with a shebang and "perl" on it.
=item * Any file that ends in F<.bat> and has a first line with "--*-Perl-*--" on it.
=back
The order of the files returned is machine-dependent. If you want them
sorted, you'll have to sort them yourself.
=cut
sub all_pod_files {
my @pod;
require File::Find;
File::Find::find({
wanted => sub { -f $_ && _is_perl ($_) and push @pod, $File::Find::name },
no_chdir => 1,
}, @_ ? @_ : _starting_points());
return @pod;
}
sub _starting_points {
return 'blib' if -e 'blib';
return 'lib';
}
sub _is_perl {
my $file = shift;
return 1 if $file =~ /\.PL$/;
return 1 if $file =~ /\.p(?:l|m|od)$/;
return 1 if $file =~ /\.t$/;
open my $fh, '<', $file or return;
my $first = <$fh>;
close $fh;
return 1 if defined $first && ($first =~ /(?:^#!.*perl)|--\*-Perl-\*--/);
return;
}
=head1 TODO
STUFF TO DO
Note the changes that are being made.
Note that you no longer can test for "no pod".
=head1 AUTHOR
Currently maintained by David E. Wheeler, C<< <david@justatheory.com> >>.
Originally by brian d foy.
Maintainer emeritus: Andy Lester, C<< <andy at petdance.com> >>.
=head1 ACKNOWLEDGEMENTS
Thanks to
Andy Lester,
David Wheeler,
Paul Miller
and
Peter Edwards
for contributions and to C<brian d foy> for the original code.
=head1 COPYRIGHT AND LICENSE
Copyright 2006-2010, Andy Lester. Some Rights Reserved.
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
1;