package Moose::Util;
-use Exporter qw/import/;
-use Scalar::Util;
-
use strict;
use warnings;
-our $VERSION = '0.01';
+use Sub::Exporter;
+use Scalar::Util ();
+use Class::MOP ();
-our $AUTHORITY = 'cpan:BERLE';
+our $VERSION = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
-our @EXPORT_OK = qw/does_role search_class_by_role/;
+my @exports = qw[
+ find_meta
+ does_role
+ search_class_by_role
+];
-sub does_role {
- my ($class, $role) = @_;
+Sub::Exporter::setup_exporter({
+ exports => \@exports,
+ groups => { all => \@exports }
+});
+
+## some utils for the utils ...
- return unless defined $class;
+sub find_meta {
+ return unless $_[0];
+ return Class::MOP::get_metaclass_by_name(ref($_[0]) || $_[0]);
+}
+
+## the functions ...
- my $meta = Class::MOP::get_metaclass_by_name (ref $class || $class);
+sub does_role {
+ my ($class_or_obj, $role) = @_;
- return unless defined $meta;
+ my $meta = find_meta($class_or_obj);
+
+ return unless defined $meta;
- return $meta->does_role ($role);
+ return 1 if $meta->does_role($role);
+ return;
}
sub search_class_by_role {
- my ($obj, $role_name) = @_;
+ my ($class_or_obj, $role_name) = @_;
+
+ my $meta = find_meta($class_or_obj);
- for my $class ($obj->meta->class_precedence_list) {
- for my $role (@{ $class->meta->roles || [] }) {
+ return unless defined $meta;
+
+ foreach my $class ($meta->class_precedence_list) {
+
+ my $_meta = find_meta($class);
+
+ next unless defined $_meta;
+
+ foreach my $role (@{ $_meta->roles || [] }) {
return $class if $role->name eq $role_name;
}
}
- return undef;
+ return;
}
1;
=head1 NAME
-Moose::Util - Moose utilities
+Moose::Util - Utilities for working with Moose classes
=head1 SYNOPSIS
- use Moose::Util qw/does_role search_class_by_role/;
+ use Moose::Util qw/find_meta does_role search_class_by_role/;
+
+ my $meta = find_meta($object) || die "No metaclass found";
if (does_role($object, $role)) {
print "The object can do $role!\n";
my $class = search_class_by_role($object, 'FooRole');
print "Nearest class with 'FooRole' is $class\n";
-=head1 FUNCTIONS
+=head1 DESCRIPTION
+
+This is a set of utility functions to help working with Moose classes. This
+is an experimental module, and it's not 100% clear what purpose it will serve.
+That said, ideas, suggestions and contributions to this collection are most
+welcome. See the L<TODO> section below for a list of ideas for possible
+functions to write.
+
+=head1 EXPORTED FUNCTIONS
=over 4
-=item does_role
+=item B<find_meta ($class_or_obj)>
- does_role($object, $rolename);
+This will attempt to locate a metaclass for the given C<$class_or_obj>
+and return it.
-Returns true if $object can do the role $rolename.
+=item B<does_role ($class_or_obj, $role_name)>
-=item search_class_by_role
+Returns true if C<$class_or_obj> can do the role C<$role_name>.
- my $class = search_class_by_role($object, $rolename);
+=item B<search_class_by_role ($class_or_obj, $role_name)>
-Returns first class in precedence list that consumed C<$rolename>.
+Returns first class in precedence list that consumed C<$role_name>.
+
+=back
+
+=head1 TODO
+
+Here is a list of possible functions to write
+
+=over 4
+
+=item discovering original method from modified method
+
+=item search for origin class of a method or attribute
=back
Anders Nor Berle E<lt>debolaz@gmail.comE<gt>
+B<with contributions from:>
+
+Robert (phaylon) Sedlacek
+
+Stevan Little
+
=head1 COPYRIGHT AND LICENSE
Copyright 2007 by Infinity Interactive, Inc.