| MooseX-Role-Parameterized documentation | Contained in the MooseX-Role-Parameterized distribution. |
MooseX::Role::Parameterized - roles with composition parameters
package Counter;
use MooseX::Role::Parameterized;
parameter name => (
isa => 'Str',
required => 1,
);
role {
my $p = shift;
my $name = $p->name;
has $name => (
is => 'rw',
isa => 'Int',
default => 0,
);
method "increment_$name" => sub {
my $self = shift;
$self->$name($self->$name + 1);
};
method "reset_$name" => sub {
my $self = shift;
$self->$name(0);
};
};
package MyGame::Weapon;
use Moose;
with Counter => { name => 'enchantment' };
package MyGame::Wand;
use Moose;
with Counter => { name => 'zapped' };
Stop! If you're new here, please read MooseX::Role::Parameterized::Tutorial for a much gentler introduction.
Your parameterized role consists of two new things: parameter declarations
and a role block.
Parameters are declared using the parameter keyword which very much
resembles has in Moose. You can use any option that has in Moose accepts. The
default value for the is option is ro as that's a very common case. Use
is => 'bare' if you want no accessor. These parameters will get their
values when the consuming class (or role) uses with in Moose. A parameter
object will be constructed with these values, and passed to the role block.
The role block then uses the usual Moose::Role keywords to build up a
role. You can shift off the parameter object to inspect what the consuming
class provided as parameters. You use the parameters to customize your
role however you wish.
There are many possible implementations for parameterized roles (hopefully with a consistent enough API); I believe this to be the easiest and most flexible design. Coincidentally, Pugs originally had an eerily similar design.
See MooseX::Role::Parameterized::Extending for some tips on how to extend this module.
I've been asked several times "Why use a parameter object and not just a parameter hashref? That would eliminate the need to explicitly declare your parameters."
The benefits of using an object are similar to the benefits of using Moose. You get an easy way to specify lazy defaults, type constraint, delegation, and so on. You get to use MooseX modules.
You also get the usual introspective and intercessory abilities that come standard with the metaobject protocol. Ambitious users should be able to add traits to the parameters metaclass to further customize behavior. Please let me know if you're doing anything viciously complicated with this extension. :)
You must use this syntax to declare methods in the role block:
method NAME => sub { ... };. This is due to a limitation in Perl. In
return though you can use parameters in your methods!
alias in Moose::Role and excludes in Moose::Role are not yet supported. I'm
completely unsure of whether they should be handled by this module. Until we
figure out a plan, either declaring or providing a parameter named alias or
excludes is an error.
Shawn M Moore, sartak@gmail.com
http://sartak.org/2009/01/parametric-roles-in-perl-5.html
http://sartak.org/2009/05/the-design-of-parameterized-roles.html
http://stevan-little.blogspot.com/2009/07/thoughts-on-parameterized-roles.html
http://perldition.org/articles/Parameterized%20Roles%20with%20MooseX::Declare.pod
http://www.modernperlbooks.com/mt/2011/01/the-parametric-role-of-my-mvc-plugin-system.html
http://sartak.org/talks/yapc-asia-2009/(parameterized)-roles/
https://github.com/SamuraiJack/JooseX-Role-Parameterized - this extension ported to JavaScript's Joose
Copyright 2007-2010 Infinity Interactive
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| MooseX-Role-Parameterized documentation | Contained in the MooseX-Role-Parameterized distribution. |
package MooseX::Role::Parameterized; use 5.008001; use Moose::Role (); use Moose::Exporter; use Carp 'confess'; use Scalar::Util 'blessed'; use MooseX::Role::Parameterized::Meta::Role::Parameterizable; our $VERSION = '0.26'; our $CURRENT_METACLASS; Moose::Exporter->setup_import_methods( with_caller => ['parameter', 'role', 'method', 'has', 'with', 'extends', 'requires', 'excludes', 'augment', 'inner', 'before', 'after', 'around', 'super', 'override'], as_is => [ 'confess', 'blessed' ], ); sub current_metaclass { $CURRENT_METACLASS } sub parameter { my $caller = shift; confess "'parameter' may not be used inside of the role block" if $CURRENT_METACLASS && $CURRENT_METACLASS->genitor->name eq $caller; my $meta = Class::MOP::class_of($caller); my $names = shift; $names = [$names] if !ref($names); for my $name (@$names) { $meta->add_parameter($name, @_); } } sub role (&) { my $caller = shift; my $role_generator = shift; Class::MOP::class_of($caller)->role_generator($role_generator); } sub init_meta { my $self = shift; my %options = @_; $options{metaclass} ||= 'MooseX::Role::Parameterized::Meta::Role::Parameterizable'; return Moose::Role->init_meta(%options); } sub has { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); my $names = shift; $names = [$names] if !ref($names); for my $name (@$names) { $meta->add_attribute($name, @_); } } sub method { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); my $name = shift; my $body = shift; my $method = $meta->method_metaclass->wrap( package_name => $caller, name => $name, body => $body, ); $meta->add_method($name => $method); } sub _add_method_modifier { my $type = shift; my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); my $code = pop @_; for (@_) { Carp::croak "Roles do not currently support " . ref($_) . " references for $type method modifiers" if ref $_; my $add_method = "add_${type}_method_modifier"; $meta->$add_method($_, $code); } } sub before { _add_method_modifier('before', @_); } sub after { _add_method_modifier('after', @_); } sub around { _add_method_modifier('around', @_); } sub with { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); Moose::Util::apply_all_roles($meta, @_); } sub requires { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); Carp::croak "Must specify at least one method" unless @_; $meta->add_required_methods(@_); } sub excludes { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); Carp::croak "Must specify at least one role" unless @_; $meta->add_excluded_roles(@_); } # see Moose.pm for discussion sub super { return unless $Moose::SUPER_BODY; $Moose::SUPER_BODY->(@Moose::SUPER_ARGS); } sub override { my $caller = shift; my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller); my ($name, $code) = @_; $meta->add_override_method_modifier($name, $code); } sub extends { Carp::croak "Roles do not currently support 'extends'" } sub inner { Carp::croak "Roles cannot support 'inner'" } sub augment { Carp::croak "Roles cannot support 'augment'" } 1; __END__