lib/strictures.pm

   1 package strictures;
   2
   3 use strict;
   4 use warnings FATAL => 'all';
   5
   6 use constant _PERL_LT_5_8_4 => ($] < 5.008004) ? 1 : 0;
   7
   8 our $VERSION = '1.004001'; # 1.4.1
   9
  10 sub VERSION {
  11   for ($_[1]) {
  12     last unless defined && !ref && int != 1;
  13     die "Major version specified as $_ - this is strictures version 1";
  14   }
  15   # disable this since Foo->VERSION(undef) correctly returns the version
  16   # and that can happen either if our caller passes undef explicitly or
  17   # because the for above autovivified $_[1] - I could make it stop but
  18   # it's pointless since we don't want to blow up if the caller does
  19   # something valid either.
  20   no warnings 'uninitialized';
  21   shift->SUPER::VERSION(@_);
  22 }
  23
  24 my $extras_load_warned;
  25
  26 our $Smells_Like_VCS = (-e '.git' || -e '.svn'
  27   || (-e '../../dist.ini' && (-e '../../.git' || -e '../../.svn')));
  28
  29 sub import {
  30   strict->import;
  31   warnings->import(FATAL => 'all');
  32
  33   my $extra_tests = do {
  34     if (exists $ENV{PERL_STRICTURES_EXTRA}) {
  35       if (_PERL_LT_5_8_4 and $ENV{PERL_STRICTURES_EXTRA}) {
  36         die 'PERL_STRICTURES_EXTRA checks are not available on perls older than 5.8.4: '
  37           . "please unset \$ENV{PERL_STRICTURES_EXTRA}\n";
  38       }
  39       $ENV{PERL_STRICTURES_EXTRA};
  40     } elsif (! _PERL_LT_5_8_4) {
  41       !!((caller)[1] =~ /^(?:t|xt|lib|blib)/
  42          and $Smells_Like_VCS)
  43     }
  44   };
  45   if ($extra_tests) {
  46     my @failed;
  47     if (eval { require indirect; 1 }) {
  48       indirect->unimport(':fatal');
  49     } else {
  50       push @failed, 'indirect';
  51     }
  52     if (eval { require multidimensional; 1 }) {
  53       multidimensional->unimport;
  54     } else {
  55       push @failed, 'multidimensional';
  56     }
  57     if (eval { require bareword::filehandles; 1 }) {
  58       bareword::filehandles->unimport;
  59     } else {
  60       push @failed, 'bareword::filehandles';
  61     }
  62     if (@failed and not $extras_load_warned++) {
  63       my $failed = join ' ', @failed;
  64       warn <<EOE;
  65 strictures.pm extra testing active but couldn't load all modules. Missing were:
  66
  67   $failed
  68
  69 Extra testing is auto-enabled in checkouts only, so if you're the author
  70 of a strictures using module you need to run:
  71
  72   cpan indirect multidimensional bareword::filehandles
  73
  74 but these modules are not required by your users.
  75 EOE
  76     }
  77   }
  78 }
  79
  80 1;
  81
  82 __END__
  83 =head1 NAME
  84
  85 strictures - turn on strict and make all warnings fatal
  86
  87 =head1 SYNOPSIS
  88
  89   use strictures 1;
  90
  91 is equivalent to
  92
  93   use strict;
  94   use warnings FATAL => 'all';
  95
  96 except when called from a file which matches:
  97
  98   (caller)[1] =~ /^(?:t|xt|lib|blib)/
  99
 100 and when either '.git' or '.svn' is present in the current directory (with
 101 the intention of only forcing extra tests on the author side) - or when '.git'
 102 or '.svn' is present two directories up along with 'dist.ini' (which would
 103 indicate we are in a 'dzil test' operation, via L<Dist::Zilla>) -
 104 or when the PERL_STRICTURES_EXTRA environment variable is set, in which case
 105
 106   use strictures 1;
 107
 108 is equivalent to
 109
 110   use strict;
 111   use warnings FATAL => 'all';
 112   no indirect 'fatal';
 113   no multidimensional;
 114   no bareword::filehandles;
 115
 116 Note that _EXTRA may at some point add even more tests, with only a minor
 117 version increase, but any changes to the effect of 'use strictures' in
 118 normal mode will involve a major version bump.
 119
 120 If any of the extra testing modules are not present, strictures will
 121 complain loudly, once, via warn(), and then shut up. But you really
 122 should consider installing them, they're all great anti-footgun tools.
 123
 124 =head1 DESCRIPTION
 125
 126 I've been writing the equivalent of this module at the top of my code for
 127 about a year now. I figured it was time to make it shorter.
 128
 129 Things like the importer in 'use Moose' don't help me because they turn
 130 warnings on but don't make them fatal - which from my point of view is
 131 useless because I want an exception to tell me my code isn't warnings clean.
 132
 133 Any time I see a warning from my code, that indicates a mistake.
 134
 135 Any time my code encounters a mistake, I want a crash - not spew to STDERR
 136 and then unknown (and probably undesired) subsequent behaviour.
 137
 138 I also want to ensure that obvious coding mistakes, like indirect object
 139 syntax (and not so obvious mistakes that cause things to accidentally compile
 140 as such) get caught, but not at the cost of an XS dependency and not at the
 141 cost of blowing things up on another machine.
 142
 143 Therefore, strictures turns on additional checking, but only when it thinks
 144 it's running in a test file in a VCS checkout - though if this causes
 145 undesired behaviour this can be overridden by setting the
 146 PERL_STRICTURES_EXTRA environment variable.
 147
 148 If additional useful author side checks come to mind, I'll add them to the
 149 _EXTRA code path only - this will result in a minor version increase (i.e.
 150 1.000000 to 1.001000 (1.1.0) or similar). Any fixes only to the mechanism of
 151 this code will result in a subversion increas (i.e. 1.000000 to 1.000001
 152 (1.0.1)).
 153
 154 If the behaviour of 'use strictures' in normal mode changes in any way, that
 155 will constitute a major version increase - and the code already checks
 156 when its version is tested to ensure that
 157
 158   use strictures 1;
 159
 160 will continue to only introduce the current set of strictures even if 2.0 is
 161 installed.
 162
 163 =head1 METHODS
 164
 165 =head2 import
 166
 167 This method does the setup work described above in L</DESCRIPTION>
 168
 169 =head2 VERSION
 170
 171 This method traps the strictures->VERSION(1) call produced by a use line
 172 with a version number on it and does the version check.
 173
 174 =head1 EXTRA TESTING RATIONALE
 175
 176 Every so often, somebody complains that they're deploying via 'git pull'
 177 and that they don't want strictures to enable itself in this case - and that
 178 setting C<PERL_STRICTURES_EXTRA> to 0 isn't acceptable (additional ways to
 179 disable extra testing would be welcome but the discussion never seems to get
 180 that far).
 181
 182 In order to allow us to skip a couple of stages and get straight to a
 183 productive conversation, here's my current rationale for turning the
 184 extra testing on via a heuristic:
 185
 186 The extra testing is all stuff that only ever blows up at compile time;
 187 this is intentional. So the oft raised concern that it's different code being
 188 tested is only sort of the case - none of the modules involved affect the
 189 final optree to my knowledge, so the author gets some additional compile
 190 time crashes which he/she then fixes, and the rest of the testing is
 191 completely valid for all environments.
 192
 193 The point of the extra testing - especially 'no indirect' - is to catch
 194 mistakes that newbie users won't even realise are mistakes without
 195 help. For example,
 196
 197   foo { ... };
 198
 199 where foo is an & prototyped sub that you forgot to import - this is
 200 pernicious to track down since all -seems- fine until it gets called
 201 and you get a crash. Worse still, you can fail to have imported it due
 202 to a circular require, at which point you have a load order dependent
 203 bug which I've seen before now -only- show up in production due to tiny
 204 differences between the production and the development environment. I wrote
 205 L<http://shadow.cat/blog/matt-s-trout/indirect-but-still-fatal/> to explain
 206 this particular problem before L<strictures> itself existed.
 207
 208 As such, in my experience so far the strictures extra testing has
 209 -avoided- production versus development differences, not caused them.
 210
 211 Additionally, strictures' policy is very much "try and provide as much
 212 protection as possible for newbies - who won't think about whether there's
 213 an option to turn on or not" - so having only the environment variable
 214 is not sufficient to achieve that (I get to explain that you need to add
 215 'use strict' at least once a week on freenode #perl - newbies sometimes
 216 completely skip steps because they don't understand that that step
 217 is important).
 218
 219 I make no claims that the heuristic is perfect - it's already been evolved
 220 significantly over time, especially for 1.004 where we changed things to
 221 ensure it only fires on files in your checkout (rather than strictures-using
 222 modules you happened to have installed, which was just silly). However, I
 223 hope the above clarifies why a heuristic approach is not only necessary but
 224 desirable from a POV of providing new users with as much safety as possible,
 225 and will allow any future discussion on the subject to focus on "how do we
 226 minimise annoyance to people deploying from checkouts intentionally".
 227
 228 =head1 COMMUNITY AND SUPPORT
 229
 230 =head2 IRC channel
 231
 232 irc.perl.org #toolchain
 233
 234 (or bug 'mst' in query on there or freenode)
 235
 236 =head2 Git repository
 237
 238 Gitweb is on http://git.shadowcat.co.uk/ and the clone URL is:
 239
 240   git clone git://git.shadowcat.co.uk/p5sagit/strictures.git
 241
 242 The web interface to the repository is at:
 243
 244   http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/strictures.git
 245
 246 =head1 AUTHOR
 247
 248 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
 249
 250 =head1 CONTRIBUTORS
 251
 252 None required yet. Maybe this module is perfect (hahahahaha ...).
 253
 254 =head1 COPYRIGHT
 255
 256 Copyright (c) 2010 the strictures L</AUTHOR> and L</CONTRIBUTORS>
 257 as listed above.
 258
 259 =head1 LICENSE
 260
 261 This library is free software and may be distributed under the same terms
 262 as perl itself.
 263
 264 =cut