blib/lib/Perl/Critic/Policy/Variables/ProtectPrivateVars.pm

filter: Statementstmt 96.5% 28 / 29 Branchbran 50.0% 1 / 2 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 11 / 11 Podpod 80.0% 4 / 5 totaltotal 93.6% 44 / 47 CC 2 SCAR 1.8
CC
2
Cov
94%
violates
2.1
BEGIN
1.0
BEGIN
1.0
CRAP 1.2
« blib/lib/Perl/Critic/Policy/Subroutines/ProhibitSubroutinePrototypes.pm ↑ Summary blib/lib/Perl/Critic/Policy/ValuesAndExpressions/ProhibitEscapedCharacters.pm »
1 package Perl::Critic::Policy::Variables::ProtectPrivateVars;
2  
3 40 ▶use 5.010001;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 40 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 40 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 40 ▶use Readonly;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 40 ▶use Perl::Critic::Utils qw{ :severities };
Subroutine BEGIN: called CC=1 SCAR=0.0
9 40 ▶use parent 'Perl::Critic::Policy';
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 40 our $VERSION = '1.150';
12  
13 #-----------------------------------------------------------------------------
14  
15 40 Readonly::Scalar my $DESC => q{Private variable used};
16 40 Readonly::Scalar my $EXPL => q{Use published APIs};
17  
18 #-----------------------------------------------------------------------------
19  
20 90 ▶sub supported_parameters { return () }
Subroutine supported_parameters: called CC=1 SCAR=0.0
Pod undocumented
21 75 ▶sub default_severity { return $SEVERITY_MEDIUM }
Subroutine default_severity: called CC=1 SCAR=0.0
Pod documented
22 74 ▶sub default_themes { return qw(core maintenance certrule ) }
Subroutine default_themes: called CC=1 SCAR=0.0
Pod documented
23 31 ▶sub applies_to { return 'PPI::Token::Symbol' }
Subroutine applies_to: called CC=1 SCAR=0.0
Pod documented
24  
25 #-----------------------------------------------------------------------------
26  
27 sub violates {
28 173 ▶ my ( $self, $elem, undef ) = @_;
Subroutine violates: called CC=2 SCAR=7.6
Pod documented
29  
30 173 ▶ if ( $elem =~ m{ \w::_\w+ \z }xms ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($elem =~ / \w::_\w+ \z /msx) 0 173 173
31 0 return $self->violation( $DESC, $EXPL, $elem );
32 }
33 173 return; #ok!
34 }
35  
36 40 1;
37  
38 __END__
39  
40 #-----------------------------------------------------------------------------
41  
42 =pod
43  
44 =head1 NAME
45  
46 Perl::Critic::Policy::Variables::ProtectPrivateVars - Prevent access to private vars in other packages.
47  
48  
49 =head1 AFFILIATION
50  
51 This Policy is part of the core L<Perl::Critic|Perl::Critic>
52 distribution.
53  
54  
55 =head1 DESCRIPTION
56  
57 By convention Perl authors (like authors in many other languages)
58 indicate private methods and variables by inserting a leading
59 underscore before the identifier. This policy catches attempts to
60 access private variables from outside the package itself.
61  
62  
63 =head1 CONFIGURATION
64  
65 This Policy is not configurable except for the standard options.
66  
67  
68 =head1 HISTORY
69  
70 This policy is inspired by a similar test in L<B::Lint|B::Lint>
71  
72  
73 =head1 SEE ALSO
74  
75 L<Perl::Critic::Policy::Subroutines::ProtectPrivateSubs|Perl::Critic::Policy::Subroutines::ProtectPrivateSubs>
76  
77  
78 =head1 AUTHOR
79  
80 Chris Dolan <cdolan@cpan.org>
81  
82  
83 =head1 COPYRIGHT
84  
85 Copyright (c) 2006-2011 Chris Dolan.
86  
87 This program is free software; you can redistribute it and/or modify
88 it under the same terms as Perl itself. The full text of this license
89 can be found in the LICENSE file included with this module.
90  
91 =cut
92  
93 # Local Variables:
94 # mode: cperl
95 # cperl-indent-level: 4
96 # fill-column: 78
97 # indent-tabs-mode: nil
98 # c-indentation-style: bsd
99 # End:
100 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
« blib/lib/Perl/Critic/Policy/Subroutines/ProhibitSubroutinePrototypes.pm ↑ Summary blib/lib/Perl/Critic/Policy/ValuesAndExpressions/ProhibitEscapedCharacters.pm »