Commit | Line | Data |
dc4600b2 |
1 | use warnings; |
2 | use strict; |
3 | |
0fe5201a |
4 | use Test::More; |
6298a324 |
5 | use List::Util 'first'; |
dc4600b2 |
6 | use lib qw(t/lib); |
7 | use DBICTest; |
6298a324 |
8 | use namespace::clean; |
0fe5201a |
9 | |
dc4600b2 |
10 | # Don't run tests for installs |
11 | unless ( DBICTest::AuthorCheck->is_author || $ENV{AUTOMATED_TESTING} || $ENV{RELEASE_TESTING} ) { |
12 | plan( skip_all => "Author tests not required for installation" ); |
13 | } |
0fe5201a |
14 | |
a109c954 |
15 | require DBIx::Class; |
16 | unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) { |
17 | my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage'); |
18 | $ENV{RELEASE_TESTING} || DBICTest::AuthorCheck->is_author |
19 | ? die ("Failed to load release-testing module requirements: $missing") |
20 | : plan skip_all => "Test needs: $missing" |
dc4600b2 |
21 | } |
7eb4ecc8 |
22 | |
9b83fccd |
23 | # Since this is about checking documentation, a little documentation |
32978f6e |
24 | # of what this is doing might be in order. |
9b83fccd |
25 | # The exceptions structure below is a hash keyed by the module |
32978f6e |
26 | # name. Any * in a name is treated like a wildcard and will behave |
8c96bbc2 |
27 | # as expected. Modules are matched by longest string first, so |
32978f6e |
28 | # A::B::C will match even if there is A::B* |
29 | |
30 | # The value for each is a hash, which contains one or more |
9b83fccd |
31 | # (although currently more than one makes no sense) of the following |
32 | # things:- |
33 | # skip => a true value means this module is not checked |
34 | # ignore => array ref containing list of methods which |
35 | # do not need to be documented. |
7eb4ecc8 |
36 | my $exceptions = { |
37 | 'DBIx::Class' => { |
517ba890 |
38 | ignore => [qw/ |
39 | MODIFY_CODE_ATTRIBUTES |
40 | component_base_class |
41 | mk_classdata |
42 | mk_classaccessor |
43 | /] |
b20edc27 |
44 | }, |
0c62fa59 |
45 | 'DBIx::Class::Row' => { |
517ba890 |
46 | ignore => [qw/ |
47 | MULTICREATE_DEBUG |
48 | /], |
0c62fa59 |
49 | }, |
cde96798 |
50 | 'DBIx::Class::FilterColumn' => { |
51 | ignore => [qw/ |
52 | new |
53 | update |
491c8ff9 |
54 | store_column |
55 | get_column |
56 | get_columns |
cde96798 |
57 | /], |
58 | }, |
bc984450 |
59 | 'DBIx::Class::ResultSource' => { |
60 | ignore => [qw/ |
517ba890 |
61 | compare_relationship_keys |
62 | pk_depends_on |
63 | resolve_condition |
64 | resolve_join |
65 | resolve_prefetch |
66 | /], |
67 | }, |
68 | 'DBIx::Class::ResultSourceHandle' => { |
69 | ignore => [qw/ |
70 | schema |
71 | source_moniker |
bc984450 |
72 | /], |
73 | }, |
b20edc27 |
74 | 'DBIx::Class::Storage' => { |
517ba890 |
75 | ignore => [qw/ |
76 | schema |
77 | cursor |
78 | /] |
7eb4ecc8 |
79 | }, |
249963d4 |
80 | 'DBIx::Class::Schema' => { |
517ba890 |
81 | ignore => [qw/ |
82 | setup_connection_class |
83 | /] |
249963d4 |
84 | }, |
32978f6e |
85 | |
86 | 'DBIx::Class::Schema::Versioned' => { |
87 | ignore => [ qw/ |
88 | connection |
517ba890 |
89 | /] |
00c937a2 |
90 | }, |
737416a4 |
91 | |
8c96bbc2 |
92 | 'DBIx::Class::Admin' => { |
93 | ignore => [ qw/ |
94 | BUILD |
95 | /] |
96 | }, |
97 | |
5f6a861d |
98 | 'DBIx::Class::Storage::DBI::Replicated*' => { |
99 | ignore => [ qw/ |
100 | connect_call_do_sql |
101 | disconnect_call_do_sql |
102 | /] |
103 | }, |
104 | |
97f9f16e |
105 | 'DBIx::Class::Admin::*' => { skip => 1 }, |
32978f6e |
106 | 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 }, |
107 | 'DBIx::Class::Componentised' => { skip => 1 }, |
108 | 'DBIx::Class::Relationship::*' => { skip => 1 }, |
109 | 'DBIx::Class::ResultSetProxy' => { skip => 1 }, |
110 | 'DBIx::Class::ResultSourceProxy' => { skip => 1 }, |
111 | 'DBIx::Class::Storage::Statistics' => { skip => 1 }, |
eb7afcab |
112 | 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 }, |
737416a4 |
113 | |
32978f6e |
114 | # test some specific components whose parents are exempt below |
32978f6e |
115 | 'DBIx::Class::Relationship::Base' => {}, |
737416a4 |
116 | |
32978f6e |
117 | # internals |
118 | 'DBIx::Class::SQLAHacks*' => { skip => 1 }, |
119 | 'DBIx::Class::Storage::DBI*' => { skip => 1 }, |
120 | 'SQL::Translator::*' => { skip => 1 }, |
737416a4 |
121 | |
32978f6e |
122 | # deprecated / backcompat stuff |
123 | 'DBIx::Class::CDBICompat*' => { skip => 1 }, |
124 | 'DBIx::Class::ResultSetManager' => { skip => 1 }, |
125 | 'DBIx::Class::DB' => { skip => 1 }, |
737416a4 |
126 | |
32978f6e |
127 | # skipped because the synopsis covers it clearly |
128 | 'DBIx::Class::InflateColumn::File' => { skip => 1 }, |
7eb4ecc8 |
129 | }; |
130 | |
32978f6e |
131 | my $ex_lookup = {}; |
132 | for my $string (keys %$exceptions) { |
133 | my $ex = $exceptions->{$string}; |
134 | $string =~ s/\*/'.*?'/ge; |
135 | my $re = qr/^$string$/; |
136 | $ex_lookup->{$re} = $ex; |
137 | } |
138 | |
139 | my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules()); |
140 | |
7eb4ecc8 |
141 | foreach my $module (@modules) { |
32978f6e |
142 | SKIP: { |
143 | |
6298a324 |
144 | my ($match) = |
145 | first { $module =~ $_ } |
32978f6e |
146 | (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) ) |
147 | ; |
148 | |
149 | my $ex = $ex_lookup->{$match} if $match; |
150 | |
151 | skip ("$module exempt", 1) if ($ex->{skip}); |
152 | |
153 | # build parms up from ignore list |
154 | my $parms = {}; |
155 | $parms->{trustme} = |
156 | [ map { qr/^$_$/ } @{ $ex->{ignore} } ] |
157 | if exists($ex->{ignore}); |
158 | |
159 | # run the test with the potentially modified parm set |
a109c954 |
160 | Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage"); |
32978f6e |
161 | } |
7eb4ecc8 |
162 | } |
32978f6e |
163 | |
164 | done_testing; |