lib/MooseX/AttributeHelpers.pm

   1
   2 package MooseX::AttributeHelpers;
   3
   4 our $VERSION   = '0.09';
   5 our $AUTHORITY = 'cpan:STEVAN';
   6
   7 use MooseX::AttributeHelpers::Meta::Method::Provided;
   8 use MooseX::AttributeHelpers::Meta::Method::Curried;
   9
  10 use MooseX::AttributeHelpers::Counter;
  11 use MooseX::AttributeHelpers::Number;
  12 use MooseX::AttributeHelpers::String;
  13 use MooseX::AttributeHelpers::Bool;
  14 use MooseX::AttributeHelpers::Collection::List;
  15 use MooseX::AttributeHelpers::Collection::Array;
  16 use MooseX::AttributeHelpers::Collection::Hash;
  17 use MooseX::AttributeHelpers::Collection::ImmutableHash;
  18 use MooseX::AttributeHelpers::Collection::Bag;
  19
  20 1;
  21
  22 __END__
  23
  24 =pod
  25
  26 =head1 NAME
  27
  28 MooseX::AttributeHelpers - Extend your attribute interfaces
  29
  30 =head1 SYNOPSIS
  31
  32   package MyClass;
  33   use Moose;
  34   use MooseX::AttributeHelpers;
  35
  36   has 'mapping' => (
  37       metaclass => 'Collection::Hash',
  38       is        => 'rw',
  39       isa       => 'HashRef[Str]',
  40       default   => sub { {} },
  41       provides  => {
  42           exists    => 'exists_in_mapping',
  43           keys      => 'ids_in_mapping',
  44           get       => 'get_mapping',
  45           set       => 'set_mapping',
  46       },
  47       curries  => {
  48           set       => { set_quantity => [ 'quantity' ] }
  49       }
  50   );
  51
  52   # ...
  53
  54   my $obj = MyClass->new;
  55   $obj->set_quantity(10);      # quantity => 10
  56   $obj->set_mapping(4, 'foo'); # 4 => 'foo'
  57   $obj->set_mapping(5, 'bar'); # 5 => 'bar'
  58   $obj->set_mapping(6, 'baz'); # 6 => 'baz'
  59
  60   # prints 'bar'
  61   print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
  62
  63   # prints '4, 5, 6'
  64   print join ', ', $obj->ids_in_mapping;
  65
  66 =head1 DESCRIPTION
  67
  68 While L<Moose> attributes provide you with a way to name your accessors,
  69 readers, writers, clearers and predicates, this library provides commonly
  70 used attribute helper methods for more specific types of data.
  71
  72 As seen in the L</SYNOPSIS>, you specify the extension via the
  73 C<metaclass> parameter. Available meta classes are:
  74
  75 =head1 PARAMETERS
  76
  77 =head2 provides
  78
  79 This points to a hashref that uses C<provider> for the keys and
  80 C<method> for the values.  The method will be added to
  81 the object itself and do what you want.
  82
  83 =head2 curries
  84
  85 This points to a hashref that uses C<provider> for the keys and
  86 C<< {method => [ @args ]} >> for the values.  The method will be added to
  87 the object itself (always using C<@args> as the beginning arguments).
  88
  89 =head1 METHOD PROVIDERS
  90
  91 =over
  92
  93 =item L<Number|MooseX::AttributeHelpers::Number>
  94
  95 Common numerical operations.
  96
  97 =item L<Counter|MooseX::AttributeHelpers::Counter>
  98
  99 Methods for incrementing and decrementing a counter attribute.
 100
 101 =item L<Counter|MooseX::AttributeHelpers::Bool>
 102
 103 Common methods for boolean values.
 104
 105 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
 106
 107 Common methods for hash references.
 108
 109 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
 110
 111 Common methods for array references.
 112
 113 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
 114
 115 Common list methods for array references.
 116
 117 =back
 118
 119 =head1 CAVEAT
 120
 121 This is an early release of this module. Right now it is in great need
 122 of documentation and tests in the test suite. However, we have used this
 123 module to great success at C<$work> where it has been tested very thoroughly
 124 and deployed into a major production site.
 125
 126 I plan on getting better docs and tests in the next few releases, but until
 127 then please refer to the few tests we do have and feel free email and/or
 128 message me on irc.perl.org if you have any questions.
 129
 130 =head1 TODO
 131
 132 We need tests and docs badly.
 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 B<with contributions from:>
 145
 146 Robert (rlb3) Boone
 147
 148 Paul (frodwith) Driver
 149
 150 Shawn (Sartak) Moore
 151
 152 Chris (perigrin) Prather
 153
 154 Robert (phaylon) Sedlacek
 155
 156 Tom (dec) Lanyon
 157
 158 Yuval Kogman
 159
 160 Jason May
 161
 162 =head1 COPYRIGHT AND LICENSE
 163
 164 Copyright 2007, 2008 by Infinity Interactive, Inc.
 165
 166 L<http://www.iinteractive.com>
 167
 168 This library is free software; you can redistribute it and/or modify
 169 it under the same terms as Perl itself.
 170
 171 =cut