t/03podcoverage.t

   1 use Test::More;
   2
   3 eval "use Pod::Coverage 0.19";
   4 plan skip_all => 'Pod::Coverage 0.19 required' if $@;
   5 eval "use Test::Pod::Coverage 1.04";
   6 plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@;
   7
   8 plan skip_all => 'set TEST_POD to enable this test'
   9   unless ($ENV{TEST_POD} || -e 'MANIFEST.SKIP');
  10
  11 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
  12 plan tests => scalar(@modules);
  13
  14 # Since this is about checking documentation, a little documentation
  15 # of what this is doing might be in order...
  16 # The exceptions structure below is a hash keyed by the module
  17 # name.  The value for each is a hash, which contains one or more
  18 # (although currently more than one makes no sense) of the following
  19 # things:-
  20 #   skip   => a true value means this module is not checked
  21 #   ignore => array ref containing list of methods which
  22 #             do not need to be documented.
  23 my $exceptions = {
  24     'DBIx::Class' => {
  25         ignore => [
  26             qw/MODIFY_CODE_ATTRIBUTES
  27               component_base_class
  28               mk_classdata
  29               mk_classaccessor/
  30         ]
  31     },
  32     'DBIx::Class::Row' => {
  33         ignore => [
  34            qw( MULTICREATE_DEBUG )
  35         ],
  36     },
  37     'DBIx::Class::Storage' => {
  38         ignore => [
  39             qw(cursor)
  40         ]
  41     },
  42     'DBIx::Class::Schema' => {
  43         ignore => [
  44             qw(setup_connection_class)
  45         ]
  46     },
  47     'DBIx::Class::CDBICompat::AccessorMapping'          => { skip => 1 },
  48     'DBIx::Class::CDBICompat::AbstractSearch' => {
  49         ignore => [qw(search_where)]
  50     },
  51     'DBIx::Class::CDBICompat::AttributeAPI'             => { skip => 1 },
  52     'DBIx::Class::CDBICompat::AutoUpdate'               => { skip => 1 },
  53     'DBIx::Class::CDBICompat::ColumnsAsHash' => {
  54         ignore => [qw(inflate_result new update)]
  55     },
  56     'DBIx::Class::CDBICompat::ColumnCase'               => { skip => 1 },
  57     'DBIx::Class::CDBICompat::ColumnGroups'             => { skip => 1 },
  58     'DBIx::Class::CDBICompat::Constraints'              => { skip => 1 },
  59     'DBIx::Class::CDBICompat::Constructor'              => { skip => 1 },
  60     'DBIx::Class::CDBICompat::Copy' => {
  61         ignore => [qw(copy)]
  62     },
  63     'DBIx::Class::CDBICompat::DestroyWarning'           => { skip => 1 },
  64     'DBIx::Class::CDBICompat::GetSet'                   => { skip => 1 },
  65     'DBIx::Class::CDBICompat::HasA'                     => { skip => 1 },
  66     'DBIx::Class::CDBICompat::HasMany'                  => { skip => 1 },
  67     'DBIx::Class::CDBICompat::ImaDBI'                   => { skip => 1 },
  68     'DBIx::Class::CDBICompat::LazyLoading'              => { skip => 1 },
  69     'DBIx::Class::CDBICompat::LiveObjectIndex'          => { skip => 1 },
  70     'DBIx::Class::CDBICompat::MightHave'                => { skip => 1 },
  71     'DBIx::Class::CDBICompat::NoObjectIndex'            => { skip => 1 },
  72     'DBIx::Class::CDBICompat::Pager'                    => { skip => 1 },
  73     'DBIx::Class::CDBICompat::ReadOnly'                 => { skip => 1 },
  74     'DBIx::Class::CDBICompat::Relationship'             => { skip => 1 },
  75     'DBIx::Class::CDBICompat::Relationships'            => { skip => 1 },
  76     'DBIx::Class::CDBICompat::Retrieve'                 => { skip => 1 },
  77     'DBIx::Class::CDBICompat::SQLTransformer'           => { skip => 1 },
  78     'DBIx::Class::CDBICompat::Stringify'                => { skip => 1 },
  79     'DBIx::Class::CDBICompat::TempColumns'              => { skip => 1 },
  80     'DBIx::Class::CDBICompat::Triggers'                 => { skip => 1 },
  81     'DBIx::Class::ClassResolver::PassThrough'           => { skip => 1 },
  82     'DBIx::Class::Componentised'                        => { skip => 1 },
  83     'DBIx::Class::Relationship::Accessor'               => { skip => 1 },
  84     'DBIx::Class::Relationship::BelongsTo'              => { skip => 1 },
  85     'DBIx::Class::Relationship::CascadeActions'         => { skip => 1 },
  86     'DBIx::Class::Relationship::HasMany'                => { skip => 1 },
  87     'DBIx::Class::Relationship::HasOne'                 => { skip => 1 },
  88     'DBIx::Class::Relationship::Helpers'                => { skip => 1 },
  89     'DBIx::Class::Relationship::ManyToMany'             => { skip => 1 },
  90     'DBIx::Class::Relationship::ProxyMethods'           => { skip => 1 },
  91     'DBIx::Class::ResultSetProxy'                       => { skip => 1 },
  92     'DBIx::Class::ResultSetManager'                     => { skip => 1 },
  93     'DBIx::Class::ResultSourceProxy'                    => { skip => 1 },
  94     'DBIx::Class::Storage::DBI'                         => { skip => 1 },
  95     'DBIx::Class::Storage::DBI::DB2'                    => { skip => 1 },
  96     'DBIx::Class::Storage::DBI::MSSQL'                  => { skip => 1 },
  97     'DBIx::Class::Storage::DBI::MultiDistinctEmulation' => { skip => 1 },
  98     'DBIx::Class::Storage::DBI::ODBC400'                => { skip => 1 },
  99     'DBIx::Class::Storage::DBI::ODBC::DB2_400_SQL'      => { skip => 1 },
 100     'DBIx::Class::Storage::DBI::Oracle'                 => { skip => 1 },
 101     'DBIx::Class::Storage::DBI::Pg'                     => { skip => 1 },
 102     'DBIx::Class::Storage::DBI::SQLite'                 => { skip => 1 },
 103     'DBIx::Class::Storage::DBI::mysql'                  => { skip => 1 },
 104     'SQL::Translator::Parser::DBIx::Class'              => { skip => 1 },
 105     'SQL::Translator::Producer::DBIx::Class::File'      => { skip => 1 },
 106
 107 # skipped because the synopsis covers it clearly
 108
 109     'DBIx::Class::InflateColumn::File'                  => { skip => 1 },
 110
 111 # skip connection since it's just an override
 112
 113     'DBIx::Class::Schema::Versioned' => { ignore => [ qw(connection) ] },
 114
 115 # don't bother since it's heavily deprecated
 116     'DBIx::Class::ResultSetManager' => { skip => 1 },
 117 };
 118
 119 foreach my $module (@modules) {
 120   SKIP:
 121     {
 122         skip "$module - No real methods", 1 if ($exceptions->{$module}{skip});
 123
 124         # build parms up from ignore list
 125         my $parms = {};
 126         $parms->{trustme} =
 127           [ map { qr/^$_$/ } @{ $exceptions->{$module}{ignore} } ]
 128           if exists($exceptions->{$module}{ignore});
 129
 130         # run the test with the potentially modified parm set
 131         pod_coverage_ok($module, $parms, "$module POD coverage");
 132     }
 133 }