Fix an issue that breaks a backward compatibility.
[gitmo/Mouse.git] / lib / Mouse / Util.pm
index eb72c43..e86da70 100644 (file)
@@ -1,42 +1,52 @@
 package Mouse::Util;
 use strict;
 use warnings;
-use base qw/Exporter/;
+
+use Exporter;
+
 use Carp qw(confess);
-use B ();
 
+use constant _MOUSE_VERBOSE => !!$ENV{MOUSE_VERBOSE};
+
+our @ISA       = qw(Exporter);
 our @EXPORT_OK = qw(
     find_meta
     does_role
     resolve_metaclass_alias
+    apply_all_roles
+    english_list
 
     load_class
     is_class_loaded
 
-    apply_all_roles
-    not_supported
-
     get_linear_isa
     get_code_info
+
+    not_supported
+
+    does meta dump
+    _MOUSE_VERBOSE
 );
 our %EXPORT_TAGS = (
     all  => \@EXPORT_OK,
+    meta => [qw(does meta dump _MOUSE_VERBOSE)],
 );
 
 # Moose::Util compatible utilities
 
 sub find_meta{
-    return Mouse::Module::class_of( $_[0] );
+    return Mouse::Meta::Module::class_of( $_[0] );
 }
 
 sub does_role{
-    my ($class_or_obj, $role) = @_;\r
-\r
-    my $meta = Mouse::Module::class_of($class_or_obj);\r
-\r
-    return 0 unless defined $meta;\r
-    return 1 if $meta->does_role($role);\r
-    return 0;
+    my ($class_or_obj, $role_name) = @_;
+
+    my $meta = Mouse::Meta::Module::class_of($class_or_obj);
+
+    (defined $role_name)
+        || ($meta || 'Mouse::Meta::Class')->throw_error("You must supply a role name to does()");
+
+    return defined($meta) && $meta->does_role($role_name);
 }
 
 
@@ -85,44 +95,46 @@ BEGIN {
 }
 
 { # taken from Sub::Identify
-    sub get_code_info($) {\r
-        my ($coderef) = @_;\r
-        ref($coderef) or return;\r
+    sub get_code_info($) {
+        my ($coderef) = @_;
+        ref($coderef) or return;
+
+        require B;
 
-        my $cv = B::svref_2object($coderef);\r
+        my $cv = B::svref_2object($coderef);
         $cv->isa('B::CV') or return;
 
-        my $gv = $cv->GV;\r
-        $gv->isa('B::GV') or return;\r
-\r
-        return ($gv->STASH->NAME, $gv->NAME);\r
-    }\r
+        my $gv = $cv->GV;
+        $gv->isa('B::GV') or return;
+
+        return ($gv->STASH->NAME, $gv->NAME);
+    }
 }
 
 # taken from Mouse::Util (0.90)
 {
     my %cache;
 
-    sub resolve_metaclass_alias {\r
-        my ( $type, $metaclass_name, %options ) = @_;\r
-\r
-        my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );\r
+    sub resolve_metaclass_alias {
+        my ( $type, $metaclass_name, %options ) = @_;
+
+        my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
+
+        return $cache{$cache_key}{$metaclass_name} ||= do{
 
-        return $cache{$cache_key}{$metaclass_name} ||= do{\r
-\r
             my $possible_full_name = join '::',
                 'Mouse::Meta', $type, 'Custom', ($options{trait} ? 'Trait' : ()), $metaclass_name
             ;
 
-            my $loaded_class = load_first_existing_class(\r
-                $possible_full_name,\r
-                $metaclass_name\r
-            );\r
-\r
-            $loaded_class->can('register_implementation')\r
-                ? $loaded_class->register_implementation\r
+            my $loaded_class = load_first_existing_class(
+                $possible_full_name,
+                $metaclass_name
+            );
+
+            $loaded_class->can('register_implementation')
+                ? $loaded_class->register_implementation
                 : $loaded_class;
-        };\r
+        };
     }
 }
 
@@ -143,7 +155,6 @@ sub load_first_existing_class {
     my @classes = @_
       or return;
 
-    my $found;
     my %exceptions;
     for my $class (@classes) {
         my $e = _try_load_one_class($class);
@@ -152,12 +163,11 @@ sub load_first_existing_class {
             $exceptions{$class} = $e;
         }
         else {
-            $found = $class;
-            last;
+            return $class;
         }
     }
-    return $found if $found;
 
+    # not found
     confess join(
         "\n",
         map {
@@ -243,7 +253,7 @@ sub apply_all_roles {
         if ($i + 1 < $max && ref($_[$i + 1])) {
             push @roles, [ $_[$i++] => $_[$i] ];
         } else {
-            push @roles, [ $_[$i] => {} ];
+            push @roles, [ $_[$i]   => undef ];
         }
         my $role_name = $roles[-1][0];
         load_class($role_name);
@@ -261,15 +271,48 @@ sub apply_all_roles {
     return;
 }
 
+# taken from Moose::Util 0.90
+sub english_list {
+    return $_[0] if @_ == 1;
+
+    my @items = sort @_;
+
+    return "$items[0] and $items[1]" if @items == 2;
+
+    my $tail = pop @items;
+
+    return join q{, }, @items, "and $tail";
+}
+
+
+# common utilities
+
 sub not_supported{
     my($feature) = @_;
 
     $feature ||= ( caller(1) )[3]; # subroutine name
 
-    local $Carp::CarpLevel = $Carp::CarpLevel + 2;
-    Carp::croak("Mouse does not currently support $feature");
+    local $Carp::CarpLevel = $Carp::CarpLevel + 1;
+    Carp::confess("Mouse does not currently support $feature");
 }
 
+sub meta{
+    return Mouse::Meta::Class->initialize($_[0]);
+}
+
+sub dump { 
+    my($self, $maxdepth) = @_;
+
+    require 'Data/Dumper.pm'; # we don't want to create its namespace
+    my $dd = Data::Dumper->new([$self]);
+    $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 2);
+    $dd->Indent(1);
+    return $dd->Dump();
+}
+
+sub does :method;
+*does = \&does_role; # alias
+
 1;
 
 __END__
@@ -280,9 +323,59 @@ Mouse::Util - features, with or without their dependencies
 
 =head1 IMPLEMENTATIONS FOR
 
-=head2 L<MRO::Compat>
+=head2 Moose::Util
+
+=head3 C<find_meta>
+
+=head3 C<does_role>
+
+=head3 C<resolve_metaclass_alias>
+
+=head3 C<apply_all_roles>
+
+=head3 C<english_list>
+
+=head2 Class::MOP
+
+=head2 C<< is_class_loaded(ClassName) -> Bool >>
+
+Returns whether C<ClassName> is actually loaded or not. It uses a heuristic which
+involves checking for the existence of C<$VERSION>, C<@ISA>, and any
+locally-defined method.
+
+=head3 C<< load_class(ClassName) >>
+
+This will load a given C<ClassName> (or die if it's not loadable).
+This function can be used in place of tricks like
+C<eval "use $module"> or using C<require>.
+
+=head2 MRO::Compat
+
+=head3 C<get_linear_isa>
+
+=head2 Sub::Identify
+
+=head3 C<get_code_info>
+
+=head1 UTILITIES FOR MOUSE
+
+=over 4
+
+=item *
+
+C<not_supported>
+
+=back
+
+=head1 SEE ALSO
+
+L<Moose::Util>
+
+L<Scalar::Util>
+
+L<Sub::Identify>
 
-=head3 get_linear_isa
+L<MRO::Compat>
 
 =cut