« blib/lib/Perl/Critic/Policy/BuiltinFunctions/ProhibitUniversalIsa.pm
↑ Summary
blib/lib/Perl/Critic/ProfilePrototype.pm »
| 1 | package Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop; | ||||||||||
| 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 List::Util qw< first >; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 9 | |||||||||||
| 10 | 40 | ▶ | use Perl::Critic::Utils qw{ :severities }; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 11 | 40 | ▶ | use parent 'Perl::Critic::Policy'; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 12 | |||||||||||
| 13 | 40 | our $VERSION = '1.150'; | |||||||||
| 14 | |||||||||||
| 15 | #----------------------------------------------------------------------------- | ||||||||||
| 16 | |||||||||||
| 17 | 40 | Readonly::Scalar my $DESC => q{Readline inside "for" loop}; | |||||||||
| 18 | 40 | Readonly::Scalar my $EXPL => [ 211 ]; | |||||||||
| 19 | |||||||||||
| 20 | #----------------------------------------------------------------------------- | ||||||||||
| 21 | |||||||||||
| 22 | 90 | ▶ | sub supported_parameters { return () } | ||||||||
|
Subroutine
supported_parameters: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 23 | 75 | ▶ | sub default_severity { return $SEVERITY_HIGH } | ||||||||
|
Subroutine
default_severity: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 24 | 92 | ▶ | sub default_themes { return qw< core bugs pbp > } | ||||||||
|
Subroutine
default_themes: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 25 | 33 | ▶ | sub applies_to { return qw< PPI::Statement::Compound > } | ||||||||
|
Subroutine
applies_to: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 26 | |||||||||||
| 27 | #----------------------------------------------------------------------------- | ||||||||||
| 28 | |||||||||||
| 29 | sub violates { | ||||||||||
| 30 | 11 | ▶ | my ( $self, $elem, undef ) = @_; | ||||||||
|
Subroutine
violates: called CC=4 SCAR=14.3
Pod
documented
| |||||||||||
| 31 | |||||||||||
| 32 | 11 | ▶ | return if $elem->type() ne 'foreach'; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 33 | |||||||||||
| 34 | 6 | ▶ | my $list = first { $_->isa('PPI::Structure::List') } $elem->schildren() | ||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.2
Branch: 1 branch
| |||||||||||
| 35 | or return; | ||||||||||
| 36 | |||||||||||
| 37 | 6 | ▶ | if ( | ||||||||
|
Branch: 1 branch
| |||||||||||
| 38 | my $readline = $list->find_first('PPI::Token::QuoteLike::Readline') | ||||||||||
| 39 | ) { | ||||||||||
| 40 | 0 | return $self->violation( $DESC, $EXPL, $readline ); | |||||||||
| 41 | } | ||||||||||
| 42 | |||||||||||
| 43 | 6 | return; #ok! | |||||||||
| 44 | } | ||||||||||
| 45 | |||||||||||
| 46 | 40 | 1; | |||||||||
| 47 | |||||||||||
| 48 | __END__ | ||||||||||
| 49 | |||||||||||
| 50 | #----------------------------------------------------------------------------- | ||||||||||
| 51 | |||||||||||
| 52 | =pod | ||||||||||
| 53 | |||||||||||
| 54 | =head1 NAME | ||||||||||
| 55 | |||||||||||
| 56 | Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop - Write C<< while( $line = <> ){...} >> instead of C<< for(<>){...} >>. | ||||||||||
| 57 | |||||||||||
| 58 | =head1 AFFILIATION | ||||||||||
| 59 | |||||||||||
| 60 | This Policy is part of the core L<Perl::Critic|Perl::Critic> | ||||||||||
| 61 | distribution. | ||||||||||
| 62 | |||||||||||
| 63 | |||||||||||
| 64 | =head1 DESCRIPTION | ||||||||||
| 65 | |||||||||||
| 66 | Using the readline operator in a C<for> or C<foreach> loop is very | ||||||||||
| 67 | slow. The iteration list of the loop creates a list context, which | ||||||||||
| 68 | causes the readline operator to read the entire input stream before | ||||||||||
| 69 | iteration even starts. Instead, just use a C<while> loop, which only | ||||||||||
| 70 | reads one line at a time. | ||||||||||
| 71 | |||||||||||
| 72 | for my $line ( <$file_handle> ){ do_something($line) } #not ok | ||||||||||
| 73 | while ( my $line = <$file_handle> ){ do_something($line) } #ok | ||||||||||
| 74 | |||||||||||
| 75 | |||||||||||
| 76 | =head1 CONFIGURATION | ||||||||||
| 77 | |||||||||||
| 78 | This Policy is not configurable except for the standard options. | ||||||||||
| 79 | |||||||||||
| 80 | |||||||||||
| 81 | =head1 AUTHOR | ||||||||||
| 82 | |||||||||||
| 83 | Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> | ||||||||||
| 84 | |||||||||||
| 85 | =head1 COPYRIGHT | ||||||||||
| 86 | |||||||||||
| 87 | Copyright (c) 2005-2011 Imaginative Software Systems. 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 : | ||||||||||