package File::Dir::Dumper::Stream::JSON::Reader;
$File::Dir::Dumper::Stream::JSON::Reader::VERSION = 'v0.4.0';
use warnings;
use strict;
use 5.012;
use parent 'File::Dir::Dumper::Base';
use Carp;
use JSON::MaybeXS qw(decode_json);
use Class::XSAccessor
accessors => { _in => 'in' };
sub _init
{
my $self = shift;
my $args = shift;
$self->_in($args->{input});
$self->_init_stream();
return;
}
sub _readline
{
my $self = shift;
return readline($self->_in());
}
sub _eof
{
my $self = shift;
return eof($self->_in());
}
sub _init_stream
{
my $self = shift;
if ($self->_readline() ne "# JSON Stream by Shlomif - Version 0.2.0\n")
{
Carp::confess "No header for JSON stream";
}
return;
}
sub fetch
{
my $self = shift;
my $buffer = "";
my $line;
if ($self->_eof())
{
return;
}
LINES:
while (!$self->_eof())
{
$line = $self->_readline();
if ($line eq "--/f\n")
{
return decode_json($buffer);
}
else
{
$buffer .= $line;
}
}
Carp::confess "Error! Reached end of file without record terminator.";
}
1; # End of File::Dir::Dumper
__END__
=pod
=encoding UTF-8
=head1 NAME
File::Dir::Dumper::Stream::JSON::Reader - reader for stream of JSON objects.
=head1 VERSION
version v0.4.0
=head1 SYNOPSIS
use File::Dir::Dumper::Stream::JSON::Reader;
my $reader = File::Dir::Dumper::Stream::JSON::Reader->new(
{
input => \*FILEHANDLE,
}
);
while (defined(my $token = $reader->fetch())
{
# Do something with $token.
}
=head1 VERSION
version v0.4.0
=head1 METHODS
=head2 $self->new({ input => $in_filehandle})
Initializes a new object that reads from the filehandle $in_filehandle.
=head2 $self->fetch()
Fetches the next object. Returns undef upon end of file.
=head1 AUTHOR
Shlomi Fish, C<< <shlomif@cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-file-dir-dumper at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Dir-Dumper>. 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 File::Dir::Dumper
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Dir-Dumper>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/File-Dir-Dumper>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/File-Dir-Dumper>
=item * Search CPAN
L<http://search.cpan.org/dist/File-Dir-Dumper>
=back
=head1 ACKNOWLEDGEMENTS
=head1 COPYRIGHT & LICENSE
Copyright 2008 Shlomi Fish, all rights reserved.
This program is released under the following license: MIT/X11 Licence.
=head1 AUTHOR
Shlomi Fish <shlomif@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2008 by Shlomi Fish.
This is free software, licensed under:
The MIT (X11) License
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/shlomif/file-dir-dumper/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
=head1 SUPPORT
=head2 Perldoc
You can find documentation for this module with the perldoc command.
perldoc File::Dir::Dumper
=head2 Websites
The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.
=over 4
=item *
MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
L<http://metacpan.org/release/File-Dir-Dumper>
=item *
Search CPAN
The default CPAN search engine, useful to view POD in HTML format.
L<http://search.cpan.org/dist/File-Dir-Dumper>
=item *
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
L<https://rt.cpan.org/Public/Dist/Display.html?Name=File-Dir-Dumper>
=item *
AnnoCPAN
The AnnoCPAN is a website that allows community annotations of Perl module documentation.
L<http://annocpan.org/dist/File-Dir-Dumper>
=item *
CPAN Ratings
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.
L<http://cpanratings.perl.org/d/File-Dir-Dumper>
=item *
CPAN Forum
The CPAN Forum is a web forum for discussing Perl modules.
L<http://cpanforum.com/dist/File-Dir-Dumper>
=item *
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
L<http://cpants.cpanauthors.org/dist/File-Dir-Dumper>
=item *
CPAN Testers
The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.
L<http://www.cpantesters.org/distro/F/File-Dir-Dumper>
=item *
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
L<http://matrix.cpantesters.org/?dist=File-Dir-Dumper>
=item *
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
L<http://deps.cpantesters.org/?module=File::Dir::Dumper>
=back
=head2 Bugs / Feature Requests
Please report any bugs or feature requests by email to C<bug-file-dir-dumper at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Dir-Dumper>. You will be automatically notified of any
progress on the request by the system.
=head2 Source Code
The code is open to the world, and available for you to hack on. Please feel free to browse it and play
with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
from your repository :)
L<https://github.com/shlomif/perl-File-Dir-Dumper>
git clone https://github.com/shlomif/perl-File-Dir-Dumper
=cut