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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/BuiltinFunctions/RequireGlobFunction.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::RequireGlobFunction;
   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 $GLOB_RX => qr{ [*?] }mx;
  23 Readonly::Scalar my $DESC    => q{Glob written as <...>};
  24 Readonly::Scalar my $EXPL    => [ 167 ];
  25
  26 #-----------------------------------------------------------------------------
  27
  28 sub supported_parameters { return ()                                }
  29 sub default_severity     { return $SEVERITY_HIGHEST                 }
  30 sub default_themes       { return qw( core pbp bugs )               }
  31 sub applies_to           { return 'PPI::Token::QuoteLike::Readline' }
  32
  33 #-----------------------------------------------------------------------------
  34
  35 sub violates {
  36     my ( $self, $elem, undef ) = @_;
  37
  38     if ( $elem =~ $GLOB_RX ) {
  39         return $self->violation( $DESC, $EXPL, $elem );
  40     }
  41     return;    #ok!
  42 }
  43
  44 1;
  45
  46 __END__
  47
  48 #-----------------------------------------------------------------------------
  49
  50 =pod
  51
  52 =head1 NAME
  53
  54 Perl::Critic::Policy::BuiltinFunctions::RequireGlobFunction - Use C<glob q{*}> instead of <*>.
  55
  56 =head1 AFFILIATION
  57
  58 This Policy is part of the core L<Perl::Critic> distribution.
  59
  60
  61 =head1 DESCRIPTION
  62
  63 Conway discourages the use of the C< <..> > construct for globbing, as
  64 it is easily confused with the angle bracket file input operator.
  65 Instead, he recommends the use of the C<glob()> function as it makes
  66 it much more obvious what you're attempting to do.
  67
  68   @files = <*.pl>;              # not ok
  69   @files = glob( "*.pl" );      # ok
  70
  71
  72 =head1 CONFIGURATION
  73
  74 This Policy is not configurable except for the standard options.
  75
  76
  77 =head1 AUTHOR
  78
  79 Graham TerMarsch <graham@howlingfrog.com>
  80
  81 =head1 COPYRIGHT
  82
  83 Copyright (C) 2005-2007 Graham TerMarsch.  All rights reserved.
  84
  85 This program is free software; you can redistribute it and/or modify
  86 it under the same terms as Perl itself.
  87
  88 =cut
  89
  90 # Local Variables:
  91 #   mode: cperl
  92 #   cperl-indent-level: 4
  93 #   fill-column: 78
  94 #   indent-tabs-mode: nil
  95 #   c-indentation-style: bsd
  96 # End:
  97 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :