« blib/lib/Perl/Critic/Policy/Variables/RequireInitializationForLocalVars.pm
↑ Summary
blib/lib/Perl/Critic/Policy/Documentation/RequirePodAtEnd.pm »
| 1 | package Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic; | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
| 7 | 40 | ▶ | use Readonly; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 8 | |||||||||||||||||||||
| 9 | 40 | ▶ | use List::SomeUtils qw( none ); | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 10 | |||||||||||||||||||||
| 11 | 40 | ▶ | use Perl::Critic::Utils qw{ :severities :classification }; | ||||||||||||||||||
|
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{Useless '## no critic' annotation}; | |||||||||||||||||||
| 19 | 40 | Readonly::Scalar my $EXPL => q{This annotation can be removed}; | |||||||||||||||||||
| 20 | |||||||||||||||||||||
| 21 | #----------------------------------------------------------------------------- | ||||||||||||||||||||
| 22 | |||||||||||||||||||||
| 23 | 90 | ▶ | sub supported_parameters { return () } | ||||||||||||||||||
|
Subroutine
supported_parameters: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||
| 24 | 75 | ▶ | sub default_severity { return $SEVERITY_LOW } | ||||||||||||||||||
|
Subroutine
default_severity: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||
| 25 | 74 | ▶ | sub default_themes { return qw(core maintenance) } | ||||||||||||||||||
|
Subroutine
default_themes: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||
| 26 | 2 | ▶ | sub applies_to { return 'PPI::Document' } | ||||||||||||||||||
|
Subroutine
applies_to: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||
| 27 | |||||||||||||||||||||
| 28 | #----------------------------------------------------------------------------- | ||||||||||||||||||||
| 29 | |||||||||||||||||||||
| 30 | sub violates { | ||||||||||||||||||||
| 31 | 2 | ▶ | my ( $self, undef, $doc ) = @_; | ||||||||||||||||||
|
Subroutine
violates: called CC=4 SCAR=17.2
Pod
documented
| |||||||||||||||||||||
| 32 | |||||||||||||||||||||
| 33 | # If for some reason $doc is not a P::C::Document, then all bets are off | ||||||||||||||||||||
| 34 | 2 | ▶ | return if not $doc->isa('Perl::Critic::Document'); | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 35 | |||||||||||||||||||||
| 36 | 2 | my @violations; | |||||||||||||||||||
| 37 | 2 | my @suppressed_viols = $doc->suppressed_violations(); | |||||||||||||||||||
| 38 | |||||||||||||||||||||
| 39 | 2 | for my $ann ( $doc->annotations() ) { | |||||||||||||||||||
| 40 | 0 | ▶ | if ( none { _annotation_suppresses_violation($ann, $_) } @suppressed_viols ) { | ||||||||||||||||||
|
Subroutine
__ANON__: not called CC=1 SCAR=6.9
Branch: 1 branch
| |||||||||||||||||||||
| 41 | 0 | push @violations, $self->violation($DESC, $EXPL, $ann->element()); | |||||||||||||||||||
| 42 | } | ||||||||||||||||||||
| 43 | } | ||||||||||||||||||||
| 44 | |||||||||||||||||||||
| 45 | 2 | return @violations; | |||||||||||||||||||
| 46 | } | ||||||||||||||||||||
| 47 | |||||||||||||||||||||
| 48 | #----------------------------------------------------------------------------- | ||||||||||||||||||||
| 49 | |||||||||||||||||||||
| 50 | sub _annotation_suppresses_violation { | ||||||||||||||||||||
| 51 | 0 | ▶ | my ($annotation, $violation) = @_; | ||||||||||||||||||
|
Subroutine
_annotation_suppresses_violation: not called CC=2 SCAR=17.9
| |||||||||||||||||||||
| 52 | |||||||||||||||||||||
| 53 | 0 | my $policy_name = $violation->policy(); | |||||||||||||||||||
| 54 | 0 | my $line = $violation->location()->[0]; | |||||||||||||||||||
| 55 | |||||||||||||||||||||
| 56 | 0 | ▶ | return $annotation->disables_line($line) | ||||||||||||||||||
|
Condition0%0/3
$annotation->disables_line($line) && $annotation->disables_policy($policy_name)
MC/DC0%0/2
$annotation->disables_line($line) && $annotation->disables_policy($policy_name)
$annotation->disables_line($line)
$annotation->disables_policy($policy_name)
Truth table0%0/3
A && B
A= $annotation->disables_line($line)B= $annotation->disables_policy($policy_name)
| |||||||||||||||||||||
| 57 | && $annotation->disables_policy($policy_name); | ||||||||||||||||||||
| 58 | } | ||||||||||||||||||||
| 59 | |||||||||||||||||||||
| 60 | #----------------------------------------------------------------------------- | ||||||||||||||||||||
| 61 | |||||||||||||||||||||
| 62 | 40 | 1; | |||||||||||||||||||
| 63 | |||||||||||||||||||||
| 64 | __END__ | ||||||||||||||||||||
| 65 | |||||||||||||||||||||
| 66 | =pod | ||||||||||||||||||||
| 67 | |||||||||||||||||||||
| 68 | =head1 NAME | ||||||||||||||||||||
| 69 | |||||||||||||||||||||
| 70 | Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic - Remove ineffective "## no critic" annotations. | ||||||||||||||||||||
| 71 | |||||||||||||||||||||
| 72 | |||||||||||||||||||||
| 73 | =head1 AFFILIATION | ||||||||||||||||||||
| 74 | |||||||||||||||||||||
| 75 | This Policy is part of the core L<Perl::Critic|Perl::Critic> distribution. | ||||||||||||||||||||
| 76 | |||||||||||||||||||||
| 77 | |||||||||||||||||||||
| 78 | =head1 DESCRIPTION | ||||||||||||||||||||
| 79 | |||||||||||||||||||||
| 80 | Sometimes, you may need to use a C<"## no critic"> annotation to work around | ||||||||||||||||||||
| 81 | a false-positive bug in L<Perl::Critic|Perl::Critic>. But eventually, that bug might get | ||||||||||||||||||||
| 82 | fixed, leaving your code with extra C<"## no critic"> annotations lying about. | ||||||||||||||||||||
| 83 | Or you may use them to locally disable a Policy, but then later decide to | ||||||||||||||||||||
| 84 | permanently remove that Policy entirely from your profile, making some of | ||||||||||||||||||||
| 85 | those C<"## no critic"> annotations pointless. Or, you may accidentally | ||||||||||||||||||||
| 86 | disable too many Policies at once, creating an opportunity for new | ||||||||||||||||||||
| 87 | violations to slip in unnoticed. | ||||||||||||||||||||
| 88 | |||||||||||||||||||||
| 89 | This Policy will emit violations if you have a C<"## no critic"> annotation in | ||||||||||||||||||||
| 90 | your source code that does not actually suppress any violations given your | ||||||||||||||||||||
| 91 | current profile. To resolve this, you should either remove the annotation | ||||||||||||||||||||
| 92 | entirely, or adjust the Policy name patterns in the annotation to match only | ||||||||||||||||||||
| 93 | the Policies that are actually being violated in your code. | ||||||||||||||||||||
| 94 | |||||||||||||||||||||
| 95 | |||||||||||||||||||||
| 96 | =head1 EXAMPLE | ||||||||||||||||||||
| 97 | |||||||||||||||||||||
| 98 | For example, let's say I have a regex, but I don't want to use the C</x> flag, | ||||||||||||||||||||
| 99 | which violates the C<RegularExpressions::RequireExtendedFormatting> policy. | ||||||||||||||||||||
| 100 | In the following code, the C<"## no critic"> annotation will suppress | ||||||||||||||||||||
| 101 | violations of that Policy and ALL Policies that match | ||||||||||||||||||||
| 102 | C<m/RegularExpressions/imx> | ||||||||||||||||||||
| 103 | |||||||||||||||||||||
| 104 | my $re = qr/foo bar baz/ms; ## no critic (RegularExpressions) | ||||||||||||||||||||
| 105 | |||||||||||||||||||||
| 106 | However, this creates a potential loop-hole for someone to introduce | ||||||||||||||||||||
| 107 | additional violations in the future, without explicitly acknowledging them. | ||||||||||||||||||||
| 108 | This Policy is designed to catch these situations by warning you that you've | ||||||||||||||||||||
| 109 | disabled more Policies than the situation really requires. The above code | ||||||||||||||||||||
| 110 | should be remedied like this: | ||||||||||||||||||||
| 111 | |||||||||||||||||||||
| 112 | my $re = qr/foo bar baz/ms; ## no critic (RequireExtendedFormatting) | ||||||||||||||||||||
| 113 | |||||||||||||||||||||
| 114 | Notice how the C<RequireExtendedFormatting> pattern more precisely matches | ||||||||||||||||||||
| 115 | the name of the Policy that I'm trying to suppress. | ||||||||||||||||||||
| 116 | |||||||||||||||||||||
| 117 | |||||||||||||||||||||
| 118 | =head1 NOTE | ||||||||||||||||||||
| 119 | |||||||||||||||||||||
| 120 | Changing your F<.perlcriticrc> file and disabling policies globally or running | ||||||||||||||||||||
| 121 | at a higher (i.e. less restrictive) severity level may cause this Policy to | ||||||||||||||||||||
| 122 | emit additional violations. So you might want to defer using this Policy | ||||||||||||||||||||
| 123 | until you have a fairly stable profile. | ||||||||||||||||||||
| 124 | |||||||||||||||||||||
| 125 | |||||||||||||||||||||
| 126 | =head1 CONFIGURATION | ||||||||||||||||||||
| 127 | |||||||||||||||||||||
| 128 | This Policy is not configurable except for the standard options. | ||||||||||||||||||||
| 129 | |||||||||||||||||||||
| 130 | |||||||||||||||||||||
| 131 | =head1 ACKNOWLEDGMENT | ||||||||||||||||||||
| 132 | |||||||||||||||||||||
| 133 | This Policy was inspired by Adam Kennedy's article at | ||||||||||||||||||||
| 134 | L<http://use.perl.org/article.pl?sid=08/09/24/1957256>. | ||||||||||||||||||||
| 135 | |||||||||||||||||||||
| 136 | |||||||||||||||||||||
| 137 | =head1 AUTHOR | ||||||||||||||||||||
| 138 | |||||||||||||||||||||
| 139 | Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> | ||||||||||||||||||||
| 140 | |||||||||||||||||||||
| 141 | |||||||||||||||||||||
| 142 | =head1 COPYRIGHT | ||||||||||||||||||||
| 143 | |||||||||||||||||||||
| 144 | Copyright (c) 2005-2021 Imaginative Software Systems. All rights reserved. | ||||||||||||||||||||
| 145 | |||||||||||||||||||||
| 146 | This program is free software; you can redistribute it and/or modify | ||||||||||||||||||||
| 147 | it under the same terms as Perl itself. The full text of this license | ||||||||||||||||||||
| 148 | can be found in the LICENSE file included with this module. | ||||||||||||||||||||
| 149 | |||||||||||||||||||||
| 150 | =cut | ||||||||||||||||||||
| 151 | |||||||||||||||||||||
| 152 | ############################################################################## | ||||||||||||||||||||
| 153 | # Local Variables: | ||||||||||||||||||||
| 154 | # mode: cperl | ||||||||||||||||||||
| 155 | # cperl-indent-level: 4 | ||||||||||||||||||||
| 156 | # fill-column: 78 | ||||||||||||||||||||
| 157 | # indent-tabs-mode: nil | ||||||||||||||||||||
| 158 | # c-indentation-style: bsd | ||||||||||||||||||||
| 159 | # End: | ||||||||||||||||||||
| 160 | # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround : | ||||||||||||||||||||