NAME

validate-with-sah - Validate data with Sah schema

VERSION

This document describes version 0.482 of validate-with-sah (from Perl distribution App-SahUtils), released on 2022-09-30.

SYNOPSIS

See examples in the "EXAMPLES" section.

DESCRIPTION

This script is useful for testing Sah schemas. You can quickly specify from the CLI a schema with some data to validate it against. This script can also be used to just normalize a Sah schema and show it (--show-schema), or compile a schema and show the raw compilation result (--show-raw-compile), or generate validator code and show it (--show-code).

OPTIONS

* marks required options.

Action selection options

--show-code, -c: Don't validate data, show generated validator source code only.
--show-raw-compile, -R: Don't validate data, show raw compilation result only.
--show-schema, -s: Don't validate data, show normalized schema only.

Configuration options

--config-path=s

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

Can be specified multiple times.

--config-profile=s, -P

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

 [profile=dev]
 username=foo
 pass=beaver
 
 [profile=production]
 username=bar
 pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--no-config

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

Data specification options

--data-file-type=s

Give hint for data file type.

Valid values:

 ["json","yaml","perl"]

--data-file=filename

Retrieve data from file.

JSON, YAML, and Perl formats are supported. File type will be guessed from filename, defaults to JSON.

--data-json=s

See --data.

Can also be specified as the 2nd command-line argument.

--data=s

Can also be specified as the 2nd command-line argument.

--multiple-data-file=filename

Retrieve multiple data from file.

This is like data_file except that for multiple data. Data must be an array.

--multiple-data-json=s

Validate multiple data (array of data) against schema (JSON-encoded).

See --multiple-data.

--multiple-data=s

Validate multiple data (array of data) against schema.

Environment options

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

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

--data-with-result, -d

Show data alongside with validation result.

The default is to show the validation result only.

--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.

--linenum, -l

When showing source code, add line numbers.

--no-naked-res

When outputing as JSON, add result envelope.

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.

Schema specification options

--schema-file-type=s, -t

Give hint for schema file type.

Valid values:

 ["json","yaml","perl"]

--schema-file=filename, -f

Retrieve schema from file.

JSON, YAML, and Perl formats are supported. File type will be guessed from filename, defaults to JSON.

--schema-json=s

See --schema.

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

--schema-module=s, -m

--schema=s

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

Validator specification options

--bool

Shortcut for --return-type bool.

See --return-type.

--bool-val

Shortcut for --return-type bool+val.

See --return-type.

--compiler=s, -C

Select compiler.

Default value:

 "perl"

Valid values:

 ["perl","js"]

--core

Generate Perl validator that avoids the use of non-core modules.

--core-or-pp

Generate Perl validator that only uses core or pure-perl modules.

--full

Shortcut for --return-type full.

See --return-type.

--no-coerce

Generate validator that does not do coercions.

--no-modules

Generate Perl validator that does not use modules.

--pp

Generate Perl validator that avoids the use of XS modules.

--return-type=s, -r

Default value:

 "str"

Valid values:

 ["bool_valid","bool_valid+val","str_errmsg","str_errmsg+val","hash_details"]

--str-val

Shortcut for --return-type str+val.

See --return-type.

--with-debug

Generate validator with debug on.

This means e.g. to pepper the validator source code with logging statements.

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 validate-with-sah validate-with-sah

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 validate-with-sah 'p/*/`validate-with-sah`/'

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.

FAQ

When there is an error (e.g. in generating validator code, in validating) the program returns undef/null, how do I see the error message?

Pass `--no-naked-res` to see the error code and error message. The default is naked for simpler output.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/validate-with-sah.conf, /home/u1/validate-with-sah.conf, or /etc/validate-with-sah.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

 coerce (see --no-coerce)
 compiler (see --compiler)
 core (see --core)
 core_or_pp (see --core-or-pp)
 data (see --data)
 data_file (see --data-file)
 data_file_type (see --data-file-type)
 data_with_result (see --data-with-result)
 format (see --format)
 linenum (see --linenum)
 log_level (see --log-level)
 multiple_data (see --multiple-data)
 multiple_data_file (see --multiple-data-file)
 naked_res (see --naked-res)
 no_modules (see --no-modules)
 pp (see --pp)
 return_type (see --return-type)
 schema (see --schema)
 schema_file (see --schema-file)
 schema_file_type (see --schema-file-type)
 schema_module (see --schema-module)
 show_code (see --show-code)
 show_raw_compile (see --show-raw-compile)
 show_schema (see --show-schema)
 with_debug (see --with-debug)

ENVIRONMENT

VALIDATE_WITH_SAH_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/validate-with-sah.conf

/home/u1/validate-with-sah.conf

/etc/validate-with-sah.conf

EXAMPLES

Should succeed and return empty string

 % validate-with-sah '"int*"' 42

Should show an error message because "x" is not int

 % validate-with-sah '"int*"' '"x"'
 Not of type integer

Validate multiple data, should return "", 1, ""

 % validate-with-sah '["int","min",1,"max",10]' --multiple-data-json '[-4,7,15]' --return-type bool
 ["", 1, ""]

Show data alongside with result, in a table

 % validate-with-sah '["int","min",1,"max",10]' --multiple-data-json '[-4,7,15]' -d
 [
   { data => -4, result => "Must be at least 1" },
   { data => 7, result => "" },
   { data => 15, result => "Must be at most 10" },
 ]

Show validator Perl source code only, with line number

 % validate-with-sah '["int","min",1,"max",10]' -c -l
    1|do {
    2|    no warnings ('void');
    3|    require Scalar::Util::Numeric;
    4|    sub {
    5|        my ($data) = @_;
    6|        my $err_data;
    7|        my $_sahv_res = 
     |        
    9|            # skip if undef
   10|            (!defined($data) ? 1 : 
     |            
   12|            (# check type 'int'
   13|            ((Scalar::Util::Numeric::isint($data)) ? 1 : (($err_data //= "Not of type integer"),0))
     |            
   15|            &&
     |            
   17|            (# clause: min
   18|            (($data >= 1) ? 1 : (($err_data //= "Must be at least 1"),0)))
     |            
   20|            &&
     |            
   22|            (# clause: max
   23|            (($data <= 10) ? 1 : (($err_data //= "Must be at most 10"),0)))));
     |        
   25|        ($err_data //= "");
     |        
   27|        return($err_data);
   28|    }}

Show validator Perl source code, with no coercion code (the validator will only accept epochs)

 % validate-with-sah '["date"]' -c --no-coerce
 do {
     no warnings ('void');
     sub {
         my ($data) = @_;
         my $err_data;
         my $_sahv_res = 
         
             # skip if undef
             (!defined($data) ? 1 : 
             
             (# check type 'date'
             ((!ref($data) && $data =~ /\A[0-9]+\z/) ? 1 : (($err_data //= "Not of type date"),0))));
         
         ($err_data //= "");
         
         return($err_data);
     }}

Show validator Perl source code, with no coercion code (the validator will only accept DateTime objects)

 % validate-with-sah '["date",{"x.perl.coerce_to":"DateTime"}]' -c --no-coerce
 do {
     no warnings ('void');
     require Scalar::Util;
     sub {
         my ($data) = @_;
         my $err_data;
         my $_sahv_res = 
         
             # skip if undef
             (!defined($data) ? 1 : 
             
             (# check type 'date'
             ((Scalar::Util::blessed($data) && $data->isa('DateTime')) ? 1 : (($err_data //= "Not of type date"),0))));
         
         ($err_data //= "");
         
         return($err_data);
     }}

Show validator JavaScript code

 % validate-with-sah '["int","min",1,"max",10]' -c -C js
 function(data) {
     var err_data = null;
     var tmp_data = [];
     var _sahv_res = 
     
         // skip if undef
         (!!(data === undefined || data === null) ? true : 
         
         (// check type 'int'
         ((typeof(data)=='number' && Math.round(data)==data || parseInt(data)==data) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Not of type integer",0))
         
         &&
         
         // set temporary data term
         ((tmp_data[0] = typeof(data)=='number' ? data : parseFloat(data)), true)
         
         &&
         
         (// clause: min
         ((tmp_data[0] >= 1) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Must be at least 1",0)))
         
         &&
         
         (// clause: max
         ((tmp_data[0] <= 10) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Must be at most 10",0)))
         
         &&
         
         // restore original data term
         ((tmp_data).pop(), true)));
     
     err_data = !(err_data === undefined || err_data === null) ? err_data : "";
     
     return(err_data);
 }

Show validator JS source code only, with line number

 % validate-with-sah '["int","min",1,"max",10]' -C js -c -l
    1|function(data) {
    2|    var err_data = null;
    3|    var tmp_data = [];
    4|    var _sahv_res = 
     |    
    6|        // skip if undef
    7|        (!!(data === undefined || data === null) ? true : 
     |        
    9|        (// check type 'int'
   10|        ((typeof(data)=='number' && Math.round(data)==data || parseInt(data)==data) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Not of type integer",0))
     |        
   12|        &&
     |        
   14|        // set temporary data term
   15|        ((tmp_data[0] = typeof(data)=='number' ? data : parseFloat(data)), true)
     |        
   17|        &&
     |        
   19|        (// clause: min
   20|        ((tmp_data[0] >= 1) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Must be at least 1",0)))
     |        
   22|        &&
     |        
   24|        (// clause: max
   25|        ((tmp_data[0] <= 10) ? true : (err_data = !(err_data === undefined || err_data === null) ? err_data : "Must be at most 10",0)))
     |        
   27|        &&
     |        
   29|        // restore original data term
   30|        ((tmp_data).pop(), true)));
     |    
   32|    err_data = !(err_data === undefined || err_data === null) ? err_data : "";
     |    
   34|    return(err_data);
   35|}

Load schema from file

 % validate-with-sah -f schema1.json '["data"]'

Load schema and data from file

 % validate-with-sah -f schema1.json --multiple-data-file datafile --data-file-type json

HOMEPAGE

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

SOURCE

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

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 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-SahUtils

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.

To install App::SahUtils, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::SahUtils

CPAN shell

perl -MCPAN -e shell
install App::SahUtils

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Action selection options

Configuration options

Data specification options

Environment options

Logging options

Output options

Schema specification options

Validator specification options

Other options

COMPLETION

bash

tcsh

other shells

FAQ

When there is an error (e.g. in generating validator code, in validating) the program returns undef/null, how do I see the error message?

CONFIGURATION FILE

ENVIRONMENT

VALIDATE_WITH_SAH_OPT

FILES

/home/u1/.config/validate-with-sah.conf

/home/u1/validate-with-sah.conf

/etc/validate-with-sah.conf

EXAMPLES

Should succeed and return empty string

Should show an error message because "x" is not int

Validate multiple data, should return "", 1, ""

Show data alongside with result, in a table

Show validator Perl source code only, with line number

Show validator Perl source code, with no coercion code (the validator will only accept epochs)

Show validator Perl source code, with no coercion code (the validator will only accept DateTime objects)

Show validator JavaScript code

Show validator JS source code only, with line number

Load schema from file

Load schema and data from file

HOMEPAGE

SOURCE

SEE ALSO

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions