4 use warnings FATAL => 'all';
7 *_PERL_LT_5_8_4 = ("$]" < 5.008004) ? sub(){1} : sub(){0};
8 # goto &UNIVERSAL::VERSION usually works on 5.8, but fails on some ARM
9 # machines. Seems to always work on 5.10 though.
10 *_CAN_GOTO_VERSION = ("$]" >= 5.010000) ? sub(){1} : sub(){0};
13 our $VERSION = '2.000005';
16 our @WARNING_CATEGORIES = grep { exists $warnings::Offsets{$_} } qw(
22 experimental::alpha_assertions
23 experimental::autoderef
25 experimental::const_attr
26 experimental::declared_refs
27 experimental::lexical_subs
28 experimental::lexical_topic
29 experimental::postderef
30 experimental::re_strict
31 experimental::refaliasing
32 experimental::regex_sets
33 experimental::script_run
34 experimental::signatures
35 experimental::smartmatch
36 experimental::win32_perlio
98 if (defined $_[1] && eval { &UNIVERSAL::VERSION; 1}) {
100 unless _PERL_LT_5_8_4;
101 $^H{strictures_enable} = int $_[1];
104 _CAN_GOTO_VERSION ? goto &UNIVERSAL::VERSION : &UNIVERSAL::VERSION;
107 our %extra_load_states;
109 our $Smells_Like_VCS;
113 my %opts = @_ == 1 ? %{$_[0]} : @_;
114 if (!exists $opts{version}) {
116 = exists $^H{strictures_enable} ? delete $^H{strictures_enable}
119 $opts{file} = (caller)[1];
120 $class->_enable(\%opts);
124 my ($class, $opts) = @_;
125 my $version = $opts->{version};
127 if !defined $version;
128 my $method = "_enable_$version";
129 if (!$class->can($method)) {
131 Carp::croak("Major version specified as $version - not supported!");
133 $class->$method($opts);
137 my ($class, $opts) = @_;
139 warnings->import(FATAL => 'all');
141 if (_want_extra($opts->{file})) {
142 _load_extras(qw(indirect multidimensional bareword::filehandles));
143 indirect->unimport(':fatal')
144 if $extra_load_states{indirect};
145 multidimensional->unimport
146 if $extra_load_states{multidimensional};
147 bareword::filehandles->unimport
148 if $extra_load_states{'bareword::filehandles'};
152 our @V2_NONFATAL = grep { exists $warnings::Offsets{$_} } (
153 'exec', # not safe to catch
154 'recursion', # will be caught by other mechanisms
155 'internal', # not safe to catch
156 'malloc', # not safe to catch
157 'newline', # stat on nonexistent file with a newline in it
158 'experimental', # no reason for these to be fatal
159 'deprecated', # unfortunately can't make these fatal
160 'portable', # everything worked fine here, just may not elsewhere
162 our @V2_DISABLE = grep { exists $warnings::Offsets{$_} } (
163 'once' # triggers inconsistently, can't be fatalized
167 my ($class, $opts) = @_;
170 warnings->import(FATAL => @WARNING_CATEGORIES);
171 warnings->unimport(FATAL => @V2_NONFATAL);
172 warnings->import(@V2_NONFATAL);
173 warnings->unimport(@V2_DISABLE);
175 if (_want_extra($opts->{file})) {
176 _load_extras(qw(indirect multidimensional bareword::filehandles));
177 indirect->unimport(':fatal')
178 if $extra_load_states{indirect};
179 multidimensional->unimport
180 if $extra_load_states{multidimensional};
181 bareword::filehandles->unimport
182 if $extra_load_states{'bareword::filehandles'};
186 sub _want_extra_env {
187 if (exists $ENV{PERL_STRICTURES_EXTRA}) {
188 if (_PERL_LT_5_8_4 and $ENV{PERL_STRICTURES_EXTRA}) {
189 die 'PERL_STRICTURES_EXTRA checks are not available on perls older'
190 . "than 5.8.4: please unset \$ENV{PERL_STRICTURES_EXTRA}\n";
192 return $ENV{PERL_STRICTURES_EXTRA} ? 1 : 0;
199 my $want_env = _want_extra_env();
201 if defined $want_env;
204 and $file =~ /^(?:t|xt|lib|blib)[\\\/]/
205 and defined $Smells_Like_VCS ? $Smells_Like_VCS
206 : ( $Smells_Like_VCS = !!(
207 -e '.git' || -e '.svn' || -e '.hg' || -e '.bzr'
208 || (-e '../../dist.ini'
209 && (-e '../../.git' || -e '../../.svn' || -e '../../.hg' || -e '../../.bzr' ))
217 foreach my $mod (@extras) {
219 if exists $extra_load_states{$mod};
221 $extra_load_states{$mod} = eval "require $mod; 1;" or do {
224 #work around 5.8 require bug
225 (my $file = $mod) =~ s|::|/|g;
226 delete $INC{"${file}.pm"};
231 my $failed = join ' ', @failed;
232 my $extras = join ' ', @extras;
234 strictures.pm extra testing active but couldn't load all modules. Missing were:
238 Extra testing is auto-enabled in checkouts only, so if you're the author
239 of a strictures-using module you need to run:
243 but these modules are not required by your users.
253 strictures - Turn on strict and make most warnings fatal
262 use warnings FATAL => 'all';
263 use warnings NONFATAL => qw(
275 except when called from a file which matches:
277 (caller)[1] =~ /^(?:t|xt|lib|blib)[\\\/]/
279 and when either C<.git>, C<.svn>, C<.hg>, or C<.bzr> is present in the current
280 directory (with the intention of only forcing extra tests on the author side)
281 -- or when C<.git>, C<.svn>, C<.hg>, or C<.bzr> is present two directories up
282 along with C<dist.ini> (which would indicate we are in a C<dzil test> operation,
283 via L<Dist::Zilla>) -- or when the C<PERL_STRICTURES_EXTRA> environment variable
284 is set, in which case it also does the equivalent of
288 no bareword::filehandles;
290 Note that C<PERL_STRICTURES_EXTRA> may at some point add even more tests, with
291 only a minor version increase, but any changes to the effect of C<use
292 strictures> in normal mode will involve a major version bump.
294 If any of the extra testing modules are not present, L<strictures> will
295 complain loudly, once, via C<warn()>, and then shut up. But you really
296 should consider installing them, they're all great anti-footgun tools.
300 I've been writing the equivalent of this module at the top of my code for
301 about a year now. I figured it was time to make it shorter.
303 Things like the importer in C<use Moose> don't help me because they turn
304 warnings on but don't make them fatal -- which from my point of view is
305 useless because I want an exception to tell me my code isn't warnings-clean.
307 Any time I see a warning from my code, that indicates a mistake.
309 Any time my code encounters a mistake, I want a crash -- not spew to STDERR
310 and then unknown (and probably undesired) subsequent behaviour.
312 I also want to ensure that obvious coding mistakes, like indirect object
313 syntax (and not so obvious mistakes that cause things to accidentally compile
314 as such) get caught, but not at the cost of an XS dependency and not at the
315 cost of blowing things up on another machine.
317 Therefore, L<strictures> turns on additional checking, but only when it thinks
318 it's running in a test file in a VCS checkout -- although if this causes
319 undesired behaviour this can be overridden by setting the
320 C<PERL_STRICTURES_EXTRA> environment variable.
322 If additional useful author side checks come to mind, I'll add them to the
323 C<PERL_STRICTURES_EXTRA> code path only -- this will result in a minor version
324 increase (e.g. 1.000000 to 1.001000 (1.1.0) or similar). Any fixes only to the
325 mechanism of this code will result in a sub-version increase (e.g. 1.000000 to
328 =head1 CATEGORY SELECTIONS
330 strictures does not enable fatal warnings for all categories.
336 Includes a warning that can cause your program to continue running
337 unintentionally after an internal fork. Not safe to fatalize.
341 Infinite recursion will end up overflowing the stack eventually anyway.
345 Triggers deep within perl, in places that are not safe to trap.
349 Triggers deep within perl, in places that are not safe to trap.
353 Includes a warning for using stat on a valid but suspect filename, ending in a
358 Experimental features are used intentionally.
362 Deprecations will inherently be added to in the future in unexpected ways,
363 so making them fatal won't be reliable.
367 Doesn't indicate an actual problem with the program, only that it may not
368 behave properly if run on a different machine.
372 Can't be fatalized. Also triggers very inconsistently, so we just disable it.
378 Depending on the version of strictures requested, different warnings will be
379 enabled. If no specific version is requested, the current version's behavior
380 will be used. Versions can be requested using perl's standard mechanism:
384 Or, by passing in a C<version> option:
386 use strictures version => 2;
393 use warnings FATAL => 'all';
394 use warnings NONFATAL => qw(
406 # and if in dev mode:
409 no bareword::filehandles;
411 Additionally, any warnings created by modules using L<warnings::register> or
412 C<warnings::register_categories()> will not be fatalized.
419 use warnings FATAL => 'all';
420 # and if in dev mode:
423 no bareword::filehandles;
429 This method does the setup work described above in L</DESCRIPTION>. Optionally
430 accepts a C<version> option to request a specific version's behavior.
434 This method traps the C<< strictures->VERSION(1) >> call produced by a use line
435 with a version number on it and does the version check.
437 =head1 EXTRA TESTING RATIONALE
439 Every so often, somebody complains that they're deploying via C<git pull>
440 and that they don't want L<strictures> to enable itself in this case -- and that
441 setting C<PERL_STRICTURES_EXTRA> to 0 isn't acceptable (additional ways to
442 disable extra testing would be welcome but the discussion never seems to get
445 In order to allow us to skip a couple of stages and get straight to a
446 productive conversation, here's my current rationale for turning the
447 extra testing on via a heuristic:
449 The extra testing is all stuff that only ever blows up at compile time;
450 this is intentional. So the oft-raised concern that it's different code being
451 tested is only sort of the case -- none of the modules involved affect the
452 final optree to my knowledge, so the author gets some additional compile
453 time crashes which he/she then fixes, and the rest of the testing is
454 completely valid for all environments.
456 The point of the extra testing -- especially C<no indirect> -- is to catch
457 mistakes that newbie users won't even realise are mistakes without
462 where foo is an & prototyped sub that you forgot to import -- this is
463 pernicious to track down since all I<seems> fine until it gets called
464 and you get a crash. Worse still, you can fail to have imported it due
465 to a circular require, at which point you have a load order dependent
466 bug which I've seen before now I<only> show up in production due to tiny
467 differences between the production and the development environment. I wrote
468 L<http://shadow.cat/blog/matt-s-trout/indirect-but-still-fatal/> to explain
469 this particular problem before L<strictures> itself existed.
471 As such, in my experience so far L<strictures>' extra testing has
472 I<avoided> production versus development differences, not caused them.
474 Additionally, L<strictures>' policy is very much "try and provide as much
475 protection as possible for newbies -- who won't think about whether there's
476 an option to turn on or not" -- so having only the environment variable
477 is not sufficient to achieve that (I get to explain that you need to add
478 C<use strict> at least once a week on freenode #perl -- newbies sometimes
479 completely skip steps because they don't understand that that step
482 I make no claims that the heuristic is perfect -- it's already been evolved
483 significantly over time, especially for 1.004 where we changed things to
484 ensure it only fires on files in your checkout (rather than L<strictures>-using
485 modules you happened to have installed, which was just silly). However, I
486 hope the above clarifies why a heuristic approach is not only necessary but
487 desirable from a point of view of providing new users with as much safety as
488 possible, and will allow any future discussion on the subject to focus on "how
489 do we minimise annoyance to people deploying from checkouts intentionally".
505 L<bareword::filehandles>
509 =head1 COMMUNITY AND SUPPORT
513 irc.perl.org #toolchain
515 (or bug 'mst' in query on there or freenode)
517 =head2 Git repository
519 Gitweb is on http://git.shadowcat.co.uk/ and the clone URL is:
521 git clone git://git.shadowcat.co.uk/p5sagit/strictures.git
523 The web interface to the repository is at:
525 http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/strictures.git
529 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
533 Karen Etheridge (cpan:ETHER) <ether@cpan.org>
535 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@gmail.com>
537 haarg - Graham Knop (cpan:HAARG) <haarg@haarg.org>
541 Copyright (c) 2010 the strictures L</AUTHOR> and L</CONTRIBUTORS>
546 This library is free software and may be distributed under the same terms