xt/dist/pod_coverage.t

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