ba30f3180f1b68e20470b31b17944849c81adb47
[dbsrgits/DBIx-Class.git] / xt / podcoverage.t
1 use warnings;
2 use strict;
3
4 use Test::More;
5 use List::Util 'first';
6 use lib qw(t/lib);
7 use DBICTest;
8 use namespace::clean;
9
10 # Don't run tests for installs
11 if ( DBICTest::RunMode->is_plain ) {
12   plan( skip_all => "Author tests not required for installation" );
13 }
14
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"
21 }
22
23 # Since this is about checking documentation, a little documentation
24 # of what this is doing might be in order.
25 # The exceptions structure below is a hash keyed by the module
26 # name. Any * in a name is treated like a wildcard and will behave
27 # as expected. Modules are matched by longest string first, so
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
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.
36 my $exceptions = {
37     'DBIx::Class' => {
38         ignore => [qw/
39             MODIFY_CODE_ATTRIBUTES
40             component_base_class
41             mk_classdata
42             mk_classaccessor
43         /]
44     },
45     'DBIx::Class::Row' => {
46         ignore => [qw/
47             MULTICREATE_DEBUG
48         /],
49     },
50     'DBIx::Class::Storage::TxnScopeGuard' => {
51         ignore => [qw/
52             IS_BROKEN_PERL
53         /],
54     },
55     'DBIx::Class::FilterColumn' => {
56         ignore => [qw/
57             new
58             update
59             store_column
60             get_column
61             get_columns
62         /],
63     },
64     'DBIx::Class::ResultSource' => {
65         ignore => [qw/
66             compare_relationship_keys
67             pk_depends_on
68             resolve_condition
69             resolve_join
70             resolve_prefetch
71         /],
72     },
73     'DBIx::Class::ResultSourceHandle' => {
74         ignore => [qw/
75             schema
76             source_moniker
77         /],
78     },
79     'DBIx::Class::Storage' => {
80         ignore => [qw/
81             schema
82             cursor
83         /]
84     },
85     'DBIx::Class::Schema' => {
86         ignore => [qw/
87             setup_connection_class
88         /]
89     },
90
91     'DBIx::Class::Schema::Versioned' => {
92         ignore => [ qw/
93             connection
94         /]
95     },
96
97     'DBIx::Class::Admin'        => {
98         ignore => [ qw/
99             BUILD
100         /]
101      },
102
103     'DBIx::Class::Storage::DBI::Replicated*'        => {
104         ignore => [ qw/
105             connect_call_do_sql
106             disconnect_call_do_sql
107         /]
108     },
109
110     'DBIx::Class::Admin::*'                         => { skip => 1 },
111     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
112     'DBIx::Class::Componentised'                    => { skip => 1 },
113     'DBIx::Class::Relationship::*'                  => { skip => 1 },
114     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
115     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
116     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
117     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
118
119 # test some specific components whose parents are exempt below
120     'DBIx::Class::Relationship::Base'               => {},
121     'DBIx::Class::SQLMaker::LimitDialects'          => {},
122
123 # internals
124     'DBIx::Class::SQLMaker*'                        => { skip => 1 },
125     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
126     'SQL::Translator::*'                            => { skip => 1 },
127
128 # deprecated / backcompat stuff
129     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
130     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
131     'DBIx::Class::DB'                               => { skip => 1 },
132
133 # skipped because the synopsis covers it clearly
134     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
135 };
136
137 my $ex_lookup = {};
138 for my $string (keys %$exceptions) {
139   my $ex = $exceptions->{$string};
140   $string =~ s/\*/'.*?'/ge;
141   my $re = qr/^$string$/;
142   $ex_lookup->{$re} = $ex;
143 }
144
145 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
146
147 foreach my $module (@modules) {
148   SKIP: {
149
150     my ($match) =
151       first { $module =~ $_ }
152       (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
153     ;
154
155     my $ex = $ex_lookup->{$match} if $match;
156
157     skip ("$module exempt", 1) if ($ex->{skip});
158
159     # build parms up from ignore list
160     my $parms = {};
161     $parms->{trustme} =
162       [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
163         if exists($ex->{ignore});
164
165     # run the test with the potentially modified parm set
166     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
167   }
168 }
169
170 done_testing;