X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FRole.pm;h=4eedae33e6f49328b37d2e42b44499b5959941f8;hb=87e636262bb48cefaaa4f30504deec928fd38513;hp=ecc016fa596818fd2adddfcf78f5bf99e5513f54;hpb=e46edf94befc235dbaac9636cb98bfa0d817751f;p=gitmo%2FMoose.git diff --git a/lib/Moose/Role.pm b/lib/Moose/Role.pm index ecc016f..4eedae3 100644 --- a/lib/Moose/Role.pm +++ b/lib/Moose/Role.pm @@ -4,92 +4,151 @@ package Moose::Role; use strict; use warnings; -use Scalar::Util (); -use Carp 'confess'; -use Sub::Name 'subname'; +use Scalar::Util 'blessed'; +use Carp 'croak'; -our $VERSION = '0.02'; +use Data::OptList; +use Sub::Exporter; + +our $VERSION = '0.57'; +$VERSION = eval $VERSION; +our $AUTHORITY = 'cpan:STEVAN'; + +use Moose (); +use Moose::Util (); use Moose::Meta::Role; +use Moose::Util::TypeConstraints; + +sub extends { + croak "Roles do not currently support 'extends'"; +} + +sub with { + Moose::Util::apply_all_roles( Moose::Meta::Role->initialize(shift), @_ ); +} + +sub requires { + my $meta = Moose::Meta::Role->initialize(shift); + croak "Must specify at least one method" unless @_; + $meta->add_required_methods(@_); +} + +sub excludes { + my $meta = Moose::Meta::Role->initialize(shift); + croak "Must specify at least one role" unless @_; + $meta->add_excluded_roles(@_); +} + +sub has { + my $meta = Moose::Meta::Role->initialize(shift); + 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; +} + +sub before { + my $meta = Moose::Meta::Role->initialize(shift); + my $code = pop @_; + + for (@_) { + croak "Moose::Role do not currently support " + . ref($_) + . " references for before method modifiers" + if ref $_; + $meta->add_before_method_modifier( $_, $code ); + } +} -sub import { - shift; - my $pkg = caller(); - - # we should never export to main - return if $pkg eq 'main'; - - Moose::Util::TypeConstraints->import($pkg); - - my $meta; - if ($pkg->can('meta')) { - $meta = $pkg->meta(); - (blessed($meta) && $meta->isa('Moose::Meta::Role')) - || confess "Whoops, not møøsey enough"; - } - else { - $meta = Moose::Meta::Role->new(role_name => $pkg); - $meta->_role_meta->add_method('meta' => sub { $meta }) - } - - # NOTE: - # &alias_method will install the method, but it - # will not name it with - - # handle superclasses - $meta->alias_method('extends' => subname 'Moose::Role::extends' => sub { - confess "Moose::Role does not currently support 'extends'" - }); - - # handle roles - $meta->alias_method('with' => subname 'Moose::with' => sub { - my ($role) = @_; - Moose::_load_all_classes($role); - $role->meta->apply($meta); - }); - - # required methods - $meta->alias_method('requires' => subname 'Moose::requires' => sub { - $meta->add_required_methods(@_); - }); - - # handle attributes - $meta->alias_method('has' => subname 'Moose::Role::has' => sub { - my ($name, %options) = @_; - $meta->add_attribute($name, %options) - }); - - # handle method modifers - $meta->alias_method('before' => subname 'Moose::Role::before' => sub { - my $code = pop @_; - $meta->add_before_method_modifier($_, $code) for @_; - }); - $meta->alias_method('after' => subname 'Moose::Role::after' => sub { - my $code = pop @_; - $meta->add_after_method_modifier($_, $code) for @_; - }); - $meta->alias_method('around' => subname 'Moose::Role::around' => sub { - my $code = pop @_; - $meta->add_around_method_modifier($_, $code) for @_; - }); - - $meta->alias_method('super' => subname 'Moose::Role::super' => sub {}); - $meta->alias_method('override' => subname 'Moose::Role::override' => sub { - my ($name, $code) = @_; - $meta->add_override_method_modifier($name, $code); - }); - - $meta->alias_method('inner' => subname 'Moose::Role::inner' => sub { - confess "Moose::Role does not currently support 'inner'"; - }); - $meta->alias_method('augment' => subname 'Moose::Role::augment' => sub { - confess "Moose::Role does not currently support 'augment'"; - }); - - # we recommend using these things - # so export them for them - $meta->alias_method('confess' => \&Carp::confess); - $meta->alias_method('blessed' => \&Scalar::Util::blessed); +sub after { + my $meta = Moose::Meta::Role->initialize(shift); + + my $code = pop @_; + for (@_) { + croak "Moose::Role do not currently support " + . ref($_) + . " references for after method modifiers" + if ref $_; + $meta->add_after_method_modifier( $_, $code ); + } +} + +sub around { + my $meta = Moose::Meta::Role->initialize(shift); + my $code = pop @_; + for (@_) { + croak "Moose::Role do not currently support " + . ref($_) + . " references for around method modifiers" + if ref $_; + $meta->add_around_method_modifier( $_, $code ); + } +} + +# see Moose.pm for discussion +sub super { + return unless $Moose::SUPER_BODY; + $Moose::SUPER_BODY->(@Moose::SUPER_ARGS); +} + +sub override { + my $meta = Moose::Meta::Role->initialize(shift); + my ( $name, $code ) = @_; + $meta->add_override_method_modifier( $name, $code ); +} + +sub inner { + croak "Moose::Role cannot support 'inner'"; +} + +sub augment { + croak "Moose::Role cannot support 'augment'"; +} + +my $exporter = Moose::Exporter->setup_import_methods( + with_caller => [ + qw( with requires excludes has before after around override make_immutable ) + ], + as_is => [ + qw( extends super inner augment ), + \&Carp::confess, + \&Scalar::Util::blessed, + ], +); + +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 $metaclass = $args{metaclass} || "Moose::Meta::Role"; + + # make a subtype for each Moose class + 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"); + } + else { + $meta = $metaclass->initialize($role); + + $meta->add_method( + 'meta' => sub { + # re-initialize so it inherits properly + $metaclass->initialize( ref($_[0]) || $_[0] ); + } + ); + } + + return $meta; } 1; @@ -105,26 +164,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; @@ -132,44 +187,93 @@ Moose::Role - The Moose Role =head1 DESCRIPTION -This is currently a very early release of Perl 6 style Roles for -Moose, it should be considered experimental and incomplete. +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 -This feature is being actively developed, but $work is currently -preventing me from paying as much attention to it as I would like. -So I am releasing it in hopes people will help me on this I. +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). -If you are interested in helping, please come to #moose on irc.perl.org -and we can talk. +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. + +=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. + +=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. + +=head2 B<< Moose::Role->init_meta(for_class => $role, metaclass => $metaclass) >> + +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. + +The default metaclass is L. You can specify an +alternate metaclass with the C parameter. =head1 CAVEATS -Currently, the role support has a number of caveats. They are as follows: +Role support has only a few caveats: =over 4 =item * -At this time classes I consume more than one Role, but they are simply -applied one after another in the order you ask for them. This is incorrect -behavior, the roles should be merged first, and conflicts determined, etc. -However, if your roles do not have any conflicts, then things will work just -fine. +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 * -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. +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. -=back +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. -Basically thats all I can think of for now, I am sure there are more though. +=item * + +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 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. @@ -177,13 +281,15 @@ to cpan-RT. Stevan Little Estevan@iinteractive.comE +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