Version 1.05
[gitmo/Moose.git] / lib / Moose / Util / MetaRole.pm
index fc76de6..b54dd5d 100644 (file)
@@ -2,86 +2,131 @@ package Moose::Util::MetaRole;
 
 use strict;
 use warnings;
+use Scalar::Util 'blessed';
 
-our $VERSION   = '0.74';
+our $VERSION   = '1.05';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use List::MoreUtils qw( all );
-
-my @Classes = qw( constructor_class destructor_class error_class );
+use List::Util qw( first );
 
 sub apply_metaclass_roles {
-    my %options = @_;
+    goto &apply_metaroles;
+}
+
+sub apply_metaroles {
+    my %args = @_;
+
+    _fixup_old_style_args(\%args);
+    Carp::cluck('applying') if $::D;
+    my $for
+        = blessed $args{for}
+        ? $args{for}
+        : Class::MOP::class_of( $args{for} );
+
+    if ( $for->isa('Moose::Meta::Role') ) {
+        return _make_new_metaclass( $for, $args{role_metaroles}, 'role' );
+    }
+    else {
+        return _make_new_metaclass( $for, $args{class_metaroles}, 'class' );
+    }
+}
+
+sub _fixup_old_style_args {
+    my $args = shift;
 
-    my $for = $options{for_class};
+    return if $args->{class_metaroles} || $args->{roles_metaroles};
 
-    my %old_classes = map { $_ => Class::MOP::class_of($for)->$_ }
-                      grep { Class::MOP::class_of($for)->can($_) }
-                      @Classes;
+    $args->{for} = delete $args->{for_class}
+        if exists $args->{for_class};
 
-    my $meta = _make_new_metaclass( $for, \%options );
+    my @old_keys = qw(
+        attribute_metaclass_roles
+        method_metaclass_roles
+        wrapped_method_metaclass_roles
+        instance_metaclass_roles
+        constructor_class_roles
+        destructor_class_roles
+        error_class_roles
+
+        application_to_class_class_roles
+        application_to_role_class_roles
+        application_to_instance_class_roles
+        application_role_summation_class_roles
+    );
 
-    for my $c ( grep { $meta->can($_) } @Classes ) {
-        if ( $options{ $c . '_roles' } ) {
-            my $class = _make_new_class(
-                $meta->$c(),
-                $options{ $c . '_roles' }
-            );
+    my $for
+        = blessed $args->{for}
+        ? $args->{for}
+        : Class::MOP::class_of( $args->{for} );
+
+    my $top_key;
+    if ( $for->isa('Moose::Meta::Class') ) {
+        $top_key = 'class_metaroles';
+
+        $args->{class_metaroles}{class} = delete $args->{metaclass_roles}
+            if exists $args->{metaclass_roles};
+    }
+    else {
+        $top_key = 'role_metaroles';
 
-            $meta->$c($class);
-        }
-        else {
-            $meta->$c( $old_classes{$c} );
-        }
+        $args->{role_metaroles}{role} = delete $args->{metaclass_roles}
+            if exists $args->{metaclass_roles};
     }
 
-    return $meta;
+    for my $old_key (@old_keys) {
+        my ($new_key) = $old_key =~ /^(.+)_(?:class|metaclass)_roles$/;
+
+        $args->{$top_key}{$new_key} = delete $args->{$old_key}
+            if exists $args->{$old_key};
+    }
+
+    return;
 }
 
 sub _make_new_metaclass {
     my $for     = shift;
-    my $options = shift;
-
-    return Class::MOP::class_of($for)
-        unless grep { exists $options->{ $_ . '_roles' } }
-            qw(
-            metaclass
-            attribute_metaclass
-            method_metaclass
-            wrapped_method_metaclass
-            instance_metaclass
-    );
+    my $roles   = shift;
+    my $primary = shift;
+
+    return $for unless keys %{$roles};
 
-    my $old_meta = Class::MOP::class_of($for);
     my $new_metaclass
-        = _make_new_class( ref $old_meta, $options->{metaclass_roles} );
-
-    # This could get called for a Moose::Meta::Role as well as a Moose::Meta::Class
-    my %classes = map {
-        $_ => _make_new_class( $old_meta->$_(), $options->{ $_ . '_roles' } )
-        }
-        grep { $old_meta->can($_) }
-        qw(
-        attribute_metaclass
-        method_metaclass
-        wrapped_method_metaclass
-        instance_metaclass
-    );
+        = exists $roles->{$primary}
+        ? _make_new_class( ref $for, $roles->{$primary} )
+        : blessed $for;
+
+    my %classes;
 
-    return $new_metaclass->reinitialize( $for, %classes );
+    for my $key ( grep { $_ ne $primary } keys %{$roles} ) {
+        my $attr = first {$_}
+            map { $for->meta->find_attribute_by_name($_) } (
+            $key . '_metaclass',
+            $key . '_class'
+        );
+
+        my $reader = $attr->get_read_method;
+
+        $classes{ $attr->init_arg }
+            = _make_new_class( $for->$reader(), $roles->{$key} );
+    }
+
+    my $new_meta = $new_metaclass->reinitialize( $for, %classes );
+
+    return $new_meta;
 }
 
 sub apply_base_class_roles {
-    my %options = @_;
+    my %args = @_;
 
-    my $for = $options{for_class};
+    my $for = $args{for} || $args{for_class};
 
     my $meta = Class::MOP::class_of($for);
 
     my $new_base = _make_new_class(
         $for,
-        $options{roles},
+        $args{roles},
         [ $meta->superclasses() ],
     );
 
@@ -99,7 +144,8 @@ sub _make_new_class {
     my $meta = Class::MOP::Class->initialize($existing_class);
 
     return $existing_class
-        if $meta->can('does_role') && all { $meta->does_role($_) } @{$roles};
+        if $meta->can('does_role') && all  { $meta->does_role($_) }
+                                      grep { !ref $_ } @{$roles};
 
     return Moose::Meta::Class->create_anon_class(
         superclasses => $superclasses,
@@ -120,9 +166,6 @@ Moose::Util::MetaRole - Apply roles to any metaclass, as well as the object base
 
   package MyApp::Moose;
 
-  use strict;
-  use warnings;
-
   use Moose ();
   use Moose::Exporter;
   use Moose::Util::MetaRole;
@@ -135,29 +178,28 @@ Moose::Util::MetaRole - Apply roles to any metaclass, as well as the object base
 
   sub init_meta {
       shift;
-      my %options = @_;
+      my %args = @_;
 
-      Moose->init_meta(%options);
+      Moose->init_meta(%args);
 
-      Moose::Util::MetaRole::apply_metaclass_roles(
-          for_class               => $options{for_class},
-          metaclass_roles         => ['MyApp::Role::Meta::Class'],
-          constructor_class_roles => ['MyApp::Role::Meta::Method::Constructor'],
+      Moose::Util::MetaRole::apply_metaroles(
+          for             => $args{for_class},
+          class_metaroles => {
+              class => => ['MyApp::Role::Meta::Class'],
+              constructor => ['MyApp::Role::Meta::Method::Constructor'],
+          },
       );
 
       Moose::Util::MetaRole::apply_base_class_roles(
-          for_class => $options{for_class},
-          roles     => ['MyApp::Role::Object'],
+          for   => $args{for_class},
+          roles => ['MyApp::Role::Object'],
       );
 
-      return $options{for_class}->meta();
+      return $args{for_class}->meta();
   }
 
 =head1 DESCRIPTION
 
-B<The whole concept behind this module is still considered
-experimental, and it could go away in the future!>
-
 This utility module is designed to help authors of Moose extensions
 write extensions that are able to cooperate with other Moose
 extensions. To do this, you must write your extensions as roles, which
@@ -177,48 +219,97 @@ this when your module is imported, the caller should not have any
 attributes defined yet.
 
 The easiest way to ensure that this happens is to use
-L<Moose::Exporter> and provide an C<init_meta> method that will be
-called when imported.
+L<Moose::Exporter>, which can generate the appropriate C<init_meta>
+method for you, and make sure it is called when imported.
 
 =head1 FUNCTIONS
 
 This module provides two functions.
 
-=head2 apply_metaclass_roles( ... )
+=head2 apply_metaroles( ... )
+
+This function will apply roles to one or more metaclasses for the specified
+class. It will return a new metaclass object for the class or role passed in
+the "for" parameter.
 
-This function will apply roles to one or more metaclasses for the
-specified class. It accepts the following parameters:
+It accepts the following parameters:
 
 =over 4
 
-=item * for_class => $name
+=item * for => $name
+
+This specifies the class or for which to alter the meta classes. This can be a
+package name, or an appropriate meta-object (a L<Moose::Meta::Class> or
+L<Moose::Meta::Role>).
+
+=item * class_metaroles => \%roles
+
+This is a hash reference specifying which metaroles will be applied to the
+class metaclass and its contained metaclasses and helper classes.
+
+Each key should in turn point to an array reference of role names.
+
+It accepts the following keys:
+
+=over 8
+
+=item class
+
+=item attribute
+
+=item method
+
+=item wrapped_method
+
+=item instance
 
-This specifies the class for which to alter the meta classes.
+=item constructor
 
-=item * metaclass_roles => \@roles
+=item destructor
 
-=item * attribute_metaclass_roles => \@roles
+=item error
 
-=item * method_metaclass_roles => \@roles
+=back
+
+=item * role_metaroles => \%roles
+
+This is a hash reference specifying which metaroles will be applied to the
+role metaclass and its contained metaclasses and helper classes.
+
+It accepts the following keys:
+
+=over 8
+
+=item role
+
+=item attribute
 
-=item * wrapped_method_metaclass_roles => \@roles
+=item method
 
-=item * instance_metaclass_roles => \@roles
+=item required_method
 
-=item * constructor_class_roles => \@roles
+=item conflicting_method
 
-=item * destructor_class_roles => \@roles
+=item application_to_class
 
-These parameter all specify one or more roles to be applied to the
-specified metaclass. You can pass any or all of these parameters at
-once.
+=item application_to_role
+
+=item application_to_instance
+
+=item application_role_summation
+
+=back
 
 =back
 
-=head2 apply_base_class_roles( for_class => $class, roles => \@roles )
+=head2 apply_base_class_roles( for => $class, roles => \@roles )
 
 This function will apply the specified roles to the object's base class.
 
+=head1 BUGS
+
+See L<Moose/BUGS> for details on reporting bugs.
+
 =head1 AUTHOR
 
 Dave Rolsky E<lt>autarch@urth.orgE<gt>