/ 
App-CSVUtils-1.032
River stage one • 3 direct dependents • 4 total dependents
/ csv-sorted-rows

NAME

csv-sorted-rows - Check that CSV rows are sorted

VERSION

This document describes version 1.032 of csv-sorted-rows (from Perl distribution App-CSVUtils), released on 2023-09-05.

SYNOPSIS

csv-sorted-rows --help (or -h, -?)

csv-sorted-rows --version (or -v)

csv-sorted-rows [--by-code=any|--by-code-json=json] [(--by-field=str)+|--by-fields-json=json] [--by-sortsub=str] [--ci|-i] [--debug|--log-level=level|--quiet|--trace|--verbose] [--format=name|--json] [--hash|-H] [--input-escape-char=str] [--input-header|--no-input-header|--noinput-header] [--input-quote-char=str] [--input-sep-char=str] [--input-tsv] [--key=any|--key-json=json|-k=any] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--quiet-arg|-q|--no-quiet-arg|--noquiet-arg] [--reverse|-r] [(--sortsub-args key=s)+|--sortsub-args-json=json] -- [input_filename]

DESCRIPTION

This utility checks that rows in the CSV are sorted according to specified sorting rule(s). Example input.csv:

name,age
Andy,20
Dennis,15
Ben,30
Jerry,30

Example check command:

% csv-sorted-rows input.csv --by-field name; # check if name is ascibetically sorted
ERROR 400: Rows are NOT sorted

Example input2.csv:

name,age
Andy,20
Ben,30
Dennis,15
Jerry,30

% csv-sorted-rows input2.csv --by-field name; # check if name is ascibetically sorted
Rows are sorted

% csv-sorted-rows input2.csv --by-field ~name; # check if name is ascibetically sorted in descending order
ERROR 400: Rows are NOT sorted

See csv-sort-rows for details on sorting options.

OPTIONS

* marks required options.

Main options

--by-code-json=s

Sort by using Perl code (JSON-encoded).

See --by-code.

--by-code=s

Sort by using Perl code.

$a and $b (or the first and second argument) will contain the two rows to be compared. Which are arrayrefs; or if --hash (-H) is specified, hashrefs; or if --key is specified, whatever the code in --key returns.

--by-field=s@

Add a sort field specification.

Each field specification is a field name with an optional prefix. FIELD (without prefix) means sort asciibetically ascending (smallest to largest), ~FIELD means sort asciibetically descending (largest to smallest), +FIELD means sort numerically ascending, -FIELD means sort numerically descending.

Can be specified multiple times.

--by-fields-json=s

Sort by a list of field specifications (JSON-encoded).

See --by-field.

--by-sortsub=s

Sort using a Sort::Sub routine.

When sorting rows, usually combined with --key because most Sort::Sub routine expects a string to be compared against.

When sorting fields, the Sort::Sub routine will get the field name as argument.

--ci, -i

(No description)

--hash, -H

Provide row in $_ as hashref instead of arrayref.

--key-json=s, -k

Generate sort keys with this Perl code (JSON-encoded).

See --key.

--key=s

Generate sort keys with this Perl code.

If specified, then will compute sort keys using Perl code and sort using the keys. Relevant when sorting using --by-code or --by-sortsub. If specified, then instead of row when sorting rows, the code (or Sort::Sub routine) will receive these sort keys to sort against.

The code will receive the row (arrayref, or if -H is specified, hashref) as the argument.

--quiet-arg, -q

If set to true, do not show messages.

Normally a message will be printed to stdout saying whether the rows are sorted or not, i.e. one of:

Rows are sorted
Rows are NOT sorted

If this option is specified, then no message will be printed. Instead, you can find out whether things are sorted via exit code (or status code in the enveloped result, if you request JSON or call this utility as a Perl function).

--reverse, -r

(No description)

--sortsub-args-json=s

Arguments to pass to Sort::Sub routine (JSON-encoded).

See --sortsub-args.

--sortsub-args=s%

Arguments to pass to Sort::Sub routine.

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

Input options

--input-escape-char=s

Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.

Defaults to \\ (backslash). Overrides --input-tsv option.

--input-filename=s

Input CSV file.

Default value:

"-"

Use - to read from stdin.

Encoding of input file is assumed to be UTF-8.

Can also be specified as the 1st command-line argument.

--input-quote-char=s

Specify field quote character in input CSV, will be passed to Text::CSV_XS.

Defaults to " (double quote). Overrides --input-tsv option.

--input-sep-char=s

Specify field separator character in input CSV, will be passed to Text::CSV_XS.

Defaults to , (comma). Overrides --input-tsv option.

--input-tsv

Inform that input file is in TSV (tab-separated) format instead of CSV.

Overriden by --input-sep-char, --input-quote-char, --input-escape-char options. If one of those options is specified, then --input-tsv will be ignored.

--no-input-header

Specify that input CSV does not have 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 (--no-input-header), the first row of the CSV is assumed to contain the first data row. Fields will be named field1, field2, and so on.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use --naked-res so you just get:

[1,2,3]
--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C csv-sorted-rows csv-sorted-rows

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete csv-sorted-rows 'p/*/`csv-sorted-rows`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CSVUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CSVUtils.

AUTHOR

perlancar <perlancar@cpan.org>

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 Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, 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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016 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.

BUGS

Please report any bugs or feature requests on the bugtracker website 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.