Final count tests
[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 },
0c62fa59 32 'DBIx::Class::Row' => {
33 ignore => [
34 qw( MULTICREATE_DEBUG )
35 ],
36 },
b20edc27 37 'DBIx::Class::Storage' => {
38 ignore => [
39 qw(cursor)
7eb4ecc8 40 ]
41 },
249963d4 42 'DBIx::Class::Schema' => {
43 ignore => [
44 qw(setup_connection_class)
45 ]
46 },
00c937a2 47 'DBIx::Class::Storage::DBI::Sybase' => {
48 ignore => [
49 qw/should_quote_data_type/,
50 ]
51 },
9b83fccd 52 'DBIx::Class::CDBICompat::AccessorMapping' => { skip => 1 },
d03c0706 53 'DBIx::Class::CDBICompat::AbstractSearch' => {
54 ignore => [qw(search_where)]
55 },
9b83fccd 56 'DBIx::Class::CDBICompat::AttributeAPI' => { skip => 1 },
57 'DBIx::Class::CDBICompat::AutoUpdate' => { skip => 1 },
5ef62e9f 58 'DBIx::Class::CDBICompat::ColumnsAsHash' => {
59 ignore => [qw(inflate_result new update)]
60 },
9b83fccd 61 'DBIx::Class::CDBICompat::ColumnCase' => { skip => 1 },
62 'DBIx::Class::CDBICompat::ColumnGroups' => { skip => 1 },
63 'DBIx::Class::CDBICompat::Constraints' => { skip => 1 },
64 'DBIx::Class::CDBICompat::Constructor' => { skip => 1 },
d03c0706 65 'DBIx::Class::CDBICompat::Copy' => {
66 ignore => [qw(copy)]
67 },
9b83fccd 68 'DBIx::Class::CDBICompat::DestroyWarning' => { skip => 1 },
69 'DBIx::Class::CDBICompat::GetSet' => { skip => 1 },
70 'DBIx::Class::CDBICompat::HasA' => { skip => 1 },
71 'DBIx::Class::CDBICompat::HasMany' => { skip => 1 },
72 'DBIx::Class::CDBICompat::ImaDBI' => { skip => 1 },
73 'DBIx::Class::CDBICompat::LazyLoading' => { skip => 1 },
74 'DBIx::Class::CDBICompat::LiveObjectIndex' => { skip => 1 },
75 'DBIx::Class::CDBICompat::MightHave' => { skip => 1 },
fd8ff563 76 'DBIx::Class::CDBICompat::NoObjectIndex' => { skip => 1 },
9b83fccd 77 'DBIx::Class::CDBICompat::Pager' => { skip => 1 },
78 'DBIx::Class::CDBICompat::ReadOnly' => { skip => 1 },
aa11d765 79 'DBIx::Class::CDBICompat::Relationship' => { skip => 1 },
80 'DBIx::Class::CDBICompat::Relationships' => { skip => 1 },
9b83fccd 81 'DBIx::Class::CDBICompat::Retrieve' => { skip => 1 },
4a534c04 82 'DBIx::Class::CDBICompat::SQLTransformer' => { skip => 1 },
9b83fccd 83 'DBIx::Class::CDBICompat::Stringify' => { skip => 1 },
84 'DBIx::Class::CDBICompat::TempColumns' => { skip => 1 },
85 'DBIx::Class::CDBICompat::Triggers' => { skip => 1 },
86 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
87 'DBIx::Class::Componentised' => { skip => 1 },
88 'DBIx::Class::Relationship::Accessor' => { skip => 1 },
89 'DBIx::Class::Relationship::BelongsTo' => { skip => 1 },
90 'DBIx::Class::Relationship::CascadeActions' => { skip => 1 },
91 'DBIx::Class::Relationship::HasMany' => { skip => 1 },
92 'DBIx::Class::Relationship::HasOne' => { skip => 1 },
93 'DBIx::Class::Relationship::Helpers' => { skip => 1 },
94 'DBIx::Class::Relationship::ManyToMany' => { skip => 1 },
95 'DBIx::Class::Relationship::ProxyMethods' => { skip => 1 },
96 'DBIx::Class::ResultSetProxy' => { skip => 1 },
cb136e67 97 'DBIx::Class::ResultSetManager' => { skip => 1 },
9b83fccd 98 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
046ad905 99 'DBIx::Class::Storage::DBI' => { skip => 1 },
9b83fccd 100 'DBIx::Class::Storage::DBI::DB2' => { skip => 1 },
101 'DBIx::Class::Storage::DBI::MSSQL' => { skip => 1 },
9b83fccd 102 'DBIx::Class::Storage::DBI::ODBC400' => { skip => 1 },
103 'DBIx::Class::Storage::DBI::ODBC::DB2_400_SQL' => { skip => 1 },
104 'DBIx::Class::Storage::DBI::Oracle' => { skip => 1 },
105 'DBIx::Class::Storage::DBI::Pg' => { skip => 1 },
106 'DBIx::Class::Storage::DBI::SQLite' => { skip => 1 },
107 'DBIx::Class::Storage::DBI::mysql' => { skip => 1 },
108 'SQL::Translator::Parser::DBIx::Class' => { skip => 1 },
109 'SQL::Translator::Producer::DBIx::Class::File' => { skip => 1 },
737416a4 110
111# skipped because the synopsis covers it clearly
112
113 'DBIx::Class::InflateColumn::File' => { skip => 1 },
114
a2800991 115# skip connection since it's just an override
737416a4 116
a2800991 117 'DBIx::Class::Schema::Versioned' => { ignore => [ qw(connection) ] },
737416a4 118
5c1d82d2 119# don't bother since it's heavily deprecated
120 'DBIx::Class::ResultSetManager' => { skip => 1 },
7eb4ecc8 121};
122
123foreach my $module (@modules) {
124 SKIP:
125 {
0ebb0072 126 skip "$module - No real methods", 1 if ($exceptions->{$module}{skip});
7eb4ecc8 127
128 # build parms up from ignore list
129 my $parms = {};
130 $parms->{trustme} =
131 [ map { qr/^$_$/ } @{ $exceptions->{$module}{ignore} } ]
132 if exists($exceptions->{$module}{ignore});
133
134 # run the test with the potentially modified parm set
135 pod_coverage_ok($module, $parms, "$module POD coverage");
136 }
137}