Source

p5-p5u / lib / P5U / Lib / TestPod.pm

package P5U::Lib::TestPod;

use 5.010;
use strict;
use utf8;

BEGIN {
	$P5U::Command::TestPod::AUTHORITY = 'cpan:TOBYINK';
	$P5U::Command::TestPod::VERSION   = '0.005';
};

use Object::AUTHORITY;
use Path::Class;
use Path::Class::Rule;
use Test::More;
use Test::Pod;

sub _uniq
{
	my %already;
	grep { not $already{"$_"}++ } @_;
}

sub test_pod
{
	my $self = shift;
	
	my @files = 
		_uniq
		map {
			(-d $_)
				? Path::Class::Rule::->new->or(
					Path::Class::Rule::->new->perl_module,
					Path::Class::Rule::->new->perl_pod,
					Path::Class::Rule::->new->perl_script,
					)->all($_)
				: Path::Class::File::->new($_)
		} @_;
	
	plan tests => scalar @files;
	pod_file_ok("$_", $_) for @files;
}

1;

__END__

=head1 NAME

P5U::Lib::TestPod - support library implementing p5u's testpod command

=head1 SYNOPSIS

 use P5U::Lib::TestPod;
 P5U::Lib::TestPod->test_pod(@files);

=head1 DESCRIPTION

This is a support library for the testpod command.

=head2 Class Method

There's only one method (a class method, not an object method... this
isn't really an OO module) worth caring about:

=over

=item C<< test_pod(@files) >>

Tests the pod in given files. Writes TAP to STDOUT.

Actually, some of the files can be directories, in which case those
directories will be scanned for Perl modules, scripts and pod files.

=back

=head1 BUGS

Please report any bugs to
L<http://rt.cpan.org/Dist/Display.html?Queue=P5U>.

=head1 SEE ALSO

L<p5u>.

=head1 AUTHOR

Toby Inkster E<lt>tobyink@cpan.orgE<gt>.

=head1 COPYRIGHT AND LICENCE

This software is copyright (c) 2012 by Toby Inkster.

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

=head1 DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.