File Coverage

blib/lib/Iterator/Flex/Product.pm

Criterion	Covered	Total	%
statement	105	106	99.0
branch	30	38	78.9
condition	4	5	80.0
subroutine	18	19	94.7
pod	1	2	50.0
total	158	170	92.9

package Iterator::Flex::Product;

# ABSTRACT: An iterator which produces a Cartesian product of iterators

use v5.28;
use strict;
use warnings;
use experimental qw( signatures declared_refs refaliasing );

our $VERSION = '0.34';

use Iterator::Flex::Utils
  qw( RETURN STATE EXHAUSTION :IterAttrs :IterStates can_meth throw_failure );
use Iterator::Flex::Factory 'to_iterator';
use parent 'Iterator::Flex::Base';
use Ref::Util;
use List::Util;

use namespace::clean;











































sub new ( $class, @args ) {
    my $pars = Ref::Util::is_hashref( $args[-1] ) ? pop @args : {};

    throw_failure( parameter => 'not enough parameters' )
      unless @args;

    my @iterators;
    my @keys;

    # distinguish between ( key => iterator, key =>iterator ) and ( iterator, iterator );
    if ( Ref::Util::is_ref( $args[0] ) ) {
        @iterators = @args;
    }
    else {
        throw_failure( parameter => 'expected an even number of arguments' )
          if @args % 2;

        while ( @args ) {
            push @keys,      shift @args;
            push @iterators, shift @args;
        }
    }

    $class->SUPER::new( { keys => \@keys, depends => \@iterators, value => [] }, $pars );
}

sub construct ( $class, $state ) {    ## no critic (ExcessComplexity)
    throw_failure( parameter => q{state must be a HASH reference} )
      unless Ref::Util::is_hashref( $state );

    $state->{value} //= [];

    my ( \@depends, \@keys, \@value, $thaw )
      = @{$state}{qw[ depends keys value thaw ]};

    # transform into iterators if required.
    my @iterators
      = map { to_iterator( $_, { ( +EXHAUSTION ) => RETURN } ) } @depends;

    # can only work if the iterators support a rewind method
    throw_failure( parameter => q{all iterables must provide a rewind method} )
      unless List::Util::all { defined can_meth( $_, 'rewind' ) } @iterators;

    throw_failure( parameter => q{number of keys not equal to number of iterators} )
      if @keys && @keys != @iterators;

    @value = map { $_->current } @iterators
      if $thaw;

    ## no critic ( AmbiguousNames )
    my @set = ( 1 ) x @value;

    my @src = map { [ $_, $_->can( 'is_exhausted' ) ] } @iterators;

    my $self;
    my $iterator_state;
    my %params = (

        ( +_SELF ) => \$self,

        ( +STATE ) => \$iterator_state,

        ( +NEXT ) => sub {
            return $self->signal_exhaustion if $iterator_state == IterState_EXHAUSTED;

            # first time through
            if ( !@value ) {

                for my $src ( @src ) {
                    my ( $iter, $is_exhausted ) = $src->@*;
                    push @value, $iter->();

                    return $self->signal_exhaustion
                      if $iter->$is_exhausted;
                }

                @set = ( 1 ) x @value;
            }

            else {
                my ( $iter, $is_exhausted ) = $src[-1]->@*;

                $value[-1] = $iter->();
                if ( $iter->$is_exhausted ) {
                    $set[-1] = 0;
                    my $idx = @src - 1;

                    while ( --$idx >= 0 ) {
                        ( $iter, $is_exhausted ) = $src[$idx]->@*;
                        $value[$idx] = $iter->();
                        last unless $iter->$is_exhausted;
                        $set[$idx] = 0;
                    }

                    return $self->signal_exhaustion
                      if !$set[0];

                    while ( ++$idx < @src ) {
                        $src[$idx][0]->rewind;
                        $value[$idx] = $src[$idx][0]->();
                        $set[$idx]   = 1;
                    }
                }

            }
            if ( @keys ) {
                my %value;
                @value{@keys} = @value;
                return \%value;
            }
            else {
                return [@value];
            }
        },

        ( +CURRENT ) => sub {
            return undef                    if !@value;
            return $self->signal_exhaustion if $iterator_state eq IterState_EXHAUSTED;
            if ( @keys ) {
                my %value;
                @value{@keys} = @value;
                return \%value;
            }
            else {
                return [@value];
            }
        },

        ( +RESET )    => sub { @value = () },
        ( +REWIND )   => sub { @value = () },
        ( +_DEPENDS ) => \@iterators,
    );

    # can only freeze if the iterators support a current method
    if (
        List::Util::all { defined can_meth( $_, 'current' ) }
        @iterators
      )
    {

        $params{ +FREEZE } = sub {
            return [ $class, { keys => \@keys } ];
        };
        $params{ +_ROLES } = ['Freeze'];
    }

    $params{ +_NAME } = 'iproduct';
    return \%params;
}


__PACKAGE__->_add_roles( qw[
      State::Closure
      Next::ClosedSelf
      Current::Closure
      Reset::Closure
      Rewind::Closure
] );

1;

#
# This file is part of Iterator-Flex
#
# This software is Copyright (c) 2018 by Smithsonian Astrophysical Observatory.
#
# This is free software, licensed under:
#
#   The GNU General Public License, Version 3, June 2007
#

__END__