/ 
Sah-Schemas-Perl-0.049
River stage one • 1 direct dependent • 1 total dependent
/ Sah::Schema::perl::modname_with_optional_args

NAME

Sah::Schema::perl::modname_with_optional_args - Perl module name (e.g. Foo::Bar) with optional arguments (e.g. Foo::Bar=arg1,arg2)

VERSION

This document describes version 0.049 of Sah::Schema::perl::modname_with_optional_args (from Perl distribution Sah-Schemas-Perl), released on 2023-10-26.

SYNOPSIS

Sample data and validation results against this schema

""  # INVALID

"Foo::Bar"  # valid

"Foo::Bar=arg1,arg2"  # valid

"Foo-Bar=arg1,arg2"  # valid, becomes "Foo::Bar=arg1,arg2"

[]  # INVALID (No module name)

["Foo"]  # valid

["Foo Bar"]  # INVALID (Invalid module name)

["Foo","arg"]  # INVALID (Args must be arrayref or hashref)

["Foo",{arg1=>1,arg2=>2}]  # valid

["Foo",["arg1","arg2"]]  # valid

["Foo",["arg1","arg2"],{}]  # INVALID (Too many elements)

Using with Data::Sah

To check data against this schema (requires Data::Sah):

use Data::Sah qw(gen_validator);
my $validator = gen_validator("perl::modname_with_optional_args*");
say $validator->($data) ? "valid" : "INVALID!";

The above validator returns a boolean result (true if data is valid, false if otherwise). To return an error message string instead (empty string if data is valid, a non-empty error message otherwise):

my $validator = gen_validator("perl::modname_with_optional_args", {return_type=>'str_errmsg'});
my $errmsg = $validator->($data);

# a sample valid data
$data = ["Foo"];
my $errmsg = $validator->($data); # => ""

# a sample invalid data
$data = "";
my $errmsg = $validator->($data); # => "String is not a valid JSON: malformed JSON string, neither tag, array, object, number, string or atom, at character offset 0 at (eval 3229) line 29.\n"

Often a schema has coercion rule or default value rules, so after validation the validated value will be different from the original. To return the validated (set-as-default, coerced, prefiltered) value:

my $validator = gen_validator("perl::modname_with_optional_args", {return_type=>'str_errmsg+val'});
my $res = $validator->($data); # [$errmsg, $validated_val]

# a sample valid data
$data = ["Foo"];
my $res = $validator->($data); # => ["",["Foo"]]

# a sample invalid data
$data = "";
my $res = $validator->($data); # => ["String is not a valid JSON: malformed JSON string, neither tag, array, object, number, string or atom, at character offset 0 at (eval 3249) line 29.\n",""]

Data::Sah can also create validator that returns a hash of detailed error message. Data::Sah can even create validator that targets other language, like JavaScript, from the same schema. Other things Data::Sah can do: show source code for validator, generate a validator code with debug comments and/or log statements, generate human text from schema. See its documentation for more details.

Using with Params::Sah

To validate function parameters against this schema (requires Params::Sah):

use Params::Sah qw(gen_validator);

sub myfunc {
    my @args = @_;
    state $validator = gen_validator("perl::modname_with_optional_args*");
    $validator->(\@args);
    ...
}

Using with Perinci::CmdLine::Lite

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:

# in lib/MyApp.pm
package
  MyApp;
our %SPEC;
$SPEC{myfunc} = {
    v => 1.1,
    summary => 'Routine to do blah ...',
    args => {
        arg1 => {
            summary => 'The blah blah argument',
            schema => ['perl::modname_with_optional_args*'],
        },
        ...
    },
};
sub myfunc {
    my %args = @_;
    ...
}
1;

# in myapp.pl
package
  main;
use Perinci::CmdLine::Any;
Perinci::CmdLine::Any->new(url=>'/MyApp/myfunc')->run;

# in command-line
% ./myapp.pl --help
myapp - Routine to do blah ...
...

% ./myapp.pl --version

% ./myapp.pl --arg1 ...

Using on the CLI with validate-with-sah

To validate some data on the CLI, you can use validate-with-sah utility. Specify the schema as the first argument (encoded in Perl syntax) and the data to validate as the second argument (encoded in Perl syntax):

% validate-with-sah '"perl::modname_with_optional_args*"' '"data..."'

validate-with-sah has several options for, e.g. validating multiple data, showing the generated validator code (Perl/JavaScript/etc), or loading schema/data from file. See its manpage for more details.

Using with Type::Tiny

To create a type constraint and type library from a schema (requires Type::Tiny as well as Type::FromSah):

package My::Types {
    use Type::Library -base;
    use Type::FromSah qw( sah2type );

    __PACKAGE__->add_type(
        sah2type('perl::modname_with_optional_args*', name=>'PerlModnameWithOptionalArgs')
    );
}

use My::Types qw(PerlModnameWithOptionalArgs);
PerlModnameWithOptionalArgs->assert_valid($data);

DESCRIPTION

Perl module name with optional arguments which will be used as import arguments, just like the -MMODULE=ARGS shortcut that perl provides. Examples:

Foo
Foo::Bar
Foo::Bar=arg1,arg2

See also: perl::modname. A two-element array from (coercible from JSON string) is also allowed:

["Foo::Bar", \@args]

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Perl.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Perl.

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=Sah-Schemas-Perl

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.