Commit | Line | Data |
e3c07b19 |
1 | |
c466e58f |
2 | package Moose::Meta::Attribute::Native::Trait::Array; |
e3c07b19 |
3 | use Moose::Role; |
4 | |
bb8ef151 |
5 | our $VERSION = '1.9900'; |
e3c07b19 |
6 | $VERSION = eval $VERSION; |
7 | our $AUTHORITY = 'cpan:STEVAN'; |
8 | |
c466e58f |
9 | with 'Moose::Meta::Attribute::Native::Trait'; |
e3c07b19 |
10 | |
2e069f5a |
11 | sub _helper_type { 'ArrayRef' } |
e3c07b19 |
12 | |
13 | no Moose::Role; |
14 | |
e3c07b19 |
15 | 1; |
16 | |
17 | __END__ |
18 | |
19 | =pod |
20 | |
21 | =head1 NAME |
22 | |
e132fd56 |
23 | Moose::Meta::Attribute::Native::Trait::Array - Helper trait for array delegation |
e3c07b19 |
24 | |
25 | =head1 SYNOPSIS |
26 | |
33f819e1 |
27 | package Stuff; |
28 | use Moose; |
33f819e1 |
29 | |
30 | has 'options' => ( |
e132fd56 |
31 | traits => ['Array'], |
32 | is => 'ro', |
33 | isa => 'ArrayRef[Str]', |
34 | default => sub { [] }, |
35 | handles => { |
36 | all_options => 'elements', |
37 | add_option => 'push', |
38 | map_options => 'map', |
39 | filter_options => 'grep', |
40 | find_option => 'first', |
41 | get_option => 'get', |
42 | join_options => 'join', |
43 | count_options => 'count', |
44 | has_options => 'count', |
45 | has_no_options => 'is_empty', |
46 | sorted_options => 'sort', |
47 | }, |
33f819e1 |
48 | ); |
49 | |
50 | no Moose; |
51 | 1; |
80683705 |
52 | |
e3c07b19 |
53 | =head1 DESCRIPTION |
54 | |
7795e4de |
55 | This trait provides native delegation methods for array references. |
56 | |
57 | =head1 DEFAULT TYPE |
58 | |
59 | If you don't provide an C<isa> value for your attribute, it will default to |
60 | C<ArrayRef>. |
33f819e1 |
61 | |
62 | =head1 PROVIDED METHODS |
63 | |
33f819e1 |
64 | =over 4 |
65 | |
e132fd56 |
66 | =item * B<count> |
33f819e1 |
67 | |
68 | Returns the number of elements in the array. |
69 | |
e132fd56 |
70 | $stuff = Stuff->new; |
71 | $stuff->options( [ "foo", "bar", "baz", "boo" ] ); |
33f819e1 |
72 | |
e132fd56 |
73 | print $stuff->count_options; # prints 4 |
33f819e1 |
74 | |
e132fd56 |
75 | This method does not accept any arguments. |
76 | |
77 | =item * B<is_empty> |
33f819e1 |
78 | |
276828fa |
79 | Returns a boolean value that is true when the array has no elements. |
33f819e1 |
80 | |
e132fd56 |
81 | $stuff->has_no_options ? die "No options!\n" : print "Good boy.\n"; |
82 | |
83 | This method does not accept any arguments. |
84 | |
85 | =item * B<elements> |
33f819e1 |
86 | |
e132fd56 |
87 | Returns all of the elements of the array as an array (not an array reference). |
cd50e921 |
88 | |
e132fd56 |
89 | my @option = $stuff->all_options; |
90 | print "@options\n"; # prints "foo bar baz boo" |
cd50e921 |
91 | |
e132fd56 |
92 | This method does not accept any arguments. |
cd50e921 |
93 | |
e132fd56 |
94 | =item * B<get($index)> |
cd50e921 |
95 | |
96 | Returns an element of the array by its index. You can also use negative index |
97 | numbers, just as with Perl's core array handling. |
98 | |
e132fd56 |
99 | my $option = $stuff->get_option(1); |
100 | print "$option\n"; # prints "bar" |
101 | |
102 | If the specified element does not exist, this will return C<undef>. |
103 | |
104 | This method does accepts just one argument. |
105 | |
106 | =item * B<pop> |
107 | |
108 | Just like Perl's builtin C<pop>. |
109 | |
110 | This method does not accept any arguments. |
111 | |
112 | =item * B<push($value1, $value2, value3 ...)> |
113 | |
114 | Just like Perl's builtin C<push>. Returns the number of elements in the new |
115 | array. |
116 | |
117 | This method accepts any number of arguments. |
118 | |
119 | =item * B<shift> |
cd50e921 |
120 | |
e132fd56 |
121 | Just like Perl's builtin C<shift>. |
cd50e921 |
122 | |
e132fd56 |
123 | This method does not accept any arguments. |
cd50e921 |
124 | |
e132fd56 |
125 | =item * B<unshift($value1, $value2, value3 ...)> |
cd50e921 |
126 | |
e132fd56 |
127 | Just like Perl's builtin C<unshift>. Returns the number of elements in the new |
128 | array. |
cd50e921 |
129 | |
e132fd56 |
130 | This method accepts any number of arguments. |
cd50e921 |
131 | |
e132fd56 |
132 | =item * B<splice($offset, $length, @values)> |
cd50e921 |
133 | |
e132fd56 |
134 | Just like Perl's builtin C<splice>. In scalar context, this returns the last |
135 | element removed, or C<undef> if no elements were removed. In list context, |
136 | this returns all the elements removed from the array. |
137 | |
138 | This method requires at least one argument. |
139 | |
140 | =item * B<first( sub { ... } )> |
33f819e1 |
141 | |
7960bcc0 |
142 | This method returns the first item matching item in the array, just like |
143 | L<List::Util>'s C<first> function. The matching is done with a subroutine |
e132fd56 |
144 | reference you pass to this method. The subroutine will be called against each |
7960bcc0 |
145 | element in the array until one matches or all elements have been checked. |
33f819e1 |
146 | |
e132fd56 |
147 | my $found = $stuff->find_option( sub {/^b/} ); |
148 | print "$found\n"; # prints "bar" |
149 | |
150 | This method requires a single argument. |
33f819e1 |
151 | |
e132fd56 |
152 | =item * B<grep( sub { ... } )> |
33f819e1 |
153 | |
80683705 |
154 | This method returns every element matching a given criteria, just like Perl's |
155 | core C<grep> function. This method requires a subroutine which implements the |
156 | matching logic. |
33f819e1 |
157 | |
e132fd56 |
158 | my @found = $stuff->filter_options( sub {/^b/} ); |
159 | print "@found\n"; # prints "bar baz boo" |
33f819e1 |
160 | |
e132fd56 |
161 | This method requires a single argument. |
162 | |
163 | =item * B<map( sub { ... } )> |
33f819e1 |
164 | |
80683705 |
165 | This method transforms every element in the array and returns a new array, |
166 | just like Perl's core C<map> function. This method requires a subroutine which |
167 | implements the transformation. |
33f819e1 |
168 | |
e132fd56 |
169 | my @mod_options = $stuff->map_options( sub { $_ . "-tag" } ); |
170 | print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag" |
171 | |
172 | This method requires a single argument. |
33f819e1 |
173 | |
e132fd56 |
174 | =item * B<reduce( sub { ... } )> |
7960bcc0 |
175 | |
e132fd56 |
176 | This method turns an array into a single value, by passing a function the |
7960bcc0 |
177 | value so far and the next value in the array, just like L<List::Util>'s |
178 | C<reduce> function. The reducing is done with a subroutine reference you pass |
179 | to this method. |
180 | |
e132fd56 |
181 | my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } ); |
182 | print "$found\n"; # prints "foobarbazboo" |
183 | |
184 | This method requires a single argument. |
7960bcc0 |
185 | |
e132fd56 |
186 | =item * B<sort> |
33f819e1 |
187 | |
e132fd56 |
188 | =item * B<sort( sub { ... } )> |
189 | |
190 | Returns the elements of the array in sorted order. |
33f819e1 |
191 | |
80683705 |
192 | You can provide an optional subroutine reference to sort with (as you can with |
e132fd56 |
193 | Perl's core C<sort> function). However, instead of using C<$a> and C<$b> in |
194 | this subroutine, you will need to use C<$_[0]> and C<$_[1]>. |
195 | |
196 | # ascending ASCIIbetical |
197 | my @sorted = $stuff->sort_options(); |
198 | |
199 | # Descending alphabetical order |
200 | my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } ); |
201 | print "@sorted_options\n"; # prints "foo boo baz bar" |
33f819e1 |
202 | |
e132fd56 |
203 | This method accepts a single argument. |
33f819e1 |
204 | |
e132fd56 |
205 | =item * B<sort_in_place> |
33f819e1 |
206 | |
e132fd56 |
207 | =item * B<sort_in_place( sub { ... } )> |
33f819e1 |
208 | |
cd50e921 |
209 | Sorts the array I<in place>, modifying the value of the attribute. |
33f819e1 |
210 | |
cd50e921 |
211 | You can provide an optional subroutine reference to sort with (as you can with |
212 | Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you |
213 | will need to use C<$_[0]> and C<$_[1]> instead. |
33f819e1 |
214 | |
e132fd56 |
215 | This method does not define a return value. |
7960bcc0 |
216 | |
e132fd56 |
217 | This method accepts a single argument. |
218 | |
219 | =item * B<shuffle> |
220 | |
221 | Returns the elements of the array in random order, like C<shuffle> from |
7960bcc0 |
222 | L<List::Util>. |
223 | |
e132fd56 |
224 | This method does not accept any arguments. |
225 | |
226 | =item * B<uniq> |
7960bcc0 |
227 | |
e132fd56 |
228 | Returns the array with all duplicate elements removed, like C<uniq> from |
7960bcc0 |
229 | L<List::MoreUtils>. |
230 | |
e132fd56 |
231 | This method does not accept any arguments. |
232 | |
233 | =item * B<join($str)> |
33f819e1 |
234 | |
80683705 |
235 | Joins every element of the array using the separator given as argument, just |
236 | like Perl's core C<join> function. |
33f819e1 |
237 | |
e132fd56 |
238 | my $joined = $stuff->join_options(':'); |
239 | print "$joined\n"; # prints "foo:bar:baz:boo" |
240 | |
241 | This method requires a single argument. |
33f819e1 |
242 | |
e132fd56 |
243 | =item * B<set($index, $value)> |
33f819e1 |
244 | |
cd50e921 |
245 | Given an index and a value, sets the specified array element's value. |
33f819e1 |
246 | |
e132fd56 |
247 | This method returns the value at C<$index> after the set. |
248 | |
249 | This method requires two arguments. |
250 | |
251 | =item * B<delete($index)> |
cd50e921 |
252 | |
253 | Removes the element at the given index from the array. |
254 | |
e132fd56 |
255 | This method returns the deleted value. Note that if no value exists, it will |
256 | return C<undef>. |
257 | |
258 | This method requires one argument. |
259 | |
260 | =item * B<insert($index, $value)> |
cd50e921 |
261 | |
262 | Inserts a new element into the array at the given index. |
263 | |
e132fd56 |
264 | This method returns the new value at C<$index>. |
265 | |
266 | This method requires two arguments. |
267 | |
268 | =item * B<clear> |
cd50e921 |
269 | |
270 | Empties the entire array, like C<@array = ()>. |
33f819e1 |
271 | |
e132fd56 |
272 | This method does not define a return value. |
273 | |
274 | This method does not accept any arguments. |
275 | |
276 | =item * B<accessor($index)> |
277 | |
278 | =item * B<accessor($index, $value)> |
33f819e1 |
279 | |
80683705 |
280 | This method provides a get/set accessor for the array, based on array indexes. |
281 | If passed one argument, it returns the value at the specified index. If |
282 | passed two arguments, it sets the value of the specified index. |
33f819e1 |
283 | |
e132fd56 |
284 | When called as a setter, this method returns the new value at C<$index>. |
285 | |
286 | This method accepts one or two arguments. |
287 | |
288 | =item * B<natatime($n)> |
289 | |
290 | =item * B<natatime($n, $code)> |
7960bcc0 |
291 | |
292 | This method returns an iterator which, on each call, returns C<$n> more items |
293 | from the array, in order, like C<natatime> from L<List::MoreUtils>. A coderef |
294 | can optionally be provided; it will be called on each group of C<$n> elements |
295 | in the array. |
296 | |
e132fd56 |
297 | This method accepts one or two arguments. |
e3c07b19 |
298 | |
e3c07b19 |
299 | =back |
300 | |
301 | =head1 BUGS |
302 | |
d4048ef3 |
303 | See L<Moose/BUGS> for details on reporting bugs. |
e3c07b19 |
304 | |
305 | =head1 AUTHOR |
306 | |
307 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
308 | |
309 | =head1 COPYRIGHT AND LICENSE |
310 | |
8e5dd3fb |
311 | Copyright 2007-2010 by Infinity Interactive, Inc. |
e3c07b19 |
312 | |
313 | L<http://www.iinteractive.com> |
314 | |
315 | This library is free software; you can redistribute it and/or modify |
316 | it under the same terms as Perl itself. |
317 | |
318 | =cut |