explicitly mark the end of code and start of pod

[p5sagit/Safe-Isa.git] / lib / Safe / Isa.pm

diff --git a/lib/Safe/Isa.pm b/lib/Safe/Isa.pm
index b725f21..47cfd3e 100644 (file)
--- a/lib/Safe/Isa.pm
+++ b/lib/Safe/Isa.pm
@@ -3,14 +3,17 @@ package Safe::Isa;
 use strict;
 use warnings FATAL => 'all';
 use Scalar::Util qw(blessed);
-use base qw(Exporter);
+use Exporter 5.57 qw(import);
 
-our $VERSION = '1.000000';
+our $VERSION = '1.000005';
 
 our @EXPORT = qw($_call_if_object $_isa $_can $_does $_DOES);
 
 our $_call_if_object = sub {
   my ($obj, $method) = (shift, shift);
+  # This is intentionally a truth test, not a defined test, otherwise
+  # we gratuitously break modules like Scalar::Defer, which would be
+  # un-perlish.
   return unless blessed($obj);
   return $obj->$method(@_);
 };
@@ -20,6 +23,11 @@ our ($_isa, $_can, $_does, $_DOES) = map {
   sub { my $obj = shift; $obj->$_call_if_object($method => @_) }
 } qw(isa can does DOES);
 
+1;
+__END__
+
+=pod
+
 =head1 NAME
 
 Safe::Isa - Call isa, can, does and DOES safely on things that may not be objects
@@ -69,9 +77,9 @@ And just in case we missed a method:
 
 Or to re-use a previous example for purposes of explication:
 
-  $foo->$_call_if_method(isa => 'Foo');  # true
-  $bar->$_call_if_method(isa => 'Foo');  # true
-  $blam->$_call_if_method(isa => 'Foo'); # false, no boom today
+  $foo->$_call_if_object(isa => 'Foo');  # true
+  $bar->$_call_if_object(isa => 'Foo');  # true
+  $blam->$_call_if_object(isa => 'Foo'); # false, no boom today
 
 =head1 DESCRIPTION
 
@@ -103,6 +111,11 @@ is equivalent to
     }
   };
 
+Note that we don't handle trying class names, because many things are valid
+class names that you might not want to treat as one (like say "Matt") - the
+C<is_module_name> function from L<Module::Runtime> is a good way to check for
+something you might be able to call methods on if you want to do that.
+
 =head1 EXPORTS
 
 =head2 $_isa
@@ -133,13 +146,18 @@ returns nothing.
 If called on an object, calls C<DOES> on it and returns the result, otherwise
 returns nothing.
 
-=head2 $_call_if_method
+=head2 $_call_if_object
 
-  $maybe_an_object->$_call_if_method(method_name => @args);
+  $maybe_an_object->$_call_if_object(method_name => @args);
 
 If called on an object, calls C<method_name> on it and returns the result,
 otherwise returns nothing.
 
+=head1 SEE ALSO
+
+I gave a lightning talk on this module (and L<curry> and L<Import::Into>) at
+L<YAPC::NA 2013|https://www.youtube.com/watch?v=wFXWV2yY7gE&t=46m05s>.
+
 =head1 AUTHOR
 
 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>