« blib/lib/Perl/Critic/Policy/ControlStructures/ProhibitUnlessBlocks.pm
↑ Summary
blib/lib/Perl/Critic/PolicyParameter/Behavior.pm »
| 1 | package Perl::Critic::Policy::ValuesAndExpressions::ProhibitEmptyQuotes; | ||||||||||
| 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 $EMPTY_RX => qr{\A ["'] \s* ['"] \z}xms; | |||||||||
| 16 | 40 | Readonly::Scalar my $DESC => q<Quotes used with a string containing no non-whitespace characters>; | |||||||||
| 17 | 40 | Readonly::Scalar my $EXPL => [ 53 ]; | |||||||||
| 18 | |||||||||||
| 19 | #----------------------------------------------------------------------------- | ||||||||||
| 20 | |||||||||||
| 21 | 90 | ▶ | sub supported_parameters { return () } | ||||||||
|
Subroutine
supported_parameters: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 22 | 113 | ▶ | sub default_severity { return $SEVERITY_LOW } | ||||||||
|
Subroutine
default_severity: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 23 | 84 | ▶ | sub default_themes { return qw(core pbp cosmetic) } | ||||||||
|
Subroutine
default_themes: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 24 | 31 | ▶ | sub applies_to { return 'PPI::Token::Quote' } | ||||||||
|
Subroutine
applies_to: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 25 | |||||||||||
| 26 | #----------------------------------------------------------------------------- | ||||||||||
| 27 | |||||||||||
| 28 | sub violates { | ||||||||||
| 29 | 72 | ▶ | my ( $self, $elem, undef ) = @_; | ||||||||
|
Subroutine
violates: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||
| 30 | 72 | ▶ | if ( $elem =~ $EMPTY_RX ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 31 | 38 | return $self->violation( $DESC, $EXPL, $elem ); | |||||||||
| 32 | } | ||||||||||
| 33 | 34 | return; #ok! | |||||||||
| 34 | } | ||||||||||
| 35 | |||||||||||
| 36 | 40 | 1; | |||||||||
| 37 | |||||||||||
| 38 | __END__ | ||||||||||
| 39 | |||||||||||
| 40 | #----------------------------------------------------------------------------- | ||||||||||
| 41 | |||||||||||
| 42 | =pod | ||||||||||
| 43 | |||||||||||
| 44 | =head1 NAME | ||||||||||
| 45 | |||||||||||
| 46 | Perl::Critic::Policy::ValuesAndExpressions::ProhibitEmptyQuotes - Write C<q{}> instead of C<''>. | ||||||||||
| 47 | |||||||||||
| 48 | =head1 AFFILIATION | ||||||||||
| 49 | |||||||||||
| 50 | This Policy is part of the core L<Perl::Critic|Perl::Critic> | ||||||||||
| 51 | distribution. | ||||||||||
| 52 | |||||||||||
| 53 | |||||||||||
| 54 | =head1 DESCRIPTION | ||||||||||
| 55 | |||||||||||
| 56 | Don't use quotes for an empty string or any string that is pure | ||||||||||
| 57 | whitespace. Instead, use C<q{}> to improve legibility. Better still, | ||||||||||
| 58 | created named values like this. Use the C<x> operator to repeat | ||||||||||
| 59 | characters. | ||||||||||
| 60 | |||||||||||
| 61 | $message = ''; #not ok | ||||||||||
| 62 | $message = ""; #not ok | ||||||||||
| 63 | $message = " "; #not ok | ||||||||||
| 64 | |||||||||||
| 65 | $message = q{}; #better | ||||||||||
| 66 | $message = q{ } #better | ||||||||||
| 67 | |||||||||||
| 68 | $EMPTY = q{}; | ||||||||||
| 69 | $message = $EMPTY; #best | ||||||||||
| 70 | |||||||||||
| 71 | $SPACE = q{ }; | ||||||||||
| 72 | $message = $SPACE x 5; #best | ||||||||||
| 73 | |||||||||||
| 74 | |||||||||||
| 75 | =head1 CONFIGURATION | ||||||||||
| 76 | |||||||||||
| 77 | This Policy is not configurable except for the standard options. | ||||||||||
| 78 | |||||||||||
| 79 | |||||||||||
| 80 | =head1 SEE ALSO | ||||||||||
| 81 | |||||||||||
| 82 | L<Perl::Critic::Policy::ValuesAndExpressions::ProhibitNoisyStrings|Perl::Critic::Policy::ValuesAndExpressions::ProhibitNoisyStrings> | ||||||||||
| 83 | |||||||||||
| 84 | =head1 AUTHOR | ||||||||||
| 85 | |||||||||||
| 86 | Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> | ||||||||||
| 87 | |||||||||||
| 88 | =head1 COPYRIGHT | ||||||||||
| 89 | |||||||||||
| 90 | Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. | ||||||||||
| 91 | |||||||||||
| 92 | This program is free software; you can redistribute it and/or modify | ||||||||||
| 93 | it under the same terms as Perl itself. The full text of this license | ||||||||||
| 94 | can be found in the LICENSE file included with this module. | ||||||||||
| 95 | |||||||||||
| 96 | =cut | ||||||||||
| 97 | |||||||||||
| 98 | # Local Variables: | ||||||||||
| 99 | # mode: cperl | ||||||||||
| 100 | # cperl-indent-level: 4 | ||||||||||
| 101 | # fill-column: 78 | ||||||||||
| 102 | # indent-tabs-mode: nil | ||||||||||
| 103 | # c-indentation-style: bsd | ||||||||||
| 104 | # End: | ||||||||||
| 105 | # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround : | ||||||||||