package MooseX::AttributeHelpers::Counter;
use Moose;
-use Moose::Util::TypeConstraints;
-our $VERSION = '0.01';
+our $VERSION = '0.17';
+$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
-extends 'Moose::Meta::Attribute';
-
-my %METHOD_CONSTRUCTORS = (
- inc => sub {
- my $attr = shift;
- return sub { $attr->set_value($_[0], $attr->get_value($_[0]) + 1) };
- },
- dec => sub {
- my $attr = shift;
- return sub { $attr->set_value($_[0], $attr->get_value($_[0]) - 1) };
- },
-);
+use MooseX::AttributeHelpers::MethodProvider::Counter;
+
+extends 'MooseX::AttributeHelpers::Base';
-has 'provides' => (
- is => 'ro',
- isa => subtype('HashRef' => where {
- (exists $METHOD_CONSTRUCTORS{$_} || return) for keys %{$_}; 1;
- }),
- required => 1,
+has '+method_provider' => (
+ default => 'MooseX::AttributeHelpers::MethodProvider::Counter'
);
-has '+$!default' => (required => 1);
-has '+type_constraint' => (required => 1);
+sub helper_type { 'Num' }
-before '_process_options' => sub {
- my ($self, %options) = @_;
-
- if (exists $options{provides}) {
- (exists $options{isa})
- || confess "You must define a type with the Counter metaclass";
-
- (find_type_constraint($options{isa})->is_subtype_of('Num'))
- || confess "The type constraint for a Counter must be a subtype of Num";
+before 'process_options_for_provides' => sub {
+ my ($self, $options, $name) = @_;
+
+ # Set some default attribute options here unless already defined
+ if ((my $type = $self->helper_type) && !exists $options->{isa}){
+ $options->{isa} = $type;
}
+
+ $options->{is} = 'ro' unless exists $options->{is};
+ $options->{default} = 0 unless exists $options->{default};
};
-after 'install_accessors' => sub {
- my $attr = shift;
- my $class = $attr->associated_class;
-
- foreach my $key (keys %{$attr->provides}) {
- (exists $METHOD_CONSTRUCTORS{$key})
- || confess "Unsupported method type ($key)";
- $class->add_method(
- $attr->provides->{$key},
- $METHOD_CONSTRUCTORS{$key}->($attr)
- );
+after 'check_provides_values' => sub {
+ my $self = shift;
+ my $provides = $self->provides;
+
+ unless (scalar keys %$provides) {
+ my $method_constructors = $self->method_constructors;
+ my $attr_name = $self->name;
+
+ foreach my $method (keys %$method_constructors) {
+ $provides->{$method} = ($method . '_' . $attr_name);
+ }
}
};
no Moose;
-no Moose::Util::TypeConstraints;
# register the alias ...
-package Moose::Meta::Attribute::Custom::Counter;
+package # hide me from search.cpan.org
+ Moose::Meta::Attribute::Custom::Counter;
sub register_implementation { 'MooseX::AttributeHelpers::Counter' }
1;
package MyHomePage;
use Moose;
+ use MooseX::AttributeHelpers;
has 'counter' => (
metaclass => 'Counter',
- is => 'rw',
- isa => 'Int',
+ is => 'ro',
+ isa => 'Num',
default => sub { 0 },
provides => {
inc => 'inc_counter',
+ dec => 'dec_counter',
+ reset => 'reset_counter',
}
);
my $page = MyHomePage->new();
$page->inc_counter; # same as $page->counter($page->counter + 1);
+ $page->dec_counter; # same as $page->counter($page->counter - 1);
=head1 DESCRIPTION
+This module provides a simple counter attribute, which can be
+incremented and decremeneted.
+
+If your attribute definition does not include any of I<is>, I<isa>,
+I<default> or I<provides> but does use the C<Counter> metaclass,
+then this module applies defaults as in the L</SYNOPSIS>
+above. This allows for a very basic counter definition:
+
+ has 'foo' => (metaclass => 'Counter');
+ $obj->inc_foo;
+
=head1 METHODS
+=over 4
+
+=item B<meta>
+
+=item B<method_provider>
+
+=item B<has_method_provider>
+
+=item B<helper_type>
+
+=item B<process_options_for_provides>
+
+Run before its superclass method.
+
+=item B<check_provides_values>
+
+Run after its superclass method.
+
+=back
+
+=head1 PROVIDED METHODS
+
+It is important to note that all those methods do in place
+modification of the value stored in the attribute.
+
+=over 4
+
+=item I<set>
+
+Set the counter to the specified value.
+
+=item I<inc>
+
+Increments the value stored in this slot by 1. Providing an argument will
+cause the counter to be increased by specified amount.
+
+=item I<dec>
+
+Decrements the value stored in this slot by 1. Providing an argument will
+cause the counter to be increased by specified amount.
+
+=item I<reset>
+
+Resets the value stored in this slot to it's default value.
+
+=back
+
=head1 BUGS
All complex software has bugs lurking in it, and this module is no
=head1 COPYRIGHT AND LICENSE
-Copyright 2007 by Infinity Interactive, Inc.
+Copyright 2007-2008 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
-=cut
\ No newline at end of file
+=cut