lib/Moose/Meta/Attribute/Native/Trait/Counter.pm

   1
   2 package Moose::Meta::Attribute::Native::Trait::Counter;
   3 use Moose::Role;
   4
   5 our $VERSION   = '1.25';
   6 $VERSION = eval $VERSION;
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   9 use Moose::Meta::Method::Accessor::Native::Counter::dec;
  10 use Moose::Meta::Method::Accessor::Native::Counter::inc;
  11 use Moose::Meta::Method::Accessor::Native::Counter::reset;
  12 use Moose::Meta::Method::Accessor::Native::Counter::set;
  13
  14 with 'Moose::Meta::Attribute::Native::Trait' =>
  15     { -excludes => ['_root_types'] };
  16
  17 sub _default_default { 0 }
  18 sub _default_is { 'ro' }
  19 sub _helper_type { 'Num' }
  20 sub _root_types { 'Num', 'Int' }
  21
  22 no Moose::Role;
  23
  24 1;
  25
  26 __END__
  27
  28 =pod
  29
  30 =head1 NAME
  31
  32 Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for counters
  33
  34 =head1 SYNOPSIS
  35
  36   package MyHomePage;
  37   use Moose;
  38
  39   has 'counter' => (
  40       traits  => ['Counter'],
  41       is      => 'ro',
  42       isa     => 'Num',
  43       default => 0,
  44       handles => {
  45           inc_counter   => 'inc',
  46           dec_counter   => 'dec',
  47           reset_counter => 'reset',
  48       },
  49   );
  50
  51   my $page = MyHomePage->new();
  52   $page->inc_counter;    # same as $page->counter( $page->counter + 1 );
  53   $page->dec_counter;    # same as $page->counter( $page->counter - 1 );
  54
  55   my $count_by_twos = 2;
  56   $page->inc_counter($count_by_twos);
  57
  58 =head1 DESCRIPTION
  59
  60 This trait provides native delegation methods for counters. A counter can be
  61 any sort of number (integer or not). The delegation methods allow you to
  62 increment, decrement, or reset the value.
  63
  64 =head1 DEFAULT TYPE
  65
  66 If you don't provide an C<isa> value for your attribute, it will default to
  67 C<Num>.
  68
  69 =head1 PROVIDED METHODS
  70
  71 =over 4
  72
  73 =item * B<set($value)>
  74
  75 Sets the counter to the specified value and returns the new value.
  76
  77 This method requires a single argument.
  78
  79 =item * B<inc>
  80
  81 =item * B<inc($arg)>
  82
  83 Increases the attribute value by the amount of the argument, or by 1 if no
  84 argument is given. This method returns the new value.
  85
  86 This method accepts a single argument.
  87
  88 =item * B<dec>
  89
  90 =item * B<dec($arg)>
  91
  92 Decreases the attribute value by the amount of the argument, or by 1 if no
  93 argument is given. This method returns the new value.
  94
  95 This method accepts a single argument.
  96
  97 =item * B<reset>
  98
  99 Resets the value stored in this slot to its default value, and returns the new
 100 value.
 101
 102 =back
 103
 104 =head1 BUGS
 105
 106 See L<Moose/BUGS> for details on reporting bugs.
 107
 108 =head1 AUTHOR
 109
 110 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 111
 112 =head1 COPYRIGHT AND LICENSE
 113
 114 Copyright 2007-2010 by Infinity Interactive, Inc.
 115
 116 L<http://www.iinteractive.com>
 117
 118 This library is free software; you can redistribute it and/or modify
 119 it under the same terms as Perl itself.
 120
 121 =cut