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.14';
   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 module provides a simple counter attribute, which can be
  61 incremented and decremented by arbitrary amounts.  The default
  62 amount of change is one.
  63
  64 =head1 PROVIDED METHODS
  65
  66 These methods are implemented in
  67 L<Moose::Meta::Attribute::Native::MethodProvider::Counter>. It is important to
  68 note that all those methods do in place modification of the value stored in
  69 the attribute.
  70
  71 =over 4
  72
  73 =item B<set($value)>
  74
  75 Set the counter to the specified value.
  76
  77 =item B<inc($arg)>
  78
  79 Increase the attribute value by the amount of the argument.
  80 No argument increments the value by 1.
  81
  82 =item B<dec($arg)>
  83
  84 Decrease the attribute value by the amount of the argument.
  85 No argument decrements the value by 1.
  86
  87 =item B<reset>
  88
  89 Resets the value stored in this slot to it's default value.
  90
  91 =back
  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 =back
 104
 105 =head1 BUGS
 106
 107 See L<Moose/BUGS> for details on reporting bugs.
 108
 109 =head1 AUTHOR
 110
 111 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 112
 113 =head1 COPYRIGHT AND LICENSE
 114
 115 Copyright 2007-2009 by Infinity Interactive, Inc.
 116
 117 L<http://www.iinteractive.com>
 118
 119 This library is free software; you can redistribute it and/or modify
 120 it under the same terms as Perl itself.
 121
 122 =cut