2 package MooseX::AttributeHelpers;
5 our $AUTHORITY = 'cpan:STEVAN';
7 use MooseX::AttributeHelpers::Meta::Method::Provided;
8 use MooseX::AttributeHelpers::Meta::Method::Curried;
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;
28 MooseX::AttributeHelpers - Extend your attribute interfaces
34 use MooseX::AttributeHelpers;
37 metaclass => 'Collection::Hash',
39 isa => 'HashRef[Str]',
40 default => sub { {} },
42 exists => 'exists_in_mapping',
43 keys => 'ids_in_mapping',
48 set => { set_quantity => [ 'quantity' ] }
55 my $obj = MyClass->new;
56 $obj->set_quantity(10); # quantity => 10
57 $obj->set_mapping(4, 'foo'); # 4 => 'foo'
58 $obj->set_mapping(5, 'bar'); # 5 => 'bar'
59 $obj->set_mapping(6, 'baz'); # 6 => 'baz'
63 print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
66 print join ', ', $obj->ids_in_mapping;
70 While L<Moose> attributes provide you with a way to name your accessors,
71 readers, writers, clearers and predicates, this library provides commonly
72 used attribute helper methods for more specific types of data.
74 As seen in the L</SYNOPSIS>, you specify the extension via the
75 C<metaclass> parameter. Available meta classes are:
81 This points to a hashref that uses C<provider> for the keys and
82 C<method> for the values. The method will be added to
83 the object itself and do what you want.
87 This points to a hashref that uses C<provider> for the keys and
88 has two choices for the value:
90 You can supply C<< {method => [ @args ]} >> for the values. The method will be
91 added to the object itself (always using C<@args> as the beginning arguments).
93 Another approach to curry a method provider is to supply a coderef instead of an
94 arrayref. The code ref takes C<$self>, C<$body>, and any additional arguments
95 passed to the final method.
101 times_with_day => sub {
102 my ($self, $body, $datetime) = @_;
103 $body->($self, sub { $_->ymd eq $datetime->ymd });
110 $obj->times_with_day(DateTime->now); # takes datetime argument, checks day
113 =head1 METHOD PROVIDERS
117 =item L<Number|MooseX::AttributeHelpers::Number>
119 Common numerical operations.
121 =item L<Counter|MooseX::AttributeHelpers::Counter>
123 Methods for incrementing and decrementing a counter attribute.
125 =item L<Counter|MooseX::AttributeHelpers::Bool>
127 Common methods for boolean values.
129 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
131 Common methods for hash references.
133 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
135 Common methods for array references.
137 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
139 Common list methods for array references.
145 This is an early release of this module. Right now it is in great need
146 of documentation and tests in the test suite. However, we have used this
147 module to great success at C<$work> where it has been tested very thoroughly
148 and deployed into a major production site.
150 I plan on getting better docs and tests in the next few releases, but until
151 then please refer to the few tests we do have and feel free email and/or
152 message me on irc.perl.org if you have any questions.
156 We need tests and docs badly.
160 All complex software has bugs lurking in it, and this module is no
161 exception. If you find a bug please either email me, or add the bug
166 Stevan Little E<lt>stevan@iinteractive.comE<gt>
168 B<with contributions from:>
172 Paul (frodwith) Driver
176 Chris (perigrin) Prather
178 Robert (phaylon) Sedlacek
186 =head1 COPYRIGHT AND LICENSE
188 Copyright 2007, 2008 by Infinity Interactive, Inc.
190 L<http://www.iinteractive.com>
192 This library is free software; you can redistribute it and/or modify
193 it under the same terms as Perl itself.