Set gitweb
[gitmo/Mouse.git] / lib / Mouse / Util.pm
index 307531a..48cc6c6 100644 (file)
@@ -1,6 +1,8 @@
 package Mouse::Util;
 use Mouse::Exporter; # enables strict and warnings
 
+# Note that those which don't exist here are defined in XS or Mouse::PurePerl
+
 # must be here because it will be refered by other modules loaded
 sub get_linear_isa($;$); ## no critic
 
@@ -38,17 +40,17 @@ BEGIN{
 
             not_supported
 
-            does meta dump
+            does meta throw_error dump
         )],
         groups => {
             default => [], # export no functions by default
 
             # The ':meta' group is 'use metaclass' for Mouse
-            meta    => [qw(does meta dump)],
+            meta    => [qw(does meta dump throw_error)],
         },
     );
 
-    our $VERSION = '0.70';
+    our $VERSION = '0.95';
 
     my $xs = !(defined(&is_valid_class_name) || $ENV{MOUSE_PUREPERL} || $ENV{PERL_ONLY});
 
@@ -67,7 +69,7 @@ BEGIN{
             Mouse::Util->import({ into => 'Mouse::Meta::Method::Accessor::XS'    }, ':meta');
             return 1;
         } || 0;
-        #warn $@ if $@;
+        warn $@ if $@ && $ENV{MOUSE_XS};
     }
 
     if(!$xs){
@@ -75,62 +77,14 @@ BEGIN{
     }
 
     *MOUSE_XS = sub(){ $xs };
-}
-
-use Carp         ();
-use Scalar::Util ();
 
-# aliases as public APIs
-# it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
-require Mouse::Meta::Module; # for the entities of metaclass cache utilities
-
-# aliases
-{
-    *class_of                    = \&Mouse::Meta::Module::_class_of;
-    *get_metaclass_by_name       = \&Mouse::Meta::Module::_get_metaclass_by_name;
-    *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
-    *get_all_metaclass_names     = \&Mouse::Meta::Module::_get_all_metaclass_names;
-
-    *Mouse::load_class           = \&load_class;
-    *Mouse::is_class_loaded      = \&is_class_loaded;
-
-    # is-a predicates
-    #generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
-    #generate_isa_predicate_for('Mouse::Meta::Class'          => 'is_a_metaclass');
-    #generate_isa_predicate_for('Mouse::Meta::Role'           => 'is_a_metarole');
-
-    # duck type predicates
-    generate_can_predicate_for(['_compiled_type_constraint']  => 'is_a_type_constraint');
-    generate_can_predicate_for(['create_anon_class']          => 'is_a_metaclass');
-    generate_can_predicate_for(['create_anon_role']           => 'is_a_metarole');
-}
-
-our $in_global_destruction = 0;
-END{ $in_global_destruction = 1 }
-
-# Moose::Util compatible utilities
-
-sub find_meta{
-    return class_of( $_[0] );
-}
-
-sub does_role{
-    my ($class_or_obj, $role_name) = @_;
-
-    my $meta = 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);
-}
-
-BEGIN {
+    # definition of mro::get_linear_isa()
     my $get_linear_isa;
-    if ($] >= 5.009_005) {
+    if ($] >= 5.010_000) {
         require mro;
         $get_linear_isa = \&mro::get_linear_isa;
-    } else {
+    }
+    else {
         # this code is based on MRO::Compat::__get_linear_isa
         my $_get_linear_isa_dfs; # this recurses so it isn't pretty
         $_get_linear_isa_dfs = sub {
@@ -178,6 +132,53 @@ BEGIN {
     *get_linear_isa = $get_linear_isa;
 }
 
+use Carp         ();
+use Scalar::Util ();
+
+# aliases as public APIs
+# it must be 'require', not 'use', because Mouse::Meta::Module depends on Mouse::Util
+require Mouse::Meta::Module; # for the entities of metaclass cache utilities
+
+# aliases
+{
+    *class_of                    = \&Mouse::Meta::Module::_class_of;
+    *get_metaclass_by_name       = \&Mouse::Meta::Module::_get_metaclass_by_name;
+    *get_all_metaclass_instances = \&Mouse::Meta::Module::_get_all_metaclass_instances;
+    *get_all_metaclass_names     = \&Mouse::Meta::Module::_get_all_metaclass_names;
+
+    *Mouse::load_class           = \&load_class;
+    *Mouse::is_class_loaded      = \&is_class_loaded;
+
+    # is-a predicates
+    #generate_isa_predicate_for('Mouse::Meta::TypeConstraint' => 'is_a_type_constraint');
+    #generate_isa_predicate_for('Mouse::Meta::Class'          => 'is_a_metaclass');
+    #generate_isa_predicate_for('Mouse::Meta::Role'           => 'is_a_metarole');
+
+    # duck type predicates
+    generate_can_predicate_for(['_compiled_type_constraint']  => 'is_a_type_constraint');
+    generate_can_predicate_for(['create_anon_class']          => 'is_a_metaclass');
+    generate_can_predicate_for(['create_anon_role']           => 'is_a_metarole');
+}
+
+our $in_global_destruction = 0;
+END{ $in_global_destruction = 1 }
+
+# Moose::Util compatible utilities
+
+sub find_meta{
+    return class_of( $_[0] );
+}
+
+sub does_role{
+    my ($class_or_obj, $role_name) = @_;
+
+    my $meta = 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);
+}
 
 # taken from Mouse::Util (0.90)
 {
@@ -212,6 +213,7 @@ sub get_code_info;
 sub get_code_package;
 
 sub is_valid_class_name;
+sub is_class_loaded;
 
 # taken from Class/MOP.pm
 sub load_first_existing_class {
@@ -270,33 +272,40 @@ sub load_class {
     return $class;
 }
 
-sub is_class_loaded;
 
 sub apply_all_roles {
     my $consumer = Scalar::Util::blessed($_[0])
-        ?                                shift   # instance
-        : Mouse::Meta::Class->initialize(shift); # class or role name
+        ?                                $_[0]   # instance
+        : Mouse::Meta::Class->initialize($_[0]); # class or role name
 
     my @roles;
 
     # Basis of Data::OptList
     my $max = scalar(@_);
-    for (my $i = 0; $i < $max ; $i++) {
-        if ($i + 1 < $max && ref($_[$i + 1])) {
-            push @roles, [ $_[$i] => $_[++$i] ];
-        } else {
-            push @roles, [ $_[$i] => undef ];
+    for (my $i = 1; $i < $max ; $i++) {
+        my $role = $_[$i];
+        my $role_name;
+        if(ref $role) {
+            $role_name = $role->name;
+        }
+        else {
+            $role_name = $role;
+            load_class($role_name);
+            $role = get_metaclass_by_name($role_name);
         }
-        my $role_name = $roles[-1][0];
-        load_class($role_name);
 
-        is_a_metarole( get_metaclass_by_name($role_name) )
+        if ($i + 1 < $max && ref($_[$i + 1]) eq 'HASH') {
+            push @roles, [ $role => $_[++$i] ];
+        } else {
+            push @roles, [ $role => undef ];
+        }
+        is_a_metarole($role)
             || $consumer->meta->throw_error("You can only consume roles, $role_name is not a Mouse role");
     }
 
     if ( scalar @roles == 1 ) {
-        my ( $role_name, $params ) = @{ $roles[0] };
-        get_metaclass_by_name($role_name)->apply( $consumer, defined $params ? $params : () );
+        my ( $role, $params ) = @{ $roles[0] };
+        $role->apply( $consumer, defined $params ? $params : () );
     }
     else {
         Mouse::Meta::Role->combine(@roles)->apply($consumer);
@@ -326,7 +335,7 @@ sub quoted_english_list {
 sub not_supported{
     my($feature) = @_;
 
-    $feature ||= ( caller(1) )[3]; # subroutine name
+    $feature ||= ( caller(1) )[3] . '()'; # subroutine name
 
     local $Carp::CarpLevel = $Carp::CarpLevel + 1;
     Carp::confess("Mouse does not currently support $feature");
@@ -337,6 +346,22 @@ sub meta :method{
     return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
 }
 
+# general throw_error() method
+# $o->throw_error($msg, depth => $leve, longmess => $croak_or_confess)
+sub throw_error :method {
+    my($self, $message, %args) = @_;
+
+    local $Carp::CarpLevel  = $Carp::CarpLevel + 1 + ($args{depth} || 0);
+    local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
+
+    if(exists $args{longmess} && !$args{longmess}) {
+        Carp::croak($message);
+    }
+    else{
+        Carp::confess($message);
+    }
+}
+
 # general dump() method
 sub dump :method {
     my($self, $maxdepth) = @_;
@@ -346,6 +371,7 @@ sub dump :method {
     $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3);
     $dd->Indent(1);
     $dd->Sortkeys(1);
+    $dd->Quotekeys(0);
     return $dd->Dump();
 }
 
@@ -363,7 +389,7 @@ Mouse::Util - Utilities for working with Mouse classes
 
 =head1 VERSION
 
-This document describes Mouse version 0.70
+This document describes Mouse version 0.95
 
 =head1 SYNOPSIS
 
@@ -417,7 +443,7 @@ C<eval "use $module ()"> or using C<require>.
 
 =head3 C<< Mouse::Util::get_all_metaclass_names() -> (ClassNames) >>
 
-=head2 MRO::Compat
+=head2 mro (or MRO::Compat)
 
 =head3 C<get_linear_isa>
 
@@ -441,6 +467,8 @@ L<Class::MOP>
 
 L<Sub::Identify>
 
+L<mro>
+
 L<MRO::Compat>
 
 =cut