The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Sah-Schemas-Re-0.006
River stage two • 8 direct dependents • 10 total dependents
/ Sah::Schema::re_or_code_from_str

NAME

Sah::Schema::re_or_code_from_str - Regex (convertable from string of the form `/.../`) or coderef (convertable from string of the form `sub { ... }`)

VERSION

This document describes version 0.006 of Sah::Schema::re_or_code_from_str (from Perl distribution Sah-Schemas-Re), released on 2023-12-20.

SYNOPSIS

Sample data and validation results against this schema

 ""  # INVALID (Not to regex or code)

 "a"  # INVALID (Not a regex or code)

 {}  # INVALID (Not a regex or code)

 qr()  # valid

 sub{package Sah::Schema::re_or_code_from_str;use warnings;use strict;no feature;use feature ':5.10'}  # valid

 "//"  # valid, becomes qr()

 "/foo"  # INVALID (Not converted to regex)

 "qr(foo"  # INVALID (Not converted to regex)

 "qr(foo("  # INVALID (Not converted to regex)

 "qr/foo/"  # INVALID (Not converted to regex)

 "/foo.*/"  # valid, becomes qr(foo.*)

 "qr(foo.*)"  # valid, becomes qr(foo.*)

 "/foo/is"  # valid, becomes qr(foo)si

 "qr(foo)is"  # valid, becomes qr(foo)si

 "/foo[/"  # INVALID (Invalid regex)

 "sub {}"  # valid

 "sub{\"foo\"}"  # valid

 "sub {"  # INVALID (Not converted to code)

 "sub {1=2}"  # INVALID (Code does not compile)

Using with Data::Sah

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

 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("re_or_code_from_str*");
 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("re_or_code_from_str", {return_type=>'str_errmsg'});
 my $errmsg = $validator->($data);
 
 # a sample valid data
 $data = "//";
 my $errmsg = $validator->($data); # => ""
 
 # a sample invalid data
 $data = "/foo";
 my $errmsg = $validator->($data); # => "Not of type object"

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("re_or_code_from_str", {return_type=>'str_errmsg+val'});
 my $res = $validator->($data); # [$errmsg, $validated_val]
 
 # a sample valid data
 $data = "//";
 my $res = $validator->($data); # => ["",qr()]
 
 # a sample invalid data
 $data = "/foo";
 my $res = $validator->($data); # => ["Not of type object","/foo"]

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("re_or_code_from_str*");
     $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 => ['re_or_code_from_str*'],
         },
         ...
     },
 };
 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 '"re_or_code_from_str*"' '"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('re_or_code_from_str*', name=>'ReOrCodeFromStr')
     );
 }

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

DESCRIPTION

Either Regexp object or coderef is accepted.

Coercion from string for Regexp is available if string is of the form of /.../ or qr(...); it will be compiled into a Regexp object. If the regex pattern inside /.../ or qr(...) is invalid, value will be rejected. Currently, unlike in normal Perl, for the qr(...) form, only parentheses ( and ) are allowed as the delimiter. Currently modifiers i, m, and s after the second / are allowed.

Coercion from string for coderef is available if string matches the regex qr/\Asub\s*\{.*\}\z/s, then it will be eval'ed into a coderef. If the code fails to compile, the value will be rejected. Note that this means you accept arbitrary code from the user to execute! Please make sure first and foremost that this is acceptable in your case. Currently string is eval'ed in the main package, without use strict or use warnings.

Unlike the default behavior of the re Sah type, coercion from other string not in the form of /.../ or qr(...) is not available. Thus, such values will be rejected.

This schema is handy if you want to accept regex or coderef from the command-line.

HOMEPAGE

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

SOURCE

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

SEE ALSO

Sah::Schema::str_or_re

Sah::Schema::str_or_code

Sah::Schema::str_or_re_or_code

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

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.