Remove test prototype that was never completed further than a loop calling ok(1)
[dbsrgits/DBIx-Class-Historic.git] / xt / podcoverage.t
CommitLineData
dc4600b2 1use warnings;
2use strict;
3
0fe5201a 4use Test::More;
6298a324 5use List::Util 'first';
dc4600b2 6use lib qw(t/lib);
7use DBICTest;
6298a324 8use namespace::clean;
0fe5201a 9
dc4600b2 10# Don't run tests for installs
39c9c72d 11if ( DBICTest::RunMode->is_plain ) {
dc4600b2 12 plan( skip_all => "Author tests not required for installation" );
13}
0fe5201a 14
a109c954 15require DBIx::Class;
16unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
17 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
6b01a153 18 $ENV{RELEASE_TESTING} || DBICTest::RunMode->is_author
a109c954 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 36my $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 },
1f870d5a 50 'DBIx::Class::Storage::TxnScopeGuard' => {
51 ignore => [qw/
52 IS_BROKEN_PERL
53 /],
54 },
cde96798 55 'DBIx::Class::FilterColumn' => {
56 ignore => [qw/
57 new
58 update
491c8ff9 59 store_column
60 get_column
61 get_columns
cde96798 62 /],
63 },
bc984450 64 'DBIx::Class::ResultSource' => {
65 ignore => [qw/
517ba890 66 compare_relationship_keys
67 pk_depends_on
68 resolve_condition
69 resolve_join
70 resolve_prefetch
50261284 71 STORABLE_freeze
72 STORABLE_thaw
517ba890 73 /],
74 },
0b66414b 75 'DBIx::Class::ResultSet' => {
76 ignore => [qw/
77 STORABLE_freeze
78 STORABLE_thaw
79 /],
80 },
517ba890 81 'DBIx::Class::ResultSourceHandle' => {
82 ignore => [qw/
83 schema
84 source_moniker
bc984450 85 /],
86 },
b20edc27 87 'DBIx::Class::Storage' => {
517ba890 88 ignore => [qw/
89 schema
90 cursor
91 /]
7eb4ecc8 92 },
249963d4 93 'DBIx::Class::Schema' => {
517ba890 94 ignore => [qw/
95 setup_connection_class
96 /]
249963d4 97 },
32978f6e 98
99 'DBIx::Class::Schema::Versioned' => {
100 ignore => [ qw/
101 connection
517ba890 102 /]
00c937a2 103 },
737416a4 104
8c96bbc2 105 'DBIx::Class::Admin' => {
106 ignore => [ qw/
107 BUILD
108 /]
109 },
110
5f6a861d 111 'DBIx::Class::Storage::DBI::Replicated*' => {
112 ignore => [ qw/
113 connect_call_do_sql
114 disconnect_call_do_sql
115 /]
116 },
117
97f9f16e 118 'DBIx::Class::Admin::*' => { skip => 1 },
32978f6e 119 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
120 'DBIx::Class::Componentised' => { skip => 1 },
db29433c 121 'DBIx::Class::AccessorGroup' => { skip => 1 },
32978f6e 122 'DBIx::Class::Relationship::*' => { skip => 1 },
123 'DBIx::Class::ResultSetProxy' => { skip => 1 },
124 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
9550c834 125 'DBIx::Class::ResultSource::*' => { skip => 1 },
32978f6e 126 'DBIx::Class::Storage::Statistics' => { skip => 1 },
eb7afcab 127 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
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
d5dedbd6 134 'DBIx::Class::SQLMaker*' => { skip => 1 },
9fc20b28 135 'DBIx::Class::SQLAHacks*' => { skip => 1 },
32978f6e 136 'DBIx::Class::Storage::DBI*' => { skip => 1 },
137 'SQL::Translator::*' => { skip => 1 },
737416a4 138
32978f6e 139# deprecated / backcompat stuff
1b6fe47d 140 'DBIx::Class::Serialize::Storable' => { skip => 1 },
32978f6e 141 'DBIx::Class::CDBICompat*' => { skip => 1 },
142 'DBIx::Class::ResultSetManager' => { skip => 1 },
143 'DBIx::Class::DB' => { skip => 1 },
737416a4 144
32978f6e 145# skipped because the synopsis covers it clearly
146 'DBIx::Class::InflateColumn::File' => { skip => 1 },
7eb4ecc8 147};
148
32978f6e 149my $ex_lookup = {};
150for my $string (keys %$exceptions) {
151 my $ex = $exceptions->{$string};
152 $string =~ s/\*/'.*?'/ge;
153 my $re = qr/^$string$/;
154 $ex_lookup->{$re} = $ex;
155}
156
157my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
158
7eb4ecc8 159foreach my $module (@modules) {
32978f6e 160 SKIP: {
161
6298a324 162 my ($match) =
163 first { $module =~ $_ }
32978f6e 164 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
165 ;
166
167 my $ex = $ex_lookup->{$match} if $match;
168
169 skip ("$module exempt", 1) if ($ex->{skip});
170
171 # build parms up from ignore list
172 my $parms = {};
173 $parms->{trustme} =
174 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
175 if exists($ex->{ignore});
176
177 # run the test with the potentially modified parm set
a109c954 178 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
32978f6e 179 }
7eb4ecc8 180}
32978f6e 181
182done_testing;