perl::critic::policy::modules::prohibitconditionalusestatements(3pm) [debian man page]

Perl::Critic::Policy::Modules::ProhibitConditionalUseStaUsernContributed Perl Perl::Critic::Policy::Modules::ProhibitConditionalUseStatements(3pm)

NAME

       Perl::Critic::Policy::Modules::ProhibitConditionalUseStatements - Avoid putting conditional logic around compile-time includes.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       Modules included via "use" are loaded at compile-time.  Placing conditional logic around the "use" statement has no effect on whether the
       module will be loaded.  Doing so can also serve to confuse the reader as to the author's original intent.

       If you need to conditionally load a module you should be using "require" instead.

       This policy will catch the following forms of conditional "use" statements:

	   # if-elsif-else
	   if ($a == 1) { use Module; }
	   if ($a == 1) { } elsif ($a == 2) { use Module; }
	   if ($a == 1) { } else { use Module; }

	   # for/foreach
	   for (1..$a) { use Module; }
	   foreach (@a) { use Module; }

	   # while
	   while ($a == 1) { use Module; }

	   # unless
	   unless ($a == 1) { use Module; }

	   # until
	   until ($a == 1) { use Module; }

	   # do-condition
	   do { use Module; } if $a == 1;
	   do { use Module; } while $a == 1;
	   do { use Module; } unless $a == 1;
	   do { use Module; } until $a == 1;

	   # operator-do
	   $a == 1 || do { use Module; };
	   $a == 1 && do { use Module; };
	   $a == 1 or do { use Module; };
	   $a == 1 and do { use Module; };

	   # non-string eval
	   eval { use Module; };

       Including a module via "use" in bare blocks, standalone do blocks, or string evals is allowed.

	   # bare block
	   { use Module; }

	   # do
	   do { use Module; }

	   # string eval
	   eval "use Module";

CONFIGURATION

       This Policy is not configurable except for the standard options.

AUTHOR

       Peter Guzis <pguzis@cpan.org>

COPYRIGHT

       Copyright (c) 2010-2011 Peter Guzis.  All rights reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  The full text of this license
       can be found in the LICENSE file included with this module.

perl v5.14.2							    2012-06-07Perl::Critic::Policy::Modules::ProhibitConditionalUseStatements(3pm)

Perl::Critic::Policy::Modules::RequireVersionVar(3pm)	User Contributed Perl Documentation  Perl::Critic::Policy::Modules::RequireVersionVar(3pm)

NAME

       Perl::Critic::Policy::Modules::RequireVersionVar - Give every module a "$VERSION" number.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       Every Perl file (modules, libraries, and programs) should have a package-scoped $VERSION variable.  The $VERSION allows clients to insist
       on a particular revision of your file like this:

	   use SomeModule 2.4;	#Only loads version 2.4

       This Policy scans your file for any package variable named $VERSION.  I'm assuming that you are using "strict", so you'll have to declare
       it like one of these:

	   our $VERSION = 1.0611;
	   $MyPackage::VERSION = 1.061;
	   use vars qw($VERSION);
	   use version; our $VERSION = qv(1.0611);

       Perl's version system does not recognize lexical variables such as

	   my $VERSION = 1.0611;

       so they are not accepted by this policy.

       A common practice is to use the "$Revision: 4106 $" keyword to automatically define the $VERSION variable like this:

	   our ($VERSION) = '$Revision: 4106 $' =~ m{ $Revision: s+ (S+) }x;

CONFIGURATION

       This Policy is not configurable except for the standard options.

NOTES

       Conway recommends using the "version" pragma instead of raw numbers or 'v-strings.'  However, this Policy only insists that the $VERSION be
       defined somehow.  I may try to extend this in the future.

TO DO

       Add check that $VERSION is independently evaluatable.  In particular, prohibit this:

	   our $VERSION = $Other::Module::VERSION;

       This doesn't work because PAUSE and other tools literally copy your version declaration out of your module and evaluates it in isolation,
       at which point there's nothing in "Other::Module", and so the $VERSION is undefined.

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  The full text of this license
       can be found in the LICENSE file included with this module.

perl v5.14.2							    2012-06-07		     Perl::Critic::Policy::Modules::RequireVersionVar(3pm)