t/91podcoverage.t

   1 use Test::More;
   2
   3 # TEMPORARY
   4 if (my $head = `git rev-parse HEAD`) {
   5   plan skip_all => "Test disabled until after merge"
   6     if $head ne `git rev-parse master`;
   7
   8   die "\n\n=================\n!!! Fix the test and remove temporary header !!!\n=================\n\n";
   9 }
  10
  11 eval "use Pod::Coverage 0.19";
  12 plan skip_all => 'Pod::Coverage 0.19 required' if $@;
  13 eval "use Test::Pod::Coverage 1.04";
  14 plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@;
  15
  16 plan skip_all => 'set TEST_POD to enable this test'
  17   unless ( $ENV{TEST_POD} || -e 'MANIFEST.SKIP' );
  18
  19 my @modules = sort { $a cmp $b } ( Test::Pod::Coverage::all_modules() );
  20 plan tests => scalar(@modules);
  21
  22 # Since this is about checking documentation, a little documentation
  23 # of what this is doing might be in order...
  24 # The exceptions structure below is a hash keyed by the module
  25 # name.  The value for each is a hash, which contains one or more
  26 # (although currently more than one makes no sense) of the following
  27 # things:-
  28 #   skip   => a true value means this module is not checked
  29 #   ignore => array ref containing list of methods which
  30 #             do not need to be documented.
  31 my $exceptions = {
  32     'SQL::Abstract' => {
  33         ignore => [
  34             qw/belch
  35               puke/
  36         ]
  37     },
  38     'SQL::Abstract::Test' => { skip => 1 },
  39     'DBIx::Class::Storage::Debug::PrettyPrint' => { skip => 1 },
  40 };
  41
  42 foreach my $module (@modules) {
  43   SKIP:
  44     {
  45         skip "$module - No user visible methods",
  46           1
  47           if ( $exceptions->{$module}{skip} );
  48
  49         # build parms up from ignore list
  50         my $parms = {};
  51         $parms->{trustme} =
  52           [ map { qr/^$_$/ } @{ $exceptions->{$module}{ignore} } ]
  53           if exists( $exceptions->{$module}{ignore} );
  54
  55         # run the test with the potentially modified parm set
  56         pod_coverage_ok( $module, $parms, "$module POD coverage" );
  57     }
  58 }