Thanks Andrew and Florian

[perl/modules/indirect.git] / lib / indirect.pm

diff --git a/lib/indirect.pm b/lib/indirect.pm
index 7028f93a755cfd82248a7fd220bf0acefa70c7ea..f4cc7dcdd7bb6cc7ca97f3cabb9a4d0f4bfd2521 100644 (file)
--- a/lib/indirect.pm
+++ b/lib/indirect.pm
@@ -11,13 +11,13 @@ indirect - Lexically warn about using the indirect object syntax.
 
 =head1 VERSION
 
-Version 0.14
+Version 0.15
 
 =cut
 
 our $VERSION;
 BEGIN {
- $VERSION = '0.14';
+ $VERSION = '0.15';
 }
 
 =head1 SYNOPSIS
@@ -29,10 +29,12 @@ BEGIN {
      use indirect;
      my $y = new Pear; # ok
      {
-      no indirect hook => sub { die "You really wanted $_[0]\->$_[1]" };
-      my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new'
+      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'
      }
     }
+    try { ... }; # warns
+
     no indirect ':fatal';
     if (defied $foo) { ... } # croaks, note the typo
 
@@ -48,7 +50,7 @@ BEGIN {
 When enabled (or disabled as some may prefer to say, since you actually turn it on by calling C<no indirect>), this pragma warns about indirect object syntax constructs that may have slipped into your code.
 This syntax is now considered harmful, since its parsing has many quirks and its use is error prone (when C<swoosh> isn't defined, C<swoosh $x> actually compiles to C<< $x->swoosh >>).
 
-It currently does not warn when the object is enclosed between braces (like C<meth { $obj } @args>) or for core functions (C<print> or C<say>).
+It currently does not warn for core functions (C<print>, C<say>, C<exec> or C<system>).
 This may change in the future, or may be added as optional features that would be enabled by passing options to C<unimport>.
 
 This module is B<not> a source filter.
@@ -76,7 +78,8 @@ If it's the string C<':fatal'>, the compilation will croak on the first indirect
 
 =item *
 
-If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with the object name as C<$_[0]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with a string representation of the object as C<$_[0]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If and only if the object is actually a block, C<$_[0]> is assured to start by C<'{'>.
 
 =item *
 
@@ -86,10 +89,6 @@ Otherwise, a warning will be emitted for each indirect construct.
 
 =cut
 
-my $msg = sub {
- "Indirect call of method \"$_[1]\" on object \"$_[0]\" at $_[2] line $_[3].\n"
-};
-
 sub unimport {
  shift;
 
@@ -99,11 +98,11 @@ sub unimport {
   if ($arg eq 'hook') {
    $hook = shift;
   } elsif ($arg eq ':fatal') {
-   $hook = sub { die $msg->(@_) };
+   $hook = sub { die msg(@_) };
   }
   last if $hook;
  }
- $hook = sub { warn $msg->(@_) } unless defined $hook;
+ $hook = sub { warn msg(@_) } unless defined $hook;
 
  $^H |= 0x00020000;
  $^H{+(__PACKAGE__)} = _tag($hook);
@@ -122,11 +121,27 @@ sub import {
  ();
 }
 
+=head1 FUNCTIONS
+
+=head2 C<msg $object, $method, $file, $line>
+
+Returns the default error message generated by C<indirect> when an invalid construct is reported.
+
+=cut
+
+sub msg {
+ my $obj = $_[0];
+
+ join ' ', "Indirect call of method \"$_[1]\" on",
+           ($obj =~ /^\s*\{/ ? "a block" : "object \"$obj\""),
+           "at $_[2] line $_[3].\n";
+};
+
 =head1 CONSTANTS
 
 =head2 C<I_THREADSAFE>
 
-True iff the module could have been built when thread-safety features.
+True iff the module could have been built with thread-safety features enabled.
 
 =head1 CAVEATS
 
@@ -166,6 +181,8 @@ Tests code coverage report is available at L<http://www.profvince.com/perl/cover
 
 Bram, for motivation and advices.
 
+Andrew Main and Florian Ragwitz, for testing on real-life code and reporting issues.
+
 =head1 COPYRIGHT & LICENSE
 
 Copyright 2008-2009 Vincent Pit, all rights reserved.