Commit | Line | Data |
22d869ff |
1 | |
2 | package MooseX::AttributeHelpers; |
3 | |
532b802c |
4 | our $VERSION = '0.08'; |
22d869ff |
5 | our $AUTHORITY = 'cpan:STEVAN'; |
6 | |
8f7951c9 |
7 | use MooseX::AttributeHelpers::Meta::Method::Provided; |
8 | |
22d869ff |
9 | use MooseX::AttributeHelpers::Counter; |
565fe238 |
10 | use MooseX::AttributeHelpers::Number; |
190b1c02 |
11 | use MooseX::AttributeHelpers::String; |
457dc4fb |
12 | use MooseX::AttributeHelpers::Collection::List; |
22d869ff |
13 | use MooseX::AttributeHelpers::Collection::Array; |
14 | use MooseX::AttributeHelpers::Collection::Hash; |
9a976497 |
15 | use MooseX::AttributeHelpers::Collection::ImmutableHash; |
16 | use MooseX::AttributeHelpers::Collection::Bag; |
22d869ff |
17 | |
18 | 1; |
19 | |
20 | __END__ |
21 | |
22 | =pod |
23 | |
24 | =head1 NAME |
25 | |
e295d072 |
26 | MooseX::AttributeHelpers - Extend your attribute interfaces |
fa4df2e6 |
27 | |
22d869ff |
28 | =head1 SYNOPSIS |
29 | |
e295d072 |
30 | package MyClass; |
31 | use Moose; |
5431dff2 |
32 | use MooseX::AttributeHelpers; |
e295d072 |
33 | |
5431dff2 |
34 | has 'mapping' => ( |
e295d072 |
35 | metaclass => 'Collection::Hash', |
36 | is => 'rw', |
5431dff2 |
37 | isa => 'HashRef[Str]', |
e295d072 |
38 | default => sub { {} }, |
39 | provides => { |
40 | exists => 'exists_in_mapping', |
41 | keys => 'ids_in_mapping', |
42 | get => 'get_mapping', |
43 | set => 'set_mapping', |
44 | }, |
45 | ); |
46 | |
47 | # ... |
48 | |
49 | my $obj = MyClass->new; |
50 | $obj->set_mapping(4, 'foo'); |
51 | $obj->set_mapping(5, 'bar'); |
52 | $obj->set_mapping(6, 'baz'); |
53 | |
54 | # prints 'bar' |
55 | print $obj->get_mapping(5) if $obj->exists_in_mapping(5); |
56 | |
57 | # prints '4, 5, 6' |
58 | print join ', ', $obj->ids_in_mapping; |
59 | |
22d869ff |
60 | =head1 DESCRIPTION |
61 | |
e295d072 |
62 | While L<Moose> attributes provide you with a way to name your accessors, |
63 | readers, writers, clearers and predicates, this library provides commonly |
64 | used attribute helper methods for more specific types of data. |
65 | |
66 | As seen in the L</SYNOPSIS>, you specify the extension via the |
67 | C<metaclass> parameter. Available meta classes are: |
68 | |
69 | =over |
70 | |
71 | =item L<Number|MooseX::AttributeHelpers::Number> |
72 | |
73 | Common numerical operations. |
74 | |
75 | =item L<Counter|MooseX::AttributeHelpers::Counter> |
76 | |
77 | Methods for incrementing and decrementing a counter attribute. |
78 | |
79 | =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash> |
80 | |
81 | Common methods for hash references. |
82 | |
83 | =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array> |
84 | |
85 | Common methods for array references. |
86 | |
72a41843 |
87 | =item L<Collection::List|MooseX::AttributeHelpers::Collection::List> |
457dc4fb |
88 | |
89 | Common list methods for array references. |
90 | |
e295d072 |
91 | =back |
92 | |
5431dff2 |
93 | =head1 CAVEAT |
94 | |
95 | This is an early release of this module. Right now it is in great need |
96 | of documentation and tests in the test suite. However, we have used this |
c91a1347 |
97 | module to great success at C<$work> where it has been tested very thoroughly |
5431dff2 |
98 | and deployed into a major production site. |
99 | |
100 | I plan on getting better docs and tests in the next few releases, but until |
101 | then please refer to the few tests we do have and feel free email and/or |
102 | message me on irc.perl.org if you have any questions. |
103 | |
104 | =head1 TODO |
105 | |
106 | We need tests and docs badly. |
107 | |
22d869ff |
108 | =head1 BUGS |
109 | |
110 | All complex software has bugs lurking in it, and this module is no |
111 | exception. If you find a bug please either email me, or add the bug |
112 | to cpan-RT. |
113 | |
114 | =head1 AUTHOR |
115 | |
116 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
117 | |
5431dff2 |
118 | B<with contributions from:> |
119 | |
120 | Robert (rlb3) Boone |
121 | |
122 | Chris (perigrin) Prather |
123 | |
124 | Robert (phaylon) Sedlacek |
125 | |
38abf787 |
126 | Tom (dec) Lanyon |
127 | |
eca30395 |
128 | Yuval Kogman |
129 | |
22d869ff |
130 | =head1 COPYRIGHT AND LICENSE |
131 | |
eca30395 |
132 | Copyright 2007, 2008 by Infinity Interactive, Inc. |
22d869ff |
133 | |
134 | L<http://www.iinteractive.com> |
135 | |
136 | This library is free software; you can redistribute it and/or modify |
137 | it under the same terms as Perl itself. |
138 | |
e295d072 |
139 | =cut |