bump version to 0.91
[gitmo/Moose.git] / lib / Moose / Meta / Attribute / Native / MethodProvider / Array.pm
index d387e78..9d60676 100644 (file)
@@ -1,7 +1,10 @@
 package Moose::Meta::Attribute::Native::MethodProvider::Array;
 use Moose::Role;
 
-our $VERSION   = '0.87';
+use List::Util;
+use List::MoreUtils;
+
+our $VERSION = '0.91';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -12,21 +15,18 @@ sub count : method {
     };
 }
 
-sub empty : method {
+sub is_empty : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        scalar @{ $reader->( $_[0] ) } ? 1 : 0;
+        scalar @{ $reader->( $_[0] ) } ? 0 : 1;
     };
 }
 
-sub find : method {
+sub first : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
         my ( $instance, $predicate ) = @_;
-        foreach my $val ( @{ $reader->($instance) } ) {
-            return $val if $predicate->($val);
-        }
-        return;
+        &List::Util::first($predicate, @{ $reader->($instance) });
     };
 }
 
@@ -34,7 +34,16 @@ sub map : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
         my ( $instance, $f ) = @_;
-        CORE::map { $f->($_) } @{ $reader->($instance) };
+        CORE::map { $f->() } @{ $reader->($instance) };
+    };
+}
+
+sub reduce : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $f ) = @_;
+        our ($a, $b);
+        List::Util::reduce { $f->($a, $b) } @{ $reader->($instance) };
     };
 }
 
@@ -43,9 +52,16 @@ sub sort : method {
     return sub {
         my ( $instance, $predicate ) = @_;
         die "Argument must be a code reference"
-            if $predicate && ref $predicate ne 'CODE';
+          if $predicate && ref $predicate ne 'CODE';
 
         if ($predicate) {
+            # Although it would be nice if we could support just using $a and
+            # $b like sort already does, using $a or $b once in a package
+            # triggers the 'Name "main::a" used only once' warning, and there
+            # is no good way to avoid that, since it happens when the file
+            # which defines the coderef is compiled, before we even get a
+            # chance to see it here. So, we have no real choice but to use
+            # normal parameters. --doy
             CORE::sort { $predicate->( $a, $b ) } @{ $reader->($instance) };
         }
         else {
@@ -54,41 +70,43 @@ sub sort : method {
     };
 }
 
-sub grep : method {
+sub shuffle : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        my ( $instance, $predicate ) = @_;
-        CORE::grep { $predicate->($_) } @{ $reader->($instance) };
+        my ( $instance ) = @_;
+        List::Util::shuffle @{ $reader->($instance) };
     };
 }
 
-sub elements : method {
+sub grep : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        my ($instance) = @_;
-        @{ $reader->($instance) };
+        my ( $instance, $predicate ) = @_;
+        CORE::grep { $predicate->() } @{ $reader->($instance) };
     };
 }
 
-sub join : method {
+sub uniq : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        my ( $instance, $separator ) = @_;
-        join $separator, @{ $reader->($instance) };
+        my ( $instance ) = @_;
+        List::MoreUtils::uniq @{ $reader->($instance) };
     };
 }
 
-sub first : method {
+sub elements : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        $reader->( $_[0] )->[0];
+        my ($instance) = @_;
+        @{ $reader->($instance) };
     };
 }
 
-sub last : method {
+sub join : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
-        $reader->( $_[0] )->[-1];
+        my ( $instance, $separator ) = @_;
+        join $separator, @{ $reader->($instance) };
     };
 }
 
@@ -99,16 +117,16 @@ sub push : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             my $instance = CORE::shift;
             $container_type_constraint->check($_)
-                || confess "Value "
-                . ( $_ || 'undef' )
-                . " did not pass container type constraint '$container_type_constraint'"
-                foreach @_;
+              || confess "Value "
+              . ( $_ || 'undef' )
+              . " did not pass container type constraint '$container_type_constraint'"
+              foreach @_;
             CORE::push @{ $reader->($instance) } => @_;
         };
     }
@@ -133,16 +151,16 @@ sub unshift : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             my $instance = CORE::shift;
             $container_type_constraint->check($_)
-                || confess "Value "
-                . ( $_ || 'undef' )
-                . " did not pass container type constraint '$container_type_constraint'"
-                foreach @_;
+              || confess "Value "
+              . ( $_ || 'undef' )
+              . " did not pass container type constraint '$container_type_constraint'"
+              foreach @_;
             CORE::unshift @{ $reader->($instance) } => @_;
         };
     }
@@ -174,14 +192,14 @@ sub set : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             ( $container_type_constraint->check( $_[2] ) )
-                || confess "Value "
-                . ( $_[2] || 'undef' )
-                . " did not pass container type constraint '$container_type_constraint'";
+              || confess "Value "
+              . ( $_[2] || 'undef' )
+              . " did not pass container type constraint '$container_type_constraint'";
             $reader->( $_[0] )->[ $_[1] ] = $_[2];
         };
     }
@@ -199,9 +217,9 @@ sub accessor : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             my $self = shift;
 
@@ -210,9 +228,9 @@ sub accessor : method {
             }
             elsif ( @_ == 2 ) {    # writer
                 ( $container_type_constraint->check( $_[1] ) )
-                    || confess "Value "
-                    . ( $_[1] || 'undef' )
-                    . " did not pass container type constraint '$container_type_constraint'";
+                  || confess "Value "
+                  . ( $_[1] || 'undef' )
+                  . " did not pass container type constraint '$container_type_constraint'";
                 $reader->($self)->[ $_[0] ] = $_[1];
             }
             else {
@@ -248,7 +266,7 @@ sub delete : method {
     my ( $attr, $reader, $writer ) = @_;
     return sub {
         CORE::splice @{ $reader->( $_[0] ) }, $_[1], 1;
-        }
+      }
 }
 
 sub insert : method {
@@ -257,14 +275,14 @@ sub insert : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             ( $container_type_constraint->check( $_[2] ) )
-                || confess "Value "
-                . ( $_[2] || 'undef' )
-                . " did not pass container type constraint '$container_type_constraint'";
+              || confess "Value "
+              . ( $_[2] || 'undef' )
+              . " did not pass container type constraint '$container_type_constraint'";
             CORE::splice @{ $reader->( $_[0] ) }, $_[1], 0, $_[2];
         };
     }
@@ -281,16 +299,16 @@ sub splice : method {
         $attr->has_type_constraint
         && $attr->type_constraint->isa(
             'Moose::Meta::TypeConstraint::Parameterized')
-        ) {
-        my $container_type_constraint
-            = $attr->type_constraint->type_parameter;
+      )
+    {
+        my $container_type_constraint = $attr->type_constraint->type_parameter;
         return sub {
             my ( $self, $i, $j, @elems ) = @_;
             ( $container_type_constraint->check($_) )
-                || confess "Value "
-                . ( defined($_) ? $_ : 'undef' )
-                . " did not pass container type constraint '$container_type_constraint'"
-                for @elems;
+              || confess "Value "
+              . ( defined($_) ? $_ : 'undef' )
+              . " did not pass container type constraint '$container_type_constraint'"
+              for @elems;
             CORE::splice @{ $reader->($self) }, $i, $j, @elems;
         };
     }
@@ -308,12 +326,12 @@ sub sort_in_place : method {
         my ( $instance, $predicate ) = @_;
 
         die "Argument must be a code reference"
-            if $predicate && ref $predicate ne 'CODE';
+          if $predicate && ref $predicate ne 'CODE';
 
         my @sorted;
         if ($predicate) {
-            @sorted = CORE::sort { $predicate->( $a, $b ) }
-            @{ $reader->($instance) };
+            @sorted =
+              CORE::sort { $predicate->( $a, $b ) } @{ $reader->($instance) };
         }
         else {
             @sorted = CORE::sort @{ $reader->($instance) };
@@ -323,6 +341,20 @@ sub sort_in_place : method {
     };
 }
 
+sub natatime : method {
+    my ( $attr, $reader, $writer ) = @_;
+    return sub {
+        my ( $instance, $n, $f ) = @_;
+        my $it = List::MoreUtils::natatime($n, @{ $reader->($instance) });
+        if ($f) {
+            while (my @vals = $it->()) {
+                $f->(@vals);
+            }
+        }
+        $it;
+    };
+}
+
 1;
 
 __END__
@@ -333,40 +365,11 @@ __END__
 
 Moose::Meta::Attribute::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
-L<Moose::Meta::Attribute::Trait::Native::Array>.
+L<Moose::Meta::Attribute::Native::Trait::Array>. Please check there for
+documentation on what methods are provided.
 
 =head1 METHODS
 
@@ -376,137 +379,6 @@ L<Moose::Meta::Attribute::Trait::Native::Array>.
 
 =back
 
-=head1 PROVIDED METHODS
-
-=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>
-
-=item B<set>
-
-=item B<shift>
-
-=item B<unshift>
-
-=item B<clear>
-
-=item B<delete>
-
-=item B<insert>
-
-=item B<splice>
-
-=item B<sort_in_place>
-
-Sorts the array I<in place>, modifying the value of the attribute.
-
-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.
-
-=item B<accessor>
-
-If passed one argument, returns the value of the requested element.
-If passed two arguments, sets the value of the requested element.
-
-=back
-
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no