Author image DULAUNOY Fabrice

NAME

BSON::Decode - Decode BSON file and return a perl data structure!

VERSION

Version 0.06

SYNOPSIS

A small module to parse BSON file to a perl structure

 my $file = shift;
 open( my $INF ,$file);
 my $bs = BSON::Decode->new($INF);

 say Dumper $bs->fetch(); # read first element
 say Dumper $bs->fetch(); # read second element
 $bs->rewind();# rewind the filehandle
 say Dumper $bs->fetch_all(); # read all element in an ARRAY
 close $INF;

DESCRIPTION

 This is a pure perl BSON decoder. It is simple and without any dependencies.
 (It was mandatory to allow use in an embeded system)
 The main use is to compare 2 BSON files

 Some of the  BSON grammar's element are not implemented

 \x06   Undefined (value)  Deprecated
 \x0C   DBPointer          Deprecated
 \x0E                      Deprecated

For binary content (\x05) The data is uuencoded as value of the subtype.

METHOD

new

 Instanciate the parser.

 By default the parser read from STDIN (unix filter).
 In that case no rewind is possible. Only sequential read.
 my $bs = BSON::Decode->new();
 It is possible to pass an argument to the constructor to chose another source.

filehandle

 an open filehandle from where to read the BSON data:
 open( my $INF ,$file);
 my $bs = BSON::Decode->new($INF);

file name

 this a path to an existing BSON file:
 my $bs = BSON::Decode->new($file);

scalar

 a perl scalar with the BSON data:
 my $bs = BSON::Decode->new($bson);

fetch_all

 Parse the BSON data and return an ARRAY with each element in a perl structure.
 The parsing is done from the current position.
 e.g.
    my $bs = BSON::Decode->new($bson_data);
    my $bson = $bs->fetch_all();

 If a parameter is provided, this override the parameter from the class new
 And allow a one line fetch_all like this:
 my $bson = BSON::Decode->fetch_all('t/test1.bson');

fetch

 Parse the BSON data and return the next element in a perl structure.
 e.g.
    my $bs = BSON::Decode->new($bson_data);
    my $bson = $bs->fetch();

rewind

 Rewind the file descriptor ( or buffer ).
 !!! BUT NOT FOR STDIN !!!
 e.g.
    my $bs = BSON::Decode->new($file);
    say Dumper $bs->fetch();

    $bs->rewind();
    say Dumper $bs->fetch_all(); # all from beginning if no rewind read all remaining elements after the first one.

delete_hash_deep

 Function to delete some keys matching a regex from a hash in deep (multiple level)
 This allow to compare 2 BSON data but skip some fields.
 e.g.
    use BSON::Decode
    use Text::Diff;
    my @skip = ( lastUpdated$', '(?i)timestamp', '^uptimeMs$' );
    my $codec1 = BSON::Decode->new( $file1 );
    my $bson1  = $codec1->fetch_all();

    my $codec2 = BSON::Decode->new( $file2 );
    my $bson2  = $codec2->fetch_all();

    delete_hash_deep( $bson1, \@skip );
    delete_hash_deep( $bson2, \@skip );

    my $b1 = Dumper($bson1);
    my $b2 = Dumper($bson2);

    my $diff = diff( \$b1, \$b2 );

    say "$all1{$f}; diff=<$diff>" if $diff;


 !!! if the hash is empty, it  stay in the perl structure

AUTHOR

DULAUNOY Fabrice, <fabrice at dulaunoy.com>

BUGS

Please report any bugs or feature requests to bug-bson-decode at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=BSON-Decode. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

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

    perldoc BSON::Decode

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2016 DULAUNOY Fabrice.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.