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
|
package Perl::Critic::Policy::Variables::ProhibitAugmentedAssignmentInDeclaration;
use 5.010001;
use strict;
use warnings;
use List::SomeUtils qw( firstval );
use Readonly;
use Perl::Critic::Utils qw{ :severities :data_conversion };
use parent 'Perl::Critic::Policy';
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
Readonly::Scalar my $DESC => q{Augmented assignment operator '%s' used in declaration};
Readonly::Scalar my $EXPL => q{Use simple assignment when initializing variables};
#-----------------------------------------------------------------------------
sub supported_parameters {
return (
{
name => 'allow_our',
description =>
q<Allow augmented assignment for our variables.>,
default_string => '0',
behavior => 'boolean',
},
);
}
sub default_severity { return $SEVERITY_HIGH }
sub default_themes { return qw( core bugs ) }
sub applies_to { return 'PPI::Statement::Variable' }
#-----------------------------------------------------------------------------
sub violates {
my ( $self, $elem, undef ) = @_;
state $augmented_assignments = { hashify( qw( **= += -= .= *= /= %= x= &= |= ^= <<= >>= &&= ||= //= ) ) };
# The assignment operator associated with a PPI::Statement::Variable
# element is assumed to be the first immediate child of that element.
# Other operators in the statement, e.g. the ',' in "my ( $a, $b ) = ();",
# as assumed to never be immediate children.
#
return
if $self->{_allow_our} and $elem->type eq 'our';
my $found = firstval { $_->isa('PPI::Token::Operator') } $elem->children();
if ( $found ) {
my $op = $found->content();
if ( exists $augmented_assignments->{ $op } ) {
return $self->violation( sprintf( $DESC, $op ), $EXPL, $found );
}
}
return;
}
1;
__END__
#-----------------------------------------------------------------------------
=pod
=for stopwords O'Regan
=head1 NAME
Perl::Critic::Policy::Variables::ProhibitAugmentedAssignmentInDeclaration - Do not write C< my $foo .= 'bar'; >.
=head1 AFFILIATION
This Policy is part of the core L<Perl::Critic|Perl::Critic>
distribution.
=head1 DESCRIPTION
Variable declarations that also do initialization with '=' are common.
Perl also allows you to use operators like '.=', '+=', etc., but it
it is more clear to not do so.
my $foo .= 'bar'; # same as my $foo = 'bar';
our $foo *= 2; # same as our $foo = 0;
my ( $foo, $bar ) += ( 1, 2 ); # same as my ( $foo, $bar ) = ( undef, 2 );
local $Carp::CarpLevel += 1; # same as local $Carp::CarpLevel = 1;
state $foo += 2; # adds 2 every time it's encountered
Such constructs are usually the result of botched cut-and-paste, and often are
bugs. Some produce warnings.
=head1 CONFIGURATION
There is an C<allow_our> boolean option for this Policy. If set, augmented
assignments are allowed when declaring C<our> variables. Since C<our>
variables are globally accessible, some modules will want to allow users to
initialize the variable prior to the module using the variable. Modules may
also wish to use the same our variable in different scopes without declaring
it at the outer scope.
With this option set, the following are flagged as indicated:
our $DEBUG //= 1; # ok
This can be enabled in your F<.perlcriticrc>:
[Perl::Critic::Policy::Variables::ProhibitAugmentedAssignmentInDeclaration]
allow_our = 1
=head1 AUTHOR
Mike O'Regan
=head1 COPYRIGHT
Copyright (c) 2011-2023 Mike O'Regan
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself. The full text of this license
can be found in the LICENSE file included with this module.
=cut
# 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 :
|
