File Coverage

blib/lib/Perl/Critic/Policy/BuiltinFunctions/ProhibitVoidMap.pm
Criterion Covered Total %
statement 26 26 100.0
branch 6 6 100.0
condition n/a
subroutine 11 11 100.0
pod 4 5 80.0
total 47 48 97.9


line stmt bran cond sub pod time code
1             package Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidMap;
2              
3 40     40   27188 use 5.010001;
  40         219  
4 40     40   317 use strict;
  40         116  
  40         955  
5 40     40   239 use warnings;
  40         121  
  40         1099  
6 40     40   253 use Readonly;
  40         108  
  40         2343  
7              
8 40     40   333 use Perl::Critic::Utils qw{ :severities :classification is_in_void_context };
  40         177  
  40         2265  
9 40     40   15065 use parent 'Perl::Critic::Policy';
  40         140  
  40         284  
10              
11             our $VERSION = '1.146';
12              
13             #-----------------------------------------------------------------------------
14              
15             Readonly::Scalar my $DESC => q{"map" used in void context};
16             Readonly::Scalar my $EXPL => q{Use a "for" loop instead};
17              
18             #-----------------------------------------------------------------------------
19              
20 94     94 0 2018 sub supported_parameters { return () }
21 83     83 1 336 sub default_severity { return $SEVERITY_MEDIUM }
22 74     74 1 327 sub default_themes { return qw( core maintenance ) }
23 35     35 1 120 sub applies_to { return 'PPI::Token::Word' }
24              
25             #-----------------------------------------------------------------------------
26              
27             sub violates {
28 385     385 1 809 my ( $self, $elem, undef ) = @_;
29              
30 385 100       787 return if $elem->content() ne 'map';
31 24 100       138 return if not is_function_call($elem);
32 21 100       51 return if not is_in_void_context($elem);
33              
34 9         73 return $self->violation( $DESC, $EXPL, $elem );
35             }
36              
37              
38             1;
39              
40             __END__
41              
42             #-----------------------------------------------------------------------------
43              
44             =pod
45              
46             =head1 NAME
47              
48             Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidMap - Don't use C<map> in void contexts.
49              
50              
51             =head1 AFFILIATION
52              
53             This Policy is part of the core L<Perl::Critic|Perl::Critic>
54             distribution.
55              
56              
57             =head1 DESCRIPTION
58              
59             C<map> and C<grep> are intended to be pure functions, not mutators.
60             If you want to iterate with side-effects, then you should use a proper
61             C<for> or C<foreach> loop.
62              
63             grep{ print frobulate($_) } @list; #not ok
64             print map{ frobulate($_) } @list; #ok
65              
66             grep{ $_ = lc $_ } @list; #not ok
67             for( @list ){ $_ = lc $_ }; #ok
68              
69             map{ push @frobbed, frobulate($_) } @list; #not ok
70             @frobbed = map { frobulate($_) } @list; #ok
71              
72              
73             =head1 CONFIGURATION
74              
75             This Policy is not configurable except for the standard options.
76              
77              
78             =head1 AUTHOR
79              
80             Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
81              
82              
83             =head1 COPYRIGHT
84              
85             Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.
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 :