git.maemo.org Git - dh-make-perl/blob - dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Policy/Variables/ProtectPrivateVars.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Policy/Variables/ProtectPrivateVars.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::Variables::ProtectPrivateVars;
   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{Private variable used};
  23 Readonly::Scalar my $EXPL => q{Use published APIs};
  24
  25 #-----------------------------------------------------------------------------
  26
  27 sub supported_parameters { return ()                   }
  28 sub default_severity     { return $SEVERITY_MEDIUM     }
  29 sub default_themes       { return qw(core maintenance) }
  30 sub applies_to           { return 'PPI::Token::Symbol' }
  31
  32 #-----------------------------------------------------------------------------
  33
  34 sub violates {
  35     my ( $self, $elem, undef ) = @_;
  36
  37     if ( $elem =~ m{ \w::_\w+ \z }xms ) {
  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::Variables::ProtectPrivateVars - Prevent access to private vars in other packages.
  54
  55 =head1 AFFILIATION
  56
  57 This Policy is part of the core L<Perl::Critic> distribution.
  58
  59
  60 =head1 DESCRIPTION
  61
  62 By convention Perl authors (like authors in many other languages)
  63 indicate private methods and variables by inserting a leading
  64 underscore before the identifier.  This policy catches attempts to
  65 access private variables from outside the package itself.
  66
  67
  68 =head1 CONFIGURATION
  69
  70 This Policy is not configurable except for the standard options.
  71
  72
  73 =head1 HISTORY
  74
  75 This policy is inspired by a similar test in L<B::Lint>
  76
  77 =head1 SEE ALSO
  78
  79 L<Perl::Critic::Policy::Subroutines::ProtectPrivateSubs>
  80
  81 =head1 AUTHOR
  82
  83 Chris Dolan <cdolan@cpan.org>
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright (c) 2006-2008 Chris Dolan.  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 :