package Moose::Meta::Attribute::Native::Trait::Counter;
use Moose::Role;
-our $VERSION = '0.93_03';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
-
-use Moose::Meta::Attribute::Native::MethodProvider::Counter;
-
with 'Moose::Meta::Attribute::Native::Trait';
-has 'method_provider' => (
- is => 'ro',
- isa => 'ClassName',
- predicate => 'has_method_provider',
- default => 'Moose::Meta::Attribute::Native::MethodProvider::Counter',
-);
-
sub _default_default { 0 }
sub _default_is { 'ro' }
sub _helper_type { 'Num' }
+sub _root_types { 'Num', 'Int' }
no Moose::Role;
1;
+# ABSTRACT: Helper trait for Int attributes which represent counters
+
__END__
=pod
-=head1 NAME
-
-Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for counters
-
=head1 SYNOPSIS
package MyHomePage;
use Moose;
has 'counter' => (
- traits => ['Counter'],
- is => 'ro',
- isa => 'Num',
- default => 0,
- handles => {
+ traits => ['Counter'],
+ is => 'ro',
+ isa => 'Num',
+ default => 0,
+ handles => {
inc_counter => 'inc',
dec_counter => 'dec',
reset_counter => 'reset',
);
my $page = MyHomePage->new();
- $page->inc_counter; # same as $page->counter( $page->counter + 1 );
- $page->dec_counter; # same as $page->counter( $page->counter - 1 );
+ $page->inc_counter; # same as $page->counter( $page->counter + 1 );
+ $page->dec_counter; # same as $page->counter( $page->counter - 1 );
+
+ my $count_by_twos = 2;
+ $page->inc_counter($count_by_twos);
=head1 DESCRIPTION
-This module provides a simple counter attribute, which can be
-incremented and decremented.
+This trait provides native delegation methods for counters. A counter can be
+any sort of number (integer or not). The delegation methods allow you to
+increment, decrement, or reset the value.
-If your attribute definition does not include any of I<is>, I<isa>,
-I<default> or I<handles> but does use the C<Counter> trait,
-then this module applies defaults as in the L</SYNOPSIS>
-above. This allows for a very basic counter definition:
+=head1 DEFAULT TYPE
- has 'foo' => (traits => ['Counter']);
- $obj->inc_foo;
+If you don't provide an C<isa> value for your attribute, it will default to
+C<Num>.
=head1 PROVIDED METHODS
-These methods are implemented in
-L<Moose::Meta::Attribute::Native::MethodProvider::Counter>. It is important to
-note that all those methods do in place modification of the value stored in
-the attribute.
-
=over 4
-=item B<set($value)>
+=item * B<set($value)>
-Set the counter to the specified value.
+Sets the counter to the specified value and returns the new value.
-=item B<inc>
+This method requires a single argument.
-Increments the value stored in this slot by 1. Providing an argument will
-cause the counter to be increased by specified amount.
+=item * B<inc>
-=item B<dec>
+=item * B<inc($arg)>
-Decrements the value stored in this slot by 1. Providing an argument will
-cause the counter to be increased by specified amount.
+Increases the attribute value by the amount of the argument, or by 1 if no
+argument is given. This method returns the new value.
-=item B<reset>
+This method accepts a single argument.
-Resets the value stored in this slot to it's default value.
+=item * B<dec>
-=back
+=item * B<dec($arg)>
-=head1 METHODS
+Decreases the attribute value by the amount of the argument, or by 1 if no
+argument is given. This method returns the new value.
-=over 4
-
-=item B<meta>
+This method accepts a single argument.
-=item B<method_provider>
+=item * B<reset>
-=item B<has_method_provider>
+Resets the value stored in this slot to its default value, and returns the new
+value.
=back
See L<Moose/BUGS> for details on reporting bugs.
-=head1 AUTHOR
-
-Stevan Little E<lt>stevan@iinteractive.comE<gt>
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2007-2009 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
projects / gitmo/Moose.git / blobdiff