git.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/ControlStructures/ProhibitUnlessBlocks.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/ControlStructures/ProhibitUnlessBlocks.pm $
   3 #     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2489 $
   6 ##############################################################################
   7
   8 package Perl::Critic::Policy::ControlStructures::ProhibitUnlessBlocks;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ :severities };
  16 use base 'Perl::Critic::Policy';
  17
  18 our $VERSION = '1.088';
  19
  20 #-----------------------------------------------------------------------------
  21
  22 Readonly::Scalar my $DESC => q{"unless" block used};
  23 Readonly::Scalar my $EXPL => [ 97 ];
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                         }
  28 sub default_severity     { return $SEVERITY_LOW              }
  29 sub default_themes       { return qw(core pbp cosmetic)      }
  30 sub applies_to           { return 'PPI::Statement::Compound' }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36
  37     if ( $elem->first_element() eq 'unless' ) {
  38         return $self->violation( $DESC, $EXPL, $elem );
  39     }
  40     return;    #ok!
  41 }
  42
  43 1;
  44
  45 __END__
  46
  47 #-----------------------------------------------------------------------------
  48
  49 =pod
  50
  51 =head1 NAME
  52
  53 Perl::Critic::Policy::ControlStructures::ProhibitUnlessBlocks - Write C<if(! $condition)> instead of C<unless($condition)>.
  54
  55 =head1 AFFILIATION
  56
  57 This Policy is part of the core L<Perl::Critic> distribution.
  58
  59
  60 =head1 DESCRIPTION
  61
  62 Conway discourages using C<unless> because it leads to double-negatives
  63 that are hard to understand.  Instead, reverse the logic and use C<if>.
  64
  65   unless($condition) { do_something() } #not ok
  66   unless(! $no_flag) { do_something() } #really bad
  67   if( ! $condition)  { do_something() } #ok
  68
  69 This Policy only covers the block-form of C<unless>.  For the postfix
  70 variety, see C<ProhibitPostfixControls>.
  71
  72
  73 =head1 CONFIGURATION
  74
  75 This Policy is not configurable except for the standard options.
  76
  77
  78 =head1 SEE ALSO
  79
  80 L<Perl::Critic::Policy::ControlStructures::ProhibitPostfixControls>
  81
  82 =head1 AUTHOR
  83
  84 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  85
  86 =head1 COPYRIGHT
  87
  88 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  89
  90 This program is free software; you can redistribute it and/or modify
  91 it under the same terms as Perl itself.  The full text of this license
  92 can be found in the LICENSE file included with this module.
  93
  94 =cut
  95
  96 # Local Variables:
  97 #   mode: cperl
  98 #   cperl-indent-level: 4
  99 #   fill-column: 78
 100 #   indent-tabs-mode: nil
 101 #   c-indentation-style: bsd
 102 # End:
 103 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :