Login
29acd0209a338ae99c62558c42815d6aa9f84f25
[gknop/Perl-Critic.git] / t / 99_pod_coverage.t
1 #!perl
2
3 ##############################################################################
4 #     $URL$
5 #    $Date$
6 #   $Author$
7 # $Revision$
8 ##############################################################################
9
10 use 5.006001;
11 use strict;
12 use warnings;
13
14 use English qw< -no_match_vars >;
15
16 use Test::More;
17
18 #-----------------------------------------------------------------------------
19
20 our $VERSION = '1.093_01';
21
22 #-----------------------------------------------------------------------------
23
24 eval 'use Test::Pod::Coverage 1.04'; ## no critic
25 plan skip_all => 'Test::Pod::Coverage 1.00 requried to test POD'
26     if $EVAL_ERROR;
27
28 {
29     # HACK: Perl::Critic::Violation uses Pod::Parser to extract the
30     # DIAGNOSTIC section of the POD in each Policy module.  This
31     # happens when the Policy first C<uses> the Violation module.
32     # Meanwhile, Pod::Coverage also uses Pod::Parser to extract the
33     # POD and compare it with the subroutines that are in the symbol
34     # table for that module.  For reasons I cannot yet explain, using
35     # Pod::Parser twice this way causes the symbol table to get very
36     # wacky and this test script dies with "Can't call method 'OPEN'
37     # on IO::String at line 1239 of Pod/Parser.pm".
38
39     # For now, my workaround is to temporarily redefine the import()
40     # method in the Violation module so that it doesn't do any Pod
41     # parsing.  I'll look for a better solution (or file a bug report)
42     # when / if I have better understanding of the problem.
43
44     no warnings qw<redefine once>; ## no critic (ProhibitNoWarnings)
45     require Perl::Critic::Violation;
46     *Perl::Critic::Violation::import = sub { 1 };
47 }
48
49 my @trusted_methods  = get_trusted_methods();
50 my $method_string = join ' | ', @trusted_methods;
51 my $trusted_rx = qr{ \A (?: $method_string ) \z }xms;
52 all_pod_coverage_ok( {trustme => [$trusted_rx]} );
53
54 #-----------------------------------------------------------------------------
55
56 sub get_trusted_methods {
57     return qw(
58         new
59         initialize_if_enabled
60         prepare_to_scan_document
61         violates
62         applies_to
63         default_themes
64         default_maximum_violations_per_document
65         default_severity
66         supported_parameters
67         description
68         Fields
69         got_sigpipe
70     );
71 }
72
73 ##############################################################################
74 # Local Variables:
75 #   mode: cperl
76 #   cperl-indent-level: 4
77 #   fill-column: 78
78 #   indent-tabs-mode: nil
79 #   c-indentation-style: bsd
80 # End:
81 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :