X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FRole.pm;h=3cc34671aefd4d172588844ea9ae90e93283ec91;hb=50589f303dc8389624f981cb62a14a76cd6d100a;hp=e1f2b9c3fc19a40e019422ca5b5a00cd7cf282c0;hpb=6549b0d1ae8b084898ac2d8ad60d6a57cccf4124;p=gitmo%2FMoose.git diff --git a/lib/Moose/Role.pm b/lib/Moose/Role.pm index e1f2b9c..3cc3467 100644 --- a/lib/Moose/Role.pm +++ b/lib/Moose/Role.pm @@ -1,19 +1,13 @@ - package Moose::Role; - use strict; use warnings; use Scalar::Util 'blessed'; use Carp 'croak'; +use Class::Load 'is_class_loaded'; -use Data::OptList; use Sub::Exporter; -our $VERSION = '0.67'; -$VERSION = eval $VERSION; -our $AUTHORITY = 'cpan:STEVAN'; - use Moose (); use Moose::Util (); @@ -22,71 +16,54 @@ use Moose::Meta::Role; use Moose::Util::TypeConstraints; sub extends { - croak "Roles do not currently support 'extends'"; + croak "Roles do not support 'extends' (you can use 'with' to specialize a role)"; } sub with { - Moose::Util::apply_all_roles( Moose::Meta::Role->initialize(shift), @_ ); + Moose::Util::apply_all_roles( shift, @_ ); } sub requires { - my $meta = Moose::Meta::Role->initialize(shift); + my $meta = shift; croak "Must specify at least one method" unless @_; $meta->add_required_methods(@_); } sub excludes { - my $meta = Moose::Meta::Role->initialize(shift); + my $meta = shift; croak "Must specify at least one role" unless @_; $meta->add_excluded_roles(@_); } sub has { - my $meta = Moose::Meta::Role->initialize(shift); + my $meta = shift; my $name = shift; croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1; - my %options = @_; + my %context = Moose::Util::_caller_info; + $context{context} = 'has declaration'; + $context{type} = 'role'; + my %options = ( definition_context => \%context, @_ ); my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; $meta->add_attribute( $_, %options ) for @$attrs; } -sub before { - my $meta = Moose::Meta::Role->initialize(shift); - my $code = pop @_; +sub _add_method_modifier { + my $type = shift; + my $meta = shift; - for (@_) { - croak "Roles do not currently support " - . ref($_) - . " references for before method modifiers" - if ref $_; - $meta->add_before_method_modifier( $_, $code ); + if ( ref($_[0]) eq 'Regexp' ) { + croak "Roles do not currently support regex " + . " references for $type method modifiers"; } + + Moose::Util::add_method_modifier($meta, $type, \@_); } -sub after { - my $meta = Moose::Meta::Role->initialize(shift); +sub before { _add_method_modifier('before', @_) } - my $code = pop @_; - for (@_) { - croak "Roles do not currently support " - . ref($_) - . " references for after method modifiers" - if ref $_; - $meta->add_after_method_modifier( $_, $code ); - } -} +sub after { _add_method_modifier('after', @_) } -sub around { - my $meta = Moose::Meta::Role->initialize(shift); - my $code = pop @_; - for (@_) { - croak "Roles do not currently support " - . ref($_) - . " references for around method modifiers" - if ref $_; - $meta->add_around_method_modifier( $_, $code ); - } -} +sub around { _add_method_modifier('around', @_) } # see Moose.pm for discussion sub super { @@ -95,7 +72,7 @@ sub super { } sub override { - my $meta = Moose::Meta::Role->initialize(shift); + my $meta = shift; my ( $name, $code ) = @_; $meta->add_override_method_modifier( $name, $code ); } @@ -109,8 +86,8 @@ sub augment { } Moose::Exporter->setup_import_methods( - with_caller => [ - qw( with requires excludes has before after around override make_immutable ) + with_meta => [ + qw( with requires excludes has before after around override ) ], as_is => [ qw( extends super inner augment ), @@ -123,30 +100,53 @@ sub init_meta { shift; my %args = @_; - my $role = $args{for_class} - or Moose->throw_error("Cannot call init_meta without specifying a for_class"); + my $role = $args{for_class}; + + unless ($role) { + require Moose; + Moose->throw_error("Cannot call init_meta without specifying a for_class"); + } my $metaclass = $args{metaclass} || "Moose::Meta::Role"; + my $meta_name = exists $args{meta_name} ? $args{meta_name} : 'meta'; + + Moose->throw_error("The Metaclass $metaclass must be loaded. (Perhaps you forgot to 'use $metaclass'?)") + unless is_class_loaded($metaclass); - # make a subtype for each Moose class + Moose->throw_error("The Metaclass $metaclass must be a subclass of Moose::Meta::Role.") + unless $metaclass->isa('Moose::Meta::Role'); + + # make a subtype for each Moose role role_type $role unless find_type_constraint($role); - # FIXME copy from Moose.pm my $meta; - if ($role->can('meta')) { - $meta = $role->meta(); - (blessed($meta) && $meta->isa('Moose::Meta::Role')) - || Moose->throw_error("You already have a &meta function, but it does not return a Moose::Meta::Role"); + if ( $meta = Class::MOP::get_metaclass_by_name($role) ) { + unless ( $meta->isa("Moose::Meta::Role") ) { + my $error_message = "$role already has a metaclass, but it does not inherit $metaclass ($meta)."; + if ( $meta->isa('Moose::Meta::Class') ) { + Moose->throw_error($error_message . ' You cannot make the same thing a role and a class. Remove either Moose or Moose::Role.'); + } else { + Moose->throw_error($error_message); + } + } } else { $meta = $metaclass->initialize($role); + } - $meta->add_method( - 'meta' => sub { - # re-initialize so it inherits properly - $metaclass->initialize( ref($_[0]) || $_[0] ); - } - ); + if (defined $meta_name) { + # also check for inherited non moose 'meta' method? + my $existing = $meta->get_method($meta_name); + if ($existing && !$existing->isa('Class::MOP::Method::Meta')) { + Carp::cluck "Moose::Role is overwriting an existing method named " + . "$meta_name in role $role with a method " + . "which returns the class's metaclass. If this is " + . "actually what you want, you should remove the " + . "existing method, otherwise, you should rename or " + . "disable this generated method using the " + . "'-meta_name' option to 'use Moose::Role'."; + } + $meta->_add_meta_method($meta_name); } return $meta; @@ -154,14 +154,12 @@ sub init_meta { 1; +# ABSTRACT: The Moose Role + __END__ =pod -=head1 NAME - -Moose::Role - The Moose Role - =head1 SYNOPSIS package Eq; @@ -186,20 +184,32 @@ Moose::Role - The Moose Role $self->as_float == $other->as_float; } -=head1 DESCRIPTION + # ... and also + + package Comparator; + use Moose; + + has compare_to => ( + is => 'ro', + does => 'Eq', + handles => 'Eq', + ); -Role support in Moose is pretty solid at this point. However, the best -documentation is still the the test suite. It is fairly safe to assume Perl 6 -style behavior and then either refer to the test suite, or ask questions on -#moose if something doesn't quite do what you expect. + # ... which allows -We are planning writing some more documentation in the near future, but nothing -is ready yet, sorry. + my $currency1 = Currency->new(...); + my $currency2 = Currency->new(...); + Comparator->new(compare_to => $currency1)->equal($currency2); + +=head1 DESCRIPTION + +The concept of roles is documented in L. This document +serves as API documentation. =head1 EXPORTED FUNCTIONS Moose::Role currently supports all of the functions that L exports, but -differs slightly in how some items are handled (see L below for +differs slightly in how some items are handled (see L below for details). Moose::Role also offers two role-specific keyword exports: @@ -211,6 +221,9 @@ Moose::Role also offers two role-specific keyword exports: Roles can require that certain methods are implemented by any class which C the role. +Note that attribute accessors also count as methods for the purposes +of satisfying the requirements of a role. + =item B Roles can C other roles, in effect saying "I can never be combined @@ -225,14 +238,35 @@ Moose::Role offers a way to remove the keywords it exports, through the C method. You simply have to say C at the bottom of your code for this to work. -=head2 B<< Moose::Role->init_meta(for_class => $role, metaclass => $metaclass) >> +=head1 METACLASS + +When you use Moose::Role, you can specify traits which will be applied to your +role metaclass: + + use Moose::Role -traits => 'My::Trait'; -The C method sets up the metaclass object for the role -specified by C. It also injects a a C accessor into -the role so you can get at this object. +This is very similar to the attribute traits feature. When you do +this, your class's C object will have the specified traits +applied to it. See L for more +details. -The default metaclass is L. You can specify an -alternate metaclass with the C parameter. +=head1 APPLYING ROLES + +In addition to being applied to a class using the 'with' syntax (see +L) and using the L 'apply_all_roles' +method, roles may also be applied to an instance of a class using +L 'apply_all_roles' or the role's metaclass: + + MyApp::Test::SomeRole->meta->apply( $instance ); + +Doing this creates a new, mutable, anonymous subclass, applies the role to that, +and reblesses. In a debugger, for example, you will see class names of the +form C< Moose::Meta::Class::__ANON__::SERIAL::6 >, which means that doing a +'ref' on your instance may not return what you expect. See L for +'DOES'. + +Additional params may be added to the new instance by providing +'rebless_params'. See L. =head1 CAVEATS @@ -260,37 +294,10 @@ In most cases, this will be a non-issue; however, it is something to keep in mind when using method modifiers in a role. You should never assume any ordering. -=item * - -The C keyword currently only works with actual methods. A method -modifier (before/around/after and override) will not count as a fulfillment -of the requirement, and neither will an autogenerated accessor for an attribute. - -It is likely that attribute accessors will eventually be allowed to fulfill those -requirements, or we will introduce a C keyword of some kind -instead. This decision has not yet been finalized. - =back =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. - -=head1 AUTHOR - -Stevan Little Estevan@iinteractive.comE - -Christian Hansen Echansen@cpan.orgE - -=head1 COPYRIGHT AND LICENSE - -Copyright 2006-2009 by Infinity Interactive, Inc. - -L - -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. +See L for details on reporting bugs. =cut