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' }
38 sub _native_type { 'Array' }
50 Moose::Meta::Attribute::Native::Trait::Array - Helper trait for ArrayRef attributes
60 isa => 'ArrayRef[Str]',
61 default => sub { [] },
63 all_options => 'elements',
66 filter_options => 'grep',
67 find_option => 'first',
69 join_options => 'join',
70 count_options => 'count',
71 has_options => 'count',
72 has_no_options => 'is_empty',
73 sorted_options => 'sort',
82 This module provides an Array attribute which provides a number of
85 =head1 PROVIDED METHODS
87 These methods are implemented in
88 L<Moose::Meta::Attribute::Native::MethodProvider::Array>.
94 Returns the number of elements in the array.
97 $stuff->options(["foo", "bar", "baz", "boo"]);
99 my $count = $stuff->count_options;
100 print "$count\n"; # prints 4
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";
110 Returns all of the elements of the array.
112 my @option = $stuff->all_options;
113 print "@options\n"; # prints "foo bar baz boo"
117 Returns an element of the array by its index. You can also use negative index
118 numbers, just as with Perl's core array handling.
120 my $option = $stuff->get_option(1);
121 print "$option\n"; # prints "bar"
125 =item B<push($value1, $value2, value3 ...)>
129 =item B<unshift($value1, $value2, value3 ...)>
131 =item B<splice($offset, $length, @values)>
133 These methods are all equivalent to the Perl core functions of the same name.
135 =item B<first( sub { ... } )>
137 This method returns the first item matching item in the array, just like
138 L<List::Util>'s C<first> function. The matching is done with a subroutine
139 reference you pass to this method. The reference will be called against each
140 element in the array until one matches or all elements have been checked.
142 my $found = $stuff->find_option( sub { /^b/ } );
143 print "$found\n"; # prints "bar"
145 =item B<grep( sub { ... } )>
147 This method returns every element matching a given criteria, just like Perl's
148 core C<grep> function. This method requires a subroutine which implements the
151 my @found = $stuff->filter_options( sub { /^b/ } );
152 print "@found\n"; # prints "bar baz boo"
154 =item B<map( sub { ... } )>
156 This method transforms every element in the array and returns a new array,
157 just like Perl's core C<map> function. This method requires a subroutine which
158 implements the transformation.
160 my @mod_options = $stuff->map_options( sub { $_ . "-tag" } );
161 print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"
163 =item B<reduce( sub { ... } )>
165 This method condenses an array into a single value, by passing a function the
166 value so far and the next value in the array, just like L<List::Util>'s
167 C<reduce> function. The reducing is done with a subroutine reference you pass
170 my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } );
171 print "$found\n"; # prints "foobarbazboo"
173 =item B<sort( sub { ... } )>
175 Returns a the array in sorted order.
177 You can provide an optional subroutine reference to sort with (as you can with
178 Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you
179 will need to use C<$_[0]> and C<$_[1]> instead.
181 # ascending ASCIIbetical
182 my @sorted = $stuff->sort_options();
184 # Descending alphabetical order
185 my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
186 print "@sorted_options\n"; # prints "foo boo baz bar"
188 =item B<sort_in_place>
190 Sorts the array I<in place>, modifying the value of the attribute.
192 You can provide an optional subroutine reference to sort with (as you can with
193 Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you
194 will need to use C<$_[0]> and C<$_[1]> instead.
198 Returns the array, with indices in random order, like C<shuffle> from
203 Returns the array, with all duplicate elements removed, like C<uniq> from
208 Joins every element of the array using the separator given as argument, just
209 like Perl's core C<join> function.
211 my $joined = $stuff->join_options( ':' );
212 print "$joined\n"; # prints "foo:bar:baz:boo"
214 =item B<set($index, $value)>
216 Given an index and a value, sets the specified array element's value.
218 =item B<delete($index)>
220 Removes the element at the given index from the array.
222 =item B<insert($index, $value)>
224 Inserts a new element into the array at the given index.
228 Empties the entire array, like C<@array = ()>.
232 This method provides a get/set accessor for the array, based on array indexes.
233 If passed one argument, it returns the value at the specified index. If
234 passed two arguments, it sets the value of the specified index.
236 =item B<natatime($n, $code)>
238 This method returns an iterator which, on each call, returns C<$n> more items
239 from the array, in order, like C<natatime> from L<List::MoreUtils>. A coderef
240 can optionally be provided; it will be called on each group of C<$n> elements
251 =item B<method_provider>
253 =item B<has_method_provider>
259 See L<Moose/BUGS> for details on reporting bugs.
263 Stevan Little E<lt>stevan@iinteractive.comE<gt>
265 =head1 COPYRIGHT AND LICENSE
267 Copyright 2007-2009 by Infinity Interactive, Inc.
269 L<http://www.iinteractive.com>
271 This library is free software; you can redistribute it and/or modify
272 it under the same terms as Perl itself.