Bump version to 1.9900 for new version numbering scheme
[gitmo/Moose.git] / lib / Moose / Meta / Role.pm
CommitLineData
e185c027 1
2package Moose::Meta::Role;
3
4use strict;
5use warnings;
6use metaclass;
7
21f1e231 8use Scalar::Util 'blessed';
b6a00b82 9use Carp 'confess';
963c24e1 10use Devel::GlobalDestruction 'in_global_destruction';
bdabd620 11
bb8ef151 12our $VERSION = '1.9900';
e606ae5f 13$VERSION = eval $VERSION;
d44714be 14our $AUTHORITY = 'cpan:STEVAN';
e185c027 15
8ee73eeb 16use Moose::Meta::Class;
f785aad8 17use Moose::Meta::Role::Attribute;
39b3bc94 18use Moose::Meta::Role::Method;
d67145ed 19use Moose::Meta::Role::Method::Required;
bb153262 20use Moose::Meta::Role::Method::Conflicting;
699a2e32 21use Moose::Meta::Method::Meta;
f785aad8 22use Moose::Util qw( ensure_all_roles );
d2782813 23use Class::MOP::MiniTrait;
8ee73eeb 24
72276e04 25use base 'Class::MOP::Module',
26 'Class::MOP::Mixin::HasAttributes',
27 'Class::MOP::Mixin::HasMethods';
80572233 28
d2782813 29Class::MOP::MiniTrait::apply(__PACKAGE__, 'Moose::Meta::Object::Trait');
30
fb1e11d5 31## ------------------------------------------------------------------
32## NOTE:
33## I normally don't do this, but I am doing
34## a whole bunch of meta-programmin in this
35## module, so it just makes sense. For a clearer
d03bd989 36## picture of what is going on in the next
37## several lines of code, look at the really
fb1e11d5 38## big comment at the end of this file (right
39## before the POD).
40## - SL
41## ------------------------------------------------------------------
80572233 42
21716c07 43my $META = __PACKAGE__->meta;
44
45## ------------------------------------------------------------------
46## attributes ...
e185c027 47
21716c07 48# NOTE:
49# since roles are lazy, we hold all the attributes
fb1e11d5 50# of the individual role in 'statis' until which
51# time when it is applied to a class. This means
52# keeping a lot of things in hash maps, so we are
21716c07 53# using a little of that meta-programmin' magic
d03bd989 54# here an saving lots of extra typin. And since
fb1e11d5 55# many of these attributes above require similar
56# functionality to support them, so we again use
57# the wonders of meta-programmin' to deliver a
21716c07 58# very compact solution to this normally verbose
59# problem.
60# - SL
61
62foreach my $action (
fb1e11d5 63 {
64 name => 'excluded_roles_map',
65 attr_reader => 'get_excluded_roles_map' ,
21716c07 66 methods => {
fb1e11d5 67 add => 'add_excluded_roles',
55f28f0a 68 get_keys => 'get_excluded_roles_list',
fb1e11d5 69 existence => 'excludes_role',
21716c07 70 }
71 },
fb1e11d5 72 {
73 name => 'required_methods',
21716c07 74 attr_reader => 'get_required_methods_map',
75 methods => {
7c62cb0a 76 remove => 'remove_required_methods',
77 get_values => 'get_required_method_list',
78 existence => 'requires_method',
21716c07 79 }
d03bd989 80 },
21716c07 81) {
fb1e11d5 82
21716c07 83 my $attr_reader = $action->{attr_reader};
84 my $methods = $action->{methods};
fb1e11d5 85
86 # create the attribute
87 $META->add_attribute($action->{name} => (
88 reader => $attr_reader,
89 default => sub { {} }
90 ));
91
92 # create some helper methods
21716c07 93 $META->add_method($methods->{add} => sub {
94 my ($self, @values) = @_;
fb1e11d5 95 $self->$attr_reader->{$_} = undef foreach @values;
21716c07 96 }) if exists $methods->{add};
fb1e11d5 97
55f28f0a 98 $META->add_method($methods->{get_keys} => sub {
21716c07 99 my ($self) = @_;
fb1e11d5 100 keys %{$self->$attr_reader};
55f28f0a 101 }) if exists $methods->{get_keys};
fb1e11d5 102
8a0bfed9 103 $META->add_method($methods->{get_values} => sub {
104 my ($self) = @_;
105 values %{$self->$attr_reader};
106 }) if exists $methods->{get_values};
107
21716c07 108 $META->add_method($methods->{get} => sub {
109 my ($self, $name) = @_;
fb1e11d5 110 $self->$attr_reader->{$name}
111 }) if exists $methods->{get};
112
21716c07 113 $META->add_method($methods->{existence} => sub {
114 my ($self, $name) = @_;
fb1e11d5 115 exists $self->$attr_reader->{$name} ? 1 : 0;
116 }) if exists $methods->{existence};
117
21716c07 118 $META->add_method($methods->{remove} => sub {
119 my ($self, @values) = @_;
120 delete $self->$attr_reader->{$_} foreach @values;
fb1e11d5 121 }) if exists $methods->{remove};
21716c07 122}
d79e62fd 123
b05518b2 124$META->add_attribute(
125 'method_metaclass',
126 reader => 'method_metaclass',
127 default => 'Moose::Meta::Role::Method',
128);
129
77ed8b8d 130$META->add_attribute(
131 'required_method_metaclass',
132 reader => 'required_method_metaclass',
133 default => 'Moose::Meta::Role::Method::Required',
134);
135
eec8ca8a 136$META->add_attribute(
bb153262 137 'conflicting_method_metaclass',
138 reader => 'conflicting_method_metaclass',
139 default => 'Moose::Meta::Role::Method::Conflicting',
eec8ca8a 140);
141
07de7559 142$META->add_attribute(
143 'application_to_class_class',
144 reader => 'application_to_class_class',
145 default => 'Moose::Meta::Role::Application::ToClass',
146);
147
148$META->add_attribute(
149 'application_to_role_class',
150 reader => 'application_to_role_class',
151 default => 'Moose::Meta::Role::Application::ToRole',
152);
153
154$META->add_attribute(
155 'application_to_instance_class',
156 reader => 'application_to_instance_class',
157 default => 'Moose::Meta::Role::Application::ToInstance',
158);
159
d037bb62 160$META->add_attribute(
161 'applied_attribute_metaclass',
162 reader => 'applied_attribute_metaclass',
163 default => 'Moose::Meta::Attribute',
164);
165
f785aad8 166# More or less copied from Moose::Meta::Class
167sub initialize {
168 my $class = shift;
169 my $pkg = shift;
6f73c555 170
171 if (defined(my $meta = Class::MOP::get_metaclass_by_name($pkg))) {
172 return $meta;
173 }
174
175 my %options = @_;
176
177 my $meta = $class->SUPER::initialize(
f785aad8 178 $pkg,
179 'attribute_metaclass' => 'Moose::Meta::Role::Attribute',
6f73c555 180 %options,
181 );
182
183 Class::MOP::weaken_metaclass($pkg) if $options{weaken};
184
185 return $meta;
f785aad8 186}
80572233 187
f785aad8 188sub reinitialize {
21716c07 189 my $self = shift;
f785aad8 190 my $pkg = shift;
191
192 my $meta = blessed $pkg ? $pkg : Class::MOP::class_of($pkg);
193
194 my %existing_classes;
195 if ($meta) {
196 %existing_classes = map { $_ => $meta->$_() } qw(
197 attribute_metaclass
198 method_metaclass
199 wrapped_method_metaclass
200 required_method_metaclass
201 conflicting_method_metaclass
202 application_to_class_class
203 application_to_role_class
204 application_to_instance_class
d037bb62 205 applied_attribute_metaclass
f785aad8 206 );
70ea9161 207 }
f785aad8 208
6f73c555 209 my %options = @_;
210 $options{weaken} = Class::MOP::metaclass_is_weak($meta->name)
211 if !exists $options{weaken}
212 && blessed($meta)
213 && $meta->isa('Moose::Meta::Role');
214
6feff4da 215 # don't need to remove generated metaobjects here yet, since we don't
216 # yet generate anything in roles. this may change in the future though...
217 # keep an eye on that
218 my $new_meta = $self->SUPER::reinitialize(
f785aad8 219 $pkg,
220 %existing_classes,
6f73c555 221 %options,
f785aad8 222 );
6feff4da 223 $new_meta->_restore_metaobjects_from($meta)
224 if $meta && $meta->isa('Moose::Meta::Role');
225 return $new_meta;
226}
227
228sub _restore_metaobjects_from {
229 my $self = shift;
230 my ($old_meta) = @_;
231
232 $self->_restore_metamethods_from($old_meta);
233 $self->_restore_metaattributes_from($old_meta);
f785aad8 234}
235
236sub add_attribute {
237 my $self = shift;
238
239 if (blessed $_[0] && ! $_[0]->isa('Moose::Meta::Role::Attribute') ) {
240 my $class = ref $_[0];
241 Moose->throw_error( "Cannot add a $class as an attribute to a role" );
21716c07 242 }
8c063f8e 243 elsif (!blessed($_[0]) && defined($_[0]) && $_[0] =~ /^\+(.*)/) {
576cd474 244 Moose->throw_error( "has '+attr' is not supported in roles" );
245 }
f785aad8 246
247 return $self->SUPER::add_attribute(@_);
248}
249
250sub _attach_attribute {
251 my ( $self, $attribute ) = @_;
252
253 $attribute->attach_to_role($self);
21716c07 254}
e185c027 255
16d721b3 256sub add_required_methods {
257 my $self = shift;
258
259 for (@_) {
260 my $method = $_;
c9d7e396 261 if (!blessed($method)) {
16d721b3 262 $method = $self->required_method_metaclass->new(
263 name => $method,
264 );
265 }
266 $self->get_required_methods_map->{$method->name} = $method;
267 }
268}
269
bb153262 270sub add_conflicting_method {
09eeab06 271 my $self = shift;
272
273 my $method;
274 if (@_ == 1 && blessed($_[0])) {
275 $method = shift;
276 }
277 else {
bb153262 278 $method = $self->conflicting_method_metaclass->new(@_);
09eeab06 279 }
280
281 $self->add_required_methods($method);
282}
283
21716c07 284## ------------------------------------------------------------------
285## method modifiers
286
21716c07 287# NOTE:
fb1e11d5 288# the before/around/after method modifiers are
21716c07 289# stored by name, but there can be many methods
290# then associated with that name. So again we have
291# lots of similar functionality, so we can do some
292# meta-programmin' and save some time.
293# - SL
294
295foreach my $modifier_type (qw[ before around after ]) {
fb1e11d5 296
297 my $attr_reader = "get_${modifier_type}_method_modifiers_map";
d03bd989 298
fb1e11d5 299 # create the attribute ...
300 $META->add_attribute("${modifier_type}_method_modifiers" => (
301 reader => $attr_reader,
302 default => sub { {} }
d03bd989 303 ));
fb1e11d5 304
305 # and some helper methods ...
21716c07 306 $META->add_method("get_${modifier_type}_method_modifiers" => sub {
307 my ($self, $method_name) = @_;
fb1e11d5 308 #return () unless exists $self->$attr_reader->{$method_name};
d9847263 309 my $mm = $self->$attr_reader->{$method_name};
310 $mm ? @$mm : ();
21716c07 311 });
fb1e11d5 312
21716c07 313 $META->add_method("has_${modifier_type}_method_modifiers" => sub {
314 my ($self, $method_name) = @_;
315 # NOTE:
fb1e11d5 316 # for now we assume that if it exists,..
21716c07 317 # it has at least one modifier in it
318 (exists $self->$attr_reader->{$method_name}) ? 1 : 0;
fb1e11d5 319 });
320
21716c07 321 $META->add_method("add_${modifier_type}_method_modifier" => sub {
322 my ($self, $method_name, $method) = @_;
fb1e11d5 323
324 $self->$attr_reader->{$method_name} = []
21716c07 325 unless exists $self->$attr_reader->{$method_name};
fb1e11d5 326
21716c07 327 my $modifiers = $self->$attr_reader->{$method_name};
fb1e11d5 328
21716c07 329 # NOTE:
fb1e11d5 330 # check to see that we aren't adding the
331 # same code twice. We err in favor of the
21716c07 332 # first on here, this may not be as expected
333 foreach my $modifier (@{$modifiers}) {
334 return if $modifier == $method;
335 }
fb1e11d5 336
21716c07 337 push @{$modifiers} => $method;
338 });
fb1e11d5 339
21716c07 340}
1331430a 341
21716c07 342## ------------------------------------------------------------------
343## override method mofidiers
0558683c 344
fb1e11d5 345$META->add_attribute('override_method_modifiers' => (
346 reader => 'get_override_method_modifiers_map',
347 default => sub { {} }
348));
349
21716c07 350# NOTE:
fb1e11d5 351# these are a little different because there
21716c07 352# can only be one per name, whereas the other
353# method modifiers can have multiples.
354# - SL
0558683c 355
21716c07 356sub add_override_method_modifier {
357 my ($self, $method_name, $method) = @_;
358 (!$self->has_method($method_name))
c245d69b 359 || Moose->throw_error("Cannot add an override of method '$method_name' " .
4c0b3599 360 "because there is a local version of '$method_name'");
fb1e11d5 361 $self->get_override_method_modifiers_map->{$method_name} = $method;
21716c07 362}
0558683c 363
21716c07 364sub has_override_method_modifier {
365 my ($self, $method_name) = @_;
366 # NOTE:
fb1e11d5 367 # for now we assume that if it exists,..
21716c07 368 # it has at least one modifier in it
fb1e11d5 369 (exists $self->get_override_method_modifiers_map->{$method_name}) ? 1 : 0;
21716c07 370}
0558683c 371
21716c07 372sub get_override_method_modifier {
373 my ($self, $method_name) = @_;
fb1e11d5 374 $self->get_override_method_modifiers_map->{$method_name};
21716c07 375}
0558683c 376
21716c07 377## general list accessor ...
80572233 378
21716c07 379sub get_method_modifier_list {
380 my ($self, $modifier_type) = @_;
fb1e11d5 381 my $accessor = "get_${modifier_type}_method_modifiers_map";
21716c07 382 keys %{$self->$accessor};
383}
e185c027 384
699a2e32 385sub _meta_method_class { 'Moose::Meta::Method::Meta' }
e606ae5f 386
21716c07 387## ------------------------------------------------------------------
80572233 388## subroles
389
278ca49c 390$META->add_attribute('roles' => (
21716c07 391 reader => 'get_roles',
392 default => sub { [] }
393));
394
80572233 395sub add_role {
396 my ($self, $role) = @_;
397 (blessed($role) && $role->isa('Moose::Meta::Role'))
c245d69b 398 || Moose->throw_error("Roles must be instances of Moose::Meta::Role");
80572233 399 push @{$self->get_roles} => $role;
e606ae5f 400 $self->reset_package_cache_flag;
80572233 401}
402
b8aeb4dc 403sub calculate_all_roles {
404 my $self = shift;
405 my %seen;
fb1e11d5 406 grep {
407 !$seen{$_->name}++
408 } ($self, map {
409 $_->calculate_all_roles
410 } @{ $self->get_roles });
b8aeb4dc 411}
412
80572233 413sub does_role {
560c498d 414 my ($self, $role) = @_;
415 (defined $role)
c245d69b 416 || Moose->throw_error("You must supply a role name to look for");
560c498d 417 my $role_name = blessed $role ? $role->name : $role;
bdabd620 418 # if we are it,.. then return true
419 return 1 if $role_name eq $self->name;
420 # otherwise.. check our children
80572233 421 foreach my $role (@{$self->get_roles}) {
bdabd620 422 return 1 if $role->does_role($role_name);
80572233 423 }
424 return 0;
425}
426
1db8ecc7 427sub find_method_by_name { (shift)->get_method(@_) }
093b12c2 428
21716c07 429## ------------------------------------------------------------------
fb1e11d5 430## role construction
21716c07 431## ------------------------------------------------------------------
e185c027 432
21716c07 433sub apply {
f315aab3 434 my ($self, $other, %args) = @_;
bca01282 435
436 (blessed($other))
c245d69b 437 || Moose->throw_error("You must pass in an blessed instance");
d03bd989 438
07de7559 439 my $application_class;
1c9db35c 440 if ($other->isa('Moose::Meta::Role')) {
07de7559 441 $application_class = $self->application_to_role_class;
1c9db35c 442 }
443 elsif ($other->isa('Moose::Meta::Class')) {
07de7559 444 $application_class = $self->application_to_class_class;
d03bd989 445 }
1c9db35c 446 else {
07de7559 447 $application_class = $self->application_to_instance_class;
d03bd989 448 }
07de7559 449
450 Class::MOP::load_class($application_class);
4c52e860 451
452 my $deprecation_check = 0;
453
454 if ( exists $args{excludes} && !exists $args{'-excludes'} ) {
455 $args{'-excludes'} = delete $args{excludes};
456 $deprecation_check = 1;
457 }
458 if ( exists $args{alias} && !exists $args{'-alias'} ) {
459 $args{'-alias'} = delete $args{alias};
460 $deprecation_check = 1;
461 }
462
463 if ( $deprecation_check ) {
4c52e860 464 Moose::Deprecated::deprecated(
465 feature => 'alias or excludes',
466 message =>
467 'The alias and excludes options for role application'.
468 ' have been renamed -alias and -excludes'.
469 " (${\$other->name} is consuming ${\$self->name}".
470 " - do you need to upgrade ${\$other->name}?)"
471 );
472 }
473
474 if ( exists $args{'-excludes'} ) {
4c52e860 475 # I wish we had coercion here :)
476 $args{'-excludes'} = (
477 ref $args{'-excludes'} eq 'ARRAY'
478 ? $args{'-excludes'}
479 : [ $args{'-excludes'} ]
480 );
481 }
482
f315aab3 483 return $application_class->new(%args)->apply($self, $other, \%args);
0558683c 484}
485
4701ceff 486sub composition_class_roles { }
487
21716c07 488sub combine {
a4e516f6 489 my ($class, @role_specs) = @_;
d03bd989 490
d03bd989 491 require Moose::Meta::Role::Composite;
492
28412c0b 493 my (@roles, %role_params);
494 while (@role_specs) {
560c498d 495 my ($role, $params) = @{ splice @role_specs, 0, 1 };
496 my $requested_role
497 = blessed $role
498 ? $role
499 : Class::MOP::class_of($role);
31d96c3e 500
6bdef412 501 my $actual_role = $requested_role->_role_for_combination($params);
31d96c3e 502 push @roles => $actual_role;
503
28412c0b 504 next unless defined $params;
31d96c3e 505 $role_params{$actual_role->name} = $params;
28412c0b 506 }
d03bd989 507
fb1e11d5 508 my $c = Moose::Meta::Role::Composite->new(roles => \@roles);
7071e2cb 509 return $c->apply_params(\%role_params);
0558683c 510}
511
6bdef412 512sub _role_for_combination {
436d7a28 513 my ($self, $params) = @_;
514 return $self;
515}
516
b6a00b82 517sub create {
2d5f3fab 518 my ( $role, $package_name, %options ) = @_;
b6a00b82 519
2d5f3fab 520 $options{package} = $package_name;
b6a00b82 521
522 (ref $options{attributes} eq 'HASH')
523 || confess "You must pass a HASH ref of attributes"
524 if exists $options{attributes};
525
526 (ref $options{methods} eq 'HASH')
527 || confess "You must pass a HASH ref of methods"
528 if exists $options{methods};
529
2937ed18 530 $options{meta_name} = 'meta'
531 unless exists $options{meta_name};
532
2d5f3fab 533 my (%initialize_options) = %options;
b6a00b82 534 delete @initialize_options{qw(
535 package
536 attributes
537 methods
2937ed18 538 meta_name
b6a00b82 539 version
540 authority
541 )};
542
543 my $meta = $role->initialize( $package_name => %initialize_options );
544
6a4a7c31 545 $meta->_instantiate_module( $options{version}, $options{authority} );
546
2937ed18 547 $meta->_add_meta_method($options{meta_name})
548 if defined $options{meta_name};
b6a00b82 549
550 if (exists $options{attributes}) {
551 foreach my $attribute_name (keys %{$options{attributes}}) {
552 my $attr = $options{attributes}->{$attribute_name};
f785aad8 553 $meta->add_attribute(
554 $attribute_name => blessed $attr ? $attr : %{$attr} );
b6a00b82 555 }
556 }
557
558 if (exists $options{methods}) {
559 foreach my $method_name (keys %{$options{methods}}) {
560 $meta->add_method($method_name, $options{methods}->{$method_name});
561 }
562 }
563
564 return $meta;
565}
566
c23885b1 567sub consumers {
568 my $self = shift;
569 my @consumers;
570 for my $meta (Class::MOP::get_all_metaclass_instances) {
571 next if $meta->name eq $self->name;
572 next unless $meta->isa('Moose::Meta::Class')
573 || $meta->isa('Moose::Meta::Role');
574 push @consumers, $meta->name
575 if $meta->does_role($self->name);
576 }
577 return @consumers;
578}
579
c9ee520d 580# anonymous roles. most of it is copied straight out of Class::MOP::Class.
581# an intrepid hacker might find great riches if he unifies this code with that
582# code in Class::MOP::Module or Class::MOP::Package
583{
584 # NOTE:
585 # this should be sufficient, if you have a
586 # use case where it is not, write a test and
587 # I will change it.
588 my $ANON_ROLE_SERIAL = 0;
589
590 # NOTE:
591 # we need a sufficiently annoying prefix
592 # this should suffice for now, this is
593 # used in a couple of places below, so
594 # need to put it up here for now.
595 my $ANON_ROLE_PREFIX = 'Moose::Meta::Role::__ANON__::SERIAL::';
596
597 sub is_anon_role {
598 my $self = shift;
599 no warnings 'uninitialized';
600 $self->name =~ /^$ANON_ROLE_PREFIX/;
601 }
602
603 sub create_anon_role {
604 my ($role, %options) = @_;
6f73c555 605 $options{weaken} = 1 unless exists $options{weaken};
c9ee520d 606 my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL;
607 return $role->create($package_name, %options);
608 }
609
610 # NOTE:
611 # this will only get called for
612 # anon-roles, all other calls
613 # are assumed to occur during
614 # global destruction and so don't
615 # really need to be handled explicitly
616 sub DESTROY {
617 my $self = shift;
618
963c24e1 619 return if in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated
c9ee520d 620
621 no warnings 'uninitialized';
622 return unless $self->name =~ /^$ANON_ROLE_PREFIX/;
623
624 # XXX: is this necessary for us? I don't understand what it's doing
625 # -sartak
626
627 # Moose does a weird thing where it replaces the metaclass for
628 # class when fixing metaclass incompatibility. In that case,
629 # we don't want to clean out the namespace now. We can detect
630 # that because Moose will explicitly update the singleton
631 # cache in Class::MOP.
632 #my $current_meta = Class::MOP::get_metaclass_by_name($self->name);
633 #return if $current_meta ne $self;
634
635 my ($serial_id) = ($self->name =~ /^$ANON_ROLE_PREFIX(\d+)/);
636 no strict 'refs';
637 foreach my $key (keys %{$ANON_ROLE_PREFIX . $serial_id}) {
638 delete ${$ANON_ROLE_PREFIX . $serial_id}{$key};
639 }
640 delete ${'main::' . $ANON_ROLE_PREFIX}{$serial_id . '::'};
641 }
642}
643
fb1e11d5 644#####################################################################
645## NOTE:
d03bd989 646## This is Moose::Meta::Role as defined by Moose (plus the use of
647## MooseX::AttributeHelpers module). It is here as a reference to
fb1e11d5 648## make it easier to see what is happening above with all the meta
649## programming. - SL
650#####################################################################
651#
652# has 'roles' => (
a40b446a 653# metaclass => 'Array',
fb1e11d5 654# reader => 'get_roles',
764a7831 655# isa => 'ArrayRef[Moose::Meta::Role]',
fb1e11d5 656# default => sub { [] },
657# provides => {
658# 'push' => 'add_role',
659# }
660# );
d03bd989 661#
fb1e11d5 662# has 'excluded_roles_map' => (
a40b446a 663# metaclass => 'Hash',
fb1e11d5 664# reader => 'get_excluded_roles_map',
665# isa => 'HashRef[Str]',
666# provides => {
667# # Not exactly set, cause it sets multiple
668# 'set' => 'add_excluded_roles',
669# 'keys' => 'get_excluded_roles_list',
670# 'exists' => 'excludes_role',
671# }
672# );
d03bd989 673#
fb1e11d5 674# has 'required_methods' => (
a40b446a 675# metaclass => 'Hash',
fb1e11d5 676# reader => 'get_required_methods_map',
72264f10 677# isa => 'HashRef[Moose::Meta::Role::Method::Required]',
d03bd989 678# provides => {
679# # not exactly set, or delete since it works for multiple
fb1e11d5 680# 'set' => 'add_required_methods',
681# 'delete' => 'remove_required_methods',
682# 'keys' => 'get_required_method_list',
d03bd989 683# 'exists' => 'requires_method',
fb1e11d5 684# }
685# );
d03bd989 686#
687# # the before, around and after modifiers are
688# # HASH keyed by method-name, with ARRAY of
fb1e11d5 689# # CODE refs to apply in that order
d03bd989 690#
fb1e11d5 691# has 'before_method_modifiers' => (
a40b446a 692# metaclass => 'Hash',
fb1e11d5 693# reader => 'get_before_method_modifiers_map',
694# isa => 'HashRef[ArrayRef[CodeRef]]',
695# provides => {
696# 'keys' => 'get_before_method_modifiers',
d03bd989 697# 'exists' => 'has_before_method_modifiers',
698# # This actually makes sure there is an
fb1e11d5 699# # ARRAY at the given key, and pushed onto
700# # it. It also checks for duplicates as well
d03bd989 701# # 'add' => 'add_before_method_modifier'
702# }
fb1e11d5 703# );
d03bd989 704#
fb1e11d5 705# has 'after_method_modifiers' => (
a40b446a 706# metaclass => 'Hash',
fb1e11d5 707# reader =>'get_after_method_modifiers_map',
708# isa => 'HashRef[ArrayRef[CodeRef]]',
709# provides => {
710# 'keys' => 'get_after_method_modifiers',
d03bd989 711# 'exists' => 'has_after_method_modifiers',
712# # This actually makes sure there is an
fb1e11d5 713# # ARRAY at the given key, and pushed onto
d03bd989 714# # it. It also checks for duplicates as well
715# # 'add' => 'add_after_method_modifier'
716# }
fb1e11d5 717# );
d03bd989 718#
fb1e11d5 719# has 'around_method_modifiers' => (
a40b446a 720# metaclass => 'Hash',
fb1e11d5 721# reader =>'get_around_method_modifiers_map',
722# isa => 'HashRef[ArrayRef[CodeRef]]',
723# provides => {
724# 'keys' => 'get_around_method_modifiers',
d03bd989 725# 'exists' => 'has_around_method_modifiers',
726# # This actually makes sure there is an
fb1e11d5 727# # ARRAY at the given key, and pushed onto
d03bd989 728# # it. It also checks for duplicates as well
729# # 'add' => 'add_around_method_modifier'
730# }
fb1e11d5 731# );
d03bd989 732#
fb1e11d5 733# # override is similar to the other modifiers
734# # except that it is not an ARRAY of code refs
735# # but instead just a single name->code mapping
d03bd989 736#
fb1e11d5 737# has 'override_method_modifiers' => (
a40b446a 738# metaclass => 'Hash',
fb1e11d5 739# reader =>'get_override_method_modifiers_map',
d03bd989 740# isa => 'HashRef[CodeRef]',
fb1e11d5 741# provides => {
742# 'keys' => 'get_override_method_modifier',
d03bd989 743# 'exists' => 'has_override_method_modifier',
744# 'add' => 'add_override_method_modifier', # checks for local method ..
fb1e11d5 745# }
746# );
d03bd989 747#
fb1e11d5 748#####################################################################
749
750
e185c027 7511;
752
753__END__
754
755=pod
756
757=head1 NAME
758
759Moose::Meta::Role - The Moose Role metaclass
760
761=head1 DESCRIPTION
762
705d4cfd 763This class is a subclass of L<Class::MOP::Module> that provides
764additional Moose-specific functionality.
765
766It's API looks a lot like L<Moose::Meta::Class>, but internally it
767implements many things differently. This may change in the future.
79592a54 768
cf3bb5c5 769=head1 INHERITANCE
770
771C<Moose::Meta::Role> is a subclass of L<Class::MOP::Module>.
772
e185c027 773=head1 METHODS
774
705d4cfd 775=head2 Construction
776
e185c027 777=over 4
778
705d4cfd 779=item B<< Moose::Meta::Role->initialize($role_name) >>
e185c027 780
705d4cfd 781This method creates a new role object with the provided name.
e185c027 782
705d4cfd 783=item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >>
78cd1d3b 784
705d4cfd 785This method accepts a list of array references. Each array reference
560c498d 786should contain a role name or L<Moose::Meta::Role> object as its first element. The second element is
c8b8d92f 787an optional hash reference. The hash reference can contain C<-excludes>
788and C<-alias> keys to control how methods are composed from the role.
e606ae5f 789
705d4cfd 790The return value is a new L<Moose::Meta::Role::Composite> that
791represents the combined roles.
db1ab48d 792
4701ceff 793=item B<< $metarole->composition_class_roles >>
794
795When combining multiple roles using C<combine>, this method is used to obtain a
796list of role names to be applied to the L<Moose::Meta::Role::Composite>
797instance returned by C<combine>. The default implementation returns an empty
798list. Extensions that need to hook into role combination may wrap this method
799to return additional role names.
800
705d4cfd 801=item B<< Moose::Meta::Role->create($name, %options) >>
e185c027 802
705d4cfd 803This method is identical to the L<Moose::Meta::Class> C<create>
804method.
805
806=item B<< Moose::Meta::Role->create_anon_role >>
e185c027 807
705d4cfd 808This method is identical to the L<Moose::Meta::Class>
809C<create_anon_class> method.
e185c027 810
705d4cfd 811=item B<< $metarole->is_anon_role >>
e185c027 812
705d4cfd 813Returns true if the role is an anonymous role.
e185c027 814
c23885b1 815=item B<< $metarole->consumers >>
816
817Returns a list of names of classes and roles which consume this role.
818
e185c027 819=back
820
705d4cfd 821=head2 Role application
822
e185c027 823=over 4
824
705d4cfd 825=item B<< $metarole->apply( $thing, @options ) >>
80572233 826
705d4cfd 827This method applies a role to the given C<$thing>. That can be another
828L<Moose::Meta::Role>, object, a L<Moose::Meta::Class> object, or a
829(non-meta) object instance.
80572233 830
705d4cfd 831The options are passed directly to the constructor for the appropriate
832L<Moose::Meta::Role::Application> subclass.
80572233 833
d05235e1 834Note that this will apply the role even if the C<$thing> in question already
835C<does> this role. L<Moose::Util/does_role> is a convenient wrapper for
836finding out if role application is necessary.
837
80572233 838=back
839
705d4cfd 840=head2 Roles and other roles
841
80572233 842=over 4
843
705d4cfd 844=item B<< $metarole->get_roles >>
d79e62fd 845
705d4cfd 846This returns an array reference of roles which this role does. This
847list may include duplicates.
d79e62fd 848
705d4cfd 849=item B<< $metarole->calculate_all_roles >>
d79e62fd 850
705d4cfd 851This returns a I<unique> list of all roles that this role does, and
852all the roles that its roles do.
d79e62fd 853
560c498d 854=item B<< $metarole->does_role($role) >>
2b14ac61 855
560c498d 856Given a role I<name> or L<Moose::Meta::Role> object, returns true if this role
857does the given role.
d79e62fd 858
705d4cfd 859=item B<< $metarole->add_role($role) >>
d79e62fd 860
705d4cfd 861Given a L<Moose::Meta::Role> object, this adds the role to the list of
862roles that the role does.
68efb014 863
705d4cfd 864=item B<< $metarole->get_excluded_roles_list >>
be4427d0 865
705d4cfd 866Returns a list of role names which this role excludes.
e185c027 867
705d4cfd 868=item B<< $metarole->excludes_role($role_name) >>
e185c027 869
705d4cfd 870Given a role I<name>, returns true if this role excludes the named
871role.
e606ae5f 872
705d4cfd 873=item B<< $metarole->add_excluded_roles(@role_names) >>
e606ae5f 874
705d4cfd 875Given one or more role names, adds those roles to the list of excluded
876roles.
bdabd620 877
705d4cfd 878=back
e185c027 879
705d4cfd 880=head2 Methods
093b12c2 881
705d4cfd 882The methods for dealing with a role's methods are all identical in API
883and behavior to the same methods in L<Class::MOP::Class>.
638853cb 884
705d4cfd 885=over 4
53dd42d8 886
705d4cfd 887=item B<< $metarole->method_metaclass >>
e185c027 888
705d4cfd 889Returns the method metaclass name for the role. This defaults to
890L<Moose::Meta::Role::Method>.
e185c027 891
705d4cfd 892=item B<< $metarole->get_method($name) >>
e185c027 893
705d4cfd 894=item B<< $metarole->has_method($name) >>
e185c027 895
705d4cfd 896=item B<< $metarole->add_method( $name, $body ) >>
e185c027 897
705d4cfd 898=item B<< $metarole->get_method_list >>
e185c027 899
705d4cfd 900=item B<< $metarole->find_method_by_name($name) >>
901
902These methods are all identical to the methods of the same name in
8f6cbfcd 903L<Class::MOP::Package>
e185c027 904
905=back
906
705d4cfd 907=head2 Attributes
908
909As with methods, the methods for dealing with a role's attribute are
910all identical in API and behavior to the same methods in
911L<Class::MOP::Class>.
912
913However, attributes stored in this class are I<not> stored as
914objects. Rather, the attribute definition is stored as a hash
915reference. When a role is composed into a class, this hash reference
916is passed directly to the metaclass's C<add_attribute> method.
917
918This is quite likely to change in the future.
919
e185c027 920=over 4
921
705d4cfd 922=item B<< $metarole->get_attribute($attribute_name) >>
923
924=item B<< $metarole->has_attribute($attribute_name) >>
1331430a 925
705d4cfd 926=item B<< $metarole->get_attribute_list >>
1331430a 927
705d4cfd 928=item B<< $metarole->add_attribute($name, %options) >>
1331430a 929
705d4cfd 930=item B<< $metarole->remove_attribute($attribute_name) >>
1331430a 931
932=back
933
705d4cfd 934=head2 Required methods
935
0558683c 936=over 4
937
705d4cfd 938=item B<< $metarole->get_required_method_list >>
0558683c 939
705d4cfd 940Returns the list of methods required by the role.
0558683c 941
705d4cfd 942=item B<< $metarole->requires_method($name) >>
0558683c 943
705d4cfd 944Returns true if the role requires the named method.
0558683c 945
0ecff16b 946=item B<< $metarole->add_required_methods(@names) >>
0558683c 947
b3c1586a 948Adds the named methods to the role's list of required methods.
0558683c 949
705d4cfd 950=item B<< $metarole->remove_required_methods(@names) >>
0558683c 951
2dda1d28 952Removes the named methods from the role's list of required methods.
0558683c 953
bb153262 954=item B<< $metarole->add_conflicting_method(%params) >>
09eeab06 955
bb153262 956Instantiate the parameters as a L<Moose::Meta::Role::Method::Conflicting>
09eeab06 957object, then add it to the required method list.
958
705d4cfd 959=back
960
961=head2 Method modifiers
0558683c 962
fa907f2e 963These methods act like their counterparts in L<Class::MOP::Class> and
705d4cfd 964L<Moose::Meta::Class>.
965
966However, method modifiers are simply stored internally, and are not
967applied until the role itself is applied to a class.
0558683c 968
969=over 4
970
705d4cfd 971=item B<< $metarole->add_after_method_modifier($method_name, $method) >>
0558683c 972
705d4cfd 973=item B<< $metarole->add_around_method_modifier($method_name, $method) >>
0558683c 974
705d4cfd 975=item B<< $metarole->add_before_method_modifier($method_name, $method) >>
0558683c 976
705d4cfd 977=item B<< $metarole->add_override_method_modifier($method_name, $method) >>
0558683c 978
705d4cfd 979These methods all add an appropriate modifier to the internal list of
980modifiers.
0558683c 981
705d4cfd 982=item B<< $metarole->has_after_method_modifiers >>
0558683c 983
705d4cfd 984=item B<< $metarole->has_around_method_modifiers >>
985
986=item B<< $metarole->has_before_method_modifiers >>
987
988=item B<< $metarole->has_override_method_modifier >>
0558683c 989
705d4cfd 990Return true if the role has any modifiers of the given type.
0558683c 991
705d4cfd 992=item B<< $metarole->get_after_method_modifiers($method_name) >>
0558683c 993
705d4cfd 994=item B<< $metarole->get_around_method_modifiers($method_name) >>
0558683c 995
705d4cfd 996=item B<< $metarole->get_before_method_modifiers($method_name) >>
0558683c 997
705d4cfd 998Given a method name, returns a list of the appropriate modifiers for
999that method.
1000
1001=item B<< $metarole->get_override_method_modifier($method_name) >>
1002
1003Given a method name, returns the override method modifier for that
1004method, if it has one.
0558683c 1005
1006=back
1007
705d4cfd 1008=head2 Introspection
505065c4 1009
705d4cfd 1010=over 4
505065c4 1011
705d4cfd 1012=item B<< Moose::Meta::Role->meta >>
505065c4 1013
705d4cfd 1014This will return a L<Class::MOP::Class> instance for this class.
505065c4 1015
1016=back
1017
e185c027 1018=head1 BUGS
1019
d4048ef3 1020See L<Moose/BUGS> for details on reporting bugs.
e185c027 1021
1022=head1 AUTHOR
1023
1024Stevan Little E<lt>stevan@iinteractive.comE<gt>
1025
1026=head1 COPYRIGHT AND LICENSE
1027
7e0492d3 1028Copyright 2006-2010 by Infinity Interactive, Inc.
e185c027 1029
1030L<http://www.iinteractive.com>
1031
1032This library is free software; you can redistribute it and/or modify
fb1e11d5 1033it under the same terms as Perl itself.
e185c027 1034
b8aeb4dc 1035=cut