« blib/lib/Perl/Critic/Policy/ErrorHandling/RequireCheckingReturnValueOfEval.pm
↑ Summary
blib/lib/Perl/Critic/Policy/Variables/RequireNegativeIndices.pm »
| 1 | package Perl::Critic::Policy::BuiltinFunctions::ProhibitReverseSortBlock; | ||||||||||||||||||||||||||||
| 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{Forbid $b before $a in sort blocks}; ## no critic (InterpolationOfMetachars) | |||||||||||||||||||||||||||
| 16 | 40 | Readonly::Scalar my $EXPL => [ 152 ]; | |||||||||||||||||||||||||||
| 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_LOWEST } | ||||||||||||||||||||||||||
|
Subroutine
default_severity: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 22 | 84 | ▶ | sub default_themes { return qw(core pbp cosmetic) } | ||||||||||||||||||||||||||
|
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, $doc) = @_; | ||||||||||||||||||||||||||
|
Subroutine
violates: called CC=13 SCAR=50.0
Pod
documented
| |||||||||||||||||||||||||||||
| 29 | |||||||||||||||||||||||||||||
| 30 | 332 | ▶ | return if $elem->content() ne 'sort'; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 31 | 0 | ▶ | return if ! is_function_call($elem); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 32 | |||||||||||||||||||||||||||||
| 33 | 0 | my $sib = $elem->snext_sibling(); | |||||||||||||||||||||||||||
| 34 | 0 | ▶ | return if !$sib; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 35 | |||||||||||||||||||||||||||||
| 36 | 0 | my $arg = $sib; | |||||||||||||||||||||||||||
| 37 | 0 | ▶ | if ( $arg->isa('PPI::Structure::List') ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 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
Condition0%0/3
$arg and $arg->isa("PPI::Statement::Expression")
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")
| |||||||||||||||||||||||||||||
| 41 | 0 | $arg = $arg->schild(0); | |||||||||||||||||||||||||||
| 42 | } | ||||||||||||||||||||||||||||
| 43 | } | ||||||||||||||||||||||||||||
| 44 | 0 | ▶ | return if !$arg || !$arg->isa('PPI::Structure::Block'); | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$arg and $arg->isa("PPI::Structure::Block")
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")
| |||||||||||||||||||||||||||||
| 45 | |||||||||||||||||||||||||||||
| 46 | # If we get here, we found a sort with a block as the first arg | ||||||||||||||||||||||||||||
| 47 | |||||||||||||||||||||||||||||
| 48 | # Look at each statement in the block separately. | ||||||||||||||||||||||||||||
| 49 | # $a is +1, $b is -1, sum should always be >= 0. | ||||||||||||||||||||||||||||
| 50 | # This may go badly if there are conditionals or loops or other | ||||||||||||||||||||||||||||
| 51 | # sub-statements... | ||||||||||||||||||||||||||||
| 52 | 0 | for my $statement ($arg->children) { | |||||||||||||||||||||||||||
| 53 | 0 | my @sort_vars = $statement =~ m/\$([ab])\b/gxms; | |||||||||||||||||||||||||||
| 54 | 0 | my $count = 0; | |||||||||||||||||||||||||||
| 55 | 0 | for my $sort_var (@sort_vars) { | |||||||||||||||||||||||||||
| 56 | 0 | ▶ | if ($sort_var eq 'a') { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 57 | 0 | $count++; | |||||||||||||||||||||||||||
| 58 | } else { | ||||||||||||||||||||||||||||
| 59 | 0 | $count--; | |||||||||||||||||||||||||||
| 60 | 0 | ▶ | if ($count < 0) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 61 | # Found too many C<$b>s too early | ||||||||||||||||||||||||||||
| 62 | 0 | return $self->violation( $DESC, $EXPL, $elem ); | |||||||||||||||||||||||||||
| 63 | } | ||||||||||||||||||||||||||||
| 64 | } | ||||||||||||||||||||||||||||
| 65 | } | ||||||||||||||||||||||||||||
| 66 | } | ||||||||||||||||||||||||||||
| 67 | 0 | return; #ok | |||||||||||||||||||||||||||
| 68 | } | ||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||
| 70 | 40 | 1; | |||||||||||||||||||||||||||
| 71 | |||||||||||||||||||||||||||||
| 72 | #----------------------------------------------------------------------------- | ||||||||||||||||||||||||||||
| 73 | |||||||||||||||||||||||||||||
| 74 | __END__ | ||||||||||||||||||||||||||||
| 75 | |||||||||||||||||||||||||||||
| 76 | =pod | ||||||||||||||||||||||||||||
| 77 | |||||||||||||||||||||||||||||
| 78 | =head1 NAME | ||||||||||||||||||||||||||||
| 79 | |||||||||||||||||||||||||||||
| 80 | Perl::Critic::Policy::BuiltinFunctions::ProhibitReverseSortBlock - Forbid $b before $a in sort blocks. | ||||||||||||||||||||||||||||
| 81 | |||||||||||||||||||||||||||||
| 82 | |||||||||||||||||||||||||||||
| 83 | =head1 AFFILIATION | ||||||||||||||||||||||||||||
| 84 | |||||||||||||||||||||||||||||
| 85 | This Policy is part of the core L<Perl::Critic|Perl::Critic> | ||||||||||||||||||||||||||||
| 86 | distribution. | ||||||||||||||||||||||||||||
| 87 | |||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||
| 89 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||
| 91 | Conway says that it is much clearer to use C<reverse> than to flip | ||||||||||||||||||||||||||||
| 92 | C<$a> and C<$b> around in a C<sort> block. He also suggests that, in | ||||||||||||||||||||||||||||
| 93 | newer perls, C<reverse> is specifically looked for and optimized, and | ||||||||||||||||||||||||||||
| 94 | in the case of a simple reversed string C<sort>, using C<reverse> with | ||||||||||||||||||||||||||||
| 95 | a C<sort> with no block is faster even in old perls. | ||||||||||||||||||||||||||||
| 96 | |||||||||||||||||||||||||||||
| 97 | my @foo = sort { $b cmp $a } @bar; #not ok | ||||||||||||||||||||||||||||
| 98 | my @foo = reverse sort @bar; #ok | ||||||||||||||||||||||||||||
| 99 | |||||||||||||||||||||||||||||
| 100 | my @foo = sort { $b <=> $a } @bar; #not ok | ||||||||||||||||||||||||||||
| 101 | my @foo = reverse sort { $a <=> $b } @bar; #ok | ||||||||||||||||||||||||||||
| 102 | |||||||||||||||||||||||||||||
| 103 | |||||||||||||||||||||||||||||
| 104 | =head1 CONFIGURATION | ||||||||||||||||||||||||||||
| 105 | |||||||||||||||||||||||||||||
| 106 | This Policy is not configurable except for the standard options. | ||||||||||||||||||||||||||||
| 107 | |||||||||||||||||||||||||||||
| 108 | |||||||||||||||||||||||||||||
| 109 | =head1 AUTHOR | ||||||||||||||||||||||||||||
| 110 | |||||||||||||||||||||||||||||
| 111 | Chris Dolan <cdolan@cpan.org> | ||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||
| 113 | |||||||||||||||||||||||||||||
| 114 | =head1 COPYRIGHT | ||||||||||||||||||||||||||||
| 115 | |||||||||||||||||||||||||||||
| 116 | Copyright (c) 2006-2011 Chris Dolan. | ||||||||||||||||||||||||||||
| 117 | |||||||||||||||||||||||||||||
| 118 | This program is free software; you can redistribute it and/or modify | ||||||||||||||||||||||||||||
| 119 | it under the same terms as Perl itself. | ||||||||||||||||||||||||||||
| 120 | |||||||||||||||||||||||||||||
| 121 | =cut | ||||||||||||||||||||||||||||
| 122 | |||||||||||||||||||||||||||||
| 123 | # Local Variables: | ||||||||||||||||||||||||||||
| 124 | # mode: cperl | ||||||||||||||||||||||||||||
| 125 | # cperl-indent-level: 4 | ||||||||||||||||||||||||||||
| 126 | # fill-column: 78 | ||||||||||||||||||||||||||||
| 127 | # indent-tabs-mode: nil | ||||||||||||||||||||||||||||
| 128 | # c-indentation-style: bsd | ||||||||||||||||||||||||||||
| 129 | # End: | ||||||||||||||||||||||||||||
| 130 | # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround : | ||||||||||||||||||||||||||||