| MooseX-Traits-Pluggable documentation | Contained in the MooseX-Traits-Pluggable distribution. |
MooseX::Traits::Pluggable - trait loading and resolution for Moose
See MooseX::Traits for usage information.
Use new_with_traits to construct an object with a list of traits and
apply_traits to apply traits to an instance.
Adds support for class precedence search for traits and some extra attributes, described below.
If the value of _trait_namespace in MooseX::Traits starts with a + the
namespace will be considered relative to the class_precedence_list (ie.
@ISA) of the original class.
Example:
package Class1
use Moose;
package Class1::Trait::Foo;
use Moose::Role;
has 'bar' => (
is => 'ro',
isa => 'Str',
required => 1,
);
package Class2;
use parent 'Class1';
with 'MooseX::Traits';
has '+_trait_namespace' => (default => '+Trait');
package Class2::Trait::Bar;
use Moose::Role;
has 'baz' => (
is => 'ro',
isa => 'Str',
required => 1,
);
package main;
my $instance = Class2->new_with_traits(
traits => ['Foo', 'Bar'],
bar => 'baz',
baz => 'quux',
);
$instance->does('Class1::Trait::Foo'); # true
$instance->does('Class2::Trait::Bar'); # true
You can search multiple namespaces for traits, for example:
has '+_trait_namespace' => (
default => sub { [qw/+Trait +Role ExtraNS::Trait/] }
);
Will search in the class_precedence_list for ::Trait::TheTrait
and ::Role::TheTrait and then for ExtraNS::Trait::TheTrait.
When traits are applied to your class or instance, you get an anonymous class
back whose name will be not the same as your original class. So ref $self
will not be Class, but $self->_original_class_name will be.
List of the (unresolved) traits applied to the instance.
List of traits applied to the instance resolved to full package names.
Please report any bugs or feature requests to bug-moosex-traits-pluggable at
rt.cpan.org, or through the web interface at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MooseX-Traits-Pluggable. I
will be notified, and then you'll automatically be notified of progress on your
bug as I make changes.
More information at:
http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Traits-Pluggable
Rafael Kitover <rkitover@cpan.org>
Tomas Doran, <bobtfish@bobtfish.net>
Copyright (c) 2009 - 2010 by the aforementioned AUTHOR and CONTRIBUTORS.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| MooseX-Traits-Pluggable documentation | Contained in the MooseX-Traits-Pluggable distribution. |
package MooseX::Traits::Pluggable; use namespace::autoclean; use Moose::Role; use Scalar::Util qw/blessed reftype/; use List::MoreUtils 'uniq'; use Carp; use Moose::Util qw/find_meta/; our $VERSION = '0.10'; our $AUTHORITY = 'id:RKITOVER'; # stolen from MX::Object::Pluggable has _original_class_name => ( is => 'ro', required => 1, isa => 'Str', default => sub { blessed $_[0] }, ); has '_trait_namespace' => ( # no accessors or init_arg init_arg => undef, (Moose->VERSION >= 0.84 ) ? (is => 'bare') : (), ); has _traits => ( is => 'ro', isa => 'ArrayRef[Str]', default => sub { [] }, ); has _resolved_traits => ( is => 'ro', isa => 'ArrayRef[ClassName]', default => sub { [] }, ); sub _find_trait { my ($class, $base, $name) = @_; my @search_ns = $class->meta->class_precedence_list; for my $ns (@search_ns) { my $full = "${ns}::${base}::${name}"; return $full if eval { Class::MOP::load_class($full) }; } croak "Could not find a class for trait: $name"; } sub _transform_trait { my ($class, $name) = @_; my $base; if ($class->can('_trait_namespace')) { $base = $class->_trait_namespace($name); } else { my $namespace = find_meta($class)->find_attribute_by_name('_trait_namespace'); if($namespace->has_default) { $base = $namespace->default; if (ref($base) && reftype($base) eq 'CODE') { $base = $class->$base($name); } } } return $name unless $base; return $1 if $name =~ /^[+](.+)$/; $base = [ $base ] if !ref($base) || reftype($base) ne 'ARRAY'; for my $ns (@$base) { if ($ns =~ /^\+(.*)/) { my $trait = eval { $class->_find_trait($1, $name) }; return $trait if defined $trait; } my $trait = join '::', $ns, $name; return $trait if eval { Class::MOP::load_class($trait) }; } croak "Could not find a class for trait: $name"; } sub _resolve_traits { my ($class, @traits) = @_; return map { my $transformed = $class->_transform_trait($_); Class::MOP::load_class($transformed); $transformed; } @traits; } sub new_with_traits { my $class = shift; $class->_build_instance_with_traits($class, @_); } sub _build_instance_with_traits { my ($this_class, $class) = (shift, shift); my ($hashref, %args, @others) = 0; if (ref($_[-1]) eq 'HASH') { %args = %{ +pop }; @others = @_; $hashref = 1; } else { %args = @_; } $args{_original_class_name} = $class; if (my $traits = delete $args{traits}) { my @traits = ref($traits) ? @$traits : ($traits); if(@traits){ $args{_traits} = \@traits; my @resolved_traits = $this_class->_resolve_traits(@traits); $args{_resolved_traits} = \@resolved_traits; my $meta = $class->meta->create_anon_class( superclasses => [ $class->meta->name ], roles => \@resolved_traits, cache => 1, ); # Method attributes in inherited roles may have turned metaclass # to lies. CatalystX::Component::Traits related special move # to deal with this here. $meta = find_meta($meta->name); $meta->add_method('meta' => sub { $meta }); $class = $meta->name; } } my $constructor = $class->meta->constructor_name; confess "$class does not have a constructor defined via the MOP?" if !$constructor; return $class->$constructor($hashref ? (@others, \%args) : %args); } sub apply_traits { my ($self, $traits, $rebless_params) = @_; my @traits = ref($traits) ? @$traits : ($traits); if (@traits) { my @resolved_traits = $self->_resolve_traits(@traits); $rebless_params ||= {}; $rebless_params->{_traits} = [ uniq @{ $self->_traits }, @traits ]; $rebless_params->{_resolved_traits} = [ uniq @{ $self->_resolved_traits }, @resolved_traits ]; for my $trait (@resolved_traits){ $trait->meta->apply($self, rebless_params => $rebless_params); } } } no Moose::Role; 1; __END__