Sah::Schema::perl::modname - Perl module name, e.g. Foo::Bar
This document describes version 0.048 of Sah::Schema::perl::modname (from Perl distribution Sah-Schemas-Perl), released on 2023-01-19.
"" # INVALID "Foo::Bar" # valid "Foo-Bar" # valid, becomes "Foo::Bar" "Foo/Bar" # valid, becomes "Foo::Bar" "Foo/Bar.pm" # valid, becomes "Foo::Bar" "Foo.Bar" # valid, becomes "Foo::Bar" "Foo|Bar" # INVALID
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("perl::modname*"); say $validator->($data) ? "valid" : "INVALID!";
The above schema 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", {return_type=>'str_errmsg'}); my $errmsg = $validator->($data); # a sample valid data $data = "Foo/Bar"; my $errmsg = $validator->($data); # => "" # a sample invalid data $data = ""; my $errmsg = $validator->($data); # => "Must match regex pattern \\A(?:[A-Za-z_][A-Za-z_0-9]*(::[A-Za-z_0-9]+)*)\\z"
Often a schema has coercion rule or default value, so after validation the validated value is different. To return the validated (set-as-default, coerced, prefiltered) value:
my $validator = gen_validator("perl::modname", {return_type=>'str_errmsg+val'}); my $res = $validator->($data); # [$errmsg, $validated_val] # a sample valid data $data = "Foo/Bar"; my $res = $validator->($data); # => ["","Foo::Bar"] # a sample invalid data $data = ""; my $res = $validator->($data); # => ["Must match regex pattern \\A(?:[A-Za-z_][A-Za-z_0-9]*(::[A-Za-z_0-9]+)*)\\z",""]
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.
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*"); $validator->(\@args); ... }
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*'], }, ... }, }; 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 ...
To create a type constraint and type library from a schema:
package My::Types { use Type::Library -base; use Type::FromSah qw( sah2type ); __PACKAGE__->add_type( sah2type('$sch_name*', name=>'PerlModname') ); } use My::Types qw(PerlModname); PerlModname->assert_valid($data);
This is a schema you can use when you want to accept a Perl module name. It offers basic checking of syntax as well as a couple of conveniences. First, it offers completion from list of locally installed Perl modules. Second, it contains coercion rule so you can also input Foo-Bar, Foo/Bar, Foo/Bar.pm or even 'Foo.Bar' and it will be normalized into Foo::Bar.
Foo-Bar
Foo/Bar
Foo/Bar.pm
Foo::Bar
To see this schema in action on the CLI, you can try e.g. the pmless script from App::PMUtils and activate its tab completion (see its manpage for more details). Then on the CLI try typing:
pmless
% pmless M/<tab> % pmless dzp/<tab> % pmless Module/List/Wildcard % pmless Module::List::Wildcard
Note that this schema does not check that the Perl module exists or is installed locally. To check that, use the perl::modname::installed schema. And there's also a perl::modname::not_installed schema.
perl::modname::installed
perl::modname::not_installed
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Perl.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Perl.
perlancar <perlancar@cpan.org>
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.
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.
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.
To install Sah::Schemas::Perl, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::Perl
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::Perl
For more information on module installation, please visit the detailed CPAN module installation guide.