2 package Moose::Meta::Attribute::Native::Trait::Array;
6 $VERSION = eval $VERSION;
7 our $AUTHORITY = 'cpan:STEVAN';
9 use Moose::Meta::Attribute::Native::MethodProvider::Array;
11 use Moose::Meta::Method::Accessor::Native::Array::count;
12 use Moose::Meta::Method::Accessor::Native::Array::elements;
13 use Moose::Meta::Method::Accessor::Native::Array::first;
14 use Moose::Meta::Method::Accessor::Native::Array::get;
15 use Moose::Meta::Method::Accessor::Native::Array::grep;
16 use Moose::Meta::Method::Accessor::Native::Array::is_empty;
17 use Moose::Meta::Method::Accessor::Native::Array::join;
18 use Moose::Meta::Method::Accessor::Native::Array::map;
19 use Moose::Meta::Method::Accessor::Native::Array::push;
20 use Moose::Meta::Method::Accessor::Native::Array::reduce;
21 use Moose::Meta::Method::Accessor::Native::Array::shuffle;
22 use Moose::Meta::Method::Accessor::Native::Array::sort;
23 use Moose::Meta::Method::Accessor::Native::Array::uniq;
25 with 'Moose::Meta::Attribute::Native::Trait';
27 has 'method_provider' => (
30 predicate => 'has_method_provider',
31 default => 'Moose::Meta::Attribute::Native::MethodProvider::Array'
34 sub _helper_type { 'ArrayRef' }
36 sub _native_type { 'Array' }
48 Moose::Meta::Attribute::Native::Trait::Array - Helper trait for ArrayRef attributes
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 module provides an Array attribute which provides a number of
83 =head1 PROVIDED METHODS
85 These methods are implemented in
86 L<Moose::Meta::Attribute::Native::MethodProvider::Array>.
92 Returns the number of elements in the array.
95 $stuff->options(["foo", "bar", "baz", "boo"]);
97 my $count = $stuff->count_options;
98 print "$count\n"; # prints 4
102 Returns a boolean value that is true when the array has no elements.
104 $stuff->has_no_options ? die "No options!\n" : print "Good boy.\n";
108 Returns all of the elements of the array.
110 my @option = $stuff->all_options;
111 print "@options\n"; # prints "foo bar baz boo"
115 Returns an element of the array by its index. You can also use negative index
116 numbers, just as with Perl's core array handling.
118 my $option = $stuff->get_option(1);
119 print "$option\n"; # prints "bar"
123 =item B<push($value1, $value2, value3 ...)>
127 =item B<unshift($value1, $value2, value3 ...)>
129 =item B<splice($offset, $length, @values)>
131 These methods are all equivalent to the Perl core functions of the same name.
133 =item B<first( sub { ... } )>
135 This method returns the first item matching item in the array, just like
136 L<List::Util>'s C<first> function. The matching is done with a subroutine
137 reference you pass to this method. The reference will be called against each
138 element in the array until one matches or all elements have been checked.
140 my $found = $stuff->find_option( sub { /^b/ } );
141 print "$found\n"; # prints "bar"
143 =item B<grep( sub { ... } )>
145 This method returns every element matching a given criteria, just like Perl's
146 core C<grep> function. This method requires a subroutine which implements the
149 my @found = $stuff->filter_options( sub { /^b/ } );
150 print "@found\n"; # prints "bar baz boo"
152 =item B<map( sub { ... } )>
154 This method transforms every element in the array and returns a new array,
155 just like Perl's core C<map> function. This method requires a subroutine which
156 implements the transformation.
158 my @mod_options = $stuff->map_options( sub { $_ . "-tag" } );
159 print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"
161 =item B<reduce( sub { ... } )>
163 This method condenses an array into a single value, by passing a function the
164 value so far and the next value in the array, just like L<List::Util>'s
165 C<reduce> function. The reducing is done with a subroutine reference you pass
168 my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } );
169 print "$found\n"; # prints "foobarbazboo"
171 =item B<sort( sub { ... } )>
173 Returns a the array in sorted order.
175 You can provide an optional subroutine reference to sort with (as you can with
176 Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you
177 will need to use C<$_[0]> and C<$_[1]> instead.
179 # ascending ASCIIbetical
180 my @sorted = $stuff->sort_options();
182 # Descending alphabetical order
183 my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
184 print "@sorted_options\n"; # prints "foo boo baz bar"
186 =item B<sort_in_place>
188 Sorts the array I<in place>, modifying the value of the attribute.
190 You can provide an optional subroutine reference to sort with (as you can with
191 Perl's core C<sort> function). However, instead of using C<$a> and C<$b>, you
192 will need to use C<$_[0]> and C<$_[1]> instead.
196 Returns the array, with indices in random order, like C<shuffle> from
201 Returns the array, with all duplicate elements removed, like C<uniq> from
206 Joins every element of the array using the separator given as argument, just
207 like Perl's core C<join> function.
209 my $joined = $stuff->join_options( ':' );
210 print "$joined\n"; # prints "foo:bar:baz:boo"
212 =item B<set($index, $value)>
214 Given an index and a value, sets the specified array element's value.
216 =item B<delete($index)>
218 Removes the element at the given index from the array.
220 =item B<insert($index, $value)>
222 Inserts a new element into the array at the given index.
226 Empties the entire array, like C<@array = ()>.
230 This method provides a get/set accessor for the array, based on array indexes.
231 If passed one argument, it returns the value at the specified index. If
232 passed two arguments, it sets the value of the specified index.
234 =item B<natatime($n, $code)>
236 This method returns an iterator which, on each call, returns C<$n> more items
237 from the array, in order, like C<natatime> from L<List::MoreUtils>. A coderef
238 can optionally be provided; it will be called on each group of C<$n> elements
249 =item B<method_provider>
251 =item B<has_method_provider>
257 See L<Moose/BUGS> for details on reporting bugs.
261 Stevan Little E<lt>stevan@iinteractive.comE<gt>
263 =head1 COPYRIGHT AND LICENSE
265 Copyright 2007-2009 by Infinity Interactive, Inc.
267 L<http://www.iinteractive.com>
269 This library is free software; you can redistribute it and/or modify
270 it under the same terms as Perl itself.