App-CSVUtils/lib/App/CSVUtils/csv_dump.pm
package App::CSVUtils::csv_dump;
use 5.010001;
use strict;
use warnings;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2025-02-04'; # DATE
our $DIST = 'App-CSVUtils'; # DIST
our $VERSION = '1.036'; # VERSION
use App::CSVUtils qw(gen_csv_util);
gen_csv_util(
name => 'csv_dump',
summary => 'Dump CSV as data structure (array of array/hash)',
description => <<'_',
This utility reads CSV file then dumps it as a text table, or as JSON if you
specify the `--format=json` or `--json` option.
_
add_args => {
hash => {
summary => 'Dump CSV as array of hashrefs instead of array of arrayrefs',
schema => 'true*',
cmdline_aliases => {H=>{}},
},
},
tags => ['category:converting', 'outputs-data-structure'],
examples => [
{
summary => 'Convert CSV to a text table',
argv => ['file.csv'],
test => 0,
'x.doc.show_result' => 0,
},
{
summary => 'Convert CSV to JSON',
src => '[[prog]] file.csv --json',
src_plang => 'bash',
test => 0,
'x.doc.show_result' => 0,
},
],
on_input_header_row => sub {
my $r = shift;
# this is a key we add ourselves
$r->{output_rows} //= [];
if ($r->{util_args}{hash}) {
$r->{wants_input_row_as_hashref} = 1;
} else {
push @{ $r->{output_rows} }, $r->{input_row};
}
},
on_input_data_row => sub {
my $r = shift;
push @{ $r->{output_rows} },
$r->{util_args}{hash} ? $r->{input_row_as_hashref} : $r->{input_row};
},
writes_csv => 0,
on_end => sub {
my $r = shift;
$r->{result} = [200, "OK", $r->{output_rows}];
},
);
1;
# ABSTRACT: Dump CSV as data structure (array of array/hash)
__END__
=pod
=encoding UTF-8
=head1 NAME
App::CSVUtils::csv_dump - Dump CSV as data structure (array of array/hash)
=head1 VERSION
This document describes version 1.036 of App::CSVUtils::csv_dump (from Perl distribution App-CSVUtils), released on 2025-02-04.
=head1 FUNCTIONS
=head2 csv_dump
Usage:
csv_dump(%args) -> [$status_code, $reason, $payload, \%result_meta]
Dump CSV as data structure (array of arrayE<sol>hash).
Examples:
=over
=item * Convert CSV to a text table:
csv_dump(input_filename => "file.csv");
=back
This utility reads CSV file then dumps it as a text table, or as JSON if you
specify the C<--format=json> or C<--json> option.
This function is not exported.
Arguments ('*' denotes required arguments):
=over 4
=item * B<hash> => I<true>
Dump CSV as array of hashrefs instead of array of arrayrefs.
=item * B<input_escape_char> => I<str>
Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.
Defaults to C<\\> (backslash). Overrides C<--input-tsv> option.
=item * B<input_filename> => I<filename> (default: "-")
Input CSV file.
Use C<-> to read from stdin.
Encoding of input file is assumed to be UTF-8.
=item * B<input_header> => I<bool> (default: 1)
Specify whether input CSV has a header row.
By default, the first row of the input CSV will be assumed to contain field
names (and the second row contains the first data row). When you declare that
input CSV does not have header row (C<--no-input-header>), the first row of the
CSV is assumed to contain the first data row. Fields will be named C<field1>,
C<field2>, and so on.
=item * B<input_quote_char> => I<str>
Specify field quote character in input CSV, will be passed to Text::CSV_XS.
Defaults to C<"> (double quote). Overrides C<--input-tsv> option.
=item * B<input_sep_char> => I<str>
Specify field separator character in input CSV, will be passed to Text::CSV_XS.
Defaults to C<,> (comma). Overrides C<--input-tsv> option.
=item * B<input_skip_num_lines> => I<posint>
Number of lines to skip before header row.
This can be useful if you have a CSV files (usually some generated reports,
sometimes converted from spreadsheet) that have additional header lines or info
before the CSV header row.
See also the alternative option: C<--input-skip-until-pattern>.
=item * B<input_skip_until_pattern> => I<re_from_str>
Skip rows until the first header row matches a regex pattern.
This is an alternative to the C<--input-skip-num-lines> and can be useful if you
have a CSV files (usually some generated reports, sometimes converted from
spreadsheet) that have additional header lines or info before the CSV header
row.
With C<--input-skip-num-lines>, you skip a fixed number of lines. With this
option, rows will be skipped until the first field matches the specified regex
pattern.
=item * B<input_tsv> => I<true>
Inform that input file is in TSV (tab-separated) format instead of CSV.
Overriden by C<--input-sep-char>, C<--input-quote-char>, C<--input-escape-char>
options. If one of those options is specified, then C<--input-tsv> will be
ignored.
=back
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code
(200 means OK, 4xx caller error, 5xx function error). Second element
($reason) is a string containing error message, or something like "OK" if status is
200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth
element (%result_meta) is called result metadata and is optional, a hash
that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-CSVUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-CSVUtils>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2025 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-CSVUtils>
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.
=cut