1 package MooseX::AttributeHelpers;
4 our $AUTHORITY = 'cpan:STEVAN';
6 use MooseX::AttributeHelpers::Composite;
8 use MooseX::AttributeHelpers::Meta::Method::Provided;
10 use MooseX::AttributeHelpers::Counter;
11 use MooseX::AttributeHelpers::Number;
12 use MooseX::AttributeHelpers::String;
13 use MooseX::AttributeHelpers::Collection::List;
14 use MooseX::AttributeHelpers::Collection::Array;
15 use MooseX::AttributeHelpers::Collection::Hash;
16 use MooseX::AttributeHelpers::Collection::ImmutableHash;
17 use MooseX::AttributeHelpers::Collection::Bag;
27 MooseX::AttributeHelpers - Extend your attribute interfaces
33 use MooseX::AttributeHelpers;
36 metaclass => 'Collection::Hash',
38 isa => 'HashRef[Str]',
39 default => sub { {} },
41 exists => 'exists_in_mapping',
42 keys => 'ids_in_mapping',
50 my $obj = MyClass->new;
51 $obj->set_mapping(4, 'foo');
52 $obj->set_mapping(5, 'bar');
53 $obj->set_mapping(6, 'baz');
56 print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
59 print join ', ', $obj->ids_in_mapping;
63 While L<Moose> attributes provide you with a way to name your accessors,
64 readers, writers, clearers and predicates, this library provides commonly
65 used attribute helper methods for more specific types of data.
67 As seen in the L</SYNOPSIS>, you specify the extension via the
68 C<metaclass> parameter. Available meta classes are:
72 =item L<Number|MooseX::AttributeHelpers::Number>
74 Common numerical operations.
76 =item L<Counter|MooseX::AttributeHelpers::Counter>
78 Methods for incrementing and decrementing a counter attribute.
80 =item L<String|MooseX::AttributeHelpers::String>
82 Common string operations.
84 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
86 Common methods for hash references.
88 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
90 Common methods for array references.
92 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
94 Common list methods for array references.
96 =item L<Collection::Bag|MooseX::AttributeHelpers::Collection::Bag>
100 =item L<Collection::ImmutableHash|MooseX::AttributeHelpers::Collection::ImmutableHash>
102 Hashes with no change methods.
108 The methods provided by the above methods can be selectively composed with the
109 metaclass L<Composite|MooseX::AttributeHelpers::Composite>, which is also
110 available in L<Trait|MooseX::AttributeHelpers::Composite::Trait> form.
114 This is an early release of this module. Right now it is in great need
115 of documentation and tests in the test suite. However, we have used this
116 module to great success at C<$work> where it has been tested very thoroughly
117 and deployed into a major production site.
119 I plan on getting better docs and tests in the next few releases, but until
120 then please refer to the few tests we do have and feel free email and/or
121 message me on irc.perl.org if you have any questions.
125 We need tests and docs badly.
129 All complex software has bugs lurking in it, and this module is no
130 exception. If you find a bug please either email me, or add the bug
135 Stevan Little E<lt>stevan@iinteractive.comE<gt>
137 B<with contributions from:>
141 Chris (perigrin) Prather
143 Robert (phaylon) Sedlacek
149 =head1 COPYRIGHT AND LICENSE
151 Copyright 2007, 2008 by Infinity Interactive, Inc.
153 L<http://www.iinteractive.com>
155 This library is free software; you can redistribute it and/or modify
156 it under the same terms as Perl itself.