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

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/NamingConventions/ProhibitMixedCaseSubs.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::NamingConventions::ProhibitMixedCaseSubs;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ :severities };
  16
  17 use base 'Perl::Critic::Policy';
  18
  19 our $VERSION = '1.088';
  20
  21 #-----------------------------------------------------------------------------
  22
  23 Readonly::Scalar my $UPPER_LOWER    => qr/ [[:upper:]] [[:lower:]] /xm;
  24 Readonly::Scalar my $LOWER_UPPER    => qr/ [[:lower:]] [[:upper:]] /xm;
  25 Readonly::Scalar my $MIXED_RX       => qr{ $UPPER_LOWER | $LOWER_UPPER }xmo;
  26 Readonly::Scalar my $DESC     => 'Mixed-case subroutine name';
  27 Readonly::Scalar my $EXPL     => [ 44 ];
  28
  29 #-----------------------------------------------------------------------------
  30
  31 sub supported_parameters { return ()                      }
  32 sub default_severity     { return $SEVERITY_LOWEST        }
  33 sub default_themes       { return qw( core pbp cosmetic ) }
  34 sub applies_to           { return 'PPI::Statement::Sub'   }
  35
  36 #-----------------------------------------------------------------------------
  37
  38 sub violates {
  39     my ( $self, $elem, undef ) = @_;
  40     (my $name = $elem->name() ) =~ s/\A.*:://mx;
  41     if ( $name =~ m/$MIXED_RX/xms ) {
  42         return $self->violation( $DESC, $EXPL, $elem );
  43     }
  44     return;    #ok!
  45 }
  46
  47 1;
  48
  49 __END__
  50
  51 #-----------------------------------------------------------------------------
  52
  53 =pod
  54
  55 =head1 NAME
  56
  57 Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseSubs - Write C<sub my_function{}> instead of C<sub MyFunction{}>.
  58
  59 =head1 AFFILIATION
  60
  61 This Policy is part of the core L<Perl::Critic> distribution.
  62
  63
  64 =head1 DESCRIPTION
  65
  66 Conway's recommended naming convention is to use lower-case words
  67 separated by underscores.  Well-recognized acronyms can be in ALL
  68 CAPS, but must be separated by underscores from other parts of the
  69 name.
  70
  71   sub foo_bar{}   #ok
  72   sub foo_BAR{}   #ok
  73   sub FOO_bar{}   #ok
  74   sub FOO_BAR{}   #ok
  75
  76   sub Some::Class::foo{}   #ok, grudgingly
  77
  78   sub FooBar {}   #not ok
  79   sub FOObar {}   #not ok
  80   sub fooBAR {}   #not ok
  81   sub fooBar {}   #not ok
  82
  83
  84 =head1 CONFIGURATION
  85
  86 This Policy is not configurable except for the standard options.
  87
  88
  89 =head1 SEE ALSO
  90
  91 L<Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseVars>
  92
  93 =head1 AUTHOR
  94
  95 Jeffrey Ryan Thalhammer <thaljef@cpan.org>
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer.  All rights reserved.
 100
 101 This program is free software; you can redistribute it and/or modify
 102 it under the same terms as Perl itself.  The full text of this license
 103 can be found in the LICENSE file included with this module.
 104
 105 =cut
 106
 107 # Local Variables:
 108 #   mode: cperl
 109 #   cperl-indent-level: 4
 110 #   fill-column: 78
 111 #   indent-tabs-mode: nil
 112 #   c-indentation-style: bsd
 113 # End:
 114 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :