X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FRole.pm;h=2225690d0a38e1f2db9833bb0d2a5a1b2da96215;hb=1344fd47a7ef94f27fb6535ce07a5c910716e326;hp=bee7fb9ed6160c19765ffe849f003e16c851ae93;hpb=9e93dd19f8c035b497ddc9ed8a8628e66042015e;p=gitmo%2FMoose.git diff --git a/lib/Moose/Role.pm b/lib/Moose/Role.pm index bee7fb9..2225690 100644 --- a/lib/Moose/Role.pm +++ b/lib/Moose/Role.pm @@ -4,13 +4,17 @@ package Moose::Role; use strict; use warnings; -use Scalar::Util (); -use Carp 'confess'; -use Sub::Name 'subname'; +use Scalar::Util 'blessed'; +use Carp 'confess', 'croak'; +use Data::OptList; use Sub::Exporter; -our $VERSION = '0.04'; +our $VERSION = '0.52'; +our $AUTHORITY = 'cpan:STEVAN'; + +use Moose (); +use Moose::Util (); use Moose::Meta::Role; use Moose::Util::TypeConstraints; @@ -22,133 +26,155 @@ use Moose::Util::TypeConstraints; my $role = $CALLER; return $METAS{$role} if exists $METAS{$role}; - + # make a subtype for each Moose class - subtype $role - => as 'Role' - => where { $_->does($role) } - unless find_type_constraint($role); - - my $meta; - if ($role->can('meta')) { - $meta = $role->meta(); - (blessed($meta) && $meta->isa('Moose::Meta::Role')) - || confess "Whoops, not møøsey enough"; - } - else { - $meta = Moose::Meta::Role->new(role_name => $role); - $meta->_role_meta->add_method('meta' => sub { $meta }) - } + role_type $role unless find_type_constraint($role); + + my $meta; + if ($role->can('meta')) { + $meta = $role->meta(); + (blessed($meta) && $meta->isa('Moose::Meta::Role')) + || confess "You already have a &meta function, but it does not return a Moose::Meta::Role"; + } + else { + $meta = Moose::Meta::Role->initialize($role); + $meta->alias_method('meta' => sub { $meta }); + } return $METAS{$role} = $meta; } - - - my %exports = ( + + + my %exports = ( extends => sub { my $meta = _find_meta(); - return subname 'Moose::Role::extends' => sub { - confess "Moose::Role does not currently support 'extends'" - }; - }, - with => sub { - my $meta = _find_meta(); - return subname 'Moose::Role::with' => sub ($;@) { - my (@roles) = @_; - Moose::_load_all_classes(@roles); - ($_->can('meta') && $_->meta->isa('Moose::Meta::Role')) - || confess "You can only consume roles, $_ is not a Moose role" - foreach @roles; - if (scalar @roles == 1) { - $roles[0]->meta->apply($meta); - } - else { - Moose::Meta::Role->combine( - map { $_->meta } @roles - )->apply($meta); - } - }; - }, + return Class::MOP::subname('Moose::Role::extends' => sub { + croak "Roles do not currently support 'extends'" + }); + }, + with => sub { + my $meta = _find_meta(); + return Class::MOP::subname('Moose::Role::with' => sub (@) { + Moose::Util::apply_all_roles($meta, @_) + }); + }, requires => sub { my $meta = _find_meta(); - return subname 'Moose::Role::requires' => sub ($;@) { + return Class::MOP::subname('Moose::Role::requires' => sub (@) { + croak "Must specify at least one method" unless @_; $meta->add_required_methods(@_); - }; - }, + }); + }, excludes => sub { my $meta = _find_meta(); - return subname 'Moose::Role::excludes' => sub ($;@) { + return Class::MOP::subname('Moose::Role::excludes' => sub (@) { + croak "Must specify at least one role" unless @_; $meta->add_excluded_roles(@_); - }; - }, + }); + }, has => sub { my $meta = _find_meta(); - return subname 'Moose::Role::has' => sub ($;%) { - my ($name, %options) = @_; - $meta->add_attribute($name, %options) - }; - }, + return Class::MOP::subname('Moose::Role::has' => sub ($;%) { + my $name = shift; + croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1; + my %options = @_; + my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ]; + $meta->add_attribute( $_, %options ) for @$attrs; + }); + }, before => sub { my $meta = _find_meta(); - return subname 'Moose::Role::before' => sub (@&) { - my $code = pop @_; - $meta->add_before_method_modifier($_, $code) for @_; - }; - }, + return Class::MOP::subname('Moose::Role::before' => sub (@&) { + my $code = pop @_; + do { + croak "Moose::Role do not currently support " + . ref($_) + . " references for before method modifiers" + if ref $_; + $meta->add_before_method_modifier($_, $code) + } for @_; + }); + }, after => sub { my $meta = _find_meta(); - return subname 'Moose::Role::after' => sub (@&) { - my $code = pop @_; - $meta->add_after_method_modifier($_, $code) for @_; - }; - }, + return Class::MOP::subname('Moose::Role::after' => sub (@&) { + my $code = pop @_; + do { + croak "Moose::Role do not currently support " + . ref($_) + . " references for after method modifiers" + if ref $_; + $meta->add_after_method_modifier($_, $code) + } for @_; + }); + }, around => sub { my $meta = _find_meta(); - return subname 'Moose::Role::around' => sub (@&) { - my $code = pop @_; - $meta->add_around_method_modifier($_, $code) for @_; - }; - }, - super => sub { - my $meta = _find_meta(); - return subname 'Moose::Role::super' => sub {}; + return Class::MOP::subname('Moose::Role::around' => sub (@&) { + my $code = pop @_; + do { + croak "Moose::Role do not currently support " + . ref($_) + . " references for around method modifiers" + if ref $_; + $meta->add_around_method_modifier($_, $code) + } for @_; + }); + }, + # see Moose.pm for discussion + super => sub { + return Class::MOP::subname('Moose::Role::super' => sub { + return unless $Moose::SUPER_BODY; $Moose::SUPER_BODY->(@Moose::SUPER_ARGS) + }); }, override => sub { my $meta = _find_meta(); - return subname 'Moose::Role::override' => sub ($&) { + return Class::MOP::subname('Moose::Role::override' => sub ($&) { my ($name, $code) = @_; - $meta->add_override_method_modifier($name, $code); - }; - }, + $meta->add_override_method_modifier($name, $code); + }); + }, inner => sub { my $meta = _find_meta(); - return subname 'Moose::Role::inner' => sub { - confess "Moose::Role does not currently support 'inner'"; - }; - }, + return Class::MOP::subname('Moose::Role::inner' => sub { + croak "Moose::Role cannot support 'inner'"; + }); + }, augment => sub { my $meta = _find_meta(); - return subname 'Moose::Role::augment' => sub { - confess "Moose::Role does not currently support 'augment'"; - }; - }, + return Class::MOP::subname('Moose::Role::augment' => sub { + croak "Moose::Role cannot support 'augment'"; + }); + }, confess => sub { return \&Carp::confess; }, blessed => sub { return \&Scalar::Util::blessed; - } - ); + } + ); - my $exporter = Sub::Exporter::build_exporter({ + my $exporter = Sub::Exporter::build_exporter({ exports => \%exports, groups => { default => [':all'] } }); - + sub import { - $CALLER = caller(); + $CALLER = + ref $_[1] && defined $_[1]->{into} ? $_[1]->{into} + : ref $_[1] + && defined $_[1]->{into_level} ? caller( $_[1]->{into_level} ) + : caller(); + + # this works because both pragmas set $^H (see perldoc perlvar) + # which affects the current compilation - i.e. the file who use'd + # us - which is why we don't need to do anything special to make + # it affect that file rather than this one (which is already compiled) + + strict->import; + warnings->import; # we should never export to main return if $CALLER eq 'main'; @@ -156,6 +182,26 @@ use Moose::Util::TypeConstraints; goto $exporter; }; + sub unimport { + no strict 'refs'; + my $class = Moose::_get_caller(@_); + + # loop through the exports ... + foreach my $name ( keys %exports ) { + + # if we find one ... + if ( defined &{ $class . '::' . $name } ) { + my $keyword = \&{ $class . '::' . $name }; + + # make sure it is from Moose::Role + my ($pkg_name) = Class::MOP::get_code_info($keyword); + next if $pkg_name ne 'Moose::Role'; + + # and if it is from Moose::Role then undef the slot + delete ${ $class . '::' }{$name}; + } + } + } } 1; @@ -171,26 +217,22 @@ Moose::Role - The Moose Role =head1 SYNOPSIS package Eq; - use strict; - use warnings; - use Moose::Role; - + use Moose::Role; # automatically turns on strict and warnings + requires 'equal'; - - sub no_equal { + + sub no_equal { my ($self, $other) = @_; !$self->equal($other); } - + # ... then in your classes - + package Currency; - use strict; - use warnings; - use Moose; - + use Moose; # automatically turns on strict and warnings + with 'Eq'; - + sub equal { my ($self, $other) = @_; $self->as_float == $other->as_float; @@ -198,77 +240,84 @@ Moose::Role - The Moose Role =head1 DESCRIPTION -Role support in Moose is coming along quite well. It's best documentation -is still the the test suite, but 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. More complete -documentation is planned and will be included with the next official -(non-developer) release. +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. + +We are planning writing some more documentation in the near future, but nothing +is ready yet, sorry. =head1 EXPORTED FUNCTIONS -Currently Moose::Role supports all of the functions that L exports, -but differs slightly in how some items are handled (see L below -for details). +Moose::Role currently supports all of the functions that L exports, but +differs slightly in how some items are handled (see L below for +details). -Moose::Role also offers two role specific keyword exports: +Moose::Role also offers two role-specific keyword exports: =over 4 =item B -Roles can require that certain methods are implemented by any class which -C the role. +Roles can require that certain methods are implemented by any class which +C the role. =item B Roles can C other roles, in effect saying "I can never be combined -with these C<@role_names>". This is a feature which should not be used -lightly. +with these C<@role_names>". This is a feature which should not be used +lightly. =back +=head2 B + +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. + =head1 CAVEATS -The role support now has only a few caveats. They are as follows: +Role support has only a few caveats: =over 4 =item * -Roles cannot use the C keyword, it will throw an exception for now. -The same is true of the C and C keywords (not sure those -really make sense for roles). All other Moose keywords will be I -so that they can be applied to the consuming class. +Roles cannot use the C keyword; it will throw an exception for now. +The same is true of the C and C keywords (not sure those +really make sense for roles). All other Moose keywords will be I +so that they can be applied to the consuming class. -=item * +=item * -Role composition does it's best to B be order sensitive when it comes -to conflict resolution and requirements detection. However, it is order -sensitive when it comes to method modifiers. All before/around/after modifiers -are included whenever a role is composed into a class, and then are applied -in the order the roles are used. This too means that there is no conflict for -before/around/after modifiers as well. +Role composition does its best to B be order-sensitive when it comes to +conflict resolution and requirements detection. However, it is order-sensitive +when it comes to method modifiers. All before/around/after modifiers are +included whenever a role is composed into a class, and then applied in the order +in which the roles are used. This also means that there is no conflict for +before/around/after modifiers. -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 +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 fufillment +The C keyword currently only works with actual methods. A method +modifier (before/around/after and override) will not count as a fufillment of the requirement, and neither will an autogenerated accessor for an attribute. -It is likely that the attribute accessors will eventually be allowed to fufill -those requirements, either that or we will introduce a C keyword -of some kind instead. This descision has not yet been finalized. +It is likely that attribute accessors will eventually be allowed to fufill 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 +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. @@ -280,11 +329,11 @@ Christian Hansen Echansen@cpan.orgE =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006-2008 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. +it under the same terms as Perl itself. -=cut \ No newline at end of file +=cut