lib/Moose/Meta/Attribute/Native/Trait/Array.pm

   1
   2 package Moose::Meta::Attribute::Native::Trait::Array;
   3 use Moose::Role;
   4
   5 our $VERSION   = '1.14';
   6 $VERSION = eval $VERSION;
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   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;
  33
  34 with 'Moose::Meta::Attribute::Native::Trait';
  35
  36 sub _helper_type { 'ArrayRef' }
  37
  38 no Moose::Role;
  39
  40 1;
  41
  42 __END__
  43
  44 =pod
  45
  46 =head1 NAME
  47
  48 Moose::Meta::Attribute::Native::Trait::Array - Helper trait for ArrayRef attributes
  49
  50 =head1 SYNOPSIS
  51
  52     package Stuff;
  53     use Moose;
  54
  55     has 'options' => (
  56        traits     => ['Array'],
  57        is         => 'ro',
  58        isa        => 'ArrayRef[Str]',
  59        default    => sub { [] },
  60        handles    => {
  61            all_options    => 'elements',
  62            add_option     => 'push',
  63            map_options    => 'map',
  64            filter_options => 'grep',
  65            find_option    => 'first',
  66            get_option     => 'get',
  67            join_options   => 'join',
  68            count_options  => 'count',
  69            has_options    => 'count',
  70            has_no_options => 'is_empty',
  71            sorted_options => 'sort',
  72        },
  73     );
  74
  75     no Moose;
  76     1;
  77
  78 =head1 DESCRIPTION
  79
  80 This module provides an Array attribute which provides a number of
  81 array operations.
  82
  83 =head1 PROVIDED METHODS
  84
  85 These methods are implemented in
  86 L<Moose::Meta::Attribute::Native::MethodProvider::Array>.
  87
  88 =over 4
  89
  90 =item B<count>
  91
  92 Returns the number of elements in the array.
  93
  94    $stuff = Stuff->new;
  95    $stuff->options(["foo", "bar", "baz", "boo"]);
  96
  97    my $count = $stuff->count_options;
  98    print "$count\n"; # prints 4
  99
 100 =item B<is_empty>
 101
 102 Returns a boolean value that is true when the array has no elements.
 103
 104    $stuff->has_no_options ? die "No options!\n" : print "Good boy.\n";
 105
 106 =item B<elements>
 107
 108 Returns all of the elements of the array.
 109
 110    my @option = $stuff->all_options;
 111    print "@options\n"; # prints "foo bar baz boo"
 112
 113 =item B<get($index)>
 114
 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.
 117
 118    my $option = $stuff->get_option(1);
 119    print "$option\n"; # prints "bar"
 120
 121 =item B<pop>
 122
 123 =item B<push($value1, $value2, value3 ...)>
 124
 125 =item B<shift>
 126
 127 =item B<unshift($value1, $value2, value3 ...)>
 128
 129 =item B<splice($offset, $length, @values)>
 130
 131 These methods are all equivalent to the Perl core functions of the same name.
 132
 133 =item B<first( sub { ... } )>
 134
 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.
 139
 140    my $found = $stuff->find_option( sub { /^b/ } );
 141    print "$found\n"; # prints "bar"
 142
 143 =item B<grep( sub { ... } )>
 144
 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
 147 matching logic.
 148
 149    my @found = $stuff->filter_options( sub { /^b/ } );
 150    print "@found\n"; # prints "bar baz boo"
 151
 152 =item B<map( sub { ... } )>
 153
 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.
 157
 158    my @mod_options = $stuff->map_options( sub { $_ . "-tag" } );
 159    print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"
 160
 161 =item B<reduce( sub { ... } )>
 162
 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
 166 to this method.
 167
 168    my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } );
 169    print "$found\n"; # prints "foobarbazboo"
 170
 171 =item B<sort( sub { ... } )>
 172
 173 Returns a the array in sorted order.
 174
 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.
 178
 179    # ascending ASCIIbetical
 180    my @sorted = $stuff->sort_options();
 181
 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"
 185
 186 =item B<sort_in_place>
 187
 188 Sorts the array I<in place>, modifying the value of the attribute.
 189
 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.
 193
 194 =item B<shuffle>
 195
 196 Returns the array, with indices in random order, like C<shuffle> from
 197 L<List::Util>.
 198
 199 =item B<uniq>
 200
 201 Returns the array, with all duplicate elements removed, like C<uniq> from
 202 L<List::MoreUtils>.
 203
 204 =item B<join($str)>
 205
 206 Joins every element of the array using the separator given as argument, just
 207 like Perl's core C<join> function.
 208
 209    my $joined = $stuff->join_options( ':' );
 210    print "$joined\n"; # prints "foo:bar:baz:boo"
 211
 212 =item B<set($index, $value)>
 213
 214 Given an index and a value, sets the specified array element's value.
 215
 216 =item B<delete($index)>
 217
 218 Removes the element at the given index from the array.
 219
 220 =item B<insert($index, $value)>
 221
 222 Inserts a new element into the array at the given index.
 223
 224 =item B<clear>
 225
 226 Empties the entire array, like C<@array = ()>.
 227
 228 =item B<accessor>
 229
 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.
 233
 234 =item B<natatime($n, $code)>
 235
 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
 239 in the array.
 240
 241 =back
 242
 243 =head1 METHODS
 244
 245 =over 4
 246
 247 =item B<meta>
 248
 249 =item B<method_provider>
 250
 251 =item B<has_method_provider>
 252
 253 =back
 254
 255 =head1 BUGS
 256
 257 See L<Moose/BUGS> for details on reporting bugs.
 258
 259 =head1 AUTHOR
 260
 261 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 262
 263 =head1 COPYRIGHT AND LICENSE
 264
 265 Copyright 2007-2009 by Infinity Interactive, Inc.
 266
 267 L<http://www.iinteractive.com>
 268
 269 This library is free software; you can redistribute it and/or modify
 270 it under the same terms as Perl itself.
 271
 272 =cut