5 use List::Util 'first';
6 use lib qw(t/lib maint/.Generated_Pod/lib);
11 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
12 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
14 ? die ("Failed to load release-testing module requirements: $missing")
15 : plan skip_all => "Test needs: $missing"
18 # this has already been required but leave it here for CPANTS static analysis
19 require Test::Pod::Coverage;
21 # Since this is about checking documentation, a little documentation
22 # of what this is doing might be in order.
23 # The exceptions structure below is a hash keyed by the module
24 # name. Any * in a name is treated like a wildcard and will behave
25 # as expected. Modules are matched by longest string first, so
26 # A::B::C will match even if there is A::B*
28 # The value for each is a hash, which contains one or more
29 # (although currently more than one makes no sense) of the following
31 # skip => a true value means this module is not checked
32 # ignore => array ref containing list of methods which
33 # do not need to be documented.
37 MODIFY_CODE_ATTRIBUTES
43 'DBIx::Class::Carp' => {
48 'DBIx::Class::Row' => {
53 'DBIx::Class::FilterColumn' => {
63 'DBIx::Class::ResultSource' => {
65 compare_relationship_keys
74 'DBIx::Class::ResultSet' => {
80 'DBIx::Class::ResultSourceHandle' => {
86 'DBIx::Class::Storage' => {
92 'DBIx::Class::Schema' => {
94 setup_connection_class
98 'DBIx::Class::Schema::Versioned' => {
104 'DBIx::Class::Admin' => {
110 'DBIx::Class::Storage::DBI::Replicated*' => {
113 disconnect_call_do_sql
117 'DBIx::Class::Admin::*' => { skip => 1 },
118 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
119 'DBIx::Class::Componentised' => { skip => 1 },
120 'DBIx::Class::AccessorGroup' => { skip => 1 },
121 'DBIx::Class::Relationship::*' => { skip => 1 },
122 'DBIx::Class::ResultSetProxy' => { skip => 1 },
123 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
124 'DBIx::Class::ResultSource::*' => { skip => 1 },
125 'DBIx::Class::Storage::Statistics' => { skip => 1 },
126 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
127 'DBIx::Class::GlobalDestruction' => { skip => 1 },
128 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary
130 # test some specific components whose parents are exempt below
131 'DBIx::Class::Relationship::Base' => {},
132 'DBIx::Class::SQLMaker::LimitDialects' => {},
135 'DBIx::Class::_Util' => { skip => 1 },
136 'DBIx::Class::SQLMaker*' => { skip => 1 },
137 'DBIx::Class::SQLAHacks*' => { skip => 1 },
138 'DBIx::Class::Storage::DBI*' => { skip => 1 },
139 'SQL::Translator::*' => { skip => 1 },
141 # deprecated / backcompat stuff
142 'DBIx::Class::Serialize::Storable' => { skip => 1 },
143 'DBIx::Class::CDBICompat*' => { skip => 1 },
144 'DBIx::Class::ResultSetManager' => { skip => 1 },
145 'DBIx::Class::DB' => { skip => 1 },
147 # skipped because the synopsis covers it clearly
148 'DBIx::Class::InflateColumn::File' => { skip => 1 },
150 # internal subclass, nothing to POD
151 'DBIx::Class::ResultSet::Pager' => { skip => 1 },
155 for my $string (keys %$exceptions) {
156 my $ex = $exceptions->{$string};
157 $string =~ s/\*/'.*?'/ge;
158 my $re = qr/^$string$/;
159 $ex_lookup->{$re} = $ex;
162 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
164 foreach my $module (@modules) {
168 first { $module =~ $_ }
169 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
172 my $ex = $ex_lookup->{$match} if $match;
174 skip ("$module exempt", 1) if ($ex->{skip});
176 # build parms up from ignore list
179 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
180 if exists($ex->{ignore});
182 # run the test with the potentially modified parm set
183 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");