7 use Scalar::Util 'blessed';
11 our $VERSION = '0.03';
12 our $AUTHORITY = 'cpan:STEVAN';
20 get_all_attribute_values
23 Sub::Exporter::setup_exporter({
25 groups => { all => \@exports }
28 ## some utils for the utils ...
32 return Class::MOP::get_metaclass_by_name(blessed($_[0]) || $_[0]);
38 my ($class_or_obj, $role) = @_;
40 my $meta = find_meta($class_or_obj);
42 return unless defined $meta;
44 return 1 if $meta->does_role($role);
48 sub search_class_by_role {
49 my ($class_or_obj, $role_name) = @_;
51 my $meta = find_meta($class_or_obj);
53 return unless defined $meta;
55 foreach my $class ($meta->class_precedence_list) {
57 my $_meta = find_meta($class);
59 next unless defined $_meta;
61 foreach my $role (@{ $_meta->roles || [] }) {
62 return $class if $role->name eq $role_name;
70 my $applicant = shift;
72 confess "Must specify at least one role to apply to $applicant" unless @_;
74 my $roles = Data::OptList::mkopt([ @_ ]);
79 my $meta = (blessed $applicant ? $applicant : find_meta($applicant));
81 Class::MOP::load_class($_->[0]) for @$roles;
83 ($_->[0]->can('meta') && $_->[0]->meta->isa('Moose::Meta::Role'))
84 || confess "You can only consume roles, " . $_->[0] . " is not a Moose role"
87 if (scalar @$roles == 1) {
88 my ($role, $params) = @{$roles->[0]};
89 $role->meta->apply($meta, (defined $params ? %$params : ()));
92 Moose::Meta::Role->combine(
98 # instance deconstruction ...
100 sub get_all_attribute_values {
101 my ($class, $instance) = @_;
103 map { $_->name => $_->get_value($instance) }
104 grep { $_->has_value($instance) }
105 $class->compute_all_applicable_attributes
109 sub get_all_init_args {
110 my ($class, $instance) = @_;
112 map { $_->init_arg => $_->get_value($instance) }
113 grep { $_->has_value($instance) }
114 grep { defined($_->init_arg) }
115 $class->compute_all_applicable_attributes
128 Moose::Util - Utilities for working with Moose classes
132 use Moose::Util qw/find_meta does_role search_class_by_role/;
134 my $meta = find_meta($object) || die "No metaclass found";
136 if (does_role($object, $role)) {
137 print "The object can do $role!\n";
140 my $class = search_class_by_role($object, 'FooRole');
141 print "Nearest class with 'FooRole' is $class\n";
145 This is a set of utility functions to help working with Moose classes. This
146 is an experimental module, and it's not 100% clear what purpose it will serve.
147 That said, ideas, suggestions and contributions to this collection are most
148 welcome. See the L<TODO> section below for a list of ideas for possible
151 =head1 EXPORTED FUNCTIONS
155 =item B<find_meta ($class_or_obj)>
157 This will attempt to locate a metaclass for the given C<$class_or_obj>
160 =item B<does_role ($class_or_obj, $role_name)>
162 Returns true if C<$class_or_obj> can do the role C<$role_name>.
164 =item B<search_class_by_role ($class_or_obj, $role_name)>
166 Returns first class in precedence list that consumed C<$role_name>.
168 =item B<apply_all_roles ($applicant, @roles)>
170 Given an C<$applicant> (which can somehow be turned into either a
171 metaclass or a metarole) and a list of C<@roles> this will do the
172 right thing to apply the C<@roles> to the C<$applicant>. This is
173 actually used internally by both L<Moose> and L<Moose::Role>, and the
174 C<@roles> will be pre-processed through L<Data::OptList::mkopt>
175 to allow for the additional arguments to be passed.
177 =item B<get_all_attribute_values($meta, $instance)>
179 Returns the values of the C<$instance>'s fields keyed by the attribute names.
181 =item B<get_all_init_args($meta, $instance)>
183 Returns a hash reference where the keys are all the attributes' C<init_arg>s
184 and the values are the instance's fields. Attributes without an C<init_arg>
191 Here is a list of possible functions to write
195 =item discovering original method from modified method
197 =item search for origin class of a method or attribute
203 All complex software has bugs lurking in it, and this module is no
204 exception. If you find a bug please either email me, or add the bug
209 Anders Nor Berle E<lt>debolaz@gmail.comE<gt>
211 B<with contributions from:>
213 Robert (phaylon) Sedlacek
217 =head1 COPYRIGHT AND LICENSE
219 Copyright 2007-2008 by Infinity Interactive, Inc.
221 L<http://www.iinteractive.com>
223 This library is free software; you can redistribute it and/or modify
224 it under the same terms as Perl itself.