Commit | Line | Data |
cb551b07 |
1 | use DBIx::Class::Optional::Dependencies -skip_all_without => 'test_podcoverage'; |
2 | |
dc4600b2 |
3 | use warnings; |
4 | use strict; |
5 | |
0fe5201a |
6 | use Test::More; |
6298a324 |
7 | use List::Util 'first'; |
3e2a5d5d |
8 | use lib qw(t/lib maint/.Generated_Pod/lib); |
dc4600b2 |
9 | use DBICTest; |
6298a324 |
10 | use namespace::clean; |
0fe5201a |
11 | |
f7ed0ed3 |
12 | # this has already been required but leave it here for CPANTS static analysis |
13 | require Test::Pod::Coverage; |
14 | |
9b83fccd |
15 | # Since this is about checking documentation, a little documentation |
32978f6e |
16 | # of what this is doing might be in order. |
9b83fccd |
17 | # The exceptions structure below is a hash keyed by the module |
32978f6e |
18 | # name. Any * in a name is treated like a wildcard and will behave |
8c96bbc2 |
19 | # as expected. Modules are matched by longest string first, so |
32978f6e |
20 | # A::B::C will match even if there is A::B* |
21 | |
22 | # The value for each is a hash, which contains one or more |
9b83fccd |
23 | # (although currently more than one makes no sense) of the following |
24 | # things:- |
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. |
7eb4ecc8 |
28 | my $exceptions = { |
29 | 'DBIx::Class' => { |
517ba890 |
30 | ignore => [qw/ |
31 | MODIFY_CODE_ATTRIBUTES |
32 | component_base_class |
33 | mk_classdata |
34 | mk_classaccessor |
35 | /] |
b20edc27 |
36 | }, |
cb551b07 |
37 | 'DBIx::Class::Optional::Dependencies' => { |
38 | ignore => [qw/ |
39 | croak |
40 | /] |
41 | }, |
70c28808 |
42 | 'DBIx::Class::Carp' => { |
43 | ignore => [qw/ |
44 | unimport |
45 | /] |
46 | }, |
0c62fa59 |
47 | 'DBIx::Class::Row' => { |
517ba890 |
48 | ignore => [qw/ |
49 | MULTICREATE_DEBUG |
50 | /], |
0c62fa59 |
51 | }, |
cde96798 |
52 | 'DBIx::Class::FilterColumn' => { |
53 | ignore => [qw/ |
54 | new |
55 | update |
491c8ff9 |
56 | store_column |
57 | get_column |
58 | get_columns |
dc6dadae |
59 | has_column_loaded |
cde96798 |
60 | /], |
61 | }, |
bc984450 |
62 | 'DBIx::Class::ResultSource' => { |
63 | ignore => [qw/ |
517ba890 |
64 | compare_relationship_keys |
65 | pk_depends_on |
66 | resolve_condition |
67 | resolve_join |
68 | resolve_prefetch |
50261284 |
69 | STORABLE_freeze |
70 | STORABLE_thaw |
517ba890 |
71 | /], |
72 | }, |
0b66414b |
73 | 'DBIx::Class::ResultSet' => { |
74 | ignore => [qw/ |
75 | STORABLE_freeze |
76 | STORABLE_thaw |
77 | /], |
78 | }, |
517ba890 |
79 | 'DBIx::Class::ResultSourceHandle' => { |
80 | ignore => [qw/ |
81 | schema |
82 | source_moniker |
bc984450 |
83 | /], |
84 | }, |
b20edc27 |
85 | 'DBIx::Class::Storage' => { |
517ba890 |
86 | ignore => [qw/ |
87 | schema |
88 | cursor |
89 | /] |
7eb4ecc8 |
90 | }, |
249963d4 |
91 | 'DBIx::Class::Schema' => { |
517ba890 |
92 | ignore => [qw/ |
93 | setup_connection_class |
94 | /] |
249963d4 |
95 | }, |
32978f6e |
96 | |
97 | 'DBIx::Class::Schema::Versioned' => { |
98 | ignore => [ qw/ |
99 | connection |
517ba890 |
100 | /] |
00c937a2 |
101 | }, |
737416a4 |
102 | |
8c96bbc2 |
103 | 'DBIx::Class::Admin' => { |
104 | ignore => [ qw/ |
105 | BUILD |
106 | /] |
107 | }, |
108 | |
5f6a861d |
109 | 'DBIx::Class::Storage::DBI::Replicated*' => { |
110 | ignore => [ qw/ |
111 | connect_call_do_sql |
112 | disconnect_call_do_sql |
113 | /] |
114 | }, |
115 | |
97f9f16e |
116 | 'DBIx::Class::Admin::*' => { skip => 1 }, |
32978f6e |
117 | 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 }, |
118 | 'DBIx::Class::Componentised' => { skip => 1 }, |
db29433c |
119 | 'DBIx::Class::AccessorGroup' => { skip => 1 }, |
32978f6e |
120 | 'DBIx::Class::Relationship::*' => { skip => 1 }, |
121 | 'DBIx::Class::ResultSetProxy' => { skip => 1 }, |
122 | 'DBIx::Class::ResultSourceProxy' => { skip => 1 }, |
9550c834 |
123 | 'DBIx::Class::ResultSource::*' => { skip => 1 }, |
32978f6e |
124 | 'DBIx::Class::Storage::Statistics' => { skip => 1 }, |
eb7afcab |
125 | 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 }, |
a4367b26 |
126 | 'DBIx::Class::GlobalDestruction' => { skip => 1 }, |
9345b14c |
127 | 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary |
737416a4 |
128 | |
32978f6e |
129 | # test some specific components whose parents are exempt below |
32978f6e |
130 | 'DBIx::Class::Relationship::Base' => {}, |
d5dedbd6 |
131 | 'DBIx::Class::SQLMaker::LimitDialects' => {}, |
737416a4 |
132 | |
32978f6e |
133 | # internals |
b1dbf716 |
134 | 'DBIx::Class::_Util' => { skip => 1 }, |
d5dedbd6 |
135 | 'DBIx::Class::SQLMaker*' => { skip => 1 }, |
9fc20b28 |
136 | 'DBIx::Class::SQLAHacks*' => { skip => 1 }, |
32978f6e |
137 | 'DBIx::Class::Storage::DBI*' => { skip => 1 }, |
138 | 'SQL::Translator::*' => { skip => 1 }, |
737416a4 |
139 | |
32978f6e |
140 | # deprecated / backcompat stuff |
1b6fe47d |
141 | 'DBIx::Class::Serialize::Storable' => { skip => 1 }, |
32978f6e |
142 | 'DBIx::Class::CDBICompat*' => { skip => 1 }, |
143 | 'DBIx::Class::ResultSetManager' => { skip => 1 }, |
144 | 'DBIx::Class::DB' => { skip => 1 }, |
737416a4 |
145 | |
32978f6e |
146 | # skipped because the synopsis covers it clearly |
147 | 'DBIx::Class::InflateColumn::File' => { skip => 1 }, |
cd122820 |
148 | |
149 | # internal subclass, nothing to POD |
150 | 'DBIx::Class::ResultSet::Pager' => { skip => 1 }, |
7eb4ecc8 |
151 | }; |
152 | |
32978f6e |
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 | |
47589465 |
161 | my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib'); |
32978f6e |
162 | |
7eb4ecc8 |
163 | foreach my $module (@modules) { |
32978f6e |
164 | SKIP: { |
165 | |
6298a324 |
166 | my ($match) = |
167 | first { $module =~ $_ } |
32978f6e |
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 |
a109c954 |
182 | Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage"); |
32978f6e |
183 | } |
7eb4ecc8 |
184 | } |
32978f6e |
185 | |
186 | done_testing; |