check in bombing test for subquery-with-as_query
[dbsrgits/DBIx-Class-Historic.git] / t / 03podcoverage.t
CommitLineData
0fe5201a 1use Test::More;
2
f09cd1d4 3eval "use Pod::Coverage 0.19";
4plan skip_all => 'Pod::Coverage 0.19 required' if $@;
0fe5201a 5eval "use Test::Pod::Coverage 1.04";
6plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@;
f09cd1d4 7
b20edc27 8plan skip_all => 'set TEST_POD to enable this test'
9 unless ($ENV{TEST_POD} || -e 'MANIFEST.SKIP');
0fe5201a 10
97fec99f 11my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
7eb4ecc8 12plan tests => scalar(@modules);
13
9b83fccd 14# Since this is about checking documentation, a little documentation
15# of what this is doing might be in order...
16# The exceptions structure below is a hash keyed by the module
17# name. The value for each is a hash, which contains one or more
18# (although currently more than one makes no sense) of the following
19# things:-
20# skip => a true value means this module is not checked
21# ignore => array ref containing list of methods which
22# do not need to be documented.
7eb4ecc8 23my $exceptions = {
24 'DBIx::Class' => {
25 ignore => [
26 qw/MODIFY_CODE_ATTRIBUTES
27 component_base_class
b20edc27 28 mk_classdata
29 mk_classaccessor/
30 ]
31 },
32 'DBIx::Class::Storage' => {
33 ignore => [
34 qw(cursor)
7eb4ecc8 35 ]
36 },
249963d4 37 'DBIx::Class::Schema' => {
38 ignore => [
39 qw(setup_connection_class)
40 ]
41 },
9b83fccd 42 'DBIx::Class::CDBICompat::AccessorMapping' => { skip => 1 },
d03c0706 43 'DBIx::Class::CDBICompat::AbstractSearch' => {
44 ignore => [qw(search_where)]
45 },
9b83fccd 46 'DBIx::Class::CDBICompat::AttributeAPI' => { skip => 1 },
47 'DBIx::Class::CDBICompat::AutoUpdate' => { skip => 1 },
5ef62e9f 48 'DBIx::Class::CDBICompat::ColumnsAsHash' => {
49 ignore => [qw(inflate_result new update)]
50 },
9b83fccd 51 'DBIx::Class::CDBICompat::ColumnCase' => { skip => 1 },
52 'DBIx::Class::CDBICompat::ColumnGroups' => { skip => 1 },
53 'DBIx::Class::CDBICompat::Constraints' => { skip => 1 },
54 'DBIx::Class::CDBICompat::Constructor' => { skip => 1 },
d03c0706 55 'DBIx::Class::CDBICompat::Copy' => {
56 ignore => [qw(copy)]
57 },
9b83fccd 58 'DBIx::Class::CDBICompat::DestroyWarning' => { skip => 1 },
59 'DBIx::Class::CDBICompat::GetSet' => { skip => 1 },
60 'DBIx::Class::CDBICompat::HasA' => { skip => 1 },
61 'DBIx::Class::CDBICompat::HasMany' => { skip => 1 },
62 'DBIx::Class::CDBICompat::ImaDBI' => { skip => 1 },
63 'DBIx::Class::CDBICompat::LazyLoading' => { skip => 1 },
64 'DBIx::Class::CDBICompat::LiveObjectIndex' => { skip => 1 },
65 'DBIx::Class::CDBICompat::MightHave' => { skip => 1 },
fd8ff563 66 'DBIx::Class::CDBICompat::NoObjectIndex' => { skip => 1 },
9b83fccd 67 'DBIx::Class::CDBICompat::Pager' => { skip => 1 },
68 'DBIx::Class::CDBICompat::ReadOnly' => { skip => 1 },
aa11d765 69 'DBIx::Class::CDBICompat::Relationship' => { skip => 1 },
70 'DBIx::Class::CDBICompat::Relationships' => { skip => 1 },
9b83fccd 71 'DBIx::Class::CDBICompat::Retrieve' => { skip => 1 },
4a534c04 72 'DBIx::Class::CDBICompat::SQLTransformer' => { skip => 1 },
9b83fccd 73 'DBIx::Class::CDBICompat::Stringify' => { skip => 1 },
74 'DBIx::Class::CDBICompat::TempColumns' => { skip => 1 },
75 'DBIx::Class::CDBICompat::Triggers' => { skip => 1 },
76 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
77 'DBIx::Class::Componentised' => { skip => 1 },
78 'DBIx::Class::Relationship::Accessor' => { skip => 1 },
79 'DBIx::Class::Relationship::BelongsTo' => { skip => 1 },
80 'DBIx::Class::Relationship::CascadeActions' => { skip => 1 },
81 'DBIx::Class::Relationship::HasMany' => { skip => 1 },
82 'DBIx::Class::Relationship::HasOne' => { skip => 1 },
83 'DBIx::Class::Relationship::Helpers' => { skip => 1 },
84 'DBIx::Class::Relationship::ManyToMany' => { skip => 1 },
85 'DBIx::Class::Relationship::ProxyMethods' => { skip => 1 },
86 'DBIx::Class::ResultSetProxy' => { skip => 1 },
cb136e67 87 'DBIx::Class::ResultSetManager' => { skip => 1 },
9b83fccd 88 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
046ad905 89 'DBIx::Class::Storage::DBI' => { skip => 1 },
9b83fccd 90 'DBIx::Class::Storage::DBI::DB2' => { skip => 1 },
91 'DBIx::Class::Storage::DBI::MSSQL' => { skip => 1 },
92 'DBIx::Class::Storage::DBI::MultiDistinctEmulation' => { skip => 1 },
93 'DBIx::Class::Storage::DBI::ODBC400' => { skip => 1 },
94 'DBIx::Class::Storage::DBI::ODBC::DB2_400_SQL' => { skip => 1 },
95 'DBIx::Class::Storage::DBI::Oracle' => { skip => 1 },
96 'DBIx::Class::Storage::DBI::Pg' => { skip => 1 },
97 'DBIx::Class::Storage::DBI::SQLite' => { skip => 1 },
98 'DBIx::Class::Storage::DBI::mysql' => { skip => 1 },
99 'SQL::Translator::Parser::DBIx::Class' => { skip => 1 },
100 'SQL::Translator::Producer::DBIx::Class::File' => { skip => 1 },
737416a4 101
102# skipped because the synopsis covers it clearly
103
104 'DBIx::Class::InflateColumn::File' => { skip => 1 },
105
a2800991 106# skip connection since it's just an override
737416a4 107
a2800991 108 'DBIx::Class::Schema::Versioned' => { ignore => [ qw(connection) ] },
737416a4 109
5c1d82d2 110# don't bother since it's heavily deprecated
111 'DBIx::Class::ResultSetManager' => { skip => 1 },
7eb4ecc8 112};
113
114foreach my $module (@modules) {
115 SKIP:
116 {
0ebb0072 117 skip "$module - No real methods", 1 if ($exceptions->{$module}{skip});
7eb4ecc8 118
119 # build parms up from ignore list
120 my $parms = {};
121 $parms->{trustme} =
122 [ map { qr/^$_$/ } @{ $exceptions->{$module}{ignore} } ]
123 if exists($exceptions->{$module}{ignore});
124
125 # run the test with the potentially modified parm set
126 pod_coverage_ok($module, $parms, "$module POD coverage");
127 }
128}