4 use warnings FATAL => 'all';
7 *_PERL_LT_5_8_4 = ($] < 5.008004) ? sub(){1} : sub(){0};
10 our $VERSION = '2.000000';
11 $VERSION = eval $VERSION;
13 our @WARNING_CATEGORIES = grep { exists $warnings::Offsets{$_} } qw(
18 experimental::autoderef
19 experimental::const_attr
20 experimental::lexical_subs
21 experimental::lexical_topic
22 experimental::postderef
23 experimental::re_strict
24 experimental::refaliasing
25 experimental::regex_sets
26 experimental::signatures
27 experimental::smartmatch
28 experimental::win32_perlio
87 if (defined $_[1] && eval { $_[0]->UNIVERSAL::VERSION($_[1]); 1}) {
89 unless _PERL_LT_5_8_4;
90 $^H{strictures_enable} = int $_[1];
92 goto &UNIVERSAL::VERSION;
95 our %extra_load_states;
101 my %opts = ref $_[0] ? %{$_[0]} : @_;
102 if (!exists $opts{version}) {
104 = exists $^H{strictures_enable} ? delete $^H{strictures_enable}
107 $opts{file} = (caller)[1];
108 $class->_enable(\%opts);
112 my ($class, $opts) = @_;
113 my $version = $opts->{version};
115 if !defined $version;
116 my $method = "_enable_$version";
117 if (!$class->can($method)) {
119 Carp::croak("Major version specified as $version - not supported!");
121 $class->$method($opts);
125 my ($class, $opts) = @_;
127 warnings->import(FATAL => 'all');
129 if (_want_extra($opts->{file})) {
130 _load_extras(qw(indirect multidimensional bareword::filehandles));
131 indirect->unimport(':fatal')
132 if $extra_load_states{indirect};
133 multidimensional->unimport
134 if $extra_load_states{multidimensional};
135 bareword::filehandles->unimport
136 if $extra_load_states{'bareword::filehandles'};
140 our @V2_NONFATAL = grep { exists $warnings::Offsets{$_} } (
141 'exec', # not safe to catch
142 'recursion', # will be caught by other mechanisms
143 'internal', # not safe to catch
144 'malloc', # not safe to catch
145 'newline', # stat on nonexistent file with a newline in it
146 'experimental', # no reason for these to be fatal
147 'deprecated', # unfortunately can't make these fatal
148 'portable', # everything worked fine here, just may not elsewhere
150 our @V2_DISABLE = grep { exists $warnings::Offsets{$_} } (
151 'once' # triggers inconsistently, can't be fatalized
155 my ($class, $opts) = @_;
158 warnings->import(FATAL => @WARNING_CATEGORIES);
159 warnings->unimport(FATAL => @V2_NONFATAL);
160 warnings->import(@V2_NONFATAL);
161 warnings->unimport(@V2_DISABLE);
163 if (_want_extra($opts->{file})) {
164 _load_extras(qw(indirect multidimensional bareword::filehandles));
165 indirect->unimport(':fatal')
166 if $extra_load_states{indirect};
167 multidimensional->unimport
168 if $extra_load_states{multidimensional};
169 bareword::filehandles->unimport
170 if $extra_load_states{'bareword::filehandles'};
174 sub _want_extra_env {
175 if (exists $ENV{PERL_STRICTURES_EXTRA}) {
176 if (_PERL_LT_5_8_4 and $ENV{PERL_STRICTURES_EXTRA}) {
177 die 'PERL_STRICTURES_EXTRA checks are not available on perls older'
178 . "than 5.8.4: please unset \$ENV{PERL_STRICTURES_EXTRA}\n";
180 return $ENV{PERL_STRICTURES_EXTRA} ? 1 : 0;
187 my $want_env = _want_extra_env();
189 if defined $want_env;
192 and $file =~ /^(?:t|xt|lib|blib)[\\\/]/
193 and defined $Smells_Like_VCS ? $Smells_Like_VCS
194 : ( $Smells_Like_VCS = !!(
195 -e '.git' || -e '.svn' || -e '.hg'
196 || (-e '../../dist.ini'
197 && (-e '../../.git' || -e '../../.svn' || -e '../../.hg' ))
205 foreach my $mod (@extras) {
207 if exists $extra_load_states{$mod};
209 $extra_load_states{$mod} = eval "require $mod; 1;" or do {
212 #work around 5.8 require bug
213 (my $file = $mod) =~ s|::|/|g;
214 delete $INC{"${file}.pm"};
219 my $failed = join ' ', @failed;
220 my $extras = join ' ', @extras;
222 strictures.pm extra testing active but couldn't load all modules. Missing were:
226 Extra testing is auto-enabled in checkouts only, so if you're the author
227 of a strictures-using module you need to run:
231 but these modules are not required by your users.
241 strictures - turn on strict and make all warnings fatal
250 use warnings FATAL => 'all';
251 use warnings NONFATAL => qw(
263 except when called from a file which matches:
265 (caller)[1] =~ /^(?:t|xt|lib|blib)[\\\/]/
267 and when either C<.git>, C<.svn>, or C<.hg> is present in the current directory
268 (with the intention of only forcing extra tests on the author side) -- or when
269 C<.git>, C<.svn>, or C<.hg> is present two directories up along with
270 C<dist.ini> (which would indicate we are in a C<dzil test> operation, via
271 L<Dist::Zilla>) -- or when the C<PERL_STRICTURES_EXTRA> environment variable is
272 set, in which case it also does the equivalent of
276 no bareword::filehandles;
278 Note that C<PERL_STRICTURES_EXTRA> may at some point add even more tests, with
279 only a minor version increase, but any changes to the effect of C<use
280 strictures> in normal mode will involve a major version bump.
282 If any of the extra testing modules are not present, L<strictures> will
283 complain loudly, once, via C<warn()>, and then shut up. But you really
284 should consider installing them, they're all great anti-footgun tools.
288 I've been writing the equivalent of this module at the top of my code for
289 about a year now. I figured it was time to make it shorter.
291 Things like the importer in C<use Moose> don't help me because they turn
292 warnings on but don't make them fatal -- which from my point of view is
293 useless because I want an exception to tell me my code isn't warnings-clean.
295 Any time I see a warning from my code, that indicates a mistake.
297 Any time my code encounters a mistake, I want a crash -- not spew to STDERR
298 and then unknown (and probably undesired) subsequent behaviour.
300 I also want to ensure that obvious coding mistakes, like indirect object
301 syntax (and not so obvious mistakes that cause things to accidentally compile
302 as such) get caught, but not at the cost of an XS dependency and not at the
303 cost of blowing things up on another machine.
305 Therefore, L<strictures> turns on additional checking, but only when it thinks
306 it's running in a test file in a VCS checkout -- although if this causes
307 undesired behaviour this can be overridden by setting the
308 C<PERL_STRICTURES_EXTRA> environment variable.
310 If additional useful author side checks come to mind, I'll add them to the
311 C<PERL_STRICTURES_EXTRA> code path only -- this will result in a minor version
312 increase (e.g. 1.000000 to 1.001000 (1.1.0) or similar). Any fixes only to the
313 mechanism of this code will result in a sub-version increase (e.g. 1.000000 to
318 Depending on the version of strictures requested, different warnings will be
319 enabled. If no specific version is requested, the current version's behavior
320 will be used. Versions can be requested using perl's standard mechanism:
324 Or, by passing in a C<version> option:
326 use strictures version => 2;
333 use warnings FATAL => 'all';
334 use warnings NONFATAL => qw(
346 # and if in dev mode:
349 no bareword::filehandles;
351 Additionally, any warnings created by modules using L<warnings::register> or
352 C<warnings::register_categories()> will not be fatalized.
359 use warnings FATAL => 'all';
360 # and if in dev mode:
363 no bareword::filehandles;
369 This method does the setup work described above in L</DESCRIPTION>. Optionally
370 accepts a C<version> option to request a specific version's behavior.
374 This method traps the C<< strictures->VERSION(1) >> call produced by a use line
375 with a version number on it and does the version check.
377 =head1 EXTRA TESTING RATIONALE
379 Every so often, somebody complains that they're deploying via C<git pull>
380 and that they don't want L<strictures> to enable itself in this case -- and that
381 setting C<PERL_STRICTURES_EXTRA> to 0 isn't acceptable (additional ways to
382 disable extra testing would be welcome but the discussion never seems to get
385 In order to allow us to skip a couple of stages and get straight to a
386 productive conversation, here's my current rationale for turning the
387 extra testing on via a heuristic:
389 The extra testing is all stuff that only ever blows up at compile time;
390 this is intentional. So the oft-raised concern that it's different code being
391 tested is only sort of the case -- none of the modules involved affect the
392 final optree to my knowledge, so the author gets some additional compile
393 time crashes which he/she then fixes, and the rest of the testing is
394 completely valid for all environments.
396 The point of the extra testing -- especially C<no indirect> -- is to catch
397 mistakes that newbie users won't even realise are mistakes without
402 where foo is an & prototyped sub that you forgot to import -- this is
403 pernicious to track down since all I<seems> fine until it gets called
404 and you get a crash. Worse still, you can fail to have imported it due
405 to a circular require, at which point you have a load order dependent
406 bug which I've seen before now I<only> show up in production due to tiny
407 differences between the production and the development environment. I wrote
408 L<http://shadow.cat/blog/matt-s-trout/indirect-but-still-fatal/> to explain
409 this particular problem before L<strictures> itself existed.
411 As such, in my experience so far L<strictures>' extra testing has
412 I<avoided> production versus development differences, not caused them.
414 Additionally, L<strictures>' policy is very much "try and provide as much
415 protection as possible for newbies -- who won't think about whether there's
416 an option to turn on or not" -- so having only the environment variable
417 is not sufficient to achieve that (I get to explain that you need to add
418 C<use strict> at least once a week on freenode #perl -- newbies sometimes
419 completely skip steps because they don't understand that that step
422 I make no claims that the heuristic is perfect -- it's already been evolved
423 significantly over time, especially for 1.004 where we changed things to
424 ensure it only fires on files in your checkout (rather than L<strictures>-using
425 modules you happened to have installed, which was just silly). However, I
426 hope the above clarifies why a heuristic approach is not only necessary but
427 desirable from a point of view of providing new users with as much safety as
428 possible, and will allow any future discussion on the subject to focus on "how
429 do we minimise annoyance to people deploying from checkouts intentionally".
445 L<bareword::filehandles>
449 =head1 COMMUNITY AND SUPPORT
453 irc.perl.org #toolchain
455 (or bug 'mst' in query on there or freenode)
457 =head2 Git repository
459 Gitweb is on http://git.shadowcat.co.uk/ and the clone URL is:
461 git clone git://git.shadowcat.co.uk/p5sagit/strictures.git
463 The web interface to the repository is at:
465 http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/strictures.git
469 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
473 Karen Etheridge (cpan:ETHER) <ether@cpan.org>
475 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@gmail.com>
477 haarg - Graham Knop (cpan:HAARG) <haarg@haarg.org>
481 Copyright (c) 2010 the strictures L</AUTHOR> and L</CONTRIBUTORS>
486 This library is free software and may be distributed under the same terms