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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/ControlStructures/ProhibitUntilBlocks.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::ProhibitUntilBlocks;
   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{"until" 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'      }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36     if ( $elem->first_element() eq 'until' ) {
  37         return $self->violation( $DESC, $EXPL, $elem );
  38     }
  39     return;    #ok!
  40 }
  41
  42 1;
  43
  44 __END__
  45
  46 #-----------------------------------------------------------------------------
  47
  48 =pod
  49
  50 =head1 NAME
  51
  52 Perl::Critic::Policy::ControlStructures::ProhibitUntilBlocks - Write C<while(! $condition)> instead of C<until($condition)>.
  53
  54 =head1 AFFILIATION
  55
  56 This Policy is part of the core L<Perl::Critic> distribution.
  57
  58
  59 =head1 DESCRIPTION
  60
  61 Conway discourages using C<until> because it leads to double-negatives
  62 that are hard to understand.  Instead, reverse the logic and use C<while>.
  63
  64   until($condition)     { do_something() } #not ok
  65   until(! $no_flag)     { do_something() } #really bad
  66   while( ! $condition)  { do_something() } #ok
  67
  68 This Policy only covers the block-form of C<until>.  For the postfix
  69 variety, see C<ProhibitPostfixControls>.
  70
  71
  72 =head1 CONFIGURATION
  73
  74 This Policy is not configurable except for the standard options.
  75
  76
  77 =head1 SEE ALSO
  78
  79 L<Perl::Critic::Policy::ControlStructures::ProhibitPostfixControls>
  80
  81 =head1 AUTHOR
  82
  83 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  88
  89 This program is free software; you can redistribute it and/or modify
  90 it under the same terms as Perl itself.  The full text of this license
  91 can be found in the LICENSE file included with this module.
  92
  93 =cut
  94
  95 # Local Variables:
  96 #   mode: cperl
  97 #   cperl-indent-level: 4
  98 #   fill-column: 78
  99 #   indent-tabs-mode: nil
 100 #   c-indentation-style: bsd
 101 # End:
 102 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :