blib/lib/Perl/Critic/Policy/RegularExpressions/RequireBracesForMultiline.pm

filter: Statementstmt 89.4% 34 / 38 Branchbran 33.3% 2 / 6 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 12 / 12 Podpod 83.3% 5 / 6 totaltotal 85.4% 53 / 62 CC 4 SCAR 6.6
CC
4
Cov
82%
violates
4.9
initialize_if_enabled
2.1
BEGIN
1.0
CRAP 1.9
« blib/lib/Perl/Critic/Policy/Miscellanea/ProhibitTies.pm ↑ Summary blib/lib/Perl/Critic/Policy/ControlStructures/ProhibitDeepNests.pm »
1 package Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline;
2  
3 40 ▶use 5.010001;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 40 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 40 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 40 ▶use Readonly;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 40 ▶use Perl::Critic::Utils qw{ :booleans :severities };
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 40 ▶use parent 'Perl::Critic::Policy';
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 40 our $VERSION = '1.150';
13  
14 #-----------------------------------------------------------------------------
15  
16 40 Readonly::Scalar my $DESC => q<Use '{' and '}' to delimit multi-line regexps>;
17 40 Readonly::Scalar my $EXPL => [242];
18  
19 40 Readonly::Array my @EXTRA_BRACKETS => qw{ () [] <> };
20  
21 #-----------------------------------------------------------------------------
22  
23 sub supported_parameters {
24 return (
25 {
26 91 ▶ name => 'allow_all_brackets',
Subroutine supported_parameters: called CC=1 SCAR=0.0
Pod undocumented
27 description =>
28 q[In addition to allowing '{}', allow '()', '[]', and '{}'.],
29 behavior => 'boolean',
30 },
31 );
32 }
33  
34 75 ▶sub default_severity { return $SEVERITY_LOWEST }
Subroutine default_severity: called CC=1 SCAR=0.0
Pod documented
35 84 ▶sub default_themes { return qw( core pbp cosmetic ) }
Subroutine default_themes: called CC=1 SCAR=0.0
Pod documented
36 31 ▶sub applies_to { return qw(PPI::Token::Regexp::Match
Subroutine applies_to: called CC=1 SCAR=0.0
Pod documented
37 PPI::Token::Regexp::Substitute
38 PPI::Token::QuoteLike::Regexp) }
39  
40 #-----------------------------------------------------------------------------
41  
42 sub initialize_if_enabled {
43 48 ▶ my ( $self, $config ) = @_;
Subroutine initialize_if_enabled: called CC=2 SCAR=7.2
Pod documented
44  
45 48 my %delimiters = ( q<{}> => 1 );
46 48 ▶ if ( $self->{_allow_all_brackets} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"_allow_all_brackets"}) 0 48 48
47 0 @delimiters{ @EXTRA_BRACKETS } = (1) x @EXTRA_BRACKETS;
48 }
49  
50 48 $self->{_allowed_delimiters} = \%delimiters;
51  
52 48 return $TRUE;
53 }
54  
55 #-----------------------------------------------------------------------------
56  
57 sub violates {
58 1 ▶ my ( $self, $elem, undef ) = @_;
Subroutine violates: called CC=3 SCAR=16.0
Pod documented
59  
60 1 my $re = $elem->get_match_string();
61 1 ▶ return if $re !~ m/\n/xms;
Branch: 1 branch
BranchTrueFalseTotal
unless $re =~ /\n/msx 1 0 1
62  
63 0 my ($match_delim) = $elem->get_delimiters();
64 0 ▶ return if $self->{_allowed_delimiters}{$match_delim};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_allowed_delimiters"}{$match_delim} 0 0 0
65  
66 0 return $self->violation( $DESC, $EXPL, $elem );
67 }
68  
69 40 1;
70  
71 __END__
72  
73 #-----------------------------------------------------------------------------
74  
75 =pod
76  
77 =head1 NAME
78  
79 Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline - Use C<{> and C<}> to delimit multi-line regexps.
80  
81  
82 =head1 AFFILIATION
83  
84 This Policy is part of the core L<Perl::Critic|Perl::Critic>
85 distribution.
86  
87  
88 =head1 DESCRIPTION
89  
90 Long regular expressions are hard to read. A good practice is to use
91 the C<x> modifier and break the regex into multiple lines with
92 comments explaining the parts. But, with the usual C<//> delimiters,
93 the beginning and end can be hard to match, especially in a C<s///>
94 regexp. Instead, try using C<{}> characters to delimit your
95 expressions.
96  
97 Compare these:
98  
99 s/
100 <a \s+ href="([^"]+)">
101 (.*?)
102 </a>
103 /link=$1, text=$2/xms;
104  
105 vs.
106  
107 s{
108 <a \s+ href="([^"]+)">
109 (.*?)
110 </a>
111 }
112 {link=$1, text=$2}xms;
113  
114 Is that an improvement? Marginally, but yes. The curly braces lead
115 the eye better.
116  
117  
118 =head1 CONFIGURATION
119  
120 There is one option for this policy, C<allow_all_brackets>. If this
121 is true, then, in addition to allowing C<{}>, the other matched pairs
122 of C<()>, C<[]>, and C<< <> >> are allowed.
123  
124  
125 =head1 CREDITS
126  
127 Initial development of this policy was supported by a grant from the
128 Perl Foundation.
129  
130  
131 =head1 AUTHOR
132  
133 Chris Dolan <cdolan@cpan.org>
134  
135  
136 =head1 COPYRIGHT
137  
138 Copyright (c) 2007-2023 Chris Dolan
139  
140 This program is free software; you can redistribute it and/or modify
141 it under the same terms as Perl itself. The full text of this license
142 can be found in the LICENSE file included with this module
143  
144 =cut
145  
146 # Local Variables:
147 # mode: cperl
148 # cperl-indent-level: 4
149 # fill-column: 78
150 # indent-tabs-mode: nil
151 # c-indentation-style: bsd
152 # End:
153 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
« blib/lib/Perl/Critic/Policy/Miscellanea/ProhibitTies.pm ↑ Summary blib/lib/Perl/Critic/Policy/ControlStructures/ProhibitDeepNests.pm »