2 package MooseX::AttributeHelpers;
5 $VERSION = eval $VERSION;
6 our $AUTHORITY = 'cpan:STEVAN';
10 use MooseX::AttributeHelpers::Meta::Method::Provided;
11 use MooseX::AttributeHelpers::Meta::Method::Curried;
13 use MooseX::AttributeHelpers::Counter;
14 use MooseX::AttributeHelpers::Number;
15 use MooseX::AttributeHelpers::String;
16 use MooseX::AttributeHelpers::Bool;
17 use MooseX::AttributeHelpers::Collection::List;
18 use MooseX::AttributeHelpers::Collection::Array;
19 use MooseX::AttributeHelpers::Collection::Hash;
20 use MooseX::AttributeHelpers::Collection::ImmutableHash;
21 use MooseX::AttributeHelpers::Collection::Bag;
31 MooseX::AttributeHelpers - Extend your attribute interfaces
37 use MooseX::AttributeHelpers;
40 metaclass => 'Collection::Hash',
42 isa => 'HashRef[Str]',
43 default => sub { {} },
45 exists => 'exists_in_mapping',
46 keys => 'ids_in_mapping',
51 set => { set_quantity => [ 'quantity' ] }
58 my $obj = MyClass->new;
59 $obj->set_quantity(10); # quantity => 10
60 $obj->set_mapping(4, 'foo'); # 4 => 'foo'
61 $obj->set_mapping(5, 'bar'); # 5 => 'bar'
62 $obj->set_mapping(6, 'baz'); # 6 => 'baz'
66 print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
69 print join ', ', $obj->ids_in_mapping;
73 While L<Moose> attributes provide you with a way to name your accessors,
74 readers, writers, clearers and predicates, this library provides commonly
75 used attribute helper methods for more specific types of data.
77 As seen in the L</SYNOPSIS>, you specify the extension via the
78 C<metaclass> parameter. Available meta classes are:
84 This points to a hashref that uses C<provider> for the keys and
85 C<method> for the values. The method will be added to
86 the object itself and do what you want.
90 This points to a hashref that uses C<provider> for the keys and
91 has two choices for the value:
93 You can supply C<< {method => [ @args ]} >> for the values. The method will be
94 added to the object itself (always using C<@args> as the beginning arguments).
96 Another approach to curry a method provider is to supply a coderef instead of an
97 arrayref. The code ref takes C<$self>, C<$body>, and any additional arguments
98 passed to the final method.
104 times_with_day => sub {
105 my ($self, $body, $datetime) = @_;
106 $body->($self, sub { $_->ymd eq $datetime->ymd });
113 $obj->times_with_day(DateTime->now); # takes datetime argument, checks day
116 =head1 METHOD PROVIDERS
120 =item L<Number|MooseX::AttributeHelpers::Number>
122 Common numerical operations.
124 =item L<Counter|MooseX::AttributeHelpers::Counter>
126 Methods for incrementing and decrementing a counter attribute.
128 =item L<Bool|MooseX::AttributeHelpers::Bool>
130 Common methods for boolean values.
132 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
134 Common methods for hash references.
136 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
138 Common methods for array references.
140 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
142 Common list methods for array references.
148 This is an early release of this module. Right now it is in great need
149 of documentation and tests in the test suite. However, we have used this
150 module to great success at C<$work> where it has been tested very thoroughly
151 and deployed into a major production site.
153 I plan on getting better docs and tests in the next few releases, but until
154 then please refer to the few tests we do have and feel free email and/or
155 message me on irc.perl.org if you have any questions.
159 We need tests and docs badly.
163 All complex software has bugs lurking in it, and this module is no
164 exception. If you find a bug please either email me, or add the bug
169 Stevan Little E<lt>stevan@iinteractive.comE<gt>
171 B<with contributions from:>
175 Paul (frodwith) Driver
179 Chris (perigrin) Prather
181 Robert (phaylon) Sedlacek
191 =head1 COPYRIGHT AND LICENSE
193 Copyright 2007, 2008 by Infinity Interactive, Inc.
195 L<http://www.iinteractive.com>
197 This library is free software; you can redistribute it and/or modify
198 it under the same terms as Perl itself.