5 use List::Util 'first';
10 # Don't run tests for installs
11 if ( DBICTest::RunMode->is_plain ) {
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::Storage::TxnScopeGuard' => {
55 'DBIx::Class::FilterColumn' => {
64 'DBIx::Class::ResultSource' => {
66 compare_relationship_keys
73 'DBIx::Class::ResultSourceHandle' => {
79 'DBIx::Class::Storage' => {
85 'DBIx::Class::Schema' => {
87 setup_connection_class
91 'DBIx::Class::Schema::Versioned' => {
97 'DBIx::Class::Admin' => {
103 'DBIx::Class::Storage::DBI::Replicated*' => {
106 disconnect_call_do_sql
110 'DBIx::Class::Admin::*' => { skip => 1 },
111 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
112 'DBIx::Class::Componentised' => { skip => 1 },
113 'DBIx::Class::Relationship::*' => { skip => 1 },
114 'DBIx::Class::ResultSetProxy' => { skip => 1 },
115 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
116 'DBIx::Class::Storage::Statistics' => { skip => 1 },
117 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
119 # test some specific components whose parents are exempt below
120 'DBIx::Class::Relationship::Base' => {},
121 'DBIx::Class::SQLMaker::LimitDialects' => {},
124 'DBIx::Class::SQLMaker*' => { skip => 1 },
125 'DBIx::Class::Storage::DBI*' => { skip => 1 },
126 'SQL::Translator::*' => { skip => 1 },
128 # deprecated / backcompat stuff
129 'DBIx::Class::CDBICompat*' => { skip => 1 },
130 'DBIx::Class::ResultSetManager' => { skip => 1 },
131 'DBIx::Class::DB' => { skip => 1 },
133 # skipped because the synopsis covers it clearly
134 'DBIx::Class::InflateColumn::File' => { skip => 1 },
138 for my $string (keys %$exceptions) {
139 my $ex = $exceptions->{$string};
140 $string =~ s/\*/'.*?'/ge;
141 my $re = qr/^$string$/;
142 $ex_lookup->{$re} = $ex;
145 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
147 foreach my $module (@modules) {
151 first { $module =~ $_ }
152 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
155 my $ex = $ex_lookup->{$match} if $match;
157 skip ("$module exempt", 1) if ($ex->{skip});
159 # build parms up from ignore list
162 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
163 if exists($ex->{ignore});
165 # run the test with the potentially modified parm set
166 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");