5 use List::Util 'first';
10 # Don't run tests for installs
11 unless ( DBICTest::AuthorCheck->is_author || $ENV{AUTOMATED_TESTING} || $ENV{RELEASE_TESTING} ) {
12 plan( skip_all => "Author tests not required for installation" );
16 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
17 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
18 $ENV{RELEASE_TESTING} || DBICTest::AuthorCheck->is_author
19 ? die ("Failed to load release-testing module requirements: $missing")
20 : plan skip_all => "Test needs: $missing"
23 # Since this is about checking documentation, a little documentation
24 # of what this is doing might be in order.
25 # The exceptions structure below is a hash keyed by the module
26 # name. Any * in a name is treated like a wildcard and will behave
27 # as expected. Modules are matched by longest string first, so
28 # A::B::C will match even if there is A::B*
30 # The value for each is a hash, which contains one or more
31 # (although currently more than one makes no sense) of the following
33 # skip => a true value means this module is not checked
34 # ignore => array ref containing list of methods which
35 # do not need to be documented.
39 MODIFY_CODE_ATTRIBUTES
45 'DBIx::Class::Row' => {
50 'DBIx::Class::FilterColumn' => {
59 'DBIx::Class::ResultSource' => {
61 compare_relationship_keys
68 'DBIx::Class::ResultSourceHandle' => {
74 'DBIx::Class::Storage' => {
80 'DBIx::Class::Schema' => {
82 setup_connection_class
86 'DBIx::Class::Schema::Versioned' => {
92 'DBIx::Class::Admin' => {
98 'DBIx::Class::Storage::DBI::Replicated*' => {
101 disconnect_call_do_sql
105 'DBIx::Class::Admin::*' => { skip => 1 },
106 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
107 'DBIx::Class::Componentised' => { skip => 1 },
108 'DBIx::Class::Relationship::*' => { skip => 1 },
109 'DBIx::Class::ResultSetProxy' => { skip => 1 },
110 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
111 'DBIx::Class::Storage::Statistics' => { skip => 1 },
112 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
114 # test some specific components whose parents are exempt below
115 'DBIx::Class::Relationship::Base' => {},
118 'DBIx::Class::SQLAHacks*' => { skip => 1 },
119 'DBIx::Class::Storage::DBI*' => { skip => 1 },
120 'SQL::Translator::*' => { skip => 1 },
122 # deprecated / backcompat stuff
123 'DBIx::Class::CDBICompat*' => { skip => 1 },
124 'DBIx::Class::ResultSetManager' => { skip => 1 },
125 'DBIx::Class::DB' => { skip => 1 },
127 # skipped because the synopsis covers it clearly
128 'DBIx::Class::InflateColumn::File' => { skip => 1 },
132 for my $string (keys %$exceptions) {
133 my $ex = $exceptions->{$string};
134 $string =~ s/\*/'.*?'/ge;
135 my $re = qr/^$string$/;
136 $ex_lookup->{$re} = $ex;
139 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
141 foreach my $module (@modules) {
145 first { $module =~ $_ }
146 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
149 my $ex = $ex_lookup->{$match} if $match;
151 skip ("$module exempt", 1) if ($ex->{skip});
153 # build parms up from ignore list
156 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
157 if exists($ex->{ignore});
159 # run the test with the potentially modified parm set
160 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");