Commit | Line | Data |
9a641848 |
1 | package Moose::Util; |
2 | |
9a641848 |
3 | use strict; |
4 | use warnings; |
5 | |
7125b244 |
6 | use Sub::Exporter; |
d7d8a8c7 |
7 | use Scalar::Util 'blessed'; |
8 | use Carp 'confess'; |
7125b244 |
9 | use Class::MOP (); |
9a641848 |
10 | |
9c10b5ad |
11 | our $VERSION = '0.04'; |
7125b244 |
12 | our $AUTHORITY = 'cpan:STEVAN'; |
9a641848 |
13 | |
7125b244 |
14 | my @exports = qw[ |
6532ca5a |
15 | find_meta |
16 | does_role |
7125b244 |
17 | search_class_by_role |
d7d8a8c7 |
18 | apply_all_roles |
ab76842e |
19 | get_all_init_args |
20 | get_all_attribute_values |
7125b244 |
21 | ]; |
9a641848 |
22 | |
7125b244 |
23 | Sub::Exporter::setup_exporter({ |
24 | exports => \@exports, |
11065d1f |
25 | groups => { all => \@exports } |
7125b244 |
26 | }); |
27 | |
28 | ## some utils for the utils ... |
29 | |
6532ca5a |
30 | sub find_meta { |
7125b244 |
31 | return unless $_[0]; |
d7d8a8c7 |
32 | return Class::MOP::get_metaclass_by_name(blessed($_[0]) || $_[0]); |
7125b244 |
33 | } |
9a641848 |
34 | |
7125b244 |
35 | ## the functions ... |
adf82331 |
36 | |
7125b244 |
37 | sub does_role { |
38 | my ($class_or_obj, $role) = @_; |
adf82331 |
39 | |
6532ca5a |
40 | my $meta = find_meta($class_or_obj); |
7125b244 |
41 | |
42 | return unless defined $meta; |
adf82331 |
43 | |
7125b244 |
44 | return 1 if $meta->does_role($role); |
45 | return; |
9a641848 |
46 | } |
47 | |
1631b53f |
48 | sub search_class_by_role { |
7125b244 |
49 | my ($class_or_obj, $role_name) = @_; |
50 | |
6532ca5a |
51 | my $meta = find_meta($class_or_obj); |
7125b244 |
52 | |
53 | return unless defined $meta; |
54 | |
55 | foreach my $class ($meta->class_precedence_list) { |
56 | |
6532ca5a |
57 | my $_meta = find_meta($class); |
1631b53f |
58 | |
7125b244 |
59 | next unless defined $_meta; |
60 | |
61 | foreach my $role (@{ $_meta->roles || [] }) { |
1631b53f |
62 | return $class if $role->name eq $role_name; |
63 | } |
64 | } |
65 | |
7125b244 |
66 | return; |
1631b53f |
67 | } |
68 | |
d7d8a8c7 |
69 | sub apply_all_roles { |
70 | my $applicant = shift; |
71 | |
72 | confess "Must specify at least one role to apply to $applicant" unless @_; |
73 | |
74 | my $roles = Data::OptList::mkopt([ @_ ]); |
75 | |
76 | #use Data::Dumper; |
77 | #warn Dumper $roles; |
78 | |
d9bb6c63 |
79 | my $meta = (blessed $applicant ? $applicant : find_meta($applicant)); |
d7d8a8c7 |
80 | |
9c10b5ad |
81 | foreach my $role_spec (@$roles) { |
82 | Class::MOP::load_class($role_spec->[0]); |
83 | } |
d7d8a8c7 |
84 | |
85 | ($_->[0]->can('meta') && $_->[0]->meta->isa('Moose::Meta::Role')) |
86 | || confess "You can only consume roles, " . $_->[0] . " is not a Moose role" |
87 | foreach @$roles; |
88 | |
89 | if (scalar @$roles == 1) { |
90 | my ($role, $params) = @{$roles->[0]}; |
91 | $role->meta->apply($meta, (defined $params ? %$params : ())); |
92 | } |
93 | else { |
94 | Moose::Meta::Role->combine( |
95 | @$roles |
96 | )->apply($meta); |
97 | } |
98 | } |
99 | |
ab76842e |
100 | # instance deconstruction ... |
101 | |
102 | sub get_all_attribute_values { |
103 | my ($class, $instance) = @_; |
104 | return +{ |
105 | map { $_->name => $_->get_value($instance) } |
106 | grep { $_->has_value($instance) } |
107 | $class->compute_all_applicable_attributes |
108 | }; |
109 | } |
110 | |
111 | sub get_all_init_args { |
112 | my ($class, $instance) = @_; |
113 | return +{ |
114 | map { $_->init_arg => $_->get_value($instance) } |
115 | grep { $_->has_value($instance) } |
116 | grep { defined($_->init_arg) } |
117 | $class->compute_all_applicable_attributes |
118 | }; |
119 | } |
120 | |
d9bb6c63 |
121 | |
9a641848 |
122 | 1; |
123 | |
124 | __END__ |
125 | |
126 | =pod |
127 | |
128 | =head1 NAME |
129 | |
7125b244 |
130 | Moose::Util - Utilities for working with Moose classes |
9a641848 |
131 | |
132 | =head1 SYNOPSIS |
133 | |
6532ca5a |
134 | use Moose::Util qw/find_meta does_role search_class_by_role/; |
135 | |
136 | my $meta = find_meta($object) || die "No metaclass found"; |
9a641848 |
137 | |
adf82331 |
138 | if (does_role($object, $role)) { |
139 | print "The object can do $role!\n"; |
9a641848 |
140 | } |
141 | |
1631b53f |
142 | my $class = search_class_by_role($object, 'FooRole'); |
143 | print "Nearest class with 'FooRole' is $class\n"; |
144 | |
7125b244 |
145 | =head1 DESCRIPTION |
146 | |
147 | This is a set of utility functions to help working with Moose classes. This |
148 | is an experimental module, and it's not 100% clear what purpose it will serve. |
149 | That said, ideas, suggestions and contributions to this collection are most |
150 | welcome. See the L<TODO> section below for a list of ideas for possible |
151 | functions to write. |
152 | |
153 | =head1 EXPORTED FUNCTIONS |
9a641848 |
154 | |
155 | =over 4 |
156 | |
6532ca5a |
157 | =item B<find_meta ($class_or_obj)> |
158 | |
159 | This will attempt to locate a metaclass for the given C<$class_or_obj> |
160 | and return it. |
161 | |
7125b244 |
162 | =item B<does_role ($class_or_obj, $role_name)> |
163 | |
164 | Returns true if C<$class_or_obj> can do the role C<$role_name>. |
165 | |
166 | =item B<search_class_by_role ($class_or_obj, $role_name)> |
167 | |
168 | Returns first class in precedence list that consumed C<$role_name>. |
169 | |
d7d8a8c7 |
170 | =item B<apply_all_roles ($applicant, @roles)> |
171 | |
172 | Given an C<$applicant> (which can somehow be turned into either a |
173 | metaclass or a metarole) and a list of C<@roles> this will do the |
174 | right thing to apply the C<@roles> to the C<$applicant>. This is |
3bb22459 |
175 | actually used internally by both L<Moose> and L<Moose::Role>, and the |
176 | C<@roles> will be pre-processed through L<Data::OptList::mkopt> |
177 | to allow for the additional arguments to be passed. |
d7d8a8c7 |
178 | |
ab76842e |
179 | =item B<get_all_attribute_values($meta, $instance)> |
180 | |
181 | Returns the values of the C<$instance>'s fields keyed by the attribute names. |
182 | |
183 | =item B<get_all_init_args($meta, $instance)> |
184 | |
185 | Returns a hash reference where the keys are all the attributes' C<init_arg>s |
186 | and the values are the instance's fields. Attributes without an C<init_arg> |
187 | will be skipped. |
188 | |
7125b244 |
189 | =back |
9a641848 |
190 | |
7125b244 |
191 | =head1 TODO |
9a641848 |
192 | |
7125b244 |
193 | Here is a list of possible functions to write |
9a641848 |
194 | |
7125b244 |
195 | =over 4 |
1631b53f |
196 | |
7125b244 |
197 | =item discovering original method from modified method |
1631b53f |
198 | |
7125b244 |
199 | =item search for origin class of a method or attribute |
1631b53f |
200 | |
9a641848 |
201 | =back |
202 | |
203 | =head1 BUGS |
204 | |
205 | All complex software has bugs lurking in it, and this module is no |
206 | exception. If you find a bug please either email me, or add the bug |
207 | to cpan-RT. |
208 | |
209 | =head1 AUTHOR |
210 | |
211 | Anders Nor Berle E<lt>debolaz@gmail.comE<gt> |
212 | |
7125b244 |
213 | B<with contributions from:> |
214 | |
215 | Robert (phaylon) Sedlacek |
216 | |
217 | Stevan Little |
218 | |
9a641848 |
219 | =head1 COPYRIGHT AND LICENSE |
220 | |
778db3ac |
221 | Copyright 2007-2008 by Infinity Interactive, Inc. |
9a641848 |
222 | |
223 | L<http://www.iinteractive.com> |
224 | |
225 | This library is free software; you can redistribute it and/or modify |
226 | it under the same terms as Perl itself. |
227 | |
228 | =cut |
229 | |