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.050 of Sah::Schema::perl::modname_with_optional_args (from Perl distribution Sah-SchemaBundle-Perl), released on 2024-02-16.

SAH SCHEMA DEFINITION

[
  "any",
  {
    "summary" => "Perl module name (e.g. Foo::Bar) with optional arguments (e.g. Foo::Bar=arg1,arg2)",
    "of" => [
      [
        "array_from_json",
        {
          summary     => "A 1- or 2-element array containing Perl module name (e.g. [\"Foo::Bar\"]) with optional arguments (e.g. [\"Foo::Bar\", [\"arg1\",\"arg2\"]])",
          description => "\nThese are valid values for this schema:\n\n    [\"Foo\"]                                      # just the module name\n    [\"Foo::Bar\", [\"arg1\",\"arg2\"]]                # with import arguments (array)\n    [\"Foo::Bar\", {\"arg1\"=>\"val\",\"arg2\"=>\"val\"}]  # with import arguments (hash)\n\n",
          max_len     => 2,
          min_len     => 1,
          elems       => [
                           ["perl::modname", { req => 1 }],
                           [
                             "any",
                             { req => 1, of => [["array", { req => 1 }], ["hash", { req => 1 }]] },
                           ],
                         ],
          examples    => [
                           { summary => "No module name", valid => 0, value => [] },
                           { valid => 1, value => ["Foo"] },
                           { summary => "Invalid module name", valid => 0, value => ["Foo Bar"] },
                           {
                             summary => "Args must be arrayref or hashref",
                             valid   => 0,
                             value   => ["Foo", "arg"],
                           },
                           { valid => 1, value => ["Foo", { arg1 => 1, arg2 => 2 }] },
                           { valid => 1, value => ["Foo", ["arg1", "arg2"]] },
                           {
                             summary => "Too many elements",
                             valid   => 0,
                             value   => ["Foo", ["arg1", "arg2"], {}],
                           },
                         ],
        },
      ],
      [
        "str",
        {
          "summary"             => "Perl module name (e.g. Foo::Bar) with optional arguments (e.g. Foo::Bar=arg1,arg2)",
          "description"         => "\nPerl module name with optional arguments which will be used as import arguments,\njust like the `-MMODULE=ARGS` shortcut that `perl` provides. Examples:\n\n    Foo\n    Foo::Bar\n    Foo::Bar=arg1,arg2\n\nSee also: `perl::modname`.\n\n",
          "match"               => "\\A(?:[A-Za-z_][A-Za-z_0-9]*(::[A-Za-z_0-9]+)*(?:=.*)?)\\z",
          "examples"            => [
                                     { valid => 0, value => "" },
                                     { valid => 1, value => "Foo::Bar" },
                                     { valid => 1, value => "Foo::Bar=arg1,arg2" },
                                     {
                                       valid => 1,
                                       validated_value => "Foo::Bar=arg1,arg2",
                                       value => "Foo-Bar=arg1,arg2",
                                     },
                                   ],
          "x.completion"        => "perl_modname",
          "x.perl.coerce_rules" => ["From_str::normalize_perl_modname"],
        },
      ],
    ],
    "x.completion" => "perl_modname",
  },
]

Base type: any

Used completion: perl_modname

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",["arg1","arg2"]];
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 3180) 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",["arg1","arg2"]];
my $res = $validator->($data); # => ["",["Foo",["arg1","arg2"]]]

# 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 3200) 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-SchemaBundle-Perl.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-SchemaBundle-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 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-SchemaBundle-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.

To install Sah::SchemaBundle::Perl, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Sah::SchemaBundle::Perl

CPAN shell

perl -MCPAN -e shell
install Sah::SchemaBundle::Perl

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)