/ 
Data-Sah-FilterBundle-Filename-Safe-0.001
River stage zero No dependents
/ Data::Sah::Filter::perl::Filename::Safe::alphanum

NAME

Data::Sah::Filter::perl::Filename::Safe::alphanum - Replace characters that are not [A-Za-z0-9_] with underscore (_)

VERSION

This document describes version 0.001 of Data::Sah::Filter::perl::Filename::Safe::alphanum (from Perl distribution Data-Sah-FilterBundle-Filename-Safe), released on 2024-01-22.

SYNOPSIS

Using in Sah schema's prefilters (or postfilters) clause

["str","prefilters",[["Filename::Safe::alphanum"]]]

Using with Data::Sah:

use Data::Sah qw(gen_validator);

my $schema = ["str","prefilters",[["Filename::Safe::alphanum"]]];
my $validator = gen_validator($schema);
if ($validator->($some_data)) { print 'Valid!' }

Using with Data::Sah:Filter directly:

use Data::Sah::Filter qw(gen_filter);

my $filter = gen_filter([["Filename::Safe::alphanum"]]);
my $filtered_value = $filter->($some_data);

Sample data and filtering results

"" # valid, unchanged
"foo" # valid, unchanged
"123  456-789.foo.bar" # valid, becomes "123_456_789_foo.bar"

DESCRIPTION

Multiple consecutive unwanted characters will be replaced with a single underscore.

A single filename extension is allowed, e.g. "foo bar.exe" -> "foo_bar.exe", but additional filename extensions will be made 'safe' too, e.g. "foo bar.doc.pdf" -> 'foo_bar_doc.pdf'.

If you want to avoid having digit as the first character, use the alphanum_identifier (Data::Sah::Filter::perl::Filename::Safe::alphanum_identifier) filter instead.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Sah-FilterBundle-Filename-Safe.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah-FilterBundle-Filename-Safe.

SEE ALSO

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) 2024 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=Data-Sah-FilterBundle-Filename-Safe

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.