xt/dist/pod_coverage.t

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