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
|
package Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline;
use 5.010001;
use strict;
use warnings;
use Readonly;
use Perl::Critic::Utils qw{ :booleans :severities };
use parent 'Perl::Critic::Policy';
our $VERSION = '1.156';
#-----------------------------------------------------------------------------
Readonly::Scalar my $DESC => q<Use '{' and '}' to delimit multi-line regexps>;
Readonly::Scalar my $EXPL => [242];
Readonly::Array my @EXTRA_BRACKETS => qw{ () [] <> };
#-----------------------------------------------------------------------------
sub supported_parameters {
return (
{
name => 'allow_all_brackets',
description =>
q[In addition to allowing '{}', allow '()', '[]', and '{}'.],
behavior => 'boolean',
},
);
}
sub default_severity { return $SEVERITY_LOWEST }
sub default_themes { return qw( core pbp cosmetic ) }
sub applies_to { return qw(PPI::Token::Regexp::Match
PPI::Token::Regexp::Substitute
PPI::Token::QuoteLike::Regexp) }
#-----------------------------------------------------------------------------
sub initialize_if_enabled {
my ( $self, undef ) = @_;
my %delimiters = ( q<{}> => 1 );
if ( $self->{_allow_all_brackets} ) {
@delimiters{ @EXTRA_BRACKETS } = (1) x @EXTRA_BRACKETS;
}
$self->{_allowed_delimiters} = \%delimiters;
return $TRUE;
}
#-----------------------------------------------------------------------------
sub violates {
my ( $self, $elem, undef ) = @_;
my $re = $elem->get_match_string();
return if $re !~ m/\n/xms;
my ($match_delim) = $elem->get_delimiters();
return if $self->{_allowed_delimiters}{$match_delim};
return $self->violation( $DESC, $EXPL, $elem );
}
1;
__END__
#-----------------------------------------------------------------------------
=pod
=head1 NAME
Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline - Use C<{> and C<}> to delimit multi-line regexps.
=head1 AFFILIATION
This Policy is part of the core L<Perl::Critic|Perl::Critic>
distribution.
=head1 DESCRIPTION
Long regular expressions are hard to read. A good practice is to use
the C<x> modifier and break the regex into multiple lines with
comments explaining the parts. But, with the usual C<//> delimiters,
the beginning and end can be hard to match, especially in a C<s///>
regexp. Instead, try using C<{}> characters to delimit your
expressions.
Compare these:
s/
<a \s+ href="([^"]+)">
(.*?)
</a>
/link=$1, text=$2/xms;
vs.
s{
<a \s+ href="([^"]+)">
(.*?)
</a>
}
{link=$1, text=$2}xms;
Is that an improvement? Marginally, but yes. The curly braces lead
the eye better.
=head1 CONFIGURATION
There is one option for this policy, C<allow_all_brackets>. If this
is true, then, in addition to allowing C<{}>, the other matched pairs
of C<()>, C<[]>, and C<< <> >> are allowed.
=head1 CREDITS
Initial development of this policy was supported by a grant from the
Perl Foundation.
=head1 AUTHOR
Chris Dolan <cdolan@cpan.org>
=head1 COPYRIGHT
Copyright (c) 2007-2023 Chris Dolan
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 :
|
