merge List into Array and ImmutableHash into Hash
[gitmo/Moose.git] / lib / Moose / Meta / Attribute / Trait / Native / MethodProvider / Array.pm
index d302645..5e5ac72 100644 (file)
@@ -5,7 +5,92 @@ our $VERSION   = '0.87';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
-with 'Moose::Meta::Attribute::Trait::Native::MethodProvider::List';
+sub count : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        scalar @{ $reader->( $_[0] ) };
+    };
+}
+
+sub empty : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        scalar @{ $reader->( $_[0] ) } ? 1 : 0;
+    };
+}
+
+sub find : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $predicate ) = @_;
+        foreach my $val ( @{ $reader->($instance) } ) {
+            return $val if $predicate->($val);
+        }
+        return;
+    };
+}
+
+sub map : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $f ) = @_;
+        CORE::map { $f->($_) } @{ $reader->($instance) };
+    };
+}
+
+sub sort : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $predicate ) = @_;
+        die "Argument must be a code reference"
+            if $predicate && ref $predicate ne 'CODE';
+
+        if ($predicate) {
+            CORE::sort { $predicate->( $a, $b ) } @{ $reader->($instance) };
+        }
+        else {
+            CORE::sort @{ $reader->($instance) };
+        }
+    };
+}
+
+sub grep : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $predicate ) = @_;
+        CORE::grep { $predicate->($_) } @{ $reader->($instance) };
+    };
+}
+
+sub elements : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ($instance) = @_;
+        @{ $reader->($instance) };
+    };
+}
+
+sub join : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $separator ) = @_;
+        join $separator, @{ $reader->($instance) };
+    };
+}
+
+sub first : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        $reader->( $_[0] )->[0];
+    };
+}
+
+sub last : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        $reader->( $_[0] )->[-1];
+    };
+}
 
 sub push : method {
     my ( $attr, $reader, $writer ) = @_;
@@ -248,6 +333,36 @@ __END__
 
 Moose::Meta::Attribute::Trait::Native::MethodProvider::Array
 
+=head1 SYNOPSIS
+
+   package Stuff;
+   use Moose;
+   use Moose::AttributeHelpers;
+
+   has 'options' => (
+       metaclass  => 'Array',
+       is         => 'rw',
+       isa        => 'ArrayRef[Str]',
+       default    => sub { [] },
+       auto_deref => 1,
+       handles   => {
+           all_options       => 'elements',
+           map_options       => 'map',
+           filter_options    => 'grep',
+           find_option       => 'find',
+           first_option      => 'first',
+           last_option       => 'last',
+           get_option        => 'get',
+           join_options      => 'join',
+           count_options     => 'count',
+           do_i_have_options => 'empty',
+           sorted_options    => 'sort',
+       }
+   );
+
+   no Moose;
+   1;
+
 =head1 DESCRIPTION
 
 This is a role which provides the method generators for
@@ -263,13 +378,102 @@ L<Moose::Meta::Attribute::Trait::Native::Array>.
 
 =head1 PROVIDED METHODS
 
-This module also consumes the B<List> method providers, to
-see those provided methods, refer to that documentation.
-
 =over 4
 
+=item B<count>
+
+Returns the number of elements in the array.
+
+   $stuff = Stuff->new;
+   $stuff->options(["foo", "bar", "baz", "boo"]);
+
+   my $count = $stuff->count_options;
+   print "$count\n"; # prints 4
+
+=item B<empty>
+
+If the array is populated, returns true. Otherwise, returns false.
+
+   $stuff->do_i_have_options ? print "Good boy.\n" : die "No options!\n" ;
+
+=item B<find>
+
+This method accepts a subroutine reference as its argument. That sub
+will receive each element of the array in turn. If it returns true for
+an element, that element will be returned by the C<find> method.
+
+   my $found = $stuff->find_option( sub { $_[0] =~ /^b/ } );
+   print "$found\n"; # prints "bar"
+
+=item B<grep>
+
+This method accepts a subroutine reference as its argument. This
+method returns every element for which that subroutine reference
+returns a true value.
+
+   my @found = $stuff->filter_options( sub { $_[0] =~ /^b/ } );
+   print "@found\n"; # prints "bar baz boo"
+
+=item B<map>
+
+This method accepts a subroutine reference as its argument. The
+subroutine will be executed for each element of the array. It is
+expected to return a modified version of that element. The return
+value of the method is a list of the modified options.
+
+   my @mod_options = $stuff->map_options( sub { $_[0] . "-tag" } );
+   print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"
+
+=item B<sort>
+
+Sorts and returns the elements of the array.
+
+You can provide an optional subroutine reference to sort with (as you
+can with the core C<sort> function). However, instead of using C<$a>
+and C<$b>, you will need to use C<$_[0]> and C<$_[1]> instead.
+
+   # ascending ASCIIbetical
+   my @sorted = $stuff->sort_options();
+
+   # Descending alphabetical order
+   my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
+   print "@sorted_options\n"; # prints "foo boo baz bar"
+
+=item B<elements>
+
+Returns all of the elements of the array
+
+   my @option = $stuff->all_options;
+   print "@options\n"; # prints "foo bar baz boo"
+
+=item B<join>
+
+Joins every element of the array using the separator given as argument.
+
+   my $joined = $stuff->join_options( ':' );
+   print "$joined\n"; # prints "foo:bar:baz:boo"
+
 =item B<get>
 
+Returns an element of the array by its index.
+
+   my $option = $stuff->get_option(1);
+   print "$option\n"; # prints "bar"
+
+=item B<first>
+
+Returns the first element of the array.
+
+   my $first = $stuff->first_option;
+   print "$first\n"; # prints "foo"
+
+=item B<last>
+
+Returns the last element of the array.
+
+   my $last = $stuff->last_option;
+   print "$last\n"; # prints "boo"
+
 =item B<pop>
 
 =item B<push>