use strict;
use warnings;
+use Scalar::Util 'blessed';
-our $VERSION = '0.65';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
-
+use Carp qw( croak );
use List::MoreUtils qw( all );
-
-my @Classes = qw( constructor_class destructor_class error_class );
+use List::Util qw( first );
+use Moose::Deprecated;
+use Scalar::Util qw( blessed );
sub apply_metaclass_roles {
- my %options = @_;
+ Moose::Deprecated::deprecated(
+ feature => 'pre-0.94 MetaRole API',
+ message =>
+ 'The old Moose::Util::MetaRole API (before version 0.94) has been deprecated.'
+ . ' Using this API will throw an error in Moose 2.0200.'
+ );
+
+ goto &apply_metaroles;
+}
+
+sub apply_metaroles {
+ my %args = @_;
+
+ _fixup_old_style_args(\%args);
+
+ my $for = _metathing_for( $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 _metathing_for {
+ my $passed = shift;
+
+ my $found
+ = blessed $passed
+ ? $passed
+ : Class::MOP::class_of($passed);
+
+ return $found
+ if defined $found
+ && blessed $found
+ && ( $found->isa('Moose::Meta::Role')
+ || $found->isa('Moose::Meta::Class') );
+
+ local $Carp::CarpLevel = $Carp::CarpLevel + 1;
+
+ my $error_start
+ = 'When using Moose::Util::MetaRole, you must pass a Moose class name,'
+ . ' role name, metaclass object, or metarole object.';
+
+ if ( defined $found && blessed $found ) {
+ croak $error_start
+ . " You passed $passed, and we resolved this to a "
+ . ( blessed $found )
+ . ' object.';
+ }
+
+ if ( defined $passed && !defined $found ) {
+ croak $error_start
+ . " You passed $passed, and this did not resolve to a metaclass or metarole."
+ . ' Maybe you need to call Moose->init_meta to initialize the metaclass first?';
+ }
+
+ if ( !defined $passed ) {
+ croak $error_start
+ . " You passed an undef."
+ . ' Maybe you need to call Moose->init_meta to initialize the metaclass first?';
+ }
+}
+
+sub _fixup_old_style_args {
+ my $args = shift;
+
+ return if $args->{class_metaroles} || $args->{role_metaroles};
+
+ Moose::Deprecated::deprecated(
+ feature => 'pre-0.94 MetaRole API',
+ message =>
+ 'The old Moose::Util::MetaRole API (before version 0.94) has been deprecated.'
+ . ' Using this API will throw an error in Moose 2.0200.'
+ );
+
+ $args->{for} = delete $args->{for_class}
+ if exists $args->{for_class};
+
+ 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
+ );
- my $for = $options{for_class};
+ my $for
+ = blessed $args->{for}
+ ? $args->{for}
+ : Class::MOP::class_of( $args->{for} );
- my %old_classes
- = map { $_ => $for->meta->$_ } grep { $for->meta->can($_) } @Classes;
+ my $top_key;
+ if ( $for->isa('Moose::Meta::Class') ) {
+ $top_key = 'class_metaroles';
- my $meta = _make_new_metaclass( $for, \%options );
+ $args->{class_metaroles}{class} = delete $args->{metaclass_roles}
+ if exists $args->{metaclass_roles};
+ }
+ else {
+ $top_key = 'role_metaroles';
+
+ $args->{role_metaroles}{role} = delete $args->{metaclass_roles}
+ if exists $args->{metaclass_roles};
+ }
- for my $c ( grep { $meta->can($_) } @Classes ) {
- if ( $options{ $c . '_roles' } ) {
- my $class = _make_new_class(
- $meta->$c(),
- $options{ $c . '_roles' }
- );
+ for my $old_key (@old_keys) {
+ my ($new_key) = $old_key =~ /^(.+)_(?:class|metaclass)_roles$/;
- $meta->$c($class);
- }
- else {
- $meta->$c( $old_classes{$c} );
- }
+ $args->{$top_key}{$new_key} = delete $args->{$old_key}
+ if exists $args->{$old_key};
}
- return $meta;
+ return;
}
sub _make_new_metaclass {
my $for = shift;
- my $options = shift;
-
- return $for->meta()
- unless grep { exists $options->{ $_ . '_roles' } }
- qw(
- metaclass
- attribute_metaclass
- method_metaclass
- instance_metaclass
- );
+ my $roles = shift;
+ my $primary = shift;
+
+ return $for unless keys %{$roles};
my $new_metaclass
- = _make_new_class( ref $for->meta(), $options->{metaclass_roles} );
-
- my $old_meta = $for->meta();
-
- # 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
- instance_metaclass
- );
+ = exists $roles->{$primary}
+ ? _make_new_class( ref $for, $roles->{$primary} )
+ : blessed $for;
+
+ my %classes;
+
+ for my $key ( grep { $_ ne $primary } keys %{$roles} ) {
+ my $attr = first {$_}
+ map { $for->meta->find_attribute_by_name($_) } (
+ $key . '_metaclass',
+ $key . '_class'
+ );
- return $new_metaclass->reinitialize( $for, %classes );
+ 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 $meta = $for->meta();
+ my $meta = _metathing_for( $args{for} || $args{for_class} );
+ croak 'You can only apply base class roles to a Moose class, not a role.'
+ if $meta->isa('Moose::Meta::Role');
my $new_base = _make_new_class(
- $for,
- $options{roles},
+ $meta->name,
+ $args{roles},
[ $meta->superclasses() ],
);
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,
1;
-__END__
-
-=head1 NAME
+# ABSTRACT: Apply roles to any metaclass, as well as the object base class
-Moose::Util::MetaRole - Apply roles to any metaclass, as well as the object base class
+__END__
=head1 SYNOPSIS
package MyApp::Moose;
- use strict;
- use warnings;
-
use Moose ();
use Moose::Exporter;
- use Moose::Util::Meta::Role;
+ use Moose::Util::MetaRole;
use MyApp::Role::Meta::Class;
use MyApp::Role::Meta::Method::Constructor;
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
=head1 USAGE
-B<It is very important that you only call this module's functions when
-your module is imported by the caller>. The process of applying roles
-to the metaclass reinitializes the metaclass object, which wipes out
-any existing attributes already defined. However, as long as you do
-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
+The easiest way to use this module is through 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 accepts the following parameters:
+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.
+
+It accepts the following parameters:
=over 4
-=item * for_class => $name
+=item * for => $name
-This specifies the class for which to alter the meta classes.
+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 * metaclass_roles => \@roles
+=item * class_metaroles => \%roles
-=item * attribute_metaclass_roles => \@roles
+This is a hash reference specifying which metaroles will be applied to the
+class metaclass and its contained metaclasses and helper classes.
-=item * method_metaclass_roles => \@roles
+Each key should in turn point to an array reference of role names.
-=item * instance_metaclass_roles => \@roles
+It accepts the following keys:
-=item * constructor_class_roles => \@roles
+=over 8
-=item * destructor_class_roles => \@roles
+=item 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 attribute
-=back
+=item method
-=head2 apply_base_class_roles( for_class => $class, roles => \@roles )
+=item wrapped_method
-This function will apply the specified roles to the object's base class.
+=item instance
-=head1 PROBLEMS WITH METACLASS ROLES AND SUBCLASS
+=item constructor
-Because of the way this module works, there is an ordering problem
-which occurs in certain situations. This sequence of events causes an
-error:
+=item destructor
-=over 4
+=item error
-=item 1.
+=back
-There is a class (ClassA) which uses some extension(s) that apply
-roles to the metaclass.
+=item * role_metaroles => \%roles
-=item 2.
+This is a hash reference specifying which metaroles will be applied to the
+role metaclass and its contained metaclasses and helper classes.
-You have another class (ClassB) which wants to subclass ClassA and
-apply some more extensions.
+It accepts the following keys:
-=back
+=over 8
-Normally, the call to C<extends> will happen at run time, I<after> the
-additional extensions are applied. This causes an error when we try to
-make the metaclass for ClassB compatible with the metaclass for
-ClassA.
+=item role
-We hope to be able to fix this in the future.
+=item attribute
-For now the workaround is for ClassB to make sure it extends ClassA
-I<before> it loads extensions:
+=item method
- package ClassB;
+=item required_method
- use Moose;
+=item conflicting_method
- BEGIN { extends 'ClassA' }
+=item application_to_class
- use MooseX::SomeExtension;
+=item application_to_role
-=head1 AUTHOR
+=item application_to_instance
-Dave Rolsky E<lt>autarch@urth.orgE<gt>
+=item application_role_summation
-=head1 COPYRIGHT AND LICENSE
+=back
-Copyright 2009 by Infinity Interactive, Inc.
+=back
+
+=head2 apply_base_class_roles( for => $class, roles => \@roles )
+
+This function will apply the specified roles to the object's base class.
-L<http://www.iinteractive.com>
+=head1 BUGS
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+See L<Moose/BUGS> for details on reporting bugs.
=cut
projects / gitmo/Moose.git / blobdiff