lib/Moose/AttributeHelpers/Trait/Counter.pm

   1
   2 package Moose::AttributeHelpers::Trait::Counter;
   3 use Moose::Role;
   4
   5 our $VERSION   = '0.85';
   6 $VERSION = eval $VERSION;
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   9 use Moose::AttributeHelpers::MethodProvider::Counter;
  10
  11 with 'Moose::AttributeHelpers::Trait::Base';
  12
  13 has 'method_provider' => (
  14     is        => 'ro',
  15     isa       => 'ClassName',
  16     predicate => 'has_method_provider',
  17     default   => 'Moose::AttributeHelpers::MethodProvider::Counter',
  18 );
  19
  20 sub _default_default { 0 }
  21 sub _default_is { 'ro' }
  22
  23 sub helper_type { 'Num' }
  24
  25 after '_check_handles_values' => sub {
  26     my $self    = shift;
  27     my $handles = $self->handles;
  28
  29     unless ( scalar keys %$handles ) {
  30         my $method_constructors = $self->method_constructors;
  31         my $attr_name           = $self->name;
  32
  33         foreach my $method ( keys %$method_constructors ) {
  34             $handles->{ $method . '_' . $attr_name } = $method;
  35         }
  36
  37         $self->_set_handles($handles);
  38     }
  39 };
  40
  41 no Moose::Role;
  42
  43 # register the alias ...
  44 package # hide me from search.cpan.org
  45     Moose::Meta::Attribute::Custom::Trait::Counter;
  46 sub register_implementation { 'Moose::AttributeHelpers::Trait::Counter' }
  47
  48 1;
  49
  50 __END__
  51
  52 =pod
  53
  54 =head1 NAME
  55
  56 Moose::AttributeHelpers::Counter
  57
  58 =head1 SYNOPSIS
  59
  60   package MyHomePage;
  61   use Moose;
  62   use Moose::AttributeHelpers;
  63
  64   has 'counter' => (
  65       metaclass => 'Counter',
  66       is        => 'ro',
  67       isa       => 'Num',
  68       default   => 0,
  69       handles   => {
  70           inc_counter   => 'inc',
  71           dec_counter   => 'dec',
  72           reset_counter => 'reset',
  73       }
  74   );
  75
  76   my $page = MyHomePage->new();
  77   $page->inc_counter; # same as $page->counter( $page->counter + 1 );
  78   $page->dec_counter; # same as $page->counter( $page->counter - 1 );
  79
  80 =head1 DESCRIPTION
  81
  82 This module provides a simple counter attribute, which can be
  83 incremented and decremented.
  84
  85 If your attribute definition does not include any of I<is>, I<isa>,
  86 I<default> or I<handles> but does use the C<Counter> metaclass,
  87 then this module applies defaults as in the L</SYNOPSIS>
  88 above. This allows for a very basic counter definition:
  89
  90   has 'foo' => (metaclass => 'Counter');
  91   $obj->inc_foo;
  92
  93 =head1 METHODS
  94
  95 =over 4
  96
  97 =item B<meta>
  98
  99 =item B<method_provider>
 100
 101 =item B<has_method_provider>
 102
 103 =item B<helper_type>
 104
 105 =back
 106
 107 =head1 PROVIDED METHODS
 108
 109 It is important to note that all those methods do in place
 110 modification of the value stored in the attribute.
 111
 112 =over 4
 113
 114 =item I<set>
 115
 116 Set the counter to the specified value.
 117
 118 =item I<inc>
 119
 120 Increments the value stored in this slot by 1. Providing an argument will
 121 cause the counter to be increased by specified amount.
 122
 123 =item I<dec>
 124
 125 Decrements the value stored in this slot by 1. Providing an argument will
 126 cause the counter to be increased by specified amount.
 127
 128 =item I<reset>
 129
 130 Resets the value stored in this slot to it's default value.
 131
 132 =back
 133
 134 =head1 BUGS
 135
 136 All complex software has bugs lurking in it, and this module is no
 137 exception. If you find a bug please either email me, or add the bug
 138 to cpan-RT.
 139
 140 =head1 AUTHOR
 141
 142 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 143
 144 =head1 COPYRIGHT AND LICENSE
 145
 146 Copyright 2007-2009 by Infinity Interactive, Inc.
 147
 148 L<http://www.iinteractive.com>
 149
 150 This library is free software; you can redistribute it and/or modify
 151 it under the same terms as Perl itself.
 152
 153 =cut