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