blib/lib/Perl/Critic/Policy/BuiltinFunctions/RequireSimpleSortBlock.pm

filter: Statementstmt 71.0% 27 / 38 Branchbran 7.1% 1 / 14 Conditioncond 0.0% 0 / 6 MC/DCmcdc 0.0% 0 / 4 Subroutinesub 100% 11 / 11 Podpod 80.0% 4 / 5 totaltotal 55.1% 43 / 78 CC 10 SCAR 37.6
CC
10
Cov
48%
violates
85.1
BEGIN
1.0
BEGIN
1.0
CRAP 43.1
« blib/lib/Perl/Critic/Policy/InputOutput/ProhibitBarewordFileHandles.pm ↑ Summary blib/lib/Perl/Critic/Policy/RegularExpressions/ProhibitComplexRegexes.pm »
1 package Perl::Critic::Policy::BuiltinFunctions::RequireSimpleSortBlock;
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{ :severities :classification };
Subroutine BEGIN: called CC=1 SCAR=0.0
9 40 ▶use parent 'Perl::Critic::Policy';
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 40 our $VERSION = '1.150';
12  
13 #-----------------------------------------------------------------------------
14  
15 40 Readonly::Scalar my $DESC => q{Sort blocks should have a single statement};
16 40 Readonly::Scalar my $EXPL => [ 149 ];
17  
18 #-----------------------------------------------------------------------------
19  
20 90 ▶sub supported_parameters { return () }
Subroutine supported_parameters: called CC=1 SCAR=0.0
Pod undocumented
21 75 ▶sub default_severity { return $SEVERITY_MEDIUM }
Subroutine default_severity: called CC=1 SCAR=0.0
Pod documented
22 86 ▶sub default_themes { return qw( core pbp maintenance complexity) }
Subroutine default_themes: called CC=1 SCAR=0.0
Pod documented
23 31 ▶sub applies_to { return 'PPI::Token::Word' }
Subroutine applies_to: called CC=1 SCAR=0.0
Pod documented
24  
25 #-----------------------------------------------------------------------------
26  
27 sub violates {
28 332 ▶ my ( $self, $elem, undef ) = @_;
Subroutine violates: called CC=10 SCAR=44.4
Pod documented
29  
30 332 ▶ return if $elem->content() ne 'sort';
Branch: 1 branch
BranchTrueFalseTotal
if $elem->content ne "sort" 332 0 332
31 0 ▶ return if ! is_function_call($elem);
Branch: 1 branch
BranchTrueFalseTotal
unless is_function_call($elem) 0 0 0
32  
33 0 my $sib = $elem->snext_sibling();
34 0 ▶ return if !$sib;
Branch: 1 branch
BranchTrueFalseTotal
unless $sib 0 0 0
35  
36 0 my $arg = $sib;
37 0 ▶ if ( $arg->isa('PPI::Structure::List') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($arg->isa("PPI::Structure::List")) 0 0 0
38 0 $arg = $arg->schild(0);
39 # Forward looking: PPI might change in v1.200 so schild(0) is a PPI::Statement::Expression
40 0 ▶ if ( $arg && $arg->isa('PPI::Statement::Expression') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($arg and $arg->isa("PPI::Statement::Expression")) 0 0 0
Condition0%0/3
$arg and $arg->isa("PPI::Statement::Expression")
!ll&&!rl&&r
000
MC/DC0%0/2
$arg and $arg->isa("PPI::Statement::Expression")
$arg $arg->isa("PPI::Statement::Expression")
Truth table0%0/3
A and B
A= $argB= $arg->isa("PPI::Statement::Expression")
ABresult
0X0
100
111
41 0 $arg = $arg->schild(0);
42 }
43 }
44 0 ▶ return if !$arg || !$arg->isa('PPI::Structure::Block');
Branch: 1 branch
BranchTrueFalseTotal
unless $arg and $arg->isa("PPI::Structure::Block") 0 0 0
Condition0%0/3
$arg and $arg->isa("PPI::Structure::Block")
!ll&&!rl&&r
000
MC/DC0%0/2
$arg and $arg->isa("PPI::Structure::Block")
$arg $arg->isa("PPI::Structure::Block")
Truth table0%0/3
A and B
A= $argB= $arg->isa("PPI::Structure::Block")
ABresult
0X0
100
111
45  
46 # If we get here, we found a sort with a block as the first arg
47 0 ▶ return if ( 1 >= $arg->schildren() );
Branch: 1 branch
BranchTrueFalseTotal
if 1 >= $arg->schildren 0 0 0
48  
49 # more than one child statements
50 0 return $self->violation( $DESC, $EXPL, $elem );
51 }
52  
53 40 1;
54  
55 #-----------------------------------------------------------------------------
56  
57 __END__
58  
59 =pod
60  
61 =head1 NAME
62  
63 Perl::Critic::Policy::BuiltinFunctions::RequireSimpleSortBlock - Sort blocks should have a single statement.
64  
65  
66 =head1 AFFILIATION
67  
68 This Policy is part of the core L<Perl::Critic|Perl::Critic>
69 distribution.
70  
71  
72 =head1 DESCRIPTION
73  
74 Conway advises that sort functions should be simple. Any complicated
75 operations on list elements should be computed and cached (perhaps via
76 a Schwartzian Transform) before the sort, rather than computed inside
77 the sort block, because the sort block is called C<N log N> times
78 instead of just C<N> times.
79  
80 This policy prohibits the most blatant case of complicated sort
81 blocks: multiple statements. Future policies may wish to examine the
82 sort block in more detail -- looking for subroutine calls or large
83 numbers of operations.
84  
85  
86 =head1 CONFIGURATION
87  
88 This Policy is not configurable except for the standard options.
89  
90  
91 =head1 AUTHOR
92  
93 Chris Dolan <cdolan@cpan.org>
94  
95 =head1 COPYRIGHT
96  
97 Copyright (c) 2006-2011 Chris Dolan.
98  
99 This program is free software; you can redistribute it and/or modify
100 it under the same terms as Perl itself.
101  
102 =cut
103  
104 # Local Variables:
105 # mode: cperl
106 # cperl-indent-level: 4
107 # fill-column: 78
108 # indent-tabs-mode: nil
109 # c-indentation-style: bsd
110 # End:
111 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
« blib/lib/Perl/Critic/Policy/InputOutput/ProhibitBarewordFileHandles.pm ↑ Summary blib/lib/Perl/Critic/Policy/RegularExpressions/ProhibitComplexRegexes.pm »