lib/perl5/5.8.8/TAP/Parser/Iterator/Array.pm

   1 package TAP::Parser::Iterator::Array;
   2
   3 use strict;
   4 use vars qw($VERSION @ISA);
   5
   6 use TAP::Parser::Iterator ();
   7
   8 @ISA = 'TAP::Parser::Iterator';
   9
  10 =head1 NAME
  11
  12 TAP::Parser::Iterator::Array - Iterator for array-based TAP sources
  13
  14 =head1 VERSION
  15
  16 Version 3.23
  17
  18 =cut
  19
  20 $VERSION = '3.23';
  21
  22 =head1 SYNOPSIS
  23
  24   use TAP::Parser::Iterator::Array;
  25   my @data = ('foo', 'bar', baz');
  26   my $it   = TAP::Parser::Iterator::Array->new(\@data);
  27   my $line = $it->next;
  28
  29 =head1 DESCRIPTION
  30
  31 This is a simple iterator wrapper for arrays of scalar content, used by
  32 L<TAP::Parser>.  Unless you're writing a plugin or subclassing, you probably
  33 won't need to use this module directly.
  34
  35 =head1 METHODS
  36
  37 =head2 Class Methods
  38
  39 =head3 C<new>
  40
  41 Create an iterator.  Takes one argument: an C<$array_ref>
  42
  43 =head2 Instance Methods
  44
  45 =head3 C<next>
  46
  47 Iterate through it, of course.
  48
  49 =head3 C<next_raw>
  50
  51 Iterate raw input without applying any fixes for quirky input syntax.
  52
  53 =head3 C<wait>
  54
  55 Get the wait status for this iterator. For an array iterator this will always
  56 be zero.
  57
  58 =head3 C<exit>
  59
  60 Get the exit status for this iterator. For an array iterator this will always
  61 be zero.
  62
  63 =cut
  64
  65 # new() implementation supplied by TAP::Object
  66
  67 sub _initialize {
  68     my ( $self, $thing ) = @_;
  69     chomp @$thing;
  70     $self->{idx}   = 0;
  71     $self->{array} = $thing;
  72     $self->{exit}  = undef;
  73     return $self;
  74 }
  75
  76 sub wait { shift->exit }
  77
  78 sub exit {
  79     my $self = shift;
  80     return 0 if $self->{idx} >= @{ $self->{array} };
  81     return;
  82 }
  83
  84 sub next_raw {
  85     my $self = shift;
  86     return $self->{array}->[ $self->{idx}++ ];
  87 }
  88
  89 1;
  90
  91 =head1 ATTRIBUTION
  92
  93 Originally ripped off from L<Test::Harness>.
  94
  95 =head1 SEE ALSO
  96
  97 L<TAP::Object>,
  98 L<TAP::Parser>,
  99 L<TAP::Parser::Iterator>,
 100
 101 =cut
 102