2 package Moose::Meta::Attribute::Native::Trait::Array;
6 $VERSION = eval $VERSION;
7 our $AUTHORITY = 'cpan:STEVAN';
9 use Moose::Meta::Method::Accessor::Native::Array::accessor;
10 use Moose::Meta::Method::Accessor::Native::Array::clear;
11 use Moose::Meta::Method::Accessor::Native::Array::count;
12 use Moose::Meta::Method::Accessor::Native::Array::delete;
13 use Moose::Meta::Method::Accessor::Native::Array::elements;
14 use Moose::Meta::Method::Accessor::Native::Array::first;
15 use Moose::Meta::Method::Accessor::Native::Array::get;
16 use Moose::Meta::Method::Accessor::Native::Array::grep;
17 use Moose::Meta::Method::Accessor::Native::Array::insert;
18 use Moose::Meta::Method::Accessor::Native::Array::is_empty;
19 use Moose::Meta::Method::Accessor::Native::Array::join;
20 use Moose::Meta::Method::Accessor::Native::Array::map;
21 use Moose::Meta::Method::Accessor::Native::Array::natatime;
22 use Moose::Meta::Method::Accessor::Native::Array::pop;
23 use Moose::Meta::Method::Accessor::Native::Array::push;
24 use Moose::Meta::Method::Accessor::Native::Array::reduce;
25 use Moose::Meta::Method::Accessor::Native::Array::set;
26 use Moose::Meta::Method::Accessor::Native::Array::shift;
27 use Moose::Meta::Method::Accessor::Native::Array::shuffle;
28 use Moose::Meta::Method::Accessor::Native::Array::splice;
29 use Moose::Meta::Method::Accessor::Native::Array::sort;
30 use Moose::Meta::Method::Accessor::Native::Array::sort_in_place;
31 use Moose::Meta::Method::Accessor::Native::Array::uniq;
32 use Moose::Meta::Method::Accessor::Native::Array::unshift;
34 with 'Moose::Meta::Attribute::Native::Trait';
36 sub _helper_type { 'ArrayRef' }
48 Moose::Meta::Attribute::Native::Trait::Array - Helper trait for array delegation
58 isa => 'ArrayRef[Str]',
59 default => sub { [] },
61 all_options => 'elements',
64 filter_options => 'grep',
65 find_option => 'first',
67 join_options => 'join',
68 count_options => 'count',
69 has_options => 'count',
70 has_no_options => 'is_empty',
71 sorted_options => 'sort',
80 This trait provides native delegation methods for array references.
84 If you don't provide an C<isa> value for your attribute, it will default to
87 =head1 PROVIDED METHODS
93 Returns the number of elements in the array.
96 $stuff->options( [ "foo", "bar", "baz", "boo" ] );
98 print $stuff->count_options; # prints 4
100 This method does not accept any arguments.
104 Returns a boolean value that is true when the array has no elements.
106 $stuff->has_no_options ? die "No options!\n" : print "Good boy.\n";
108 This method does not accept any arguments.
112 Returns all of the elements of the array as an array (not an array reference).
114 my @option = $stuff->all_options;
115 print "@options\n"; # prints "foo bar baz boo"
117 This method does not accept any arguments.
119 =item * B<get($index)>
121 Returns an element of the array by its index. You can also use negative index
122 numbers, just as with Perl's core array handling.
124 my $option = $stuff->get_option(1);
125 print "$option\n"; # prints "bar"
127 If the specified element does not exist, this will return C<undef>.
129 This method does accepts just one argument.
133 Just like Perl's builtin C<pop>.
135 This method does not accept any arguments.
137 =item * B<push($value1, $value2, value3 ...)>
139 Just like Perl's builtin C<push>. Returns the number of elements in the new
142 This method accepts any number of arguments.
146 Just like Perl's builtin C<shift>.
148 This method does not accept any arguments.
150 =item * B<unshift($value1, $value2, value3 ...)>
152 Just like Perl's builtin C<unshift>. Returns the number of elements in the new
155 This method accepts any number of arguments.
157 =item * B<splice($offset, $length, @values)>
159 Just like Perl's builtin C<splice>. In scalar context, this returns the last
160 element removed, or C<undef> if no elements were removed. In list context,
161 this returns all the elements removed from the array.
163 This method requires at least one argument.
165 =item * B<first( sub { ... } )>
167 This method returns the first item matching item in the array, just like
168 L<List::Util>'s C<first> function. The matching is done with a subroutine
169 reference you pass to this method. The subroutine will be called against each
170 element in the array until one matches or all elements have been checked.
172 my $found = $stuff->find_option( sub {/^b/} );
173 print "$found\n"; # prints "bar"
175 This method requires a single argument.
177 =item * B<grep( sub { ... } )>
179 This method returns every element matching a given criteria, just like Perl's
180 core C<grep> function. This method requires a subroutine which implements the
183 my @found = $stuff->filter_options( sub {/^b/} );
184 print "@found\n"; # prints "bar baz boo"
186 This method requires a single argument.
188 =item * B<map( sub { ... } )>
190 This method transforms every element in the array and returns a new array,
191 just like Perl's core C<map> function. This method requires a subroutine which
192 implements the transformation.
194 my @mod_options = $stuff->map_options( sub { $_ . "-tag" } );
195 print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"
197 This method requires a single argument.
199 =item * B<reduce( sub { ... } )>
201 This method turns an array into a single value, by passing a function the
202 value so far and the next value in the array, just like L<List::Util>'s
203 C<reduce> function. The reducing is done with a subroutine reference you pass
206 my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } );
207 print "$found\n"; # prints "foobarbazboo"
209 This method requires a single argument.
213 =item * B<sort( sub { ... } )>
215 Returns the elements of the array in sorted order.
217 You can provide an optional subroutine reference to sort with (as you can with
218 Perl's core C<sort> function). However, instead of using C<$a> and C<$b> in
219 this subroutine, you will need to use C<$_[0]> and C<$_[1]>.
221 # ascending ASCIIbetical
222 my @sorted = $stuff->sort_options();
224 # Descending alphabetical order
225 my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
226 print "@sorted_options\n"; # prints "foo boo baz bar"
228 This method accepts a single argument.
230 =item * B<sort_in_place>
232 =item * B<sort_in_place( sub { ... } )>
234 Sorts the array I<in place>, modifying the value of the attribute.
236 You can provide an optional subroutine reference to sort with (as you can with
237 Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you
238 will need to use C<$_[0]> and C<$_[1]> instead.
240 This method does not define a return value.
242 This method accepts a single argument.
246 Returns the elements of the array in random order, like C<shuffle> from
249 This method does not accept any arguments.
253 Returns the array with all duplicate elements removed, like C<uniq> from
256 This method does not accept any arguments.
258 =item * B<join($str)>
260 Joins every element of the array using the separator given as argument, just
261 like Perl's core C<join> function.
263 my $joined = $stuff->join_options(':');
264 print "$joined\n"; # prints "foo:bar:baz:boo"
266 This method requires a single argument.
268 =item * B<set($index, $value)>
270 Given an index and a value, sets the specified array element's value.
272 This method returns the value at C<$index> after the set.
274 This method requires two arguments.
276 =item * B<delete($index)>
278 Removes the element at the given index from the array.
280 This method returns the deleted value. Note that if no value exists, it will
283 This method requires one argument.
285 =item * B<insert($index, $value)>
287 Inserts a new element into the array at the given index.
289 This method returns the new value at C<$index>.
291 This method requires two arguments.
295 Empties the entire array, like C<@array = ()>.
297 This method does not define a return value.
299 This method does not accept any arguments.
301 =item * B<accessor($index)>
303 =item * B<accessor($index, $value)>
305 This method provides a get/set accessor for the array, based on array indexes.
306 If passed one argument, it returns the value at the specified index. If
307 passed two arguments, it sets the value of the specified index.
309 When called as a setter, this method returns the new value at C<$index>.
311 This method accepts one or two arguments.
313 =item * B<natatime($n)>
315 =item * B<natatime($n, $code)>
317 This method returns an iterator which, on each call, returns C<$n> more items
318 from the array, in order, like C<natatime> from L<List::MoreUtils>. A coderef
319 can optionally be provided; it will be called on each group of C<$n> elements
322 This method accepts one or two arguments.
328 See L<Moose/BUGS> for details on reporting bugs.
332 Stevan Little E<lt>stevan@iinteractive.comE<gt>
334 =head1 COPYRIGHT AND LICENSE
336 Copyright 2007-2009 by Infinity Interactive, Inc.
338 L<http://www.iinteractive.com>
340 This library is free software; you can redistribute it and/or modify
341 it under the same terms as Perl itself.