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