view release on metacpan or  search on metacpan

xt/podcoverage.t  view on Meta::CPAN

use warnings;
use strict;

use Test::More;
plan skip_all => "Skipping finicky test on older perl"
  if "$]" < 5.008005;

# This test must run via 'dzil test', not 'prove xt/' directly —
# PodWeaver must have already processed the source files.
do {
  my $sample = do { local (@ARGV, $/) = 'lib/DBIO/Admin.pm'; <> };
  plan skip_all => 'Run via dzil test — PodWeaver must process files first (prove xt/ not supported)'
    unless $sample =~ /^=head1 (?:ATTRIBUTES|METHODS)/m;
};

require DBIO;
unless ( DBIO::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
  my $missing = DBIO::Optional::Dependencies->req_missing_for ('test_podcoverage');
  $ENV{RELEASE_TESTING}
    ? die ("Failed to load release-testing module requirements: $missing")
    : plan skip_all => "Test needs: $missing"
}

# this has already been required but leave it here for CPANTS static analysis
require Test::Pod::Coverage;

# Since this is about checking documentation, a little documentation
# of what this is doing might be in order.
# The exceptions structure below is a hash keyed by the module
# name. Any * in a name is treated like a wildcard and will behave
# as expected. Modules are matched by longest string first, so
# A::B::C will match even if there is A::B*

# The value for each is a hash, which contains one or more
# (although currently more than one makes no sense) of the following
# things:-
#   skip   => a true value means this module is not checked
#   ignore => array ref containing list of methods which
#             do not need to be documented.
my $exceptions = {
    'DBIO' => {
        ignore => [qw/
            MODIFY_CODE_ATTRIBUTES
            component_base_class
            mk_classdata
            mk_classaccessor
        /]
    },
    'DBIO::Carp' => {
        ignore => [qw/
            unimport
        /]
    },
    'DBIO::Row' => {
        ignore => [qw/
            MULTICREATE_DEBUG
            clean_rs
            serializable_columns
        /],
    },
    'DBIO::FilterColumn' => {
        ignore => [qw/
            new
            update
            store_column
            get_column
            get_columns
            get_dirty_columns
            has_column_loaded
        /],
    },