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

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