Initial Commit
This commit is contained in:
Riley Schneider
469
database/perl/vendor/lib/Tie/Array/CSV.pm
vendored
Normal file
469
database/perl/vendor/lib/Tie/Array/CSV.pm
vendored
Normal file
@@ -0,0 +1,469 @@
|
||||
package Tie::Array::CSV;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
our $VERSION = '0.08';
|
||||
$VERSION = eval $VERSION;
|
||||
|
||||
use Carp;
|
||||
|
||||
use Tie::File;
|
||||
use Text::CSV;
|
||||
|
||||
use Scalar::Util qw/blessed/;
|
||||
|
||||
use Tie::Array;
|
||||
our @ISA = ('Tie::Array');
|
||||
|
||||
sub parse_opts {
|
||||
my $class = shift;
|
||||
|
||||
croak "Must specify a file" unless @_;
|
||||
|
||||
my ($file, %opts);
|
||||
|
||||
# handle one arg as either hashref (of opts) or file
|
||||
if (@_ == 1) {
|
||||
if (ref $_[0] eq 'HASH') {
|
||||
%opts = %{ shift() };
|
||||
} else {
|
||||
$file = shift;
|
||||
}
|
||||
}
|
||||
|
||||
# handle file and hashref of opts
|
||||
if (@_ == 2 and ref $_[1] eq 'HASH') {
|
||||
$file = shift;
|
||||
%opts = %{ shift() };
|
||||
}
|
||||
|
||||
# handle file before hash of opts
|
||||
if (@_ % 2) {
|
||||
$file = shift;
|
||||
}
|
||||
|
||||
# handle hash of opts
|
||||
if (@_) {
|
||||
%opts = @_;
|
||||
}
|
||||
|
||||
# handle file passed has hash(ref) value to 'file' key
|
||||
if (!$file and defined $opts{file}) {
|
||||
$file = delete $opts{file};
|
||||
}
|
||||
|
||||
# file wasn't specified as lone arg or as a hash opt
|
||||
croak "Must specify a file" unless $file;
|
||||
|
||||
# parse specific options
|
||||
if (exists $opts{sep_char}) {
|
||||
$opts{text_csv}{sep_char} = delete $opts{sep_char};
|
||||
}
|
||||
|
||||
return ($file, \%opts);
|
||||
}
|
||||
|
||||
sub new {
|
||||
my $class = shift;
|
||||
my ($file, $opts) = $class->parse_opts(@_);
|
||||
|
||||
my @self;
|
||||
tie @self, $class, $file, $opts;
|
||||
|
||||
return \@self;
|
||||
|
||||
}
|
||||
|
||||
sub TIEARRAY {
|
||||
my $class = shift;
|
||||
my ($file, $opts) = $class->parse_opts(@_);
|
||||
|
||||
my @tiefile;
|
||||
tie @tiefile, 'Tie::File', $file, recsep => "\n", %{ $opts->{tie_file} || {} }
|
||||
or croak "Cannot tie file $file";
|
||||
|
||||
my $csv;
|
||||
if (blessed $opts->{text_csv} and $opts->{text_csv}->isa('Text::CSV')) {
|
||||
$csv = $opts->{text_csv};
|
||||
} else {
|
||||
$csv = Text::CSV->new($opts->{text_csv} || {})
|
||||
or croak "CSV (new) error: " . Text::CSV->error_diag();
|
||||
}
|
||||
|
||||
my $self = {
|
||||
file => \@tiefile,
|
||||
csv => $csv,
|
||||
};
|
||||
|
||||
bless $self, $class;
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub FETCH {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
|
||||
my $line = $self->{file}[$index];
|
||||
|
||||
my $rowclass = ref($self) . '::Row';
|
||||
tie my @line, $rowclass, {
|
||||
file => $self->{file},
|
||||
line_num => $index,
|
||||
fields => $self->_parse($line),
|
||||
csv => $self->{csv},
|
||||
};
|
||||
|
||||
return \@line;
|
||||
}
|
||||
|
||||
sub STORE {
|
||||
my $self = shift;
|
||||
my ($index, $value) = @_;
|
||||
|
||||
$self->{file}[$index] = $self->_combine($value);
|
||||
}
|
||||
|
||||
sub FETCHSIZE {
|
||||
my $self = shift;
|
||||
|
||||
return scalar @{ $self->{file} };
|
||||
}
|
||||
|
||||
sub STORESIZE {
|
||||
my $self = shift;
|
||||
my $new_size = shift;
|
||||
|
||||
$#{ $self->{file} } = $new_size - 1;
|
||||
|
||||
}
|
||||
|
||||
sub EXISTS {
|
||||
my $self = shift;
|
||||
my ($index) = shift;
|
||||
return exists $self->{file}[$index];
|
||||
}
|
||||
|
||||
sub DELETE {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
return $self->SPLICE($index,1);
|
||||
}
|
||||
|
||||
sub _parse {
|
||||
my $self = shift;
|
||||
my ($line) = @_;
|
||||
$line = '' unless defined $line;
|
||||
|
||||
return [$self->{csv}->fields] if $self->{csv}->parse($line);
|
||||
|
||||
croak "CSV parse error: " . $self->{csv}->error_diag;
|
||||
}
|
||||
|
||||
sub _combine {
|
||||
my $self = shift;
|
||||
my ($value) = @_;
|
||||
|
||||
return $self->{csv}->string
|
||||
if $self->{csv}->combine( ref $value ? @$value : ($value) );
|
||||
|
||||
croak "CSV combine error: " . $self->{csv}->error_diag();
|
||||
}
|
||||
|
||||
package Tie::Array::CSV::Row;
|
||||
|
||||
use Carp;
|
||||
|
||||
use Tie::Array;
|
||||
our @ISA = ('Tie::Array');
|
||||
|
||||
use overload
|
||||
'@{}' => sub{ $_[0]{fields} };
|
||||
|
||||
sub TIEARRAY {
|
||||
my $class = shift;
|
||||
my $self = shift;
|
||||
|
||||
bless $self, $class;
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub FETCH {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
|
||||
return $self->{fields}[$index];
|
||||
}
|
||||
|
||||
sub STORE {
|
||||
my $self = shift;
|
||||
my ($index, $value) = @_;
|
||||
|
||||
$self->{fields}[$index] = $value;
|
||||
|
||||
$self->_update;
|
||||
|
||||
}
|
||||
|
||||
sub FETCHSIZE {
|
||||
my $self = shift;
|
||||
|
||||
return scalar @{ $self->{fields} };
|
||||
}
|
||||
|
||||
sub STORESIZE {
|
||||
my $self = shift;
|
||||
my $new_size = shift;
|
||||
|
||||
my $return = (
|
||||
$#{ $self->{fields} } = $new_size - 1
|
||||
);
|
||||
|
||||
$self->_update;
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
sub SHIFT {
|
||||
my $self = shift;
|
||||
|
||||
my $value = shift @{ $self->{fields} };
|
||||
|
||||
$self->_update;
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
sub UNSHIFT {
|
||||
my $self = shift;
|
||||
my $value = shift;
|
||||
|
||||
unshift @{ $self->{fields} }, $value;
|
||||
|
||||
$self->_update;
|
||||
|
||||
return $self->FETCHSIZE();
|
||||
}
|
||||
|
||||
sub DELETE {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
|
||||
my $return = splice @{ $self->{fields} }, $index, 1;
|
||||
$self->_update;
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
sub EXISTS {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
|
||||
return exists $self->{fields}[$index];
|
||||
}
|
||||
|
||||
sub _update {
|
||||
my $self = shift;
|
||||
|
||||
if(@{ $self->{fields} }) {
|
||||
$self->{csv}->combine(@{ $self->{fields} })
|
||||
or croak "CSV combine error: " . $self->{csv}->error_diag();
|
||||
$self->{file}[$self->{line_num}] = $self->{csv}->string;
|
||||
} else {
|
||||
$self->{file}[$self->{line_num}] = '';
|
||||
}
|
||||
}
|
||||
|
||||
__END__
|
||||
__POD__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Tie::Array::CSV - A tied array which combines the power of Tie::File and Text::CSV
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
use strict; use warnings;
|
||||
use Tie::Array::CSV;
|
||||
tie my @file, 'Tie::Array::CSV', 'filename';
|
||||
|
||||
print $file[0][2];
|
||||
$file[3][5] = "Camel";
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This module allows an array to be tied to a CSV file for reading and writing. The array is a standard Perl 2D array (i.e. an array of array references) which gives access to the row and column of the user's choosing. This is done using the well established modules:
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
L<Tie::File>
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
arbitrary line access
|
||||
|
||||
=item *
|
||||
|
||||
low memory use even for large files
|
||||
|
||||
=back
|
||||
|
||||
=item *
|
||||
|
||||
L<Text::CSV>
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
row parsing
|
||||
|
||||
=item *
|
||||
|
||||
row updating
|
||||
|
||||
=item *
|
||||
|
||||
uses the speedy L<Text::CSV_XS> if installed
|
||||
|
||||
=back
|
||||
|
||||
=back
|
||||
|
||||
This module was inspired by L<Tie::CSV_File> which (sadly) hasn't been maintained. It also doesn't attempt to do any of the parsing (as that module did), but rather passes all of the heavy lifting to other modules.
|
||||
|
||||
Note that while the L<Tie::File> prevents the need to read in the entire file, while in use, a parsed row IS held in memory.
|
||||
|
||||
=head1 CONSTRUCTORS
|
||||
|
||||
Since version 0.04 both constructors allow the options that version 0.03 only offered for the C<new> constructor. The constructors must be passed a file name, either as the first argument, or as the value to the option key C<file>. Options may be passed as key-value pairs or as a hash reference. This yields the many ways of calling the constructors shown below, one for every taste.
|
||||
|
||||
N.B. Should a lone argument filename and a C<file> option key both be passed to the constructor, the lone argument wins.
|
||||
|
||||
=head2 C<tie> Constructor
|
||||
|
||||
As with any tied array, the construction uses the C<tie> function. Basic usage is as follows:
|
||||
|
||||
tie my @file, 'Tie::Array::CSV', 'filename';
|
||||
|
||||
which would tie the lexically scoped array C<@file> to the file C<filename> using this module. Following the first two arguements to C<tie>, one may optionally pass a key-value pairs or a hashref containing additional configuration or even file specification.
|
||||
|
||||
tie my @file, 'Tie::Array::CSV', 'filename', { opt_key => val, ... };
|
||||
tie my @file, 'Tie::Array::CSV', 'filename', opt_key => val, ... ;
|
||||
tie my @file, 'Tie::Array::CSV', { file => 'filename', opt_key => val, ... };
|
||||
tie my @file, 'Tie::Array::CSV', file => 'filename', opt_key => val, ... ;
|
||||
|
||||
Of course, the magical Perl C<tie> can be scary for some, for those people there is the ...
|
||||
|
||||
=head2 C<new> Constructor
|
||||
|
||||
[ Added in version 0.03 ]
|
||||
|
||||
my $array = Tie::Array::CSV->new( 'filename' );
|
||||
my $array = Tie::Array::CSV->new( 'filename', { opt_key => val, ... });
|
||||
my $array = Tie::Array::CSV->new( 'filename', opt_key => val, ... );
|
||||
my $array = Tie::Array::CSV->new( file => 'filename', opt_key => val, ... );
|
||||
my $array = Tie::Array::CSV->new( { file => 'filename', opt_key => val, ... } );
|
||||
|
||||
It only returns a reference to the C<tie>d array due to a limitations in how C<tie> magic works.
|
||||
|
||||
=head2 Options
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
C<file> - alternative method for specifing the file to C<tie>. This is overridden by a lone filename or handle passed as the first argument to the constructor.
|
||||
|
||||
=item *
|
||||
|
||||
C<tie_file> - hashref of options which are passed to the L<Tie::File> constructor
|
||||
|
||||
=item *
|
||||
|
||||
C<text_csv> - either:
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
hashref of options which are passed to the L<Text::CSV> constructor
|
||||
|
||||
=item *
|
||||
|
||||
an object which satisfies C<< isa('Text::CSV') >> (added in version 0.05)
|
||||
|
||||
=back
|
||||
|
||||
=item *
|
||||
|
||||
C<sep_char> - for ease of use, a C<sep_char> option may be specified, which is passed to the L<Text::CSV> constructor. This option overrides a corresponding entry in the C<text_csv> pass-through hash.
|
||||
|
||||
=back
|
||||
|
||||
Equivalent examples:
|
||||
|
||||
tie my @file, 'Tie::Array::CSV', 'filename', {
|
||||
tie_file => {},
|
||||
text_csv => { sep_char => ';' },
|
||||
};
|
||||
|
||||
tie my @file, 'Tie::Array::CSV', 'filename', sep_char => ';';
|
||||
|
||||
Note that as of version 0.05 the functionality from the former C<hold_row> option has been separated into its own subclass module L<Tie::Array::CSV::HoldRow>. If deferring row operations is of interest to you, please see that module.
|
||||
|
||||
=head1 ERRORS
|
||||
|
||||
For simplicity this module C<croak>s on all almost all errors, which are trappable using a C<$SIG{__DIE__}> handler. Modifing a severed row object issues a warning.
|
||||
|
||||
=head1 CAVEATS
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
Much of the functionality of normal arrays is mimicked using L<Tie::Array>. The interaction of this with L<Tie::File> should be mentioned in that certain actions may be very inefficient. For example, C<(un)shift>-ing the first row of data will probably involve L<Tie::Array> asking L<Tie::File> to move each row up one line, one-by-one. As a note, the intra-row C<(un)shift> does not suffer this problem.
|
||||
|
||||
=item *
|
||||
|
||||
At one time, some effort was been made to allow for fields which contain linebreaks. Quickly it became clear that linebreaks would change line numbers used for row access by L<Tie::File>. Attempts to compensate for this, unfortunately, moved the module far from its stated goals, and therefore far less powerful for its intended purposes. The decision has been made (for now) not to support such files.
|
||||
|
||||
=back
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
L<Tie::CSV_File> - inspiration for this module, but problematic
|
||||
|
||||
=back
|
||||
|
||||
=head1 SOURCE REPOSITORY
|
||||
|
||||
L<http://github.com/jberger/Tie-Array-CSV>
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Joel Berger, E<lt>joel.a.berger@gmail.comE<gt>
|
||||
|
||||
=head1 CONTRIBUTORS
|
||||
|
||||
Christian Walde (Mithaldu)
|
||||
Graham Ollis (plicease)
|
||||
|
||||
=head1 COPYRIGHT AND LICENSE
|
||||
|
||||
Copyright (C) 2013 by L</AUTHOR> and L</CONTRIBUTORS>.
|
||||
|
||||
This library is free software; you can redistribute it and/or modify
|
||||
it under the same terms as Perl itself.
|
||||
|
||||
=cut
|
||||
|
||||
210
database/perl/vendor/lib/Tie/Array/CSV/HoldRow.pm
vendored
Normal file
210
database/perl/vendor/lib/Tie/Array/CSV/HoldRow.pm
vendored
Normal file
@@ -0,0 +1,210 @@
|
||||
package Tie::Array::CSV::HoldRow;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Carp;
|
||||
|
||||
use Tie::File;
|
||||
use Text::CSV;
|
||||
|
||||
use Scalar::Util qw/weaken/;
|
||||
|
||||
use Tie::Array::CSV;
|
||||
our @ISA = ('Tie::Array::CSV');
|
||||
|
||||
# This is essentially the same TIEARRAY method as T::A::CSV,
|
||||
# but initializes active_rows. This isn't strictly necessary, thanks to autoviv
|
||||
sub TIEARRAY {
|
||||
my $class = shift;
|
||||
|
||||
my $self = $class->SUPER::TIEARRAY(@_);
|
||||
|
||||
$self->{active_rows} = {},
|
||||
|
||||
# rebless
|
||||
bless $self, $class;
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub FETCH {
|
||||
my $self = shift;
|
||||
my $index = shift;
|
||||
|
||||
if ($self->{active_rows}{$index}) {
|
||||
return $self->{active_rows}{$index}
|
||||
}
|
||||
|
||||
my $line_array = $self->SUPER::FETCH($index);
|
||||
|
||||
weaken(
|
||||
$self->{active_rows}{$index} = $line_array
|
||||
);
|
||||
|
||||
return $line_array;
|
||||
}
|
||||
|
||||
sub STORE {
|
||||
my $self = shift;
|
||||
my ($index, $value) = @_;
|
||||
|
||||
$self->{file}[$index] = $self->_combine($value);
|
||||
}
|
||||
|
||||
sub SPLICE {
|
||||
my $self = shift;
|
||||
my $size = $self->FETCHSIZE;
|
||||
my $offset = @_ ? shift : 0;
|
||||
$offset += $size if $offset < 0;
|
||||
my $length = @_ ? shift : $size-$offset;
|
||||
|
||||
my @replace_rows = map { $self->_combine($_) } @_;
|
||||
|
||||
## reindex active_rows ##
|
||||
|
||||
# assuming removing items
|
||||
my @active_rows =
|
||||
sort { $a <=> $b }
|
||||
grep { defined $self->{active_rows}{$_} }
|
||||
keys %{ $self->{active_rows} };
|
||||
my $delta = @replace_rows - $length;
|
||||
|
||||
# if instead adding items
|
||||
if ($length < @replace_rows) {
|
||||
# reverse ot avoid overwriting active items
|
||||
@active_rows = reverse @active_rows;
|
||||
$delta = @replace_rows + $length;
|
||||
}
|
||||
|
||||
foreach my $index (@active_rows) {
|
||||
# skip lines before those affected
|
||||
next if ($index < $offset);
|
||||
|
||||
if ($index >= $offset and $index < ($offset + $length)) { #items that are being removed
|
||||
tied(@{$self->{active_rows}{$index}})->{line_num} = undef;
|
||||
} else { #shifting affected items
|
||||
tied(@{$self->{active_rows}{$index}})->{line_num} = $index+$delta;
|
||||
$self->{active_rows}{$index+$delta} = delete $self->{active_rows}{$index};
|
||||
}
|
||||
}
|
||||
|
||||
## end reindexing logic ##
|
||||
|
||||
my @return = map { $self->_parse($_) }
|
||||
splice(@{ $self->{file} },$offset,$length,@replace_rows);
|
||||
|
||||
return @return
|
||||
|
||||
}
|
||||
|
||||
sub SHIFT {
|
||||
my $self = shift;
|
||||
my ($return) = $self->SPLICE(0,1);
|
||||
return $return;
|
||||
}
|
||||
|
||||
sub UNSHIFT { scalar shift->SPLICE(0,0,@_) }
|
||||
|
||||
sub PUSH {
|
||||
my $self = shift;
|
||||
my $i = $self->FETCHSIZE;
|
||||
$self->STORE($i++, shift) while (@_);
|
||||
}
|
||||
|
||||
sub POP {
|
||||
my $self = shift;
|
||||
my $newsize = $self->FETCHSIZE - 1;
|
||||
my $val;
|
||||
if ($newsize >= 0) {
|
||||
$val = $self->FETCH($newsize);
|
||||
$self->STORESIZE($newsize);
|
||||
}
|
||||
return $val;
|
||||
}
|
||||
|
||||
sub CLEAR { shift->STORESIZE(0) }
|
||||
|
||||
sub EXTEND { }
|
||||
|
||||
package Tie::Array::CSV::HoldRow::Row;
|
||||
|
||||
use Carp;
|
||||
|
||||
use Tie::Array::CSV;
|
||||
our @ISA = ('Tie::Array::CSV::Row');
|
||||
|
||||
sub TIEARRAY {
|
||||
my $class = shift;
|
||||
my $self = $class->SUPER::TIEARRAY(@_);
|
||||
|
||||
# rebless
|
||||
bless $self, $class;
|
||||
|
||||
$self->{need_update} = 0;
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
# _update now marks for deferred update
|
||||
sub _update {
|
||||
my $self = shift;
|
||||
$self->{need_update} = 1;
|
||||
}
|
||||
|
||||
sub _deferred_update {
|
||||
my $self = shift;
|
||||
unless (defined $self->{line_num}) {
|
||||
carp "Attempted to write out from a severed row";
|
||||
return undef;
|
||||
}
|
||||
|
||||
$self->SUPER::_update();
|
||||
}
|
||||
|
||||
sub DESTROY {
|
||||
my $self = shift;
|
||||
$self->_deferred_update if $self->{need_update} == 1;
|
||||
}
|
||||
|
||||
__END__
|
||||
__POD__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Tie::Array::CSV::HoldRow - A Tie::Array::CSV subclass for deferring row operations
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
use strict; use warnings;
|
||||
use Tie::Array::CSV::HoldRow;
|
||||
tie my @file, 'Tie::Array::CSV::HoldRow', 'filename';
|
||||
|
||||
print $file[0][2];
|
||||
$file[3][5] = "Camel";
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This module is an experimental subclass of L<Tie::Array::CSV>, see usage information in that documentation.
|
||||
|
||||
While the usage is the same, the timing of the file IO is different. As opposed to the base module, the file is not updated while the reference to the row is still in scope. Note that for both modules, the parsed row is still held in memory while the row is in scope, the ONLY difference is that the file reflects changes immediately when C<hold_row> is false. To reiterate, this option only affects file IO, not memory usage.
|
||||
|
||||
When multiple rows are kept alive/removed/modified there was the possibility that conflicting directives could be given to a single physical line. To combat this possibility, as of version 0.05, all (living) child row objects are made aware of line number changes in the parent (outer array) should these occur. Futher if a row object is alive, but the parent object removes that line, the row object is remains intact, but the links between the row object and parent/file are severed.
|
||||
|
||||
=head1 SOURCE REPOSITORY
|
||||
|
||||
L<http://github.com/jberger/Tie-Array-CSV>
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Joel Berger, E<lt>joel.a.berger@gmail.comE<gt>
|
||||
|
||||
=head1 COPYRIGHT AND LICENSE
|
||||
|
||||
Copyright (C) 2013 by Joel Berger
|
||||
|
||||
This library is free software; you can redistribute it and/or modify
|
||||
it under the same terms as Perl itself.
|
||||
|
||||
=cut
|
||||
|
||||
Reference in New Issue
Block a user