1 BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) }
2 use DBIx::Class::Optional::Dependencies -skip_all_without => 'test_podcoverage';
8 use Module::Runtime 'require_module';
9 use lib 'maint/.Generated_Pod/lib';
11 use DBIx::Class::Schema::SanityChecker;
14 # this has already been required but leave it here for CPANTS static analysis
15 require Test::Pod::Coverage;
17 # Since this is about checking documentation, a little documentation
18 # of what this is doing might be in order.
19 # The exceptions structure below is a hash keyed by the module
20 # name. Any * in a name is treated like a wildcard and will behave
21 # as expected. Modules are matched by longest string first, so
22 # A::B::C will match even if there is A::B*
24 # The value for each is a hash, which contains one or more
25 # (although currently more than one makes no sense) of the following
27 # skip => a true value means this module is not checked
28 # ignore => array ref containing list of methods which
29 # do not need to be documented.
36 'DBIx::Class::Optional::Dependencies' => {
41 'DBIx::Class::Carp' => {
46 'DBIx::Class::Row' => {
51 'DBIx::Class::FilterColumn' => {
62 'DBIx::Class::ResultSource' => {
64 compare_relationship_keys
71 get_rsrc_instance_specific_attribute
72 set_rsrc_instance_specific_attribute
73 get_rsrc_instance_specific_handler
74 set_rsrc_instance_specific_handler
77 'DBIx::Class::ResultSet' => {
83 'DBIx::Class::ResultSourceHandle' => {
89 'DBIx::Class::Storage' => {
95 'DBIx::Class::Schema' => {
97 setup_connection_class
101 'DBIx::Class::Schema::Versioned' => {
106 'DBIx::Class::Schema::SanityChecker' => {
108 qr/^ (?: check_${_} | format_${_}_errors ) $/x
109 } @{ DBIx::Class::Schema::SanityChecker->available_checks } ]
112 'DBIx::Class::Admin' => {
118 'DBIx::Class::Storage::DBI::Replicated*' => {
121 disconnect_call_do_sql
125 'DBIx::Class::_TempExtlib*' => { skip => 1 },
127 'DBIx::Class::Admin::*' => { skip => 1 },
128 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
129 'DBIx::Class::Componentised' => { skip => 1 },
130 'DBIx::Class::AccessorGroup' => { skip => 1 },
131 'DBIx::Class::Relationship::*' => { skip => 1 },
132 'DBIx::Class::ResultSetProxy' => { skip => 1 },
133 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
134 'DBIx::Class::ResultSource::*' => { skip => 1 },
135 'DBIx::Class::Storage::Statistics' => { skip => 1 },
136 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
137 'DBIx::Class::GlobalDestruction' => { skip => 1 },
138 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary
140 # test some specific components whose parents are exempt below
141 'DBIx::Class::Relationship::Base' => {},
142 'DBIx::Class::SQLMaker::LimitDialects' => {},
145 'DBIx::Class::_Util' => { skip => 1 },
146 'DBIx::Class::SQLMaker*' => { skip => 1 },
147 'DBIx::Class::SQLAHacks*' => { skip => 1 },
148 'DBIx::Class::Storage::DBI*' => { skip => 1 },
149 'SQL::Translator::*' => { skip => 1 },
151 # deprecated / backcompat stuff
152 'DBIx::Class::Serialize::Storable' => { skip => 1 },
153 'DBIx::Class::CDBICompat*' => { skip => 1 },
154 'DBIx::Class::ResultSetManager' => { skip => 1 },
155 'DBIx::Class::DB' => { skip => 1 },
157 # skipped because the synopsis covers it clearly
158 'DBIx::Class::InflateColumn::File' => { skip => 1 },
160 # internal subclass, nothing to POD
161 'DBIx::Class::ResultSet::Pager' => { skip => 1 },
165 for my $string (keys %$exceptions) {
166 my $ex = $exceptions->{$string};
167 $string =~ s/\*/'.*?'/ge;
168 my $re = qr/^$string$/;
169 $ex_lookup->{$re} = $ex;
172 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
174 foreach my $module (@modules) {
178 grep { $module =~ $_ }
179 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
182 my $ex = $ex_lookup->{$match} if $match;
184 skip ("$module exempt", 1) if ($ex->{skip});
186 skip ("$module not loadable", 1) unless eval { require_module($module) };
188 # build parms up from ignore list
190 $parms->{trustme} = [ map
191 { ref $_ eq 'Regexp' ? $_ : qr/^\Q$_\E$/ }
193 ] if exists($ex->{ignore});
195 # run the test with the potentially modified parm set
196 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");