use strict;
use warnings FATAL => 'all';
-our $VERSION = '1.000000'; # 1.0.0
+use constant _PERL_LT_5_8_4 => ($] < 5.008004) ? 1 : 0;
+
+our $VERSION = '1.004000'; # 1.4.0
sub VERSION {
for ($_[1]) {
last unless defined && !ref && int != 1;
die "Major version specified as $_ - this is strictures version 1";
}
+ # disable this since Foo->VERSION(undef) correctly returns the version
+ # and that can happen either if our caller passes undef explicitly or
+ # because the for above autovivified $_[1] - I could make it stop but
+ # it's pointless since we don't want to blow up if the caller does
+ # something valid either.
+ no warnings 'uninitialized';
shift->SUPER::VERSION(@_);
}
+my $extras_load_warned;
+
sub import {
strict->import;
warnings->import(FATAL => 'all');
- my $do_indirect = do {
+
+ my $extra_tests = do {
if (exists $ENV{PERL_STRICTURES_EXTRA}) {
- $ENV{PERL_STRICTURES_EXTRA}
- } else {
- !!($0 =~ /^x?t\/.*(?:load|compile|coverage).*\.t$/)
+ if (_PERL_LT_5_8_4 and $ENV{PERL_STRICTURES_EXTRA}) {
+ die 'PERL_STRICTUTRES_EXTRA checks are not available on perls older than 5.8.4, '
+ . "please unset \$ENV{PERL_STRICTURES_EXTRA}\n";
+ }
+ $ENV{PERL_STRICTURES_EXTRA};
+ } elsif (! _PERL_LT_5_8_4) {
+ !!((caller)[1] =~ /^(?:t|xt|lib|blib)/
+ and (-e '.git' or -e '.svn'))
}
};
- if ($do_indirect) {
+ if ($extra_tests) {
+ my @failed;
if (eval { require indirect; 1 }) {
- indirect->unimport('FATAL');
+ indirect->unimport(':fatal');
} else {
- die "strictures.pm extra testing active but couldn't load indirect.pm: $@";
+ push @failed, 'indirect';
+ }
+ if (eval { require multidimensional; 1 }) {
+ multidimensional->unimport;
+ } else {
+ push @failed, 'multidimensional';
+ }
+ if (eval { require bareword::filehandles; 1 }) {
+ bareword::filehandles->unimport;
+ } else {
+ push @failed, 'bareword::filehandles';
+ }
+ if (@failed and not $extras_load_warned++) {
+ my $failed = join ' ', @failed;
+ warn <<EOE;
+strictures.pm extra testing active but couldn't load all modules. Missing were:
+
+ $failed
+
+Extra testing is auto-enabled in checkouts only, so if you're the author
+of a strictures using module you need to run:
+
+ cpan indirect multidimensional bareword::filehandles
+
+but these modules are not required by your users.
+EOE
}
}
}
use strict;
use warnings FATAL => 'all';
-except when called from a file where $0 matches:
+except when called from a file which matches:
- /^x?t\/.*(?:load|compile|coverage).*\.t$/
+ (caller)[1] =~ /^(?:t|xt|lib|blib)/
-or when the PERL_STRICTURES_EXTRA environment variable is set, in which
-case
+and when either '.git' or '.svn' is present in the current directory (with
+the intention of only forcing extra tests on the author side) - or when the
+PERL_STRICTURES_EXTRA environment variable is set, in which case
use strictures 1;
use strict;
use warnings FATAL => 'all';
no indirect 'fatal';
+ no multidimensional;
+ no bareword::filehandles;
Note that _EXTRA may at some point add even more tests, with only a minor
version increase, but any changes to the effect of 'use strictures' in
normal mode will involve a major version bump.
+If any of the extra testing modules are not present, strictures will
+complain loudly, once, via warn(), and then shut up. But you really
+should consider installing them, they're all great anti-footgun tools.
+
=head1 DESCRIPTION
I've been writing the equivalent of this module at the top of my code for
as such) get caught, but not at the cost of an XS dependency and not at the
cost of blowing things up on another machine.
-Therefore, strictures turns on indirect checking only when it thinks it's
-running in a compilation (or pod coverage) test - though if this causes
-undesired behaviour this can be overriden by setting the
+Therefore, strictures turns on additional checking, but only when it thinks
+it's running in a test file in a VCS checkout - though if this causes
+undesired behaviour this can be overridden by setting the
PERL_STRICTURES_EXTRA environment variable.
If additional useful author side checks come to mind, I'll add them to the
will continue to only introduce the current set of strictures even if 2.0 is
installed.
+
+=head1 METHODS
+
+=head2 import
+
+This method does the setup work described above in L</DESCRIPTION>
+
+=head2 VERSION
+
+This method traps the strictures->VERSION(1) call produced by a use line
+with a version number on it and does the version check.
+
+=head1 COMMUNITY AND SUPPORT
+
+=head2 IRC channel
+
+irc.perl.org #toolchain
+
+(or bug 'mst' in query on there or freenode)
+
+=head2 Git repository
+
+Gitweb is on http://git.shadowcat.co.uk/ and the clone URL is:
+
+ git clone git://git.shadowcat.co.uk/p5sagit/strictures.git
+
+=head1 AUTHOR
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+=head1 CONTRIBUTORS
+
+None required yet. Maybe this module is perfect (hahahahaha ...).
+
+=head1 COPYRIGHT
+
+Copyright (c) 2010 the strictures L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut
projects / p5sagit/strictures.git / blobdiff