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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/ValuesAndExpressions/RequireQuotedHeredocTerminator.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::ValuesAndExpressions::RequireQuotedHeredocTerminator;
   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 $HEREDOC_RX => qr/ \A << \s* ["|'] .* ['|"] \z /mx;
  23 Readonly::Scalar my $DESC       => q{Heredoc terminator must be quoted};
  24 Readonly::Scalar my $EXPL       => [ 64 ];
  25
  26 #-----------------------------------------------------------------------------
  27
  28 sub supported_parameters { return ()                       }
  29 sub default_severity     { return $SEVERITY_MEDIUM         }
  30 sub default_themes       { return qw(core pbp maintenance) }
  31 sub applies_to           { return 'PPI::Token::HereDoc'    }
  32
  33 #-----------------------------------------------------------------------------
  34
  35 sub violates {
  36     my ( $self, $elem, undef ) = @_;
  37     if ( $elem !~ $HEREDOC_RX ) {
  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::ValuesAndExpressions::RequireQuotedHeredocTerminator - Write C< print <<'THE_END' > or C< print <<"THE_END" >.
  54
  55 =head1 AFFILIATION
  56
  57 This Policy is part of the core L<Perl::Critic> distribution.
  58
  59
  60 =head1 DESCRIPTION
  61
  62 Putting single or double-quotes around your HEREDOC terminator make it obvious
  63 to the reader whether the content is going to be interpolated or not.
  64
  65   print <<END_MESSAGE;    #not ok
  66   Hello World
  67   END_MESSAGE
  68
  69   print <<'END_MESSAGE';  #ok
  70   Hello World
  71   END_MESSAGE
  72
  73   print <<"END_MESSAGE";  #ok
  74   $greeting
  75   END_MESSAGE
  76
  77
  78 =head1 CONFIGURATION
  79
  80 This Policy is not configurable except for the standard options.
  81
  82
  83 =head1 SEE ALSO
  84
  85 L<Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator>
  86
  87 =head1 AUTHOR
  88
  89 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  90
  91 =head1 COPYRIGHT
  92
  93 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
  94
  95 This program is free software; you can redistribute it and/or modify
  96 it under the same terms as Perl itself.  The full text of this license
  97 can be found in the LICENSE file included with this module.
  98
  99 =cut
 100
 101 # Local Variables:
 102 #   mode: cperl
 103 #   cperl-indent-level: 4
 104 #   fill-column: 78
 105 #   indent-tabs-mode: nil
 106 #   c-indentation-style: bsd
 107 # End:
 108 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :