Commit | Line | Data |
c0329273 |
1 | BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) } |
cb551b07 |
2 | use DBIx::Class::Optional::Dependencies -skip_all_without => 'test_podcoverage'; |
3 | |
dc4600b2 |
4 | use warnings; |
5 | use strict; |
6 | |
0fe5201a |
7 | use Test::More; |
554484cb |
8 | use Module::Runtime 'require_module'; |
c0329273 |
9 | use lib 'maint/.Generated_Pod/lib'; |
dc4600b2 |
10 | use DBICTest; |
12e7015a |
11 | use DBIx::Class::Schema::SanityChecker; |
6298a324 |
12 | use namespace::clean; |
0fe5201a |
13 | |
f7ed0ed3 |
14 | # this has already been required but leave it here for CPANTS static analysis |
15 | require Test::Pod::Coverage; |
16 | |
9b83fccd |
17 | # Since this is about checking documentation, a little documentation |
32978f6e |
18 | # of what this is doing might be in order. |
9b83fccd |
19 | # The exceptions structure below is a hash keyed by the module |
32978f6e |
20 | # name. Any * in a name is treated like a wildcard and will behave |
8c96bbc2 |
21 | # as expected. Modules are matched by longest string first, so |
32978f6e |
22 | # A::B::C will match even if there is A::B* |
23 | |
24 | # The value for each is a hash, which contains one or more |
9b83fccd |
25 | # (although currently more than one makes no sense) of the following |
26 | # things:- |
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. |
7eb4ecc8 |
30 | my $exceptions = { |
31 | 'DBIx::Class' => { |
517ba890 |
32 | ignore => [qw/ |
517ba890 |
33 | component_base_class |
517ba890 |
34 | /] |
b20edc27 |
35 | }, |
cb551b07 |
36 | 'DBIx::Class::Optional::Dependencies' => { |
37 | ignore => [qw/ |
38 | croak |
39 | /] |
40 | }, |
70c28808 |
41 | 'DBIx::Class::Carp' => { |
42 | ignore => [qw/ |
43 | unimport |
44 | /] |
45 | }, |
0c62fa59 |
46 | 'DBIx::Class::Row' => { |
517ba890 |
47 | ignore => [qw/ |
48 | MULTICREATE_DEBUG |
49 | /], |
0c62fa59 |
50 | }, |
cde96798 |
51 | 'DBIx::Class::FilterColumn' => { |
52 | ignore => [qw/ |
53 | new |
54 | update |
491c8ff9 |
55 | store_column |
56 | get_column |
57 | get_columns |
b482a095 |
58 | get_dirty_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 |
73f54e27 |
71 | get_rsrc_instance_specific_attribute |
72 | set_rsrc_instance_specific_attribute |
73 | get_rsrc_instance_specific_handler |
74 | set_rsrc_instance_specific_handler |
517ba890 |
75 | /], |
76 | }, |
0b66414b |
77 | 'DBIx::Class::ResultSet' => { |
78 | ignore => [qw/ |
79 | STORABLE_freeze |
80 | STORABLE_thaw |
81 | /], |
82 | }, |
517ba890 |
83 | 'DBIx::Class::ResultSourceHandle' => { |
84 | ignore => [qw/ |
85 | schema |
86 | source_moniker |
bc984450 |
87 | /], |
88 | }, |
b20edc27 |
89 | 'DBIx::Class::Storage' => { |
517ba890 |
90 | ignore => [qw/ |
91 | schema |
92 | cursor |
93 | /] |
7eb4ecc8 |
94 | }, |
249963d4 |
95 | 'DBIx::Class::Schema' => { |
517ba890 |
96 | ignore => [qw/ |
97 | setup_connection_class |
98 | /] |
249963d4 |
99 | }, |
32978f6e |
100 | |
101 | 'DBIx::Class::Schema::Versioned' => { |
102 | ignore => [ qw/ |
103 | connection |
517ba890 |
104 | /] |
00c937a2 |
105 | }, |
12e7015a |
106 | 'DBIx::Class::Schema::SanityChecker' => { |
107 | ignore => [ map { |
108 | qr/^ (?: check_${_} | format_${_}_errors ) $/x |
109 | } @{ DBIx::Class::Schema::SanityChecker->available_checks } ] |
110 | }, |
737416a4 |
111 | |
8c96bbc2 |
112 | 'DBIx::Class::Admin' => { |
113 | ignore => [ qw/ |
114 | BUILD |
115 | /] |
116 | }, |
117 | |
5f6a861d |
118 | 'DBIx::Class::Storage::DBI::Replicated*' => { |
119 | ignore => [ qw/ |
120 | connect_call_do_sql |
121 | disconnect_call_do_sql |
122 | /] |
123 | }, |
124 | |
399b9455 |
125 | 'DBIx::Class::_TempExtlib*' => { skip => 1 }, |
126 | |
97f9f16e |
127 | 'DBIx::Class::Admin::*' => { skip => 1 }, |
32978f6e |
128 | 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 }, |
129 | 'DBIx::Class::Componentised' => { skip => 1 }, |
db29433c |
130 | 'DBIx::Class::AccessorGroup' => { skip => 1 }, |
32978f6e |
131 | 'DBIx::Class::Relationship::*' => { skip => 1 }, |
132 | 'DBIx::Class::ResultSetProxy' => { skip => 1 }, |
133 | 'DBIx::Class::ResultSourceProxy' => { skip => 1 }, |
9550c834 |
134 | 'DBIx::Class::ResultSource::*' => { skip => 1 }, |
32978f6e |
135 | 'DBIx::Class::Storage::Statistics' => { skip => 1 }, |
eb7afcab |
136 | 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 }, |
a4367b26 |
137 | 'DBIx::Class::GlobalDestruction' => { skip => 1 }, |
9345b14c |
138 | 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary |
737416a4 |
139 | |
32978f6e |
140 | # test some specific components whose parents are exempt below |
32978f6e |
141 | 'DBIx::Class::Relationship::Base' => {}, |
d5dedbd6 |
142 | 'DBIx::Class::SQLMaker::LimitDialects' => {}, |
737416a4 |
143 | |
32978f6e |
144 | # internals |
b1dbf716 |
145 | 'DBIx::Class::_Util' => { skip => 1 }, |
d5dedbd6 |
146 | 'DBIx::Class::SQLMaker*' => { skip => 1 }, |
9fc20b28 |
147 | 'DBIx::Class::SQLAHacks*' => { skip => 1 }, |
32978f6e |
148 | 'DBIx::Class::Storage::DBI*' => { skip => 1 }, |
149 | 'SQL::Translator::*' => { skip => 1 }, |
737416a4 |
150 | |
32978f6e |
151 | # deprecated / backcompat stuff |
1b6fe47d |
152 | 'DBIx::Class::Serialize::Storable' => { skip => 1 }, |
32978f6e |
153 | 'DBIx::Class::CDBICompat*' => { skip => 1 }, |
154 | 'DBIx::Class::ResultSetManager' => { skip => 1 }, |
155 | 'DBIx::Class::DB' => { skip => 1 }, |
737416a4 |
156 | |
32978f6e |
157 | # skipped because the synopsis covers it clearly |
158 | 'DBIx::Class::InflateColumn::File' => { skip => 1 }, |
cd122820 |
159 | |
160 | # internal subclass, nothing to POD |
161 | 'DBIx::Class::ResultSet::Pager' => { skip => 1 }, |
7eb4ecc8 |
162 | }; |
163 | |
32978f6e |
164 | my $ex_lookup = {}; |
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; |
170 | } |
171 | |
47589465 |
172 | my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib'); |
32978f6e |
173 | |
7eb4ecc8 |
174 | foreach my $module (@modules) { |
32978f6e |
175 | SKIP: { |
176 | |
6298a324 |
177 | my ($match) = |
87b12551 |
178 | grep { $module =~ $_ } |
32978f6e |
179 | (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) ) |
180 | ; |
181 | |
182 | my $ex = $ex_lookup->{$match} if $match; |
183 | |
184 | skip ("$module exempt", 1) if ($ex->{skip}); |
185 | |
554484cb |
186 | skip ("$module not loadable", 1) unless eval { require_module($module) }; |
187 | |
32978f6e |
188 | # build parms up from ignore list |
189 | my $parms = {}; |
12e7015a |
190 | $parms->{trustme} = [ map |
191 | { ref $_ eq 'Regexp' ? $_ : qr/^\Q$_\E$/ } |
192 | @{ $ex->{ignore} } |
193 | ] if exists($ex->{ignore}); |
32978f6e |
194 | |
195 | # run the test with the potentially modified parm set |
a109c954 |
196 | Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage"); |
32978f6e |
197 | } |
7eb4ecc8 |
198 | } |
32978f6e |
199 | |
200 | done_testing; |