File: ConstantLeadingUnderscore.t

package info (click to toggle)
libperl-critic-pulp-perl 99-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 1,700 kB
  • sloc: perl: 13,768; sh: 285; makefile: 6; ansic: 1
file content (189 lines) | stat: -rwxr-xr-x 6,962 bytes parent folder | download
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#!/usr/bin/perl -w

# Copyright 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde

# This file is part of Perl-Critic-Pulp.
#
# Perl-Critic-Pulp is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 3, or (at your option) any later
# version.
#
# Perl-Critic-Pulp is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with Perl-Critic-Pulp.  If not, see <http://www.gnu.org/licenses/>.


use 5.006;
use strict;
use warnings;
use Test::More tests => 75;

use lib 't';
use MyTestHelpers;
BEGIN { MyTestHelpers::nowarnings() }

require Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore;


#------------------------------------------------------------------------------
my $want_version = 99;
is ($Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore::VERSION,
    $want_version, 'VERSION variable');
is (Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore->VERSION,
    $want_version, 'VERSION class method');
{
  ok (eval { Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore->VERSION($want_version); 1 }, "VERSION class check $want_version");
  my $check_version = $want_version + 1000;
  ok (! eval { Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore->VERSION($check_version); 1 }, "VERSION class check $check_version");
}

#-----------------------------------------------------------------------------
# _use_constant_single_name()

require PPI::Document;
foreach my $data ([ 'use constant', undef ],
                  [ 'use constant 1.03', undef ],

                  [ "use constant 'FOO', 123", 'FOO' ],
                  [ 'use constant "FOO", 123', 'FOO' ],
                  [ 'use constant q{FOO}, 123', 'FOO' ],
                  [ 'use constant qq{FOO}, 123', 'FOO' ],
                  [ 'use constant FOO => 123', 'FOO' ],

                  # FIXME: this one not handled yet
                  [ 'use constant qw(FOO 123)', 'FOO',
                    'qw() not handled yet'],

                  [ 'use constant {x=>1}', undef ],
                  [ 'use constant { qw(x 1) }', undef ],

                 ) {

  foreach my $suffix ('', ';') {
    foreach my $ver ('', ' 1.00') {

      my ($str, $want, $todo) = @$data;
    TODO: {
        local $TODO = $todo;

        $str .= $suffix;
        $str =~ s/constant/constant$ver/;

        my $document = PPI::Document->new (\$str)
          or die "oops, no parse: $str";
        my $incs = ($document->find ('PPI::Statement::Include')
                    || $document->find ('PPI::Statement::Sub')
                    || die "oops, no target statement in '$str'");
        my $inc = $incs->[0] or die "oops, no Include element";
        my $got = Perl::Critic::Policy::Compatibility::ConstantLeadingUnderscore::_use_constant_single_name ($inc);
        is ($got, $want, "str: $str");
      }
    }
  }
}

#-----------------------------------------------------------------------------
# the policy

require Perl::Critic;
my $single_policy = 'Compatibility::ConstantLeadingUnderscore';
my $critic = Perl::Critic->new
  ('-profile' => '',
   '-single-policy' => $single_policy);
{ my @p = $critic->policies;
  is (scalar @p, 1,
      "single policy $single_policy");

  my $policy = $p[0];
  ok (eval { $policy->VERSION($want_version); 1 },
      "VERSION object check $want_version");
  my $check_version = $want_version + 1000;
  ok (! eval { $policy->VERSION($check_version); 1 },
      "VERSION object check $check_version");
}

foreach my $data (
                  # from the pod
                  [ 0, 'use constant FOO => 1;' ],
                  [ 1, 'use constant _FOO => 1;' ],

                  [ 0, 'use 5.005; use constant FOO => 1;' ],
                  [ 1, 'use 5.005; use constant _FOO => 1;' ],
                  [ 0, 'use 5.006; use constant _FOO => 1;' ],

                  [ 0, 'use constant 1.01; use constant FOO => 1;' ],
                  [ 1, 'use constant 1.01; use constant _FOO => 1;' ],
                  [ 0, 'use constant 1.02; use constant _FOO => 1;' ],

                  [ 0, 'use constant 1.01 FOO => 1;' ],
                  [ 1, 'use constant 1.01 _FOO => 1;' ],
                  [ 0, 'use constant 1.02 _FOO => 1;' ],

                  # multi-constant before version num
                  [ 1, 'use constant _FOO => 1; use constant 1.01;' ],
                  [ 1, 'use constant _FOO => 1; use 5.006;' ],

                  [ 3, 'use constant _FOO => 1;
                        use constant _BAR => 1;
                        use constant 1.01;
                        use constant _QUUX => 1;' ],
                  [ 2, 'use constant _FOO => 1;
                        use constant _BAR => 1;
                        use constant 1.02;
                        use constant _QUUX => 1;' ],
                  [ 3, 'use constant _FOO => 1;
                        use constant _BAR => 1;
                        use 5.005;
                        use constant _QUUX => 1;' ],
                  [ 2, 'use constant _FOO => 1;
                        use constant _BAR => 1;
                        use 5.006;
                        use constant _QUUX => 1;' ],

                  [ 1, 'require 5.006;
                        use constant _foo => 1;' ],
                  [ 0, 'BEGIN { require 5.006; }
                        use constant _foo => 1;' ],
                  [ 0, 'BEGIN { { require 5.006; } }
                        use constant _foo => 1;' ],
                  [ 0, 'BEGIN { foo(); { require 5.010 } }
                        use constant _foo => 1;' ],
                  [ 1, 'use constant _foo => 1;
                        BEGIN { require 5.010 }' ],

                  [ 0, 'use constant 1000.9 _foo => 1;' ],
                  [ 0, 'use constant 1000.9; use constant _foo => 1;' ],

                  # bogus version number forms don't count as a version
                  # declaration, so policy should fire
                  [ 1, 'use constant \'1.03\';
                        use constant _foo => 1;' ],
                  [ 1, 'use constant "1.03";
                        use constant _foo => 1;' ],

                  # this is a syntax error, but shouldn't tickle the policy
                  [ 0, 'use constant \'1.02\' _foo => 1;' ],

                  [ 0, '1;' ],

                 ) {
  my ($want_count, $str) = @$data;

  my @violations = $critic->critique (\$str);

  my $got_count = scalar @violations;
  is ($got_count, $want_count, "str: $str");

  if ($got_count != $want_count) {
    foreach (@violations) {
      diag ($_->description);
    }
  }
}

exit 0;