The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

ELLIOTJS / Perl-Critic-1.101_002 / t / 20_policy_pod_spelling.t 

            

              
1
2
3
4
5
6
7
8
—
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
—
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
—
64
65
66
67
68
69
70
71
72
73
74
75
—
76
77
78
79
80
81
82
83
84
85
86
87
88
89
—
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
—
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
—
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

              
#!perl
##############################################################################
#      $URL: http://perlcritic.tigris.org/svn/perlcritic/branches/Perl-Critic-PPI-1.204/t/20_policy_pod_spelling.t $
#     $Date: 2009-07-21 08:50:56 -0700 (Tue, 21 Jul 2009) $
#   $Author: clonezone $
# $Revision: 3404 $
##############################################################################
=for stopwords arglbargl
=cut
use 5.006001;
use strict;
use warnings;
use Perl::Critic::TestUtils qw(pcritique);
use Test::More tests => 5;
#-----------------------------------------------------------------------------
our $VERSION = '1.101_001';
#-----------------------------------------------------------------------------
Perl::Critic::TestUtils::block_perlcriticrc();
my $code;
my $policy = 'Documentation::PodSpelling';
my $can_podspell =
        eval {require Pod::Spell}
    &&  can_determine_spell_command()
    &&  can_run_spell_command();
sub can_determine_spell_command {
    my $pol = Perl::Critic::Policy::Documentation::PodSpelling->new();
    $pol->initialize_if_enabled();
    return $pol->_get_spell_command_line();
}
sub can_run_spell_command {
    my $pol = Perl::Critic::Policy::Documentation::PodSpelling->new();
    $pol->initialize_if_enabled();
    return $pol->_run_spell_command( <<'END_TEST_CODE' );
=pod
=head1 Test The Spell Command
=cut
END_TEST_CODE
}
sub can_podspell {
    return $can_podspell && ! Perl::Critic::Policy::Documentation::PodSpelling->got_sigpipe();
}
#-----------------------------------------------------------------------------
SKIP: {
$code = <<'END_PERL';
=head1 Silly
=cut
END_PERL
if ( eval { pcritique($policy, \$code) } ) {
   skip 'Test environment is not English', 4
}
#-----------------------------------------------------------------------------
$code = <<'END_PERL';
=head1 arglbargl
=cut
END_PERL
is(
    eval { pcritique($policy, \$code) },
    can_podspell() ? 1 : undef,
    'Mispelled header',
);
#-----------------------------------------------------------------------------
$code = <<'END_PERL';
=head1 Test
arglbargl
=cut
END_PERL
is(
    eval { pcritique($policy, \$code) },
    can_podspell() ? 1 : undef,
    'Mispelled body',
);
#-----------------------------------------------------------------------------
$code = <<'END_PERL';
=for stopwords arglbargl
=head1 Test
arglbargl
=cut
END_PERL
is(
    eval { pcritique($policy, \$code) },
    can_podspell() ? 0 : undef,
    'local stopwords',
);
#-----------------------------------------------------------------------------
$code = <<'END_PERL';
=head1 Test
arglbargl
=cut
END_PERL
{
    my %config = (stop_words => 'foo arglbargl bar');
    is(
        eval { pcritique($policy, \$code, \%config) },
        can_podspell() ? 0 : undef ,
        'global stopwords',
    );
}
{
    my %config = (stop_words_file => 't/20_policy_pod_spelling.d/stop-words.txt');
    is(
        eval { pcritique($policy, \$code, \%config) },
        can_podspell() ? 0 : undef ,
        'global stopwords from file',
    );
}
} # end skip
#-----------------------------------------------------------------------------
# ensure we run true if this test is loaded by
# t/20_policy_pod_spelling.t_without_optional_dependencies.t
1;
# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 78
#   indent-tabs-mode: nil
#   c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :