5 use List::Util 'first';
6 use lib qw(t/lib maint/.Generated_Pod/lib);
10 plan skip_all => "Skipping finicky test on older perl"
14 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
15 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
17 ? die ("Failed to load release-testing module requirements: $missing")
18 : plan skip_all => "Test needs: $missing"
21 # this has already been required but leave it here for CPANTS static analysis
22 require Test::Pod::Coverage;
24 # Since this is about checking documentation, a little documentation
25 # of what this is doing might be in order.
26 # The exceptions structure below is a hash keyed by the module
27 # name. Any * in a name is treated like a wildcard and will behave
28 # as expected. Modules are matched by longest string first, so
29 # A::B::C will match even if there is A::B*
31 # The value for each is a hash, which contains one or more
32 # (although currently more than one makes no sense) of the following
34 # skip => a true value means this module is not checked
35 # ignore => array ref containing list of methods which
36 # do not need to be documented.
40 MODIFY_CODE_ATTRIBUTES
46 'DBIx::Class::Carp' => {
51 'DBIx::Class::Row' => {
56 'DBIx::Class::FilterColumn' => {
67 'DBIx::Class::ResultSource' => {
69 compare_relationship_keys
78 'DBIx::Class::ResultSet' => {
84 'DBIx::Class::ResultSourceHandle' => {
90 'DBIx::Class::Storage' => {
96 'DBIx::Class::Schema' => {
98 setup_connection_class
102 'DBIx::Class::Schema::Versioned' => {
108 'DBIx::Class::Admin' => {
114 'DBIx::Class::Storage::DBI::Replicated*' => {
117 disconnect_call_do_sql
121 'DBIx::Class::Admin::*' => { skip => 1 },
122 'DBIx::Class::Optional::Dependencies' => { skip => 1 },
123 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
124 'DBIx::Class::Componentised' => { skip => 1 },
125 'DBIx::Class::AccessorGroup' => { skip => 1 },
126 'DBIx::Class::Relationship::*' => { skip => 1 },
127 'DBIx::Class::ResultSetProxy' => { skip => 1 },
128 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
129 'DBIx::Class::ResultSource::*' => { skip => 1 },
130 'DBIx::Class::Storage::Statistics' => { skip => 1 },
131 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
132 'DBIx::Class::GlobalDestruction' => { skip => 1 },
133 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary
135 # test some specific components whose parents are exempt below
136 'DBIx::Class::Relationship::Base' => {},
137 'DBIx::Class::SQLMaker::LimitDialects' => {},
140 'DBIx::Class::_Util' => { skip => 1 },
141 'DBIx::Class::SQLMaker*' => { skip => 1 },
142 'DBIx::Class::SQLAHacks*' => { skip => 1 },
143 'DBIx::Class::Storage::DBI*' => { skip => 1 },
144 'SQL::Translator::*' => { skip => 1 },
146 # deprecated / backcompat stuff
147 'DBIx::Class::Serialize::Storable' => { skip => 1 },
148 'DBIx::Class::CDBICompat*' => { skip => 1 },
149 'DBIx::Class::ResultSetManager' => { skip => 1 },
150 'DBIx::Class::DB' => { skip => 1 },
152 # skipped because the synopsis covers it clearly
153 'DBIx::Class::InflateColumn::File' => { skip => 1 },
155 # internal subclass, nothing to POD
156 'DBIx::Class::ResultSet::Pager' => { skip => 1 },
160 for my $string (keys %$exceptions) {
161 my $ex = $exceptions->{$string};
162 $string =~ s/\*/'.*?'/ge;
163 my $re = qr/^$string$/;
164 $ex_lookup->{$re} = $ex;
167 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
169 foreach my $module (@modules) {
173 first { $module =~ $_ }
174 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
177 my $ex = $ex_lookup->{$match} if $match;
179 skip ("$module exempt", 1) if ($ex->{skip});
181 skip ("$module not loadable", 1) unless eval "require $module";
183 # build parms up from ignore list
186 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
187 if exists($ex->{ignore});
189 # run the test with the potentially modified parm set
190 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");