Version 1.05
[gitmo/Moose.git] / lib / Moose / Util.pm
index ed914bf..c68503b 100644 (file)
@@ -3,18 +3,19 @@ package Moose::Util;
 use strict;
 use warnings;
 
+use Data::OptList;
 use Sub::Exporter;
 use Scalar::Util 'blessed';
 use Class::MOP   0.60;
 
-our $VERSION   = '0.75';
+our $VERSION   = '1.05';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 my @exports = qw[
-    find_meta 
+    find_meta
     does_role
-    search_class_by_role   
+    search_class_by_role
     ensure_all_roles
     apply_all_roles
     get_all_init_args
@@ -23,6 +24,8 @@ my @exports = qw[
     resolve_metaclass_alias
     add_method_modifier
     english_list
+    meta_attribute_alias
+    meta_class_alias
 ];
 
 Sub::Exporter::setup_exporter({
@@ -40,7 +43,7 @@ sub does_role {
     my ($class_or_obj, $role) = @_;
 
     my $meta = find_meta($class_or_obj);
-    
+
     return unless defined $meta;
     return unless $meta->can('does_role');
     return 1 if $meta->does_role($role);
@@ -48,15 +51,17 @@ sub does_role {
 }
 
 sub search_class_by_role {
-    my ($class_or_obj, $role_name) = @_;
-    
+    my ($class_or_obj, $role) = @_;
+
     my $meta = find_meta($class_or_obj);
 
     return unless defined $meta;
 
+    my $role_name = blessed $role ? $role->name : $role;
+
     foreach my $class ($meta->class_precedence_list) {
-        
-        my $_meta = find_meta($class);        
+
+        my $_meta = find_meta($class);
 
         next unless defined $_meta;
 
@@ -78,7 +83,7 @@ sub ensure_all_roles {
 
 sub apply_all_roles {
     my $applicant = shift;
-    _apply_all_roles($applicant, sub { 1 }, @_);
+    _apply_all_roles($applicant, undef, @_);
 }
 
 sub _apply_all_roles {
@@ -92,30 +97,42 @@ sub _apply_all_roles {
 
     my $roles = Data::OptList::mkopt( [@_] );
 
+    my @role_metas;
     foreach my $role (@$roles) {
-        my $meta = Class::MOP::load_class( $role->[0] );
+        my $meta;
+
+        if ( blessed $role->[0] ) {
+            $meta = $role->[0];
+        }
+        else {
+            Class::MOP::load_class( $role->[0] , $role->[1] );
+            $meta = Class::MOP::class_of( $role->[0] );
+        }
 
-        unless ($meta->isa('Moose::Meta::Role') ) {
+        unless ($meta && $meta->isa('Moose::Meta::Role') ) {
             require Moose;
             Moose->throw_error( "You can only consume roles, "
                     . $role->[0]
                     . " is not a Moose role" );
         }
+
+        push @role_metas, [ $meta, $role->[1] ];
     }
 
-    @$roles = grep { local $_ = $_->[0]; $role_filter->() } @$roles;
+    if ( defined $role_filter ) {
+        @role_metas = grep { local $_ = $_->[0]; $role_filter->() } @role_metas;
+    }
 
-    return unless @$roles;
+    return unless @role_metas;
 
     my $meta = ( blessed $applicant ? $applicant : find_meta($applicant) );
 
-    if ( scalar @$roles == 1 ) {
-        my ( $role, $params ) = @{ $roles->[0] };
-        my $role_meta = Class::MOP::class_of($role);
-        $role_meta->apply( $meta, ( defined $params ? %$params : () ) );
+    if ( scalar @role_metas == 1 ) {
+        my ( $role, $params ) = @{ $role_metas[0] };
+        $role->apply( $meta, ( defined $params ? %$params : () ) );
     }
     else {
-        Moose::Meta::Role->combine( @$roles )->apply($meta);
+        Moose::Meta::Role->combine(@role_metas)->apply($meta);
     }
 }
 
@@ -135,7 +152,7 @@ sub get_all_init_args {
     return +{
         map { $_->init_arg => $_->get_value($instance) }
             grep { $_->has_value($instance) }
-                grep { defined($_->init_arg) } 
+                grep { defined($_->init_arg) }
                     $class->get_all_attributes
     };
 }
@@ -144,6 +161,15 @@ sub resolve_metatrait_alias {
     return resolve_metaclass_alias( @_, trait => 1 );
 }
 
+sub _build_alias_package_name {
+    my ($type, $name, $trait) = @_;
+    return 'Moose::Meta::'
+         . $type
+         . '::Custom::'
+         . ( $trait ? 'Trait::' : '' )
+         . $name;
+}
+
 {
     my %cache;
 
@@ -154,12 +180,9 @@ sub resolve_metatrait_alias {
         return $cache{$cache_key}{$metaclass_name}
             if $cache{$cache_key}{$metaclass_name};
 
-        my $possible_full_name
-            = 'Moose::Meta::' 
-            . $type
-            . '::Custom::'
-            . ( $options{trait} ? "Trait::" : "" )
-            . $metaclass_name;
+        my $possible_full_name = _build_alias_package_name(
+            $type, $metaclass_name, $options{trait}
+        );
 
         my $loaded_class = Class::MOP::load_first_existing_class(
             $possible_full_name,
@@ -175,7 +198,10 @@ sub resolve_metatrait_alias {
 
 sub add_method_modifier {
     my ( $class_or_obj, $modifier_name, $args ) = @_;
-    my $meta                = find_meta($class_or_obj);
+    my $meta
+        = $class_or_obj->can('add_before_method_modifier')
+        ? $class_or_obj
+        : find_meta($class_or_obj);
     my $code                = pop @{$args};
     my $add_modifier_method = 'add_' . $modifier_name . '_method_modifier';
     if ( my $method_modifier_type = ref( @{$args}[0] ) ) {
@@ -186,6 +212,18 @@ sub add_method_modifier {
             $meta->$add_modifier_method( $_->name, $code )
                 for @matched_methods;
         }
+        elsif ($method_modifier_type eq 'ARRAY') {
+            $meta->$add_modifier_method( $_, $code ) for @{$args->[0]};
+        }
+        else {
+            $meta->throw_error(
+                sprintf(
+                    "Methods passed to %s must be provided as a list, arrayref or regex, not %s",
+                    $modifier_name,
+                    $method_modifier_type,
+                )
+            );
+        }
     }
     else {
         $meta->$add_modifier_method( $_, $code ) for @{$args};
@@ -205,6 +243,37 @@ sub english_list {
     return $list;
 }
 
+sub _caller_info {
+    my $level = @_ ? ($_[0] + 1) : 2;
+    my %info;
+    @info{qw(package file line)} = caller($level);
+    return \%info;
+}
+
+sub _create_alias {
+    my ($type, $name, $trait, $for) = @_;
+    my $package = _build_alias_package_name($type, $name, $trait);
+    Class::MOP::Class->initialize($package)->add_method(
+        register_implementation => sub { $for }
+    );
+}
+
+sub meta_attribute_alias {
+    my ($to, $from) = @_;
+    $from ||= caller;
+    my $meta = Class::MOP::class_of($from);
+    my $trait = $meta->isa('Moose::Meta::Role');
+    _create_alias('Attribute', $to, $trait, $from);
+}
+
+sub meta_class_alias {
+    my ($to, $from) = @_;
+    $from ||= caller;
+    my $meta = Class::MOP::class_of($from);
+    my $trait = $meta->isa('Moose::Meta::Role');
+    _create_alias('Class', $to, $trait, $from);
+}
+
 1;
 
 __END__
@@ -241,19 +310,22 @@ some of them may be useful for use in your own code.
 =item B<find_meta($class_or_obj)>
 
 This method takes a class name or object and attempts to find a
-metaclass for the class, if one exists. It will not create one if it
+metaclass for the class, if one exists. It will B<not> create one if it
 does not yet exist.
 
-=item B<does_role($class_or_obj, $role_name)>
+=item B<does_role($class_or_obj, $role_or_obj)>
 
-Returns true if C<$class_or_obj> does the given C<$role_name>.
+Returns true if C<$class_or_obj> does the given C<$role_or_obj>. The role can
+be provided as a name or a L<Moose::Meta::Role> object.
 
-The class must already have a metaclass for this to work.
+The class must already have a metaclass for this to work. If it doesn't, this
+function simply returns false.
 
-=item B<search_class_by_role($class_or_obj, $role_name)>
+=item B<search_class_by_role($class_or_obj, $role_or_obj)>
 
 Returns the first class in the class's precedence list that does
-C<$role_name>, if any.
+C<$role_or_obj>, if any. The role can be either a name or a
+L<Moose::Meta::Role> object.
 
 The class must already have a metaclass for this to work.
 
@@ -264,9 +336,9 @@ applicant can be a role name, class name, or object.
 
 The C<$applicant> must already have a metaclass object.
 
-The list of C<@roles> should be a list of names, each of which can be
-followed by an optional hash reference of options (C<exclude> and
-C<alias>).
+The list of C<@roles> should a list of names or L<Moose::Meta::Role> objects,
+each of which can be followed by an optional hash reference of options
+(C<-excludes> and C<-alias>).
 
 =item B<ensure_all_roles($applicant, @roles)>
 
@@ -298,8 +370,16 @@ when specifying the C<metaclass> or C<traits> option for an attribute:
         metaclass => "Bar",
     );
 
-The name resolution mechanism is covered in L<Moose/Trait Name
-Resolution>.
+The name resolution mechanism is covered in
+L<Moose/Metaclass and Trait Name Resolution>.
+
+=item B<meta_class_alias($to[, $from])>
+
+=item B<meta_attribute_alias($to[, $from])>
+
+Create an alias from the class C<$from> (or the current package, if
+C<$from> is unspecified), so that
+L<Moose/Metaclass and Trait Name Resolution> works properly.
 
 =item B<english_list(@items)>
 
@@ -323,9 +403,7 @@ Here is a list of possible functions to write
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+See L<Moose/BUGS> for details on reporting bugs.
 
 =head1 AUTHOR