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