Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::variables::prohibitpackagevars(3pm) [debian man page]

Perl::Critic::Policy::Variables::ProhibitPackageVars(3pmUser Contributed Perl DocumentatiPerl::Critic::Policy::Variables::ProhibitPackageVars(3pm)

NAME

       Perl::Critic::Policy::Variables::ProhibitPackageVars - Eliminate globals declared with "our" or "use vars".

AFFILIATION

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

DESCRIPTION

       Conway suggests avoiding package variables completely, because they expose your internals to other packages.  Never use a package variable
       when a lexical variable will suffice.  If your package needs to keep some dynamic state, consider using an object or closures to keep the
       state private.

       This policy assumes that you're using "strict vars" so that naked variable declarations are not package variables by default.  Thus, it
       complains you declare a variable with "our" or "use vars", or if you make reference to variable with a fully-qualified package name.

	   $Some::Package::foo = 1;    # not ok
	   our $foo	       = 1;    # not ok
	   use vars '$foo';	       # not ok
	   $foo = 1;		       # not allowed by 'strict'
	   local $foo = 1;	       # bad taste, but technically ok.
	   use vars '$FOO';	       # ok, because it's ALL CAPS
	   my $foo = 1; 	       # ok

       In practice though, its not really practical to prohibit all package variables.	Common variables like $VERSION and @EXPORT need to be
       global, as do any variables that you want to Export.  To work around this, the Policy overlooks any variables that are in ALL_CAPS.  This
       forces you to put all your exported variables in ALL_CAPS too, which seems to be the usual practice anyway.

CONFIGURATION

       There is room for exceptions.  Some modules, like the core File::Find module, use package variables as their only interface, and others
       like Data::Dumper use package variables as their most common interface.	These module can be specified from your .perlcriticrc file, and
       the policy will ignore them.

	   [Variables::ProhibitPackageVars]
	   packages = Data::Dumper File::Find FindBin Log::Log4perl

       This is the default setting.  Using "packages ="  will override these defaults.

       You can also add packages to the defaults like so:

	   [Variables::ProhibitPackageVars]
	   add_packages = My::Package

       You can add package "main" to the list of packages, but that will only OK variables explicitly in the "main" package.

SEE ALSO

       Perl::Critic::Policy::Variables::ProhibitPunctuationVars

       Perl::Critic::Policy::Variables::ProhibitLocalVars

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::Variables::ProhibitPackageVars(3pm)

Check Out this Related Man Page

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

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: 4126 $" keyword to automatically define the $VERSION variable like this:

	   our ($VERSION) = '$Revision: 4126 $' =~ 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.16.3							    2014-06-09		       Perl::Critic::Policy::Modules::RequireVersionVar(3)
Man Page