blib/lib/Perl/Critic/Policy/InputOutput/RequireCheckedSyscalls.pm

filter: Statementstmt 90.0% 45 / 50 Branchbran 42.8% 6 / 14 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 12 / 12 Podpod 83.3% 5 / 6 totaltotal 82.9% 68 / 82 CC 10 SCAR 14.8
CC
10
Cov
80%
violates
9.2
initialize_if_enabled
5.5
BEGIN
1.0
CRAP 4.4
« blib/lib/Perl/Critic/Policy/Subroutines/ProhibitNestedSubs.pm ↑ Summary blib/lib/Perl/Critic/Policy/CodeLayout/ProhibitHardTabs.pm »
1 package Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls;
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{ :booleans :characters :severities :classification
9 40 ▶ hashify is_perl_bareword };
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
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{Return value of flagged function ignored};
18 40 Readonly::Scalar my $EXPL => [208, 278];
19  
20 40 Readonly::Array my @DEFAULT_FUNCTIONS => qw(
21 open close print say
22 );
23 # I created this list by searching for "return" in perlfunc
24 40 Readonly::Array my @BUILTIN_FUNCTIONS => qw(
25 accept bind binmode chdir chmod chown close closedir connect
26 dbmclose dbmopen exec fcntl flock fork ioctl kill link listen
27 mkdir msgctl msgget msgrcv msgsnd open opendir pipe print read
28 readdir readline readlink readpipe recv rename rmdir say seek seekdir
29 semctl semget semop send setpgrp setpriority setsockopt shmctl
30 shmget shmread shutdown sleep socket socketpair symlink syscall
31 sysopen sysread sysseek system syswrite tell telldir truncate
32 umask unlink utime wait waitpid
33 );
34  
35 #-----------------------------------------------------------------------------
36  
37 sub supported_parameters {
38 return (
39 {
40 93 ▶ name => 'functions',
Subroutine supported_parameters: called CC=1 SCAR=0.0
Pod undocumented
41 description =>
42 'The set of functions to require checking the return value of.',
43 default_string => join( $SPACE, @DEFAULT_FUNCTIONS ),
44 behavior => 'string list',
45 },
46 {
47 name => 'exclude_functions',
48 description =>
49 'The set of functions to not require checking the return value of.',
50 default_string => $EMPTY,
51 behavior => 'string list',
52 },
53 {
54 name => 'autodie_modules',
55 description => 'Modules which export autodie.',
56 default_string => 'autodie',
57 behavior => 'string list',
58 },
59 );
60 }
61  
62 78 ▶sub default_severity { return $SEVERITY_LOWEST }
Subroutine default_severity: called CC=1 SCAR=0.0
Pod documented
63 74 ▶sub default_themes { return qw( core maintenance certrule ) }
Subroutine default_themes: called CC=1 SCAR=0.0
Pod documented
64 31 ▶sub applies_to { return 'PPI::Token::Word' }
Subroutine applies_to: called CC=1 SCAR=0.0
Pod documented
65  
66 #-----------------------------------------------------------------------------
67  
68 sub initialize_if_enabled {
69 50 ▶ my ($self, $config) = @_;
Subroutine initialize_if_enabled: called CC=5 SCAR=17.0
Pod documented
70  
71 50 my @specified_functions = keys %{ $self->{_functions} };
72 50 my @resulting_functions;
73  
74 50 foreach my $function (@specified_functions) {
75 200 ▶ if ( $function eq ':defaults' ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($function eq ':defaults') { } 0 200 200
elsif ($function eq ':builtins') { } 0 200 200
76 0 push @resulting_functions, @DEFAULT_FUNCTIONS;
77 }
78 elsif ( $function eq ':builtins' ) {
79 0 push @resulting_functions, @BUILTIN_FUNCTIONS;
80 }
81 else {
82 200 push @resulting_functions, $function;
83 }
84 }
85  
86 50 my %functions = hashify(@resulting_functions);
87  
88 50 foreach my $function ( keys %{ $self->{_exclude_functions} } ) {
89 0 delete $functions{$function};
90 }
91  
92 50 $self->{_functions} = \%functions;
93  
94 50 return $TRUE;
95 }
96  
97 #-----------------------------------------------------------------------------
98  
99 sub violates {
100 332 ▶ my ( $self, $elem, undef ) = @_;
Subroutine violates: called CC=6 SCAR=22.1
Pod documented
101  
102 332 ▶ if ( $self->{_functions}->{':all'} ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($self->{'_functions'}{':all'}) { } 0 332 332
elsif (not $self->{'_functions'}{$elem->content}) { } 329 3 332
103 0 ▶ return if is_perl_bareword($elem);
Branch: 1 branch
BranchTrueFalseTotal
if is_perl_bareword($elem) 0 0 0
104 0 ▶ return if $self->{_exclude_functions}->{ $elem->content() };
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_exclude_functions"}{$elem->content} 0 0 0
105 }
106 elsif ( not $self->{_functions}->{ $elem->content() } ) {
107 329 return;
108 }
109  
110 3 ▶ return if ! is_unchecked_call( $elem, [ keys %{ $self->{_autodie_modules} } ] );
Branch: 1 branch
BranchTrueFalseTotal
unless is_unchecked_call($elem, [keys %{$$self{"_autodie_modules"};}]) 0 3 3
111  
112 3 return $self->violation( "$DESC - " . $elem->content(), $EXPL, $elem );
113 }
114  
115  
116 40 1;
117  
118 __END__
119  
120 #-----------------------------------------------------------------------------
121  
122 =pod
123  
124 =for stopwords nyah autodie builtins
125  
126 =head1 NAME
127  
128 Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls - Return value of flagged function ignored.
129  
130 =head1 AFFILIATION
131  
132 This Policy is part of the core L<Perl::Critic|Perl::Critic>
133 distribution.
134  
135  
136 =head1 DESCRIPTION
137  
138 This performs identically to InputOutput::RequireCheckedOpen/Close
139 except that this is configurable to apply to any function, whether
140 core or user-defined.
141  
142 If your module uses L<Fatal|Fatal>,
143 L<Fatal::Exception|Fatal::Exception>, or L<autodie|autodie> then any functions
144 wrapped by those modules will not trigger this policy. For example:
145  
146 use Fatal qw(open);
147 open my $fh, $filename; # no violation
148 close $fh; # yes violation
149  
150 use autodie;
151 open $filehandle, $mode, $filename; # no violation
152  
153 Currently, L<autodie|autodie> is not properly treated as a pragma; its
154 lexical effects aren't taken into account.
155  
156  
157 =head1 CONFIGURATION
158  
159 This policy watches for a configurable list of function names. By
160 default, it applies to C<open>, C<print>, C<say> and C<close>. You can
161 override this to set it to a different list of functions with the
162 C<functions> and C<exclude_functions> settings. To do this, put
163 entries in a F<.perlcriticrc> file like this:
164  
165 [InputOutput::RequireCheckedSyscalls]
166 functions = open opendir read readline readdir close closedir
167  
168 We have defined a few shortcuts for creating this list
169  
170 [InputOutput::RequireCheckedSyscalls]
171 functions = :defaults opendir readdir closedir
172  
173 [InputOutput::RequireCheckedSyscalls]
174 functions = :builtins
175  
176 [InputOutput::RequireCheckedSyscalls]
177 functions = :all
178  
179 The C<:builtins> shortcut above represents all of the builtin
180 functions that have error conditions (about 65 of them, many of them
181 rather obscure).
182  
183 You can require checking all builtins except C<print> by combining
184 the C<functions> and C<exclude_functions>:
185  
186 [InputOutput::RequireCheckedSyscalls]
187 functions = :builtins
188 exclude_functions = print
189  
190 This is a lot easier to read than the alternative.
191  
192 The C<:all> is the insane case: you must check the return value of
193 EVERY function call, even C<return> and C<exit>. Yes, this "feature"
194 is overkill and is wasting CPU cycles on your computer by just
195 existing. Nyah nyah. I shouldn't code after midnight.
196  
197 If you create a module that exports C<autodie> you can tell this policy about
198 it with the C<autodie_modules> setting:
199  
200 [InputOutput::RequireCheckedSyscalls]
201 autodie_modules = My::Thing
202  
203 =head1 CREDITS
204  
205 Initial development of this policy was supported by a grant from the
206 Perl Foundation.
207  
208 This policy module is based heavily on policies written by Andrew
209 Moore <amoore@mooresystems.com>.
210  
211  
212 =head1 AUTHOR
213  
214 Chris Dolan <cdolan@cpan.org>
215  
216  
217 =head1 COPYRIGHT
218  
219 Copyright (c) 2007-2011 Chris Dolan. Many rights reserved.
220  
221 This program is free software; you can redistribute it and/or modify
222 it under the same terms as Perl itself. The full text of this license
223 can be found in the LICENSE file included with this module.
224  
225 =cut
226  
227 ##############################################################################
228 # Local Variables:
229 # mode: cperl
230 # cperl-indent-level: 4
231 # fill-column: 78
232 # indent-tabs-mode: nil
233 # c-indentation-style: bsd
234 # End:
235 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :
« blib/lib/Perl/Critic/Policy/Subroutines/ProhibitNestedSubs.pm ↑ Summary blib/lib/Perl/Critic/Policy/CodeLayout/ProhibitHardTabs.pm »