File Coverage

blib/lib/Net/LDAP/Class/SimpleIterator.pm

Criterion	Covered	Total	%
statement	37	41	90.2
branch	7	10	70.0
condition			n/a
subroutine	12	12	100.0
pod	5	5	100.0
total	61	68	89.7

package Net::LDAP::Class::SimpleIterator;
use strict;
use warnings;
use base qw( Rose::Object );
use Carp;
use Data::Dump qw( dump );
use Net::LDAP::Class::MethodMaker ( 'scalar' => [qw( code )], );

our $VERSION = '0.26';

=head1 NAME

Net::LDAP::Class::SimpleIterator - iterate over Net::LDAP::Class objects

=head1 SYNOPSIS

 my $iterator = $user->groups_iterator;
 while ( my $group = $iterator->next ) {
    # $group isa Net::LDAP::Class::Group
 }
 printf("%d groups found\n", $iterator->count);

=head1 DESCRIPTION

Net::LDAP::Class::SimpleIterator uses a closure (CODE reference)
to implement a simple next()-based API.

=head1 METHODS

=head2 init

Implements the standard object initialization.

=cut

sub init {
    my $self = shift;
    $self->SUPER::init(@_);
    if ( !defined $self->code ) {
        croak "code ref required";
    }
    $self->{_count} = 0;
    return $self;
}

=head2 code(I)

Required in new(). I is called on every invocation
of next().

=head2 next

Calls code() and returns its value, incrementing count() if the value
is defined.

=cut

sub next {
    my $self = shift;
    return undef if !exists $self->{code};
    my $ret = $self->{code}->();
    if ( defined $ret ) {
        $self->{_count}++;
    }
    else {
        $self->finish;
    }
    return $ret;
}

=head2 count

Returns the number of iterations of next() that returned defined.

=cut

sub count { return shift->{_count} }

=head2 finish

Deletes the internal code reference.

=cut

sub finish {
    my $self = shift;
    delete $self->{code};
}

=head2 is_exhausted

Tests for the existence of the internal code reference, returning
true if the internal code reference no longer exists and false
if it does.

=cut

sub is_exhausted {
    my $self = shift;
    return exists $self->{code} ? 0 : 1;
}

sub DESTROY {
    my $self = shift;
    if ( defined $self->{code} ) {
        carp("non-exhausted iterator DESTROY'd");
        Data::Dump::dump($self);
        $self->finish;
    }
}

1;

__END__