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