xt/podcoverage.t

   1 use warnings;
   2 use strict;
   3
   4 use Test::More;
   5 use List::Util 'first';
   6 use lib qw(t/lib maint/.Generated_Pod/lib);
   7 use DBICTest;
   8 use namespace::clean;
   9
  10 require DBIx::Class;
  11 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
  12   my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
  13   $ENV{RELEASE_TESTING}
  14     ? die ("Failed to load release-testing module requirements: $missing")
  15     : plan skip_all => "Test needs: $missing"
  16 }
  17
  18 # Since this is about checking documentation, a little documentation
  19 # of what this is doing might be in order.
  20 # The exceptions structure below is a hash keyed by the module
  21 # name. Any * in a name is treated like a wildcard and will behave
  22 # as expected. Modules are matched by longest string first, so
  23 # A::B::C will match even if there is A::B*
  24
  25 # 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     'DBIx::Class' => {
  33         ignore => [qw/
  34             MODIFY_CODE_ATTRIBUTES
  35             component_base_class
  36             mk_classdata
  37             mk_classaccessor
  38         /]
  39     },
  40     'DBIx::Class::Carp' => {
  41         ignore => [qw/
  42             unimport
  43         /]
  44     },
  45     'DBIx::Class::Row' => {
  46         ignore => [qw/
  47             MULTICREATE_DEBUG
  48         /],
  49     },
  50     'DBIx::Class::FilterColumn' => {
  51         ignore => [qw/
  52             new
  53             update
  54             store_column
  55             get_column
  56             get_columns
  57         /],
  58     },
  59     'DBIx::Class::ResultSource' => {
  60         ignore => [qw/
  61             compare_relationship_keys
  62             pk_depends_on
  63             resolve_condition
  64             resolve_join
  65             resolve_prefetch
  66             STORABLE_freeze
  67             STORABLE_thaw
  68         /],
  69     },
  70     'DBIx::Class::ResultSet' => {
  71         ignore => [qw/
  72             STORABLE_freeze
  73             STORABLE_thaw
  74         /],
  75     },
  76     'DBIx::Class::ResultSourceHandle' => {
  77         ignore => [qw/
  78             schema
  79             source_moniker
  80         /],
  81     },
  82     'DBIx::Class::Storage' => {
  83         ignore => [qw/
  84             schema
  85             cursor
  86         /]
  87     },
  88     'DBIx::Class::Schema' => {
  89         ignore => [qw/
  90             setup_connection_class
  91         /]
  92     },
  93
  94     'DBIx::Class::Schema::Versioned' => {
  95         ignore => [ qw/
  96             connection
  97         /]
  98     },
  99
 100     'DBIx::Class::Admin'        => {
 101         ignore => [ qw/
 102             BUILD
 103         /]
 104      },
 105
 106     'DBIx::Class::Storage::DBI::Replicated*'        => {
 107         ignore => [ qw/
 108             connect_call_do_sql
 109             disconnect_call_do_sql
 110         /]
 111     },
 112
 113     'DBIx::Class::Admin::*'                         => { skip => 1 },
 114     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
 115     'DBIx::Class::Componentised'                    => { skip => 1 },
 116     'DBIx::Class::AccessorGroup'                    => { skip => 1 },
 117     'DBIx::Class::Relationship::*'                  => { skip => 1 },
 118     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
 119     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
 120     'DBIx::Class::ResultSource::*'                  => { skip => 1 },
 121     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
 122     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
 123     'DBIx::Class::GlobalDestruction'                => { skip => 1 },
 124     'DBIx::Class::Storage::BlockRunner'             => { skip => 1 }, # temporary
 125
 126 # test some specific components whose parents are exempt below
 127     'DBIx::Class::Relationship::Base'               => {},
 128     'DBIx::Class::SQLMaker::LimitDialects'          => {},
 129
 130 # internals
 131     'DBIx::Class::SQLMaker*'                        => { skip => 1 },
 132     'DBIx::Class::SQLAHacks*'                       => { skip => 1 },
 133     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
 134     'SQL::Translator::*'                            => { skip => 1 },
 135
 136 # deprecated / backcompat stuff
 137     'DBIx::Class::Serialize::Storable'              => { skip => 1 },
 138     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
 139     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
 140     'DBIx::Class::DB'                               => { skip => 1 },
 141
 142 # skipped because the synopsis covers it clearly
 143     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
 144
 145 # internal subclass, nothing to POD
 146     'DBIx::Class::ResultSet::Pager'                 => { skip => 1 },
 147 };
 148
 149 my $ex_lookup = {};
 150 for my $string (keys %$exceptions) {
 151   my $ex = $exceptions->{$string};
 152   $string =~ s/\*/'.*?'/ge;
 153   my $re = qr/^$string$/;
 154   $ex_lookup->{$re} = $ex;
 155 }
 156
 157 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
 158
 159 foreach my $module (@modules) {
 160   SKIP: {
 161
 162     my ($match) =
 163       first { $module =~ $_ }
 164       (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
 165     ;
 166
 167     my $ex = $ex_lookup->{$match} if $match;
 168
 169     skip ("$module exempt", 1) if ($ex->{skip});
 170
 171     # build parms up from ignore list
 172     my $parms = {};
 173     $parms->{trustme} =
 174       [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
 175         if exists($ex->{ignore});
 176
 177     # run the test with the potentially modified parm set
 178     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
 179   }
 180 }
 181
 182 done_testing;