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