reset handlemoose state on mutation
[gitmo/Moo.git] / lib / Moo / Role.pm
CommitLineData
d245e471 1package Moo::Role;
2
3use strictures 1;
4use Moo::_Utils;
5use base qw(Role::Tiny);
6
a047096b 7require Moo::sification;
8
d245e471 9BEGIN { *INFO = \%Role::Tiny::INFO }
10
11our %INFO;
12
13sub import {
14 my $target = caller;
6c49212f 15 my ($me) = @_;
d245e471 16 strictures->import;
1ba11455 17 return if $INFO{$target}; # already exported into this package
d245e471 18 # get symbol table reference
19 my $stash = do { no strict 'refs'; \%{"${target}::"} };
167455a0 20 _install_coderef "${target}::has" => "Moo::Role::has" => sub {
d245e471 21 my ($name, %spec) = @_;
22 ($INFO{$target}{accessor_maker} ||= do {
faa9ce11 23 require Method::Generate::Accessor;
d245e471 24 Method::Generate::Accessor->new
25 })->generate_method($target, $name, \%spec);
57d402ef 26 push @{$INFO{$target}{attributes}||=[]}, $name, \%spec;
6c49212f 27 $me->_maybe_reset_handlemoose($target);
d245e471 28 };
6c49212f 29 # install before/after/around subs
30 foreach my $type (qw(before after around)) {
31 *{_getglob "${target}::${type}"} = sub {
32 require Class::Method::Modifiers;
33 push @{$INFO{$target}{modifiers}||=[]}, [ $type => @_ ];
34 $me->_maybe_reset_handlemoose($target);
35 };
36 }
37 *{_getglob "${target}::requires"} = sub {
38 push @{$INFO{$target}{requires}||=[]}, @_;
39 $me->_maybe_reset_handlemoose($target);
40 };
41 *{_getglob "${target}::with"} = sub {
42 $me->apply_roles_to_package($target, @_);
43 $me->_maybe_reset_handlemoose($target);
44 };
45 # grab all *non-constant* (stash slot is not a scalarref) subs present
46 # in the symbol table and store their refaddrs (no need to forcibly
47 # inflate constant subs into real subs) - also add '' to here (this
48 # is used later) with a map to the coderefs in case of copying or re-use
49 my @not_methods = ('', map { *$_{CODE}||() } grep !ref($_), values %$stash);
50 @{$INFO{$target}{not_methods}={}}{@not_methods} = @not_methods;
51 # a role does itself
52 $Role::Tiny::APPLIED_TO{$target} = { $target => undef };
53
7f9775b1 54 if ($INC{'Moo/HandleMoose.pm'}) {
55 Moo::HandleMoose::inject_fake_metaclass_for($target);
56 }
6c49212f 57}
58
59sub _maybe_reset_handlemoose {
60 my ($class, $target) = @_;
61 if ($INC{"Moo/HandleMoose.pm"}) {
62 Moo::HandleMoose::maybe_reinject_fake_metaclass_for($target);
63 }
d245e471 64}
65
a84066c7 66sub _inhale_if_moose {
67 my ($self, $role) = @_;
68 _load_module($role);
69 if (!$INFO{$role} and $INC{"Moose.pm"}) {
70 if (my $meta = Class::MOP::class_of($role)) {
71 $INFO{$role}{methods} = {
a3411285 72 map +($_ => $role->can($_)),
73 grep !$meta->get_method($_)->isa('Class::MOP::Method::Meta'),
74 $meta->get_method_list
a84066c7 75 };
76 $Role::Tiny::APPLIED_TO{$role} = {
77 map +($_->name => 1), $meta->calculate_all_roles
78 };
79 $INFO{$role}{requires} = [ $meta->get_required_method_list ];
57d402ef 80 $INFO{$role}{attributes} = [
a84066c7 81 map +($_ => $meta->get_attribute($_)), $meta->get_attribute_list
57d402ef 82 ];
a84066c7 83 my $mods = $INFO{$role}{modifiers} = [];
84 foreach my $type (qw(before after around)) {
85 my $map = $meta->${\"get_${type}_method_modifiers_map"};
86 foreach my $method (keys %$map) {
87 foreach my $mod (@{$map->{$method}}) {
88 push @$mods, [ $type => $method => $mod ];
89 }
90 }
91 }
92 require Class::Method::Modifiers if @$mods;
93 $INFO{$role}{inhaled_from_moose} = 1;
94 }
95 }
96}
97
a41e15c3 98sub _maybe_make_accessors {
99 my ($self, $role, $target) = @_;
100 my $m;
101 if ($INFO{$role}{inhaled_from_moose}
102 or $m = Moo->_accessor_maker_for($target)
103 and ref($m) ne 'Method::Generate::Accessor') {
104 $self->_make_accessors($role, $target);
105 }
106}
107
a84066c7 108sub _make_accessors_if_moose {
109 my ($self, $role, $target) = @_;
110 if ($INFO{$role}{inhaled_from_moose}) {
a41e15c3 111 $self->_make_accessors($role, $target);
112 }
113}
114
115sub _make_accessors {
116 my ($self, $role, $target) = @_;
117 my $acc_gen = ($Moo::MAKERS{$target}{accessor} ||= do {
118 require Method::Generate::Accessor;
119 Method::Generate::Accessor->new
120 });
db10ae2d 121 my $con_gen = $Moo::MAKERS{$target}{constructor};
a41e15c3 122 my @attrs = @{$INFO{$role}{attributes}||[]};
123 while (my ($name, $spec) = splice @attrs, 0, 2) {
db10ae2d 124 # needed to ensure we got an index for an arrayref based generator
125 if ($con_gen) {
126 $spec = $con_gen->all_attribute_specs->{$name};
127 }
a41e15c3 128 $acc_gen->generate_method($target, $name, $spec);
a84066c7 129 }
130}
131
4a79464d 132sub apply_roles_to_package {
133 my ($me, $to, @roles) = @_;
134 $me->_inhale_if_moose($_) for @roles;
135 $me->SUPER::apply_roles_to_package($to, @roles);
136}
137
6893ea30 138sub apply_single_role_to_package {
369a4c50 139 my ($me, $to, $role) = @_;
a84066c7 140 $me->_inhale_if_moose($role);
d245e471 141 $me->_handle_constructor($to, $INFO{$role}{attributes});
a41e15c3 142 $me->_maybe_make_accessors($role, $to);
143 $me->SUPER::apply_single_role_to_package($to, $role);
d245e471 144}
145
146sub create_class_with_roles {
147 my ($me, $superclass, @roles) = @_;
148
c69190f1 149 my $new_name = join(
150 '__WITH__', $superclass, my $compose_name = join '__AND__', @roles
151 );
152
d245e471 153 return $new_name if $Role::Tiny::COMPOSED{class}{$new_name};
154
a84066c7 155 $me->_inhale_if_moose($_) for @roles;
156
64284a1b 157 my $m;
158 if ($m = Moo->_accessor_maker_for($superclass)
159 and ref($m) ne 'Method::Generate::Accessor') {
160 # old fashioned way time.
161 *{_getglob("${new_name}::ISA")} = [ $superclass ];
162 $me->apply_roles_to_package($new_name, @roles);
163 return $new_name;
164 }
165
faa9ce11 166 require Sub::Quote;
d245e471 167
168 $me->SUPER::create_class_with_roles($superclass, @roles);
169
170 foreach my $role (@roles) {
171 die "${role} is not a Role::Tiny" unless my $info = $INFO{$role};
172 }
173
c69190f1 174 $Moo::MAKERS{$new_name} = {};
175
d245e471 176 $me->_handle_constructor(
873df570 177 $new_name, [ map @{$INFO{$_}{attributes}||[]}, @roles ], $superclass
d245e471 178 );
179
180 return $new_name;
181}
182
a84066c7 183sub _composable_package_for {
184 my ($self, $role) = @_;
185 my $composed_name = 'Role::Tiny::_COMPOSABLE::'.$role;
186 return $composed_name if $Role::Tiny::COMPOSED{role}{$composed_name};
187 $self->_make_accessors_if_moose($role, $composed_name);
188 $self->SUPER::_composable_package_for($role);
189}
190
dccea57d 191sub _install_single_modifier {
192 my ($me, @args) = @_;
193 _install_modifier(@args);
d245e471 194}
195
196sub _handle_constructor {
c4570291 197 my ($me, $to, $attr_info, $superclass) = @_;
57d402ef 198 return unless $attr_info && @$attr_info;
d245e471 199 if ($INFO{$to}) {
57d402ef 200 push @{$INFO{$to}{attributes}||=[]}, @$attr_info;
d245e471 201 } else {
202 # only fiddle with the constructor if the target is a Moo class
203 if ($INC{"Moo.pm"}
c4570291 204 and my $con = Moo->_constructor_maker_for($to, $superclass)) {
a41e15c3 205 # shallow copy of the specs since the constructor will assign an index
57d402ef 206 $con->register_attribute_specs(map ref() ? { %$_ } : $_, @$attr_info);
d245e471 207 }
208 }
209}
210
2111;
bce933ec 212
0b6e5fff 213=head1 NAME
214
215Moo::Role - Minimal Object Orientation support for Roles
bce933ec 216
217=head1 SYNOPSIS
218
219 package My::Role;
220
221 use Moo::Role;
222
223 sub foo { ... }
224
225 sub bar { ... }
226
227 has baz => (
228 is => 'ro',
229 );
230
231 1;
232
233else where
234
235 package Some::Class;
236
237 use Moo;
238
239 # bar gets imported, but not foo
240 with('My::Role');
241
242 sub foo { ... }
243
244 1;
245
246=head1 DESCRIPTION
247
248C<Moo::Role> builds upon L<Role::Tiny>, so look there for most of the
249documentation on how this works. The main addition here is extra bits to make
250the roles more "Moosey;" which is to say, it adds L</has>.
251
252=head1 IMPORTED SUBROUTINES
253
254See L<Role::Tiny/IMPORTED SUBROUTINES> for all the other subroutines that are
255imported by this module.
256
257=head2 has
258
259 has attr => (
260 is => 'ro',
261 );
262
263Declares an attribute for the class to be composed into. See
264L<Moo/has> for all options.
40f3e3aa 265
266=head1 AUTHORS
267
268See L<Moo> for authors.
269
270=head1 COPYRIGHT AND LICENSE
271
272See L<Moo> for the copyright and license.
273
274=cut