4 use warnings FATAL => 'all';
6 use Exporter 5.57 qw(import);
8 our $VERSION = '1.000007';
10 our @EXPORT = qw($_call_if_object $_isa $_can $_does $_DOES $_call_if_can);
12 our $_call_if_object = sub {
13 my ($obj, $method) = (shift, shift);
14 # This is intentionally a truth test, not a defined test, otherwise
15 # we gratuitously break modules like Scalar::Defer, which would be
17 return unless Scalar::Util::blessed($obj);
18 return $obj->isa(@_) if lc($method) eq 'does' and not $obj->can($method);
19 return $obj->$method(@_);
22 our ($_isa, $_can, $_does, $_DOES) = map {
24 sub { my $obj = shift; $obj->$_call_if_object($method => @_) }
25 } qw(isa can does DOES);
27 our $_call_if_can = sub {
28 my ($obj, $method) = (shift, shift);
29 $obj->$_call_if_object(can => $method) && $obj->$_call_if_object($method => @_);
39 Safe::Isa - Call isa, can, does and DOES safely on things that may not be objects
46 { package Foo; sub new { bless({}, $_[0]) } }
47 { package Bar; our @ISA = qw(Foo); sub bar { 1 } }
55 $foo->isa('Foo'); # true
56 $bar->isa('Foo'); # true
57 $blam->isa('Foo'); # BOOM
59 $foo->can('bar'); # false
60 $bar->can('bar'); # true
61 $blam->can('bar'); # BOOM
67 $foo->$_isa('Foo'); # true
68 $bar->$_isa('Foo'); # true
69 $blam->$_isa('Foo'); # false, no boom today
71 $foo->$_can('bar'); # false
72 $bar->$_can('bar'); # true
73 $blam->$_can('bar'); # false, no boom today
77 $maybe_an_object->$_does('RoleName'); # true or false, no boom today
78 $maybe_an_object->$_DOES('RoleName'); # true or false, no boom today
80 And just in case we missed a method or two:
82 $maybe_an_object->$_call_if_object(name => @args);
83 $maybe_an_object->$_call_if_can(name => @args);
85 Or to re-use a previous example for purposes of explication:
87 $foo->$_call_if_object(isa => 'Foo'); # true
88 $bar->$_call_if_object(isa => 'Foo'); # true
89 $blam->$_call_if_object(isa => 'Foo'); # false, no boom today
93 How many times have you found yourself writing:
95 if ($obj->isa('Something')) {
97 and then shortly afterwards cursing and changing it to:
99 if (Scalar::Util::blessed($obj) and $obj->isa('Something')) {
101 Right. That's why this module exists.
103 Since perl allows us to provide a subroutine reference or a method name to
104 the -> operator when used as a method call, and a subroutine doesn't require
105 the invocant to actually be an object, we can create safe versions of isa,
106 can and friends by using a subroutine reference that only tries to call the
107 method if it's used on an object. So:
109 my $isa_Foo = $maybe_an_object->$_call_if_object(isa => 'Foo');
114 if (Scalar::Util::blessed($maybe_an_object)) {
115 $maybe_an_object->isa('Foo');
121 Note that we don't handle trying class names, because many things are valid
122 class names that you might not want to treat as one (like say "Matt") - the
123 C<is_module_name> function from L<Module::Runtime> is a good way to check for
124 something you might be able to call methods on if you want to do that.
130 $maybe_an_object->$_isa('Foo');
132 If called on an object, calls C<isa> on it and returns the result, otherwise
137 $maybe_an_object->$_can('Foo');
139 If called on an object, calls C<can> on it and returns the result, otherwise
144 $maybe_an_object->$_does('Foo');
146 If called on an object, calls C<does> on it and returns the result, otherwise
151 $maybe_an_object->$_DOES('Foo');
153 If called on an object, calls C<DOES> on it and returns the result, otherwise
156 =head2 $_call_if_object
158 $maybe_an_object->$_call_if_object(method_name => @args);
160 If called on an object, calls C<method_name> on it and returns the result,
161 otherwise returns nothing.
165 $maybe_an_object->$_call_if_can(name => @args);
167 If called on an object, calls C<can> on it; if that returns true, then
168 calls C<method_name> on it and returns the result; if any condition is false
173 I gave a lightning talk on this module (and L<curry> and L<Import::Into>) at
174 L<YAPC::NA 2013|https://www.youtube.com/watch?v=wFXWV2yY7gE&t=46m05s>.
178 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
182 None yet. Well volunteered? :)
186 Copyright (c) 2012 the Safe::Isa L</AUTHOR> and L</CONTRIBUTORS>
191 This library is free software and may be distributed under the same terms