1 use DBIx::Class::Optional::Dependencies -skip_all_without => 'test_podcoverage';
7 use List::Util 'first';
8 use lib qw(t/lib maint/.Generated_Pod/lib);
12 # this has already been required but leave it here for CPANTS static analysis
13 require Test::Pod::Coverage;
15 # Since this is about checking documentation, a little documentation
16 # of what this is doing might be in order.
17 # The exceptions structure below is a hash keyed by the module
18 # name. Any * in a name is treated like a wildcard and will behave
19 # as expected. Modules are matched by longest string first, so
20 # A::B::C will match even if there is A::B*
22 # The value for each is a hash, which contains one or more
23 # (although currently more than one makes no sense) of the following
25 # skip => a true value means this module is not checked
26 # ignore => array ref containing list of methods which
27 # do not need to be documented.
31 MODIFY_CODE_ATTRIBUTES
37 'DBIx::Class::Optional::Dependencies' => {
42 'DBIx::Class::Carp' => {
47 'DBIx::Class::Row' => {
52 'DBIx::Class::FilterColumn' => {
62 'DBIx::Class::ResultSource' => {
64 compare_relationship_keys
73 'DBIx::Class::ResultSet' => {
79 'DBIx::Class::ResultSourceHandle' => {
85 'DBIx::Class::Storage' => {
91 'DBIx::Class::Schema' => {
93 setup_connection_class
97 'DBIx::Class::Schema::Versioned' => {
103 'DBIx::Class::Admin' => {
109 'DBIx::Class::Storage::DBI::Replicated' => {
112 disconnect_call_do_sql
114 get_use_dbms_capability
116 set_use_dbms_capability
123 'DBIx::Class::Storage::DBI::Replicated::Balanced' => {
125 has_auto_validate_every
129 'DBIx::Class::Admin::*' => { skip => 1 },
130 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
131 'DBIx::Class::Componentised' => { skip => 1 },
132 'DBIx::Class::AccessorGroup' => { skip => 1 },
133 'DBIx::Class::Relationship::*' => { skip => 1 },
134 'DBIx::Class::ResultSetProxy' => { skip => 1 },
135 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
136 'DBIx::Class::ResultSource::*' => { skip => 1 },
137 'DBIx::Class::Storage::Statistics' => { skip => 1 },
138 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
139 'DBIx::Class::GlobalDestruction' => { skip => 1 },
140 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary
142 # test some specific components whose parents are exempt below
143 'DBIx::Class::Relationship::Base' => {},
144 'DBIx::Class::SQLMaker::LimitDialects' => {},
147 'DBIx::Class::_Util' => { skip => 1 },
148 'DBIx::Class::_Types' => { skip => 1 },
149 'DBIx::Class::SQLMaker*' => { skip => 1 },
150 'DBIx::Class::SQLAHacks*' => { skip => 1 },
151 'DBIx::Class::Storage::DBI*' => { skip => 1 },
152 'SQL::Translator::*' => { skip => 1 },
154 # deprecated / backcompat stuff
155 'DBIx::Class::Serialize::Storable' => { skip => 1 },
156 'DBIx::Class::CDBICompat*' => { skip => 1 },
157 'DBIx::Class::ResultSetManager' => { skip => 1 },
158 'DBIx::Class::DB' => { skip => 1 },
160 # skipped because the synopsis covers it clearly
161 'DBIx::Class::InflateColumn::File' => { skip => 1 },
163 # internal subclass, nothing to POD
164 'DBIx::Class::ResultSet::Pager' => { skip => 1 },
168 for my $string (keys %$exceptions) {
169 my $ex = $exceptions->{$string};
170 $string =~ s/\*/'.*?'/ge;
171 my $re = qr/^$string$/;
172 $ex_lookup->{$re} = $ex;
175 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
177 foreach my $module (@modules) {
181 first { $module =~ $_ }
182 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
185 my $ex = $ex_lookup->{$match} if $match;
187 skip ("$module exempt", 1) if ($ex->{skip});
189 # build parms up from ignore list
192 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
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");