diff options
author | DongHun Kwak <dh0128.kwak@samsung.com> | 2022-07-22 14:08:36 +0900 |
---|---|---|
committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2022-07-22 14:08:36 +0900 |
commit | ed5d60008a45c9e27a3e3cfa8ff4333871d26f44 (patch) | |
tree | ee54837194632d111afded07d53407006dca10d5 | |
parent | 7a160a887342dbe0525b9a33c1a772ecf614edb8 (diff) | |
download | perl-Test-Pod-Coverage-ed5d60008a45c9e27a3e3cfa8ff4333871d26f44.tar.gz perl-Test-Pod-Coverage-ed5d60008a45c9e27a3e3cfa8ff4333871d26f44.tar.bz2 perl-Test-Pod-Coverage-ed5d60008a45c9e27a3e3cfa8ff4333871d26f44.zip |
Imported Upstream version 1.10upstream/1.10upstream
-rw-r--r-- | Changes | 148 | ||||
-rw-r--r-- | MANIFEST | 6 | ||||
-rw-r--r-- | META.json | 59 | ||||
-rw-r--r-- | META.yml | 42 | ||||
-rw-r--r-- | Makefile.PL | 53 | ||||
-rw-r--r-- | README | 17 | ||||
-rw-r--r-- | lib/Test/Pod/Coverage.pm (renamed from Coverage.pm) | 23 | ||||
-rw-r--r-- | t/nosymbols.t | 1 |
8 files changed, 264 insertions, 85 deletions
@@ -1,60 +1,88 @@ -Revision history for Test::Pod::Coverage - -1.08 Wed Jan 25 21:59:49 CST 2006 - [FIXES] - * File and directory names may now contain periods and hyphens. - * Now exports all_modules(). - -1.07_01 Wed Dec 28 23:10:31 CST 2005 - [ENHANCEMENTS] - * Can now use an alternate class that implements the Pod::Coverage - interface. This is mostly useful for avoiding the necessity to - redocument or itemize overriden methods in a subclass by using - Pod::Coverage::CountParents. Thanks to Ricardo Signes. - -1.06 Tue Jun 22 16:51:42 CDT 2004 - [ENHANCEMENTS] - * Looks in blib/ if there is one, otherwise looks in lib/ - * Doesn't report "no public symbols" unless verbose mode is on. - * Thanks to David Wheeler and Shawn Sorichetti for nudging. - This behavior will be in Test::Pod soon, too. - -1.04 Sat May 1 00:06:14 CDT 2004 - [FIXES] - * Now it runs taint-safe. I was not untainting the filename. - -1.02 Fri Apr 30 23:27:23 CDT 2004 - [FIXES] - * Fixed a warning in all_modules() under 5.8.3 - -1.00 Wed Apr 28 23:50:19 CDT 2004 - [ENHANCEMENTS] - * Now runs taint-safe. - * No longer uses File::Find. - -0.08 Fri Feb 13 23:13:21 CST 2004 - [ENHANCEMENTS] - * Added all_pod_coverage_ok(), and all_modules() for support. - -0.06 Jan 27 2004 - [ENHANCEMENTS] - * Files with all pod and no symbols is no longer an error. - * Enhanced some of the error messages. - -0.04 Sun Jan 18 21:51:59 CST 2004 - [ENHANCEMENTS] - * Now lists the naked subroutines in the error message. - - -0.03 Sat Jan 17 11:14:56 CST 2004 - [ENHANCEMENTS] - * Now says what module has a problem if it can't find any - POD. Thanks, Barbie. - - [INTERNALS] - * Added a couple more tests to bring my test coverage up - to 100%, according to Devel::Cover. Whoo! - -0.02 - First version with the new reasonable API on pod_coverage_ok(). - If you got in on 0.01, switch now. +Revision history for Perl module Test::Pod::Coverage + +1.10 2014-07-17 NEILB + - Changed license to Artistic 2.0, at PETDANCE's request. + - Added README + - Moved Coverage.pm to lib/Test/Pod/Coverage.pm + - Min perl version now set to 5.006 in both code and dist metadata. + Addresses RT#21564 from ANDK++ + - Added DESCRIPTION section to pod (RT#28715 JEREMIAH++), + and changed to a minimal SYNOPSIS, with everything else moved + to the DESCRIPTION. + - The "no verbose" tests in t/nosymbols.t weren't ensuring that the + tests were running with HARNESS_VERBOSE set to false. You could set + that true in your environment and break the test. + RT#53947 - thanks to Pete Armstrong. + - Makefile.PL: Ensured all prereqs listed in PREREQ_PM, + and TEST_REQUIRES set if a recent enough ExtUtils::MakeMaker. + - Added github repo to pod and dist metadata + - Deleted the old META.yml, so new MYMETA.{yml,json} will be generated. + - Reformatted as per CPAN::Changes::Spec + +1.09_01 2014-07-08 NEILB + - Specified license as 'Perl' in metadata, to match doc. + - All of the changes in 1.10 were first done in this developer release, + apart from the change to Artistic License 2.0. + +1.08 2006-01-26 PETDANCE + [FIXES] + - File and directory names may now contain periods and hyphens. + - Now exports all_modules(). + +1.07_01 2005-12-29 PETDANCE + [ENHANCEMENTS] + - Can now use an alternate class that implements the Pod::Coverage + interface. This is mostly useful for avoiding the necessity to + redocument or itemize overriden methods in a subclass by using + Pod::Coverage::CountParents. Thanks to Ricardo Signes. + +1.06 2004-06-22 PETDANCE + [ENHANCEMENTS] + - Looks in blib/ if there is one, otherwise looks in lib/ + - Doesn't report "no public symbols" unless verbose mode is on. + - Thanks to David Wheeler and Shawn Sorichetti for nudging. + This behavior will be in Test::Pod soon, too. + +1.04 2004-05-01 PETDANCE + [FIXES] + - Now it runs taint-safe. I was not untainting the filename. + +1.02 2004-05-01 PETDANCE + [FIXES] + - Fixed a warning in all_modules() under 5.8.3 + +1.00 2004-04-29 PETDANCE + [ENHANCEMENTS] + - Now runs taint-safe. + - No longer uses File::Find. + +0.08 2004-02-14 PETDANCE + [ENHANCEMENTS] + - Added all_pod_coverage_ok(), and all_modules() for support. + +0.06 2004-01-27 PETDANCE + [ENHANCEMENTS] + - Files with all pod and no symbols is no longer an error. + - Enhanced some of the error messages. + +0.04 2004-01-19 PETDANCE + [ENHANCEMENTS] + - Now lists the naked subroutines in the error message. + + +0.03 2004-01-17 PETDANCE (not released) + [ENHANCEMENTS] + - Now says what module has a problem if it can't find any POD. + Thanks, Barbie. + + [INTERNALS] + - Added a couple more tests to bring my test coverage up + to 100%, according to Devel::Cover. Whoo! + +0.02 2004-01-05 PETDANCE + - First version with the new reasonable API on pod_coverage_ok(). + If you got in on 0.01, switch now. + +0.01 2004-01-04 PETDANCE + - First release to CPAN + @@ -1,7 +1,7 @@ Changes -Coverage.pm +lib/Test/Pod/Coverage.pm MANIFEST -META.yml +README Makefile.PL t/00.load.t t/all_pod_coverage_ok.t @@ -20,3 +20,5 @@ t/pod.t t/privates.t t/self.t t/simple.t +META.yml Module YAML meta-data (added by MakeMaker) +META.json Module JSON meta-data (added by MakeMaker) diff --git a/META.json b/META.json new file mode 100644 index 0000000..03bb46c --- /dev/null +++ b/META.json @@ -0,0 +1,59 @@ +{ + "abstract" : "Check for pod coverage in your distribution", + "author" : [ + "unknown" + ], + "dynamic_config" : 1, + "generated_by" : "ExtUtils::MakeMaker version 6.98, CPAN::Meta::Converter version 2.141170", + "license" : [ + "artistic_2" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Test-Pod-Coverage", + "no_index" : { + "directory" : [ + "t", + "inc" + ] + }, + "prereqs" : { + "build" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "runtime" : { + "requires" : { + "Pod::Coverage" : "0", + "Test::Builder" : "0", + "perl" : "5.006", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "requires" : { + "Test::Builder::Tester" : "0", + "Test::More" : "0", + "lib" : "0" + } + } + }, + "release_status" : "stable", + "resources" : { + "repository" : { + "type" : "git", + "url" : "git://github.com/neilbowers/Test-Pod-Coverage.git", + "web" : "https://github.com/neilbowers/Test-Pod-Coverage" + } + }, + "version" : "1.10" +} @@ -1,13 +1,31 @@ -# http://module-build.sourceforge.net/META-spec.html -#XXXXXXX This is a prototype!!! It will change in the future!!! XXXXX# -name: Test-Pod-Coverage -version: 1.08 -version_from: Coverage.pm -installdirs: site +--- +abstract: 'Check for pod coverage in your distribution' +author: + - unknown +build_requires: + ExtUtils::MakeMaker: '0' + Test::Builder::Tester: '0' + Test::More: '0' + lib: '0' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 1 +generated_by: 'ExtUtils::MakeMaker version 6.98, CPAN::Meta::Converter version 2.141170' +license: artistic_2 +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Test-Pod-Coverage +no_index: + directory: + - t + - inc requires: - Pod::Coverage: 0 - Test::Builder::Tester: 0 - Test::More: 0 - -distribution_type: module -generated_by: ExtUtils::MakeMaker version 6.30 + Pod::Coverage: '0' + Test::Builder: '0' + perl: '5.006' + strict: '0' + warnings: '0' +resources: + repository: git://github.com/neilbowers/Test-Pod-Coverage.git +version: '1.10' diff --git a/Makefile.PL b/Makefile.PL index d10eabb..fa93ea9 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -2,15 +2,56 @@ use strict; use warnings; use ExtUtils::MakeMaker; +my $mm_ver = $ExtUtils::MakeMaker::VERSION; +if ($mm_ver =~ /_/) { + $mm_ver = eval $mm_ver; + die $@ if $@; +} + +my @REQUIRES = ( + 'strict' => 0, + 'warnings' => 0, + 'Pod::Coverage' => 0, + 'Test::Builder' => 0, +); + +my @TEST_REQUIRES = ( + 'Test::Builder::Tester' => 0, + 'Test::More' => 0, + 'lib' => 0, +); + +push(@REQUIRES, @TEST_REQUIRES) if $mm_ver < 6.64; + WriteMakefile( NAME => 'Test::Pod::Coverage', - VERSION_FROM => 'Coverage.pm', + VERSION_FROM => 'lib/Test/Pod/Coverage.pm', ABSTRACT => "Check for pod coverage in your distribution", - PREREQ_PM => { - 'Pod::Coverage' => 0, - 'Test::More' => 0, - 'Test::Builder::Tester' => 0, - }, + PREREQ_PM => { @REQUIRES }, + + ($mm_ver >= 6.64 + ? (TEST_REQUIRES => { @TEST_REQUIRES }) + : () + ), + + ($mm_ver >= 6.48 + ? (MIN_PERL_VERSION => 5.006) + : () + ), + + ($mm_ver >= 6.31 ? (LICENSE => 'artistic_2') : ()), + + ($mm_ver <= 6.45 ? () : (META_MERGE => { + 'meta-spec' => { version => 2 }, + resources => { + repository => { + type => 'git', + web => 'https://github.com/neilbowers/Test-Pod-Coverage', + url => 'git://github.com/neilbowers/Test-Pod-Coverage.git', + }, + }, + })), + dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, clean => { FILES => 'Test-Pod-Coverage-*' }, ); @@ -0,0 +1,17 @@ + + README for Perl module Test::Pod::Coverage + +This module is used to add a test to your Perl distribution, +which checks for pod coverage of all appropriate files. + +You can read a nicely formatted version of the documentation for +this module online: + + https://metacpan.org/pod/Test::Pod::Coverage + +You should be able to install this using your usual method for installing +modules from CPAN. If you don't have one let, have a look at: + + http://www.cpan.org/modules/INSTALL.html + +This module was written by Andy Lester, <petdance@cpan.org> diff --git a/Coverage.pm b/lib/Test/Pod/Coverage.pm index fee0eb4..f803b93 100644 --- a/Coverage.pm +++ b/lib/Test/Pod/Coverage.pm @@ -6,19 +6,25 @@ Test::Pod::Coverage - Check for pod coverage in your distribution. =head1 VERSION -Version 1.08 +Version 1.10 =cut -our $VERSION = "1.08"; +our $VERSION = "1.10"; =head1 SYNOPSIS -Checks for POD coverage in files for your distribution. +In one of your dist's test files (eg C<t/pod-coverage.t>): use Test::Pod::Coverage tests=>1; pod_coverage_ok( "Foo::Bar", "Foo::Bar is covered" ); +=head1 DESCRIPTION + +Test::Pod::Coverage is used to create a test for your distribution, +to ensure that all relevant files in your distribution are appropriately +documented in pod. + Can also be called with L<Pod::Coverage> parms. use Test::Pod::Coverage tests=>1; @@ -73,6 +79,7 @@ modules in the module distribution: =cut +use 5.006; use strict; use warnings; @@ -284,6 +291,10 @@ L<http://search.cpan.org/dist/Test-Pod-Coverage> =back +=head1 REPOSITORY + +L<https://github.com/neilbowers/Test-Pod-Coverage> + =head1 AUTHOR Written by Andy Lester, C<< <andy at petdance.com> >>. @@ -297,8 +308,10 @@ writing Pod::Coverage. Copyright 2006, Andy Lester, All Rights Reserved. -You may use, modify, and distribute this package under the -same terms as Perl itself. +This program is free software; you can redistribute it and/or modify it +under the terms of the Artistic License version 2.0. + +See http://dev.perl.org/licenses/ for more information =cut diff --git a/t/nosymbols.t b/t/nosymbols.t index 02d2c41..af892f1 100644 --- a/t/nosymbols.t +++ b/t/nosymbols.t @@ -10,6 +10,7 @@ BEGIN { } NO_VERBOSE: { + local $ENV{HARNESS_VERBOSE} = 0; test_out( "ok 1 - Checking Nosymbols" ); pod_coverage_ok( "Nosymbols", "Checking Nosymbols" ); test_test( "Handles files with no symbols" ); |