Rename internal rsrc method to be more descriptive, stop proxying it
[dbsrgits/DBIx-Class.git] / xt / podcoverage.t
CommitLineData
dc4600b2 1use warnings;
2use strict;
3
0fe5201a 4use Test::More;
6298a324 5use List::Util 'first';
3e2a5d5d 6use lib qw(t/lib maint/.Generated_Pod/lib);
dc4600b2 7use DBICTest;
6298a324 8use namespace::clean;
0fe5201a 9
a109c954 10require DBIx::Class;
11unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
12 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
20884f55 13 $ENV{RELEASE_TESTING}
a109c954 14 ? die ("Failed to load release-testing module requirements: $missing")
15 : plan skip_all => "Test needs: $missing"
dc4600b2 16}
7eb4ecc8 17
f7ed0ed3 18# this has already been required but leave it here for CPANTS static analysis
19require Test::Pod::Coverage;
20
9b83fccd 21# Since this is about checking documentation, a little documentation
32978f6e 22# of what this is doing might be in order.
9b83fccd 23# The exceptions structure below is a hash keyed by the module
32978f6e 24# name. Any * in a name is treated like a wildcard and will behave
8c96bbc2 25# as expected. Modules are matched by longest string first, so
32978f6e 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
9b83fccd 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.
7eb4ecc8 34my $exceptions = {
35 'DBIx::Class' => {
517ba890 36 ignore => [qw/
37 MODIFY_CODE_ATTRIBUTES
38 component_base_class
39 mk_classdata
40 mk_classaccessor
41 /]
b20edc27 42 },
70c28808 43 'DBIx::Class::Carp' => {
44 ignore => [qw/
45 unimport
46 /]
47 },
0c62fa59 48 'DBIx::Class::Row' => {
517ba890 49 ignore => [qw/
50 MULTICREATE_DEBUG
51 /],
0c62fa59 52 },
cde96798 53 'DBIx::Class::FilterColumn' => {
54 ignore => [qw/
55 new
56 update
491c8ff9 57 store_column
58 get_column
59 get_columns
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 153my $ex_lookup = {};
154for 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 161my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
32978f6e 162
7eb4ecc8 163foreach 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
186done_testing;