squash, slight mod to t/100populate.t
[dbsrgits/DBIx-Class.git] / xt / podcoverage.t
1 use warnings;
2 use strict;
3
4 use Test::More;
5 use List::Util 'first';
6 use lib qw(t/lib maint/.Generated_Pod/lib);
7 use DBICTest;
8 use namespace::clean;
9
10 require DBIx::Class;
11 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
12   my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
13   $ENV{RELEASE_TESTING}
14     ? die ("Failed to load release-testing module requirements: $missing")
15     : plan skip_all => "Test needs: $missing"
16 }
17
18 # this has already been required but leave it here for CPANTS static analysis
19 require Test::Pod::Coverage;
20
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*
27
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
30 # things:-
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.
34 my $exceptions = {
35     'DBIx::Class' => {
36         ignore => [qw/
37             MODIFY_CODE_ATTRIBUTES
38             component_base_class
39             mk_classdata
40             mk_classaccessor
41         /]
42     },
43     'DBIx::Class::Carp' => {
44         ignore => [qw/
45             unimport
46         /]
47     },
48     'DBIx::Class::Row' => {
49         ignore => [qw/
50             MULTICREATE_DEBUG
51         /],
52     },
53     'DBIx::Class::FilterColumn' => {
54         ignore => [qw/
55             new
56             update
57             store_column
58             get_column
59             get_columns
60         /],
61     },
62     'DBIx::Class::ResultSource' => {
63         ignore => [qw/
64             compare_relationship_keys
65             pk_depends_on
66             resolve_condition
67             resolve_join
68             resolve_prefetch
69             STORABLE_freeze
70             STORABLE_thaw
71         /],
72     },
73     'DBIx::Class::ResultSet' => {
74         ignore => [qw/
75             STORABLE_freeze
76             STORABLE_thaw
77         /],
78     },
79     'DBIx::Class::ResultSourceHandle' => {
80         ignore => [qw/
81             schema
82             source_moniker
83         /],
84     },
85     'DBIx::Class::Storage' => {
86         ignore => [qw/
87             schema
88             cursor
89         /]
90     },
91     'DBIx::Class::Schema' => {
92         ignore => [qw/
93             setup_connection_class
94         /]
95     },
96
97     'DBIx::Class::Schema::Versioned' => {
98         ignore => [ qw/
99             connection
100         /]
101     },
102
103     'DBIx::Class::Admin'        => {
104         ignore => [ qw/
105             BUILD
106         /]
107      },
108
109     'DBIx::Class::Storage::DBI::Replicated*'        => {
110         ignore => [ qw/
111             connect_call_do_sql
112             disconnect_call_do_sql
113         /]
114     },
115
116     'DBIx::Class::Admin::*'                         => { skip => 1 },
117     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
118     'DBIx::Class::Componentised'                    => { skip => 1 },
119     'DBIx::Class::AccessorGroup'                    => { skip => 1 },
120     'DBIx::Class::Relationship::*'                  => { skip => 1 },
121     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
122     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
123     'DBIx::Class::ResultSource::*'                  => { skip => 1 },
124     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
125     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
126     'DBIx::Class::GlobalDestruction'                => { skip => 1 },
127     'DBIx::Class::Storage::BlockRunner'             => { skip => 1 }, # temporary
128
129 # test some specific components whose parents are exempt below
130     'DBIx::Class::Relationship::Base'               => {},
131     'DBIx::Class::SQLMaker::LimitDialects'          => {},
132
133 # internals
134     'DBIx::Class::_Util'                            => { skip => 1 },
135     'DBIx::Class::SQLMaker*'                        => { skip => 1 },
136     'DBIx::Class::SQLAHacks*'                       => { skip => 1 },
137     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
138     'SQL::Translator::*'                            => { skip => 1 },
139
140 # deprecated / backcompat stuff
141     'DBIx::Class::Serialize::Storable'              => { skip => 1 },
142     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
143     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
144     'DBIx::Class::DB'                               => { skip => 1 },
145
146 # skipped because the synopsis covers it clearly
147     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
148
149 # internal subclass, nothing to POD
150     'DBIx::Class::ResultSet::Pager'                 => { skip => 1 },
151 };
152
153 my $ex_lookup = {};
154 for my $string (keys %$exceptions) {
155   my $ex = $exceptions->{$string};
156   $string =~ s/\*/'.*?'/ge;
157   my $re = qr/^$string$/;
158   $ex_lookup->{$re} = $ex;
159 }
160
161 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
162
163 foreach my $module (@modules) {
164   SKIP: {
165
166     my ($match) =
167       first { $module =~ $_ }
168       (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
169     ;
170
171     my $ex = $ex_lookup->{$match} if $match;
172
173     skip ("$module exempt", 1) if ($ex->{skip});
174
175     # build parms up from ignore list
176     my $parms = {};
177     $parms->{trustme} =
178       [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
179         if exists($ex->{ignore});
180
181     # run the test with the potentially modified parm set
182     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
183   }
184 }
185
186 done_testing;