From: Vincent Pit Date: Sun, 23 Oct 2011 14:22:50 +0000 (+0200) Subject: This is 0.26 X-Git-Tag: v0.26 X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=95e1bfaed7d61198ba2d63d27405e3e6fb39fba7;p=perl%2Fmodules%2Findirect.git This is 0.26 --- diff --git a/Changes b/Changes index 1d730c6..b0727e3 100644 --- a/Changes +++ b/Changes @@ -1,5 +1,17 @@ Revision history for indirect +0.26 2011-10-23 14:25 UTC + + Add : "no indirect 'global'" enables the pragma for the whole program, + except for lexical scopes that "use indirect" explicitely. + + Chg : Passing both the 'fatal' and 'hook' options to unimport() is + now considered an error, and will result in an exception. + unimport() used to consider only the first passed option of + those two, and silently ignored the other. + + Tst : Test failures of t/41-threads-teardown.t and t/50-external.t on + Cygwin should have been addressed. + + Tst : Threads tests will not fail anymore if resources constraints + prevent the system from creating all the required threads. + 0.25 2011-08-24 15:40 UTC + Fix : RT #69291 is now also fixed for perl 5.8. The pragma will no longer vivify the "indirect" entry in the hints hash %^H on diff --git a/META.json b/META.json index 2e83a2c..dc83d09 100644 --- a/META.json +++ b/META.json @@ -1,10 +1,10 @@ { - "abstract" : "Lexically warn about using the indirect object syntax.", + "abstract" : "Lexically warn about using the indirect method call syntax.", "author" : [ "Vincent Pit " ], "dynamic_config" : 1, - "generated_by" : "ExtUtils::MakeMaker version 6.59, CPAN::Meta::Converter version 2.112150", + "generated_by" : "ExtUtils::MakeMaker version 6.59, CPAN::Meta::Converter version 2.112621", "license" : [ "perl_5" ], @@ -22,6 +22,7 @@ "prereqs" : { "build" : { "requires" : { + "Carp" : 0, "ExtUtils::MakeMaker" : 0, "Test::More" : 0, "XSLoader" : 0 @@ -34,6 +35,7 @@ }, "runtime" : { "requires" : { + "Carp" : 0, "XSLoader" : 0, "perl" : "5.008001" } @@ -52,5 +54,5 @@ "url" : "http://git.profvince.com/?p=perl%2Fmodules%2Findirect.git" } }, - "version" : "0.25" + "version" : "0.26" } diff --git a/META.yml b/META.yml index 4fa62c8..fb2456e 100644 --- a/META.yml +++ b/META.yml @@ -1,15 +1,16 @@ --- -abstract: 'Lexically warn about using the indirect object syntax.' +abstract: 'Lexically warn about using the indirect method call syntax.' author: - 'Vincent Pit ' build_requires: + Carp: 0 ExtUtils::MakeMaker: 0 Test::More: 0 XSLoader: 0 configure_requires: ExtUtils::MakeMaker: 0 dynamic_config: 1 -generated_by: 'ExtUtils::MakeMaker version 6.59, CPAN::Meta::Converter version 2.112150' +generated_by: 'ExtUtils::MakeMaker version 6.59, CPAN::Meta::Converter version 2.112621' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html @@ -20,6 +21,7 @@ no_index: - t - inc requires: + Carp: 0 XSLoader: 0 perl: 5.008001 resources: @@ -27,4 +29,4 @@ resources: homepage: http://search.cpan.org/dist/indirect/ license: http://dev.perl.org/licenses/ repository: http://git.profvince.com/?p=perl%2Fmodules%2Findirect.git -version: 0.25 +version: 0.26 diff --git a/README b/README index 2b53d6f..ab4fa5e 100644 --- a/README +++ b/README @@ -1,58 +1,67 @@ NAME - indirect - Lexically warn about using the indirect object syntax. + indirect - Lexically warn about using the indirect method call syntax. VERSION - Version 0.25 + Version 0.26 SYNOPSIS - # In a script - no indirect; + In a script : + + no indirect; # lexically enables the pragma my $x = new Apple 1, 2, 3; # warns { - use indirect; - my $y = new Pear; # ok + use indirect; # lexically disables the pragma + my $y = new Pear; # legit, does not warn { - no indirect hook => sub { die "You really wanted $_[0]\->$_[1] at $_[2]:$_[3]" }; - my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new at blurp.pm:13' + # lexically specify an hook called for each indirect construct + no indirect hook => sub { + die "You really wanted $_[0]\->$_[1] at $_[2]:$_[3]" + }; + my $z = new Pineapple 'fresh'; # croaks 'You really wanted...' } } - try { ... }; # warns + try { ... }; # warns if try() hasn't been declared in this package - no indirect ':fatal'; # or 'FATAL', or ':Fatal' ... + no indirect 'fatal'; # or ':fatal', 'FATAL', ':Fatal' ... if (defied $foo) { ... } # croaks, note the typo - # From the command-line - perl -M-indirect -e 'my $x = new Banana;' # warns + Global uses : + + # Globally enable the pragma from the command-line + perl -M-indirect=global -e 'my $x = new Banana;' # warns - # Or each time perl is ran - export PERL5OPT="-M-indirect" - perl -e 'my $y = new Coconut;' # warns + # Globally enforce the pragma each time perl is executed + export PERL5OPT="-M-indirect=global,fatal" + perl -e 'my $y = new Coconut;' # croaks DESCRIPTION - When enabled (or disabled as some may prefer to say, since you actually - turn it on by calling "no indirect"), this pragma warns about indirect - object syntax constructs that may have slipped into your code. + When enabled, this pragma warns about indirect method calls that are + present in your code. - This syntax is now considered harmful, since its parsing has many quirks - and its use is error prone (when "swoosh" is not defined, "swoosh $x" - actually compiles to "$x->swoosh"). In + The indirect syntax is now considered harmful, since its parsing has + many quirks and its use is error prone : when the subroutine "foo" has + not been declared in the current package, "foo $x" actually compiles to + "$x->foo", and "foo { key => 1 }" to "'key'->foo(1)". In , - Matt S. Trout gives an example of an indirect construct that can cause a - particularly bewildering error. + Matt S. Trout gives an example of an undesirable indirect method call on + a block that can cause a particularly bewildering error. - It currently does not warn for core functions ("print", "say", "exec" or - "system"). This may change in the future, or may be added as optional - features that would be enabled by passing options to "unimport". + This pragma currently does not warn for core functions ("print", "say", + "exec" or "system"). This may change in the future, or may be added as + optional features that would be enabled by passing options to + "unimport". This module is not a source filter. METHODS - "unimport [ hook => $hook | ':fatal', 'FATAL', ... ]" + "unimport [ 'global', hook => $hook | 'fatal' ]" Magically called when "no indirect @opts" is encountered. Turns the module on. The policy to apply depends on what is first found in @opts : * If it is a string that matches "/^:?fatal$/i", the compilation will - croak on the first indirect syntax met. + croak when the first indirect method call is found. + + This option is mutually exclusive with the 'hook' option. * If the key/value pair "hook => $hook" comes first, $hook will be called for each error with a string representation of the object as @@ -60,15 +69,48 @@ METHODS line number as $_[3]. If and only if the object is actually a block, $_[0] is assured to start by '{'. - * Otherwise, a warning will be emitted for each indirect construct. + This option is mutually exclusive with the 'fatal' option. + + * If none of "fatal" and "hook" are specified, a warning will be + emitted for each indirect method call. + + * If @opts contains a string that matches "/^:?global$/i", the pragma + will be globally enabled for all code compiled after the current "no + indirect" statement, except for code that is in the lexical scope of + "use indirect". This option may come indifferently before or after + the "fatal" or "hook" options, in the case they are also passed to + "unimport". + + The global policy applied is the one resulting of the "fatal" or + "hook" options, thus defaults to a warning when none of those are + specified : + + no indirect 'global'; # warn for any indirect call + no indirect qw; # die on any indirect call + no indirect 'global', hook => \&hook # custom global action + + Note that if another policy is installed by a "no indirect" + statement further in the code, it will overrule the global policy : + + no indirect 'global'; # warn globally + { + no indirect 'fatal'; # throw exceptions for this lexical scope + ... + require Some::Module; # the global policy will apply for the + # compilation phase of this module + } "import" Magically called at each "use indirect". Turns the module off. + As explained in "unimport"'s description, an "use indirect" statement + will lexically override a global policy previously installed by "no + indirect 'global', ..." (if there's one). + FUNCTIONS "msg $object, $method, $file, $line" - Returns the default error message generated by "indirect" when an - invalid construct is reported. + Returns the default error message that "indirect" generates when an + indirect method call is reported. CONSTANTS "I_THREADSAFE" @@ -82,12 +124,12 @@ CONSTANTS DIAGNOSTICS "Indirect call of method "%s" on object "%s" at %s line %d." - The default warning/exception message thrown when an indirect call on an - object is found. + The default warning/exception message thrown when an indirect method + call on an object is found. "Indirect call of method "%s" on a block at %s line %d." - The default warning/exception message thrown when an indirect call on a - block is found. + The default warning/exception message thrown when an indirect method + call on a block is found. ENVIRONMENT "PERL_INDIRECT_PM_DISABLE" @@ -109,10 +151,9 @@ CAVEATS "require"d scopes. Before "perl" 5.12, "meth $obj" (no semicolon) at the end of a file is - not seen as an indirect object syntax, although it is as soon as there - is another token before the end (as in "meth $obj;" or "meth $obj 1"). - If you use "perl" 5.12 or greater, those constructs are correctly - reported. + not seen as an indirect method call, although it is as soon as there is + another token before the end (as in "meth $obj;" or "meth $obj 1"). If + you use "perl" 5.12 or greater, those constructs are correctly reported. With 5.8 perls, the pragma does not propagate into "eval STRING". This is due to a shortcoming in the way perl handles the hints hash, which is @@ -127,7 +168,7 @@ DEPENDENCIES A C compiler. This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard. - XSLoader (standard since perl 5.006). + Carp (standard since perl 5), XSLoader (since perl 5.006). AUTHOR Vincent Pit, "", . diff --git a/lib/indirect.pm b/lib/indirect.pm index 1e08274..c59f8be 100644 --- a/lib/indirect.pm +++ b/lib/indirect.pm @@ -11,13 +11,13 @@ indirect - Lexically warn about using the indirect method call syntax. =head1 VERSION -Version 0.25 +Version 0.26 =cut our $VERSION; BEGIN { - $VERSION = '0.25'; + $VERSION = '0.26'; } =head1 SYNOPSIS