blib/lib/Perl/Critic/Policy/TestingAndDebugging/RequireUseWarnings.pm

filter: Statementstmt 100% 71 / 71 Branchbran 76.4% 26 / 34 Conditioncond 44.4% 4 / 9 MC/DCmcdc 40.0% 2 / 5 Subroutinesub 100% 18 / 18 Podpod 83.3% 5 / 6 totaltotal 88.1% 126 / 143 CC 22 SCAR 17.9
CC
22
Cov
89%
violates
12.2
__ANON__
8.3
_find_isnt_include_or_package
3.0
CRAP 6.0
« blib/lib/Perl/Critic/PolicyParameter/Behavior/Integer.pm ↑ Summary blib/lib/Perl/Critic/Policy/RegularExpressions/RequireExtendedFormatting.pm »
1 package Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings;
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 version ();
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 40 ▶use Perl::Critic::Utils qw{ :severities $EMPTY };
Subroutine BEGIN: called CC=1 SCAR=0.0
11 40 ▶use Perl::Critic::Utils::Constants qw{ :equivalent_modules };
Subroutine BEGIN: called CC=1 SCAR=0.0
12 40 ▶use parent 'Perl::Critic::Policy';
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 40 our $VERSION = '1.150';
15  
16 #-----------------------------------------------------------------------------
17  
18 40 Readonly::Scalar my $DESC => q{Code before warnings are enabled};
19 40 Readonly::Scalar my $EXPL => [431];
20  
21 40 Readonly::Scalar my $MINIMUM_VERSION => version->new(5.006);
22 40 Readonly::Scalar my $PERL_VERSION_WHICH_IMPLIES_WARNINGS => version->new(5.036);
23  
24 #-----------------------------------------------------------------------------
25  
26 sub supported_parameters {
27 return (
28 {
29 91 ▶ name => 'equivalent_modules',
Subroutine supported_parameters: called CC=1 SCAR=0.0
Pod undocumented
30 description =>
31 q<The additional modules to treat as equivalent to "warnings".>,
32 default_string => $EMPTY,
33 behavior => 'string list',
34 list_always_present_values => ['warnings', @WARNINGS_EQUIVALENT_MODULES],
35 },
36 );
37 }
38  
39 83 ▶sub default_severity { return $SEVERITY_HIGH }
Subroutine default_severity: called CC=1 SCAR=0.0
Pod documented
40 92 ▶sub default_themes { return qw( core pbp bugs certrule ) }
Subroutine default_themes: called CC=1 SCAR=0.0
Pod documented
41 33 ▶sub applies_to { return 'PPI::Document' }
Subroutine applies_to: called CC=1 SCAR=0.0
Pod documented
42  
43 37 ▶sub default_maximum_violations_per_document { return 1; }
Subroutine default_maximum_violations_per_document: called CC=1 SCAR=0.0
Pod documented
44  
45 #-----------------------------------------------------------------------------
46  
47 sub violates {
48 33 ▶ my ( $self, undef, $document ) = @_;
Subroutine violates: called CC=11 SCAR=25.0
Pod documented
49  
50 33 my $version = $document->highest_explicit_perl_version();
51 33 ▶ return if $version and ($version < $MINIMUM_VERSION or $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS);
Branch: 1 branch
BranchTrueFalseTotal
if $version and $version < $MINIMUM_VERSION || $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS 0 33 33
Condition16%1/6
$version and $version < $MINIMUM_VERSION || $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS
!ll&&!rl&&r
3300
$version < $MINIMUM_VERSION or $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS
l!l&&r!l&&!r
000
MC/DC0%0/3
$version and $version < $MINIMUM_VERSION || $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS
$version $version < $MINIMUM_VERSION $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS
Truth table25%1/4
A and B or C
A= $versionB= $version < $MINIMUM_VERSIONC= $version >= $PERL_VERSION_WHICH_IMPLIES_WARNINGS
ABCresult
0XX0
1000
11X1
1011
52  
53 # Find the first 'use warnings' statement
54 33 my $warn_stmnt = $document->find_first( $self->_generate_is_use_warnings() );
55 33 ▶ my $warn_line = $warn_stmnt ? $warn_stmnt->location()->[0] : undef;
Branch: 1 branch
BranchTrueFalseTotal
$warn_stmnt ? : 29 4 33
56  
57 # Find all statements that aren't 'use', 'require', or 'package'
58 33 my $stmnts_ref = $self->_find_isnt_include_or_package($document);
59 33 ▶ return if !$stmnts_ref;
Branch: 1 branch
BranchTrueFalseTotal
unless $stmnts_ref 2 31 33
60  
61 # If the 'use warnings' statement is not defined, or the other
62 # statement appears before the 'use warnings', then it violates.
63  
64 31 my @viols;
65 31 for my $stmnt ( @{ $stmnts_ref } ) {
66 205 ▶ last if $stmnt->isa('PPI::Statement::End');
Branch: 1 branch
BranchTrueFalseTotal
if $stmnt->isa("PPI::Statement::End") 0 205 205
67 205 ▶ last if $stmnt->isa('PPI::Statement::Data');
Branch: 1 branch
BranchTrueFalseTotal
if $stmnt->isa("PPI::Statement::Data") 0 205 205
68  
69 205 my $stmnt_line = $stmnt->location()->[0];
70 205 ▶ if ( (! defined $warn_line) || ($stmnt_line < $warn_line) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $warn_line or $stmnt_line < $warn_line) 8 197 205
Condition100%3/3
not defined $warn_line or $stmnt_line < $warn_line
l!l&&r!l&&!r
62197
MC/DC100%2/2
not defined $warn_line or $stmnt_line < $warn_line
not defined $warn_line $stmnt_line < $warn_line
Truth table100%3/3
not(A) or B
A= not defined $warn_lineB= $stmnt_line < $warn_line
ABresult
1X1
011
000
71 8 push @viols, $self->violation( $DESC, $EXPL, $stmnt );
72 }
73 }
74 31 return @viols;
75 }
76  
77 #-----------------------------------------------------------------------------
78  
79 sub _generate_is_use_warnings {
80 33 ▶ my ($self) = @_;
Subroutine _generate_is_use_warnings: called CC=1 SCAR=0.0
81  
82 return sub {
83 479 ▶ my (undef, $elem) = @_;
Subroutine __ANON__: called CC=8 SCAR=21.2
84  
85 479 ▶ return 0 if !$elem->isa('PPI::Statement::Include');
Branch: 1 branch
BranchTrueFalseTotal
unless $elem->isa("PPI::Statement::Include") 420 59 479
86 59 ▶ return 0 if $elem->type() ne 'use';
Branch: 1 branch
BranchTrueFalseTotal
if $elem->type ne "use" 0 59 59
87  
88 # We only want file-scoped pragmas
89 59 my $parent = $elem->parent();
90 59 ▶ return 0 if !$parent->isa('PPI::Document');
Branch: 1 branch
BranchTrueFalseTotal
unless $parent->isa("PPI::Document") 0 59 59
91  
92 59 ▶ if ( my $pragma = $elem->pragma() ) {
Branch: 2 branches
BranchTrueFalseTotal
if (my $pragma = $elem->pragma) { } 58 1 59
elsif (my $module = $elem->module) { } 1 0 1
93 58 ▶ return 1 if $self->{_equivalent_modules}{$pragma};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_equivalent_modules"}{$pragma} 29 29 58
94 }
95 elsif ( my $module = $elem->module() ) {
96 1 ▶ return 1 if $self->{_equivalent_modules}{$module};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_equivalent_modules"}{$module} 0 1 1
97 }
98  
99 30 return 0;
100 33 };
101 }
102  
103 #-----------------------------------------------------------------------------
104 # Here, we're using the fact that Perl::Critic::Document::find() is optimized
105 # to search for elements based on their type. This is faster than using the
106 # native PPI::Node::find() method with a custom callback function.
107  
108 sub _find_isnt_include_or_package {
109 33 ▶ my ($self, $doc) = @_;
Subroutine _find_isnt_include_or_package: called CC=3 SCAR=11.0
110 33 ▶ my $all_statements = $doc->find('PPI::Statement') or return;
Branch: 1 branch
BranchTrueFalseTotal
my $all_statements = $doc->find("PPI::Statement") or return 2 31 33
111 31 my @wanted_statements = grep { _statement_isnt_include_or_package($_) } @{$all_statements};
112 31 ▶ return @wanted_statements ? \@wanted_statements : ();
Branch: 1 branch
BranchTrueFalseTotal
@wanted_statements ? : 31 0 31
113 }
114  
115 #-----------------------------------------------------------------------------
116  
117 sub _statement_isnt_include_or_package {
118 296 ▶ my ($elem) = @_;
Subroutine _statement_isnt_include_or_package: called CC=3 SCAR=11.0
119 296 ▶ return 0 if $elem->isa('PPI::Statement::Package');
Branch: 1 branch
BranchTrueFalseTotal
if $elem->isa("PPI::Statement::Package") 30 266 296
120 266 ▶ return 0 if $elem->isa('PPI::Statement::Include');
Branch: 1 branch
BranchTrueFalseTotal
if $elem->isa("PPI::Statement::Include") 61 205 266
121 205 return 1;
122 }
123  
124 40 1;
125  
126 __END__
127  
128 #-----------------------------------------------------------------------------
129  
130 =pod
131  
132 =head1 NAME
133  
134 Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings - Always C<use warnings>.
135  
136  
137 =head1 AFFILIATION
138  
139 This Policy is part of the core L<Perl::Critic|Perl::Critic>
140 distribution.
141  
142  
143 =head1 DESCRIPTION
144  
145 Using warnings, and paying attention to what they say, is probably the
146 single most effective way to improve the quality of your code. This
147 policy requires that the C<'use warnings'> statement must come before
148 any other statements except C<package>, C<require>, and other C<use>
149 statements. Thus, all the code in the entire package will be
150 affected.
151  
152 There are special exemptions for L<Moose|Moose>,
153 L<Moose::Role|Moose::Role>, and
154 L<Moose::Util::TypeConstraints|Moose::Util::TypeConstraints> because
155 they enforces warnings; e.g. C<'use Moose'> is treated as
156 equivalent to C<'use warnings'>.
157  
158 This policy will not complain if the file explicitly states that it is
159 compatible with a version of perl prior to 5.6 via an include
160 statement, e.g. by having C<require 5.005> in it.
161  
162 The maximum number of violations per document for this policy defaults
163 to 1.
164  
165  
166 =head1 CONFIGURATION
167  
168 If you make use of things like
169 L<Moose::Exporter|Moose::Exporter>, you can create your own modules
170 that import the L<warnings|warnings> pragma into the code that is
171 C<use>ing them. There is an option to add to the default set of
172 pragmata and modules in your F<.perlcriticrc>: C<equivalent_modules>.
173  
174 [TestingAndDebugging::RequireUseWarnings]
175 equivalent_modules = MooseX::My::Sugar
176  
177  
178 =head1 BUGS
179  
180 Needs to check for -w on the shebang line.
181  
182  
183 =head1 SEE ALSO
184  
185 L<Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings|Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings>
186  
187  
188 =head1 AUTHOR
189  
190 Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
191  
192  
193 =head1 COPYRIGHT
194  
195 Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.
196  
197 This program is free software; you can redistribute it and/or modify
198 it under the same terms as Perl itself. The full text of this license
199 can be found in the LICENSE file included with this module
200  
201 =cut
202  
203 ##############################################################################
204 # Local Variables:
205 # mode: cperl
206 # cperl-indent-level: 4
207 # fill-column: 78
208 # indent-tabs-mode: nil
209 # c-indentation-style: bsd
210 # End:
211 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
« blib/lib/Perl/Critic/PolicyParameter/Behavior/Integer.pm ↑ Summary blib/lib/Perl/Critic/Policy/RegularExpressions/RequireExtendedFormatting.pm »