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

NAME

Sah::Schemas::Re - Various regular-expression schemas

VERSION

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

SAH SCHEMAS

The following schemas are included in this distribution:

  • obj::re

    Regexp object.

    This schema can be used as a stricter version of the re type. Unlike re, this schema only accepts Regexp object and not string.

  • re_from_str

    Regexp object from string using Regexp::From::String's str_to_re().

    This schema accepts Regexp object or string which will be coerced to Regexp object using Regexp::From::String's str_to_re() function.

    Basically, if string is of the form of /.../ or qr(...), then you could specify metacharacters as if you are writing a literal regexp pattern in Perl. Otherwise, your string will be quotemeta()-ed first then compiled to Regexp object. This means in the second case you cannot specify metacharacters.

    What's the difference between this schema and str_or_re (from Sah::Schemas::Str)? Both this schema and str_or_re accept string, but this schema will still coerce strings not in the form of /.../ or qr(...) to regexp object, while str_or_re will leave the string as-is. In other words, this schema always converts input to Regexp object while str_or_re does not.

  • re_or_code_from_str

    Regex (convertable from string of the form `/.../`) or coderef (convertable from string of the form `sub { ... }`).

    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 specification

Data::Sah - Perl implementation of Sah

Sah::PSchemas::Re

Sah::Schemas::RegexpPattern

Sah::Schema::str_or_re

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.