use Sub::Exporter;
use Scalar::Util 'blessed';
-use Carp 'confess';
-use Class::MOP ();
+use Class::MOP 0.60;
-our $VERSION = '0.02';
+our $VERSION = '0.72';
+$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
my @exports = qw[
does_role
search_class_by_role
apply_all_roles
+ get_all_init_args
+ get_all_attribute_values
+ resolve_metatrait_alias
+ resolve_metaclass_alias
+ add_method_modifier
+ english_list
];
Sub::Exporter::setup_exporter({
my $meta = find_meta($class_or_obj);
return unless defined $meta;
-
+ return unless $meta->can('does_role');
return 1 if $meta->does_role($role);
return;
}
sub apply_all_roles {
my $applicant = shift;
-
- confess "Must specify at least one role to apply to $applicant" unless @_;
-
- my $roles = Data::OptList::mkopt([ @_ ]);
-
- #use Data::Dumper;
- #warn Dumper $roles;
-
- my $meta;
- if (blessed $applicant &&
- ($applicant->isa('Class::MOP::Class') ||
- $applicant->isa('Moose::Meta::Role')) ){
- $meta = $applicant;
+
+ unless (@_) {
+ require Moose;
+ Moose->throw_error("Must specify at least one role to apply to $applicant");
+ }
+
+ my $roles = Data::OptList::mkopt( [@_] );
+
+ my $meta = ( blessed $applicant ? $applicant : find_meta($applicant) );
+
+ foreach my $role_spec (@$roles) {
+ Class::MOP::load_class( $role_spec->[0] );
+ }
+
+ foreach my $role (@$roles) {
+ unless ( $role->[0]->can('meta')
+ && $role->[0]->meta->isa('Moose::Meta::Role') ) {
+
+ require Moose;
+ Moose->throw_error( "You can only consume roles, "
+ . $role->[0]
+ . " is not a Moose role" );
+ }
+ }
+
+ if ( scalar @$roles == 1 ) {
+ my ( $role, $params ) = @{ $roles->[0] };
+ $role->meta->apply( $meta, ( defined $params ? %$params : () ) );
}
else {
- $meta = find_meta($applicant);
+ Moose::Meta::Role->combine( @$roles )->apply($meta);
}
-
- Class::MOP::load_class($_->[0]) for @$roles;
-
- ($_->[0]->can('meta') && $_->[0]->meta->isa('Moose::Meta::Role'))
- || confess "You can only consume roles, " . $_->[0] . " is not a Moose role"
- foreach @$roles;
+}
+
+# instance deconstruction ...
+
+sub get_all_attribute_values {
+ my ($class, $instance) = @_;
+ return +{
+ map { $_->name => $_->get_value($instance) }
+ grep { $_->has_value($instance) }
+ $class->compute_all_applicable_attributes
+ };
+}
+
+sub get_all_init_args {
+ my ($class, $instance) = @_;
+ return +{
+ map { $_->init_arg => $_->get_value($instance) }
+ grep { $_->has_value($instance) }
+ grep { defined($_->init_arg) }
+ $class->compute_all_applicable_attributes
+ };
+}
+
+sub resolve_metatrait_alias {
+ return resolve_metaclass_alias( @_, trait => 1 );
+}
+
+{
+ my %cache;
- if (scalar @$roles == 1) {
- my ($role, $params) = @{$roles->[0]};
- $role->meta->apply($meta, (defined $params ? %$params : ()));
+ sub resolve_metaclass_alias {
+ my ( $type, $metaclass_name, %options ) = @_;
+
+ my $cache_key = $type . q{ } . ( $options{trait} ? '-Trait' : '' );
+ return $cache{$cache_key}{$metaclass_name}
+ if $cache{$cache_key}{$metaclass_name};
+
+ my $possible_full_name
+ = 'Moose::Meta::'
+ . $type
+ . '::Custom::'
+ . ( $options{trait} ? "Trait::" : "" )
+ . $metaclass_name;
+
+ my $loaded_class = Class::MOP::load_first_existing_class(
+ $possible_full_name,
+ $metaclass_name
+ );
+
+ return $cache{$cache_key}{$metaclass_name}
+ = $loaded_class->can('register_implementation')
+ ? $loaded_class->register_implementation
+ : $loaded_class;
+ }
+}
+
+sub add_method_modifier {
+ my ( $class_or_obj, $modifier_name, $args ) = @_;
+ my $meta = find_meta($class_or_obj);
+ my $code = pop @{$args};
+ my $add_modifier_method = 'add_' . $modifier_name . '_method_modifier';
+ if ( my $method_modifier_type = ref( @{$args}[0] ) ) {
+ if ( $method_modifier_type eq 'Regexp' ) {
+ my @all_methods = $meta->get_all_methods;
+ my @matched_methods
+ = grep { $_->name =~ @{$args}[0] } @all_methods;
+ $meta->$add_modifier_method( $_->name, $code )
+ for @matched_methods;
+ }
}
else {
- Moose::Meta::Role->combine(
- @$roles
- )->apply($meta);
- }
+ $meta->$add_modifier_method( $_, $code ) for @{$args};
+ }
+}
+
+sub english_list {
+ my @items = sort @_;
+
+ return $items[0] if @items == 1;
+ return "$items[0] and $items[1]" if @items == 2;
+
+ my $tail = pop @items;
+ my $list = join ', ', @items;
+ $list .= ', and ' . $tail;
+
+ return $list;
}
1;
=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.
+This is a set of utility functions to help working with Moose classes, and
+is used internally by Moose itself. The goal is to provide useful functions
+that for both Moose users and Moose extenders (MooseX:: authors).
+
+This is a relatively new addition to the Moose tool chest, so 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
Given an C<$applicant> (which can somehow be turned into either a
metaclass or a metarole) and a list of C<@roles> this will do the
right thing to apply the C<@roles> to the C<$applicant>. This is
-actually used internally by both L<Moose> and L<Moose::Role>.
+actually used internally by both L<Moose> and L<Moose::Role>, and the
+C<@roles> will be preprocessed through L<Data::OptList::mkopt>
+to allow for the additional arguments to be passed.
+
+=item B<get_all_attribute_values($meta, $instance)>
+
+Returns the values of the C<$instance>'s fields keyed by the attribute names.
+
+=item B<get_all_init_args($meta, $instance)>
+
+Returns a hash reference where the keys are all the attributes' C<init_arg>s
+and the values are the instance's fields. Attributes without an C<init_arg>
+will be skipped.
+
+=item B<resolve_metaclass_alias($category, $name, %options)>
+
+=item B<resolve_metatrait_alias($category, $name, %options)>
+
+Resolve a short name like in e.g.
+
+ has foo => (
+ metaclass => "Bar",
+ );
+
+to a full class name.
+
+=item B<add_method_modifier ($class_or_obj, $modifier_name, $args)>
+
+=item B<english_list(@items)>
+
+Given a list of scalars, turns them into a proper list in English
+("one and two", "one, two, three, and four"). This is used to help us
+make nicer error messages.
=back
=head1 COPYRIGHT AND LICENSE
-Copyright 2007-2008 by Infinity Interactive, Inc.
+Copyright 2007-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Moose.git / blobdiff