7 use Scalar::Util 'blessed';
8 use Carp 'confess', 'croak';
13 our $VERSION = '0.55_01';
14 $VERSION = eval $VERSION;
15 our $AUTHORITY = 'cpan:STEVAN';
20 use Moose::Meta::Role;
21 use Moose::Util::TypeConstraints;
24 croak "Roles do not currently support 'extends'";
28 Moose::Util::apply_all_roles( Moose::Meta::Role->initialize(shift), @_ );
32 my $meta = Moose::Meta::Role->initialize(shift);
33 croak "Must specify at least one method" unless @_;
34 $meta->add_required_methods(@_);
38 my $meta = Moose::Meta::Role->initialize(shift);
39 croak "Must specify at least one role" unless @_;
40 $meta->add_excluded_roles(@_);
44 my $meta = Moose::Meta::Role->initialize(shift);
46 croak 'Usage: has \'name\' => ( key => value, ... )' if @_ == 1;
48 my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
49 $meta->add_attribute( $_, %options ) for @$attrs;
53 my $meta = Moose::Meta::Role->initialize(shift);
57 croak "Moose::Role do not currently support "
59 . " references for before method modifiers"
61 $meta->add_before_method_modifier( $_, $code );
66 my $meta = Moose::Meta::Role->initialize(shift);
70 croak "Moose::Role do not currently support "
72 . " references for after method modifiers"
74 $meta->add_after_method_modifier( $_, $code );
79 my $meta = Moose::Meta::Role->initialize(shift);
82 croak "Moose::Role do not currently support "
84 . " references for around method modifiers"
86 $meta->add_around_method_modifier( $_, $code );
90 # see Moose.pm for discussion
92 return unless $Moose::SUPER_BODY;
93 $Moose::SUPER_BODY->(@Moose::SUPER_ARGS);
97 my $meta = Moose::Meta::Role->initialize(shift);
98 my ( $name, $code ) = @_;
99 $meta->add_override_method_modifier( $name, $code );
103 croak "Moose::Role cannot support 'inner'";
107 croak "Moose::Role cannot support 'augment'";
110 my $exporter = Moose::Exporter->setup_import_methods(
112 qw( with requires excludes has before after around override make_immutable )
115 qw( extends super inner augment ),
117 \&Scalar::Util::blessed,
125 my $role = $args{for_class}
127 "Cannot call init_meta without specifying a for_class";
129 my $metaclass = $args{metaclass} || "Moose::Meta::Role";
131 # make a subtype for each Moose class
132 role_type $role unless find_type_constraint($role);
134 # FIXME copy from Moose.pm
136 if ($role->can('meta')) {
137 $meta = $role->meta();
138 (blessed($meta) && $meta->isa('Moose::Meta::Role'))
139 || confess "You already have a &meta function, but it does not return a Moose::Meta::Role";
142 $meta = $metaclass->initialize($role);
146 # re-initialize so it inherits properly
147 $metaclass->initialize( ref($_[0]) || $_[0] );
163 Moose::Role - The Moose Role
168 use Moose::Role; # automatically turns on strict and warnings
173 my ($self, $other) = @_;
174 !$self->equal($other);
177 # ... then in your classes
180 use Moose; # automatically turns on strict and warnings
185 my ($self, $other) = @_;
186 $self->as_float == $other->as_float;
191 Role support in Moose is pretty solid at this point. However, the best
192 documentation is still the the test suite. It is fairly safe to assume Perl 6
193 style behavior and then either refer to the test suite, or ask questions on
194 #moose if something doesn't quite do what you expect.
196 We are planning writing some more documentation in the near future, but nothing
199 =head1 EXPORTED FUNCTIONS
201 Moose::Role currently supports all of the functions that L<Moose> exports, but
202 differs slightly in how some items are handled (see L<CAVEATS> below for
205 Moose::Role also offers two role-specific keyword exports:
209 =item B<requires (@method_names)>
211 Roles can require that certain methods are implemented by any class which
214 =item B<excludes (@role_names)>
216 Roles can C<exclude> other roles, in effect saying "I can never be combined
217 with these C<@role_names>". This is a feature which should not be used
224 Moose::Role offers a way to remove the keywords it exports, through the
225 C<unimport> method. You simply have to say C<no Moose::Role> at the bottom of
226 your code for this to work.
228 =head2 B<< Moose::Role->init_meta(for_class => $role, metaclass => $metaclass) >>
230 The C<init_meta> method sets up the metaclass object for the role
231 specified by C<for_class>. It also injects a a C<meta> accessor into
232 the role so you can get at this object.
234 The default metaclass is L<Moose::Meta::Role>. You can specify an
235 alternate metaclass with the C<metaclass> parameter.
239 Role support has only a few caveats:
245 Roles cannot use the C<extends> keyword; it will throw an exception for now.
246 The same is true of the C<augment> and C<inner> keywords (not sure those
247 really make sense for roles). All other Moose keywords will be I<deferred>
248 so that they can be applied to the consuming class.
252 Role composition does its best to B<not> be order-sensitive when it comes to
253 conflict resolution and requirements detection. However, it is order-sensitive
254 when it comes to method modifiers. All before/around/after modifiers are
255 included whenever a role is composed into a class, and then applied in the order
256 in which the roles are used. This also means that there is no conflict for
257 before/around/after modifiers.
259 In most cases, this will be a non-issue; however, it is something to keep in
260 mind when using method modifiers in a role. You should never assume any
265 The C<requires> keyword currently only works with actual methods. A method
266 modifier (before/around/after and override) will not count as a fufillment
267 of the requirement, and neither will an autogenerated accessor for an attribute.
269 It is likely that attribute accessors will eventually be allowed to fufill those
270 requirements, or we will introduce a C<requires_attr> keyword of some kind
271 instead. This decision has not yet been finalized.
277 All complex software has bugs lurking in it, and this module is no
278 exception. If you find a bug please either email me, or add the bug
283 Stevan Little E<lt>stevan@iinteractive.comE<gt>
285 Christian Hansen E<lt>chansen@cpan.orgE<gt>
287 =head1 COPYRIGHT AND LICENSE
289 Copyright 2006-2008 by Infinity Interactive, Inc.
291 L<http://www.iinteractive.com>
293 This library is free software; you can redistribute it and/or modify
294 it under the same terms as Perl itself.