2 package MooseX::AttributeHelpers;
5 our $AUTHORITY = 'cpan:STEVAN';
7 use MooseX::AttributeHelpers::Meta::Method::Provided;
9 use MooseX::AttributeHelpers::Trait::Counter;
10 use MooseX::AttributeHelpers::Trait::Number;
11 use MooseX::AttributeHelpers::Trait::String;
13 use MooseX::AttributeHelpers::Counter;
14 use MooseX::AttributeHelpers::Number;
15 use MooseX::AttributeHelpers::String;
16 use MooseX::AttributeHelpers::Collection::List;
17 use MooseX::AttributeHelpers::Collection::Array;
18 use MooseX::AttributeHelpers::Collection::Hash;
19 use MooseX::AttributeHelpers::Collection::ImmutableHash;
20 use MooseX::AttributeHelpers::Collection::Bag;
30 MooseX::AttributeHelpers - Extend your attribute interfaces
36 use MooseX::AttributeHelpers;
39 metaclass => 'Collection::Hash',
41 isa => 'HashRef[Str]',
42 default => sub { {} },
44 exists => 'exists_in_mapping',
45 keys => 'ids_in_mapping',
53 my $obj = MyClass->new;
54 $obj->set_mapping(4, 'foo');
55 $obj->set_mapping(5, 'bar');
56 $obj->set_mapping(6, 'baz');
59 print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
62 print join ', ', $obj->ids_in_mapping;
66 While L<Moose> attributes provide you with a way to name your accessors,
67 readers, writers, clearers and predicates, this library provides commonly
68 used attribute helper methods for more specific types of data.
70 As seen in the L</SYNOPSIS>, you specify the extension via the
71 C<metaclass> parameter. Available meta classes are:
75 =item L<Number|MooseX::AttributeHelpers::Number>
77 Common numerical operations.
79 =item L<Counter|MooseX::AttributeHelpers::Counter>
81 Methods for incrementing and decrementing a counter attribute.
83 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
85 Common methods for hash references.
87 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
89 Common methods for array references.
91 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
93 Common list methods for array references.
99 This is an early release of this module. Right now it is in great need
100 of documentation and tests in the test suite. However, we have used this
101 module to great success at C<$work> where it has been tested very thoroughly
102 and deployed into a major production site.
104 I plan on getting better docs and tests in the next few releases, but until
105 then please refer to the few tests we do have and feel free email and/or
106 message me on irc.perl.org if you have any questions.
110 We need tests and docs badly.
114 All complex software has bugs lurking in it, and this module is no
115 exception. If you find a bug please either email me, or add the bug
120 Stevan Little E<lt>stevan@iinteractive.comE<gt>
122 B<with contributions from:>
126 Chris (perigrin) Prather
128 Robert (phaylon) Sedlacek
134 =head1 COPYRIGHT AND LICENSE
136 Copyright 2007, 2008 by Infinity Interactive, Inc.
138 L<http://www.iinteractive.com>
140 This library is free software; you can redistribute it and/or modify
141 it under the same terms as Perl itself.