-#!/usr/bin/env perl
package MooseX::Role::Parameterized;
use Moose (
extends => { -as => 'moose_extends' },
- qw/around confess/,
+ around => { -as => 'moose_around' },
+ qw/confess blessed/,
);
+moose_extends 'Moose::Exporter';
-use Carp 'croak';
use Moose::Role ();
-moose_extends 'Moose::Exporter';
use MooseX::Role::Parameterized::Meta::Role::Parameterizable;
our $CURRENT_METACLASS;
__PACKAGE__->setup_import_methods(
- with_caller => ['parameter', 'role', 'method'],
- as_is => ['has', 'with', 'extends', 'requires', 'excludes', 'augment', 'inner'],
+ with_caller => ['parameter', 'role', 'method', 'has', 'with', 'extends',
+ 'requires', 'excludes', 'augment', 'inner', 'before',
+ 'after', 'around', 'super', 'override'],
+ as_is => [ 'confess', 'blessed' ],
);
sub parameter {
my $caller = shift;
- my $names = shift;
+ confess "'parameter' may not be used inside of the role block"
+ if $CURRENT_METACLASS;
+
+ my $meta = Class::MOP::class_of($caller);
+
+ my $names = shift;
$names = [$names] if !ref($names);
for my $name (@$names) {
- Class::MOP::Class->initialize($caller)->add_parameter($name, @_);
+ $meta->add_parameter($name, @_);
}
}
-sub role {
+sub role (&) {
my $caller = shift;
my $role_generator = shift;
- Class::MOP::Class->initialize($caller)->role_generator($role_generator);
+ Class::MOP::class_of($caller)->role_generator($role_generator);
}
sub init_meta {
);
}
-# give role a (&) prototype
-around _make_wrapper => sub {
- my $orig = shift;
- my ($self, $caller, $sub, $fq_name) = @_;
-
- if ($fq_name =~ /::role$/) {
- return sub (&) { $sub->($caller, @_) };
- }
-
- return $orig->(@_);
-};
-
sub has {
- confess "has must be called within the role { ... } block."
- unless $CURRENT_METACLASS;
+ my $caller = shift;
+ my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller);
my $names = shift;
$names = [$names] if !ref($names);
for my $name (@$names) {
- $CURRENT_METACLASS->add_attribute($name, @_);
+ $meta->add_attribute($name, @_);
}
}
sub method {
- confess "method must be called within the role { ... } block."
- unless $CURRENT_METACLASS;
-
my $caller = shift;
+ my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller);
+
my $name = shift;
my $body = shift;
- my $method = $CURRENT_METACLASS->method_metaclass->wrap(
+ my $method = $meta->method_metaclass->wrap(
package_name => $caller,
name => $name,
body => $body,
);
- $CURRENT_METACLASS->add_method($name => $method);
+ $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 {
- confess "with must be called within the role { ... } block."
- unless $CURRENT_METACLASS;
- Moose::Util::apply_all_roles($CURRENT_METACLASS, @_);
+ my $caller = shift;
+ my $meta = $CURRENT_METACLASS || Class::MOP::class_of($caller);
+
+ Moose::Util::apply_all_roles($meta, @_);
}
sub requires {
- confess "requires must be called within the role { ... } block."
- unless $CURRENT_METACLASS;
- croak "Must specify at least one method" unless @_;
- $CURRENT_METACLASS->add_required_methods(@_);
+ 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 {
- confess "excludes must be called within the role { ... } block."
- unless $CURRENT_METACLASS;
- croak "Must specify at least one role" unless @_;
- $CURRENT_METACLASS->add_excluded_roles(@_);
+ 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(@_);
}
-sub extends { croak "Roles do not currently support 'extends'" }
+# see Moose.pm for discussion
+sub super {
+ return unless $Moose::SUPER_BODY;
+ $Moose::SUPER_BODY->(@Moose::SUPER_ARGS);
+}
-sub inner { croak "Roles cannot support 'inner'" }
+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 { croak "Roles cannot support 'augment'" }
+sub augment { Carp::croak "Roles cannot support 'augment'" }
1;
+__END__
+
+=head1 NAME
+
+MooseX::Role::Parameterized - parameterized roles
+
+=head1 SYNOPSIS
+
+ package MyRole::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 "decrement_$name" => sub {
+ my $self = shift;
+ $self->$name($self->$name - 1);
+ };
+ };
+
+ package MyGame::Tile;
+ use Moose;
+
+ with 'MyRole::Counter' => { name => 'stepped_on' };
+
+=head1 L<MooseX::Role::Parameterized::Tutorial>
+
+B<Stop!> If you're new here, please read
+L<MooseX::Role::Parameterized::Tutorial> for a much gentler introduction.
+
+=head1 DESCRIPTION
+
+Your parameterized role consists of two new things: parameter declarations
+and a C<role> block.
+
+Parameters are declared using the L</parameter> keyword which very much
+resembles L<Moose/has>. You can use any option that L<Moose/has> accepts. The
+default value for the C<is> option is C<ro> as that's a very common case. These
+parameters will get their values when the consuming class (or role) uses
+L<Moose/with>. A parameter object will be constructed with these values, and
+passed to the C<role> block.
+
+The C<role> block then uses the usual L<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.
+
+=head2 Why a parameters object?
+
+I've been asked several times "Why use a parameter I<object> and not just a
+parameter I<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. :)
+
+=head1 CAVEATS
+
+You must use this syntax to declare methods in the role block:
+C<< method NAME => sub { ... }; >>. This is due to a limitation in Perl. In
+return though you can use parameters I<in your methods>!
+
+L<Moose::Role/alias> and L<Moose::Role/excludes> 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 C<alias> or
+C<excludes> is an error.
+
+=head1 AUTHOR
+
+Shawn M Moore, C<< <sartak@bestpractical.com> >>
+
+=head1 EXAMPLES
+
+=over 4
+
+=item L<MooseX::Role::Matcher>
+
+=item L<MooseX::Role::XMLRPC::Client>
+
+=item L<MooseX::RelatedClassRoles>
+
+=item L<WWW::Mechanize::TreeBuilder>
+
+=item L<NetHack::Item::Role::IncorporatesStats>
+
+=item L<TAEB::Action::Role::Item>
+
+=item L<KiokuDB::Role::Scan>
+
+=item L<Fey::Role::MakesAliasObjects>
+
+=item L<Fey::Role::HasAliasName>
+
+=item L<Fey::Role::SetOperation>
+
+=back
+
+=head1 SEE ALSO
+
+L<http://sartak.blogspot.com/2009/05/parameterized-roles.html>
+
+=cut
+
projects / gitmo/MooseX-Role-Parameterized.git / blobdiff