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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/BuiltinFunctions/RequireBlockMap.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::BuiltinFunctions::RequireBlockMap;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ :severities :classification :ppi };
  16 use base 'Perl::Critic::Policy';
  17
  18 our $VERSION = '1.088';
  19
  20 #-----------------------------------------------------------------------------
  21
  22 Readonly::Scalar my $DESC => q{Expression form of "map"};
  23 Readonly::Scalar my $EXPL => [ 169 ];
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                  }
  28 sub default_severity     { return $SEVERITY_HIGH      }
  29 sub default_themes       { return qw( core bugs pbp ) }
  30 sub applies_to           { return 'PPI::Token::Word'  }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36
  37     return if $elem ne 'map';
  38     return if ! is_function_call($elem);
  39
  40     my $arg = first_arg($elem);
  41     return if !$arg;
  42     return if $arg->isa('PPI::Structure::Block');
  43
  44     return $self->violation( $DESC, $EXPL, $elem );
  45 }
  46
  47 1;
  48
  49 __END__
  50
  51 #-----------------------------------------------------------------------------
  52
  53 =pod
  54
  55 =head1 NAME
  56
  57 Perl::Critic::Policy::BuiltinFunctions::RequireBlockMap - Write C<map { $_ =~ /$pattern/ } @list> instead of C<map /$pattern/, @list>.
  58
  59 =head1 AFFILIATION
  60
  61 This Policy is part of the core L<Perl::Critic> distribution.
  62
  63
  64 =head1 DESCRIPTION
  65
  66 The expression forms of C<grep> and C<map> are awkward and hard to read.
  67 Use the block forms instead.
  68
  69   @matches = grep   /pattern/,   @list;        #not ok
  70   @matches = grep { /pattern/ }  @list;        #ok
  71
  72   @mapped = map   transform($_),   @list;      #not ok
  73   @mapped = map { transform($_) }  @list;      #ok
  74
  75
  76
  77 =head1 CONFIGURATION
  78
  79 This Policy is not configurable except for the standard options.
  80
  81
  82 =head1 SEE ALSO
  83
  84 L<Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval>
  85
  86 L<Perl::Critic::Policy::BuiltinFunctions::RequireBlockGrep>
  87
  88 =head1 AUTHOR
  89
  90 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  91
  92 =head1 COPYRIGHT
  93
  94 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  95
  96 This program is free software; you can redistribute it and/or modify
  97 it under the same terms as Perl itself.  The full text of this license
  98 can be found in the LICENSE file included with this module.
  99
 100 =cut
 101
 102 # Local Variables:
 103 #   mode: cperl
 104 #   cperl-indent-level: 4
 105 #   fill-column: 78
 106 #   indent-tabs-mode: nil
 107 #   c-indentation-style: bsd
 108 # End:
 109 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :