File Coverage

blib/lib/xDT/Parser.pm

Criterion	Covered	Total	%
statement	3	5	60.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	5	7	71.4

package xDT::Parser;

use v5.10;
use Moose;
use namespace::autoclean;
use FileHandle;
use Carp;

use xDT::Record;
use xDT::Object;

=head1 NAME

xDT::Parser - A Parser for xDT files.

=head1 VERSION

Version 1.00

=cut

our $VERSION = '1.00';


=head1 SYNOPSIS

Can be used to open xdt files and to iterate over contained objects.

    use xDT::Parser;

    my $parser = xDT::Parser->new();
    $parser->open($xdtFile);

    my $object = $parser->nextObject();
    ...

    $parser->close();

=head1 ATTRUBITES

=head2 fh
FileHandle to the currently open file.
=cut

has 'fh' => (
    is            => 'rw',
    isa           => 'FileHandle',
    documentation => q{The filehandle the parser will use to read xDT data.},
);

=head1 SUBROUTINES/METHODS

=head1 open($xdtFile)
Sets the parsers filehandle on this file.
=cut

sub open {
    my ($self, $file) = @_;

    croak("Error: provided file '$file' does not exist or is not readable.")
        unless (-f $file);

    my $fh = FileHandle->new($file, 'r')
        or croak("Error: could not open filehandle $file.");

    $self->fh($fh);
}

=head1 close
Closes the parsers filehandle
=cut

sub close {
    my $self = shift;

    close $self->fh;
}

=head1 nextObject
Returns the next object of the xDT file.
=cut

sub nextObject {
    my $self = shift;
    my $object = xDT::Object->new();

    while (my $record = $self->_next()) {
        last if ($record->isObjectEnd);
        $object->addRecord($record);
    }

    return $object;
}

sub _next {
    my $self = shift;
    my $line;

    do {
        $line = $self->fh->getline() or return undef;
    } while ($line =~ /^\s*$/);

    return xDT::Record->new($line);
}

=head1 AUTHOR

Christoph Beger, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc xDT::Parser


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2017 Christoph Beger.

This program is released under the following license: MIT


=cut

__PACKAGE__->meta->make_immutable;

1; # End of xDT::Parser