—

              
package Sah::Schema::dirname::unix;
use strict;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-01-08'; # DATE
our $DIST = 'Sah-Schemas-Path'; # DIST
our $VERSION = '0.030'; # VERSION
our $schema = ["str" => {
    summary => 'Filesystem directory name on a Unix system',
    description => <<'MARKDOWN',
This is like the `dirname` schema but with extra checks relevant to the Unix,
(e.g. a path element cannot be longer than 255 characters) and prefilters (e.g.
multipile consecutive slashes `//` will be normalized into a single one `/`).
MARKDOWN
    match => '\A(?:/|/?(?:[^/\0]{1,255})(?:/[^/\0]{1,255})*)\z',
    'x.completion' => ['dirname'],
    prefilters => [
        'Path::expand_tilde',
        'Path::strip_slashes',
    ],
    examples => [
        {value=>'', valid=>0},
        {value=>'/', valid=>1},
        {value=>'foo/bar', valid=>1},
        {value=>'foo//bar', valid=>1, validated_value=>'foo/bar'},
        {value=>'a' x 256, valid=>0, summary=>'Path element too long'},
        {value=>"foo\0", valid=>0, summary=>"Contains null character"},
    ],
}];
1;
# ABSTRACT: Filesystem directory name on a Unix system
__END__
HideShow 228 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
Sah::Schema::dirname::unix - Filesystem directory name on a Unix system
=head1 VERSION
This document describes version 0.030 of Sah::Schema::dirname::unix (from Perl distribution Sah-Schemas-Path), released on 2024-01-08.
=head1 SAH SCHEMA DEFINITION
 [
   "str",
   {
     "match"        => "\\A(?:/|/?(?:[^/\\0]{1,255})(?:/[^/\\0]{1,255})*)\\z",
     "prefilters"   => ["Path::expand_tilde", "Path::strip_slashes"],
     "summary"      => "Filesystem directory name on a Unix system",
     "x.completion" => ["dirname"],
   },
 ]
Base type: L<str|Data::Sah::Type::str>
Used prefilters: L<Path::expand_tilde|Data::Sah::Filter::perl::Path::expand_tilde>, L<Path::strip_slashes|Data::Sah::Filter::perl::Path::strip_slashes>
Used completion: L<dirname|Perinci::Sub::XCompletion::dirname>
=head1 SYNOPSIS
=head2 Sample data and validation results against this schema
 ""  # INVALID
 "/"  # valid
 "foo/bar"  # valid
 "foo//bar"  # valid, becomes "foo/bar"
 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  # INVALID (Path element too long)
 "foo\0"  # INVALID (Contains null character)
=head2 Using with Data::Sah
To check data against this schema (requires L<Data::Sah>):
 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("dirname::unix*");
 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("dirname::unix", {return_type=>'str_errmsg'});
 my $errmsg = $validator->($data);
  
 # a sample valid data
 $data = "foo//bar";
 my $errmsg = $validator->($data); # => ""
  
 # a sample invalid data
 $data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
 my $errmsg = $validator->($data); # => "Must match regex pattern \\A(?:/|/?(?:[^/\\0]{1,255})(?:/[^/\\0]{1,255})*)\\z"
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("dirname::unix", {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 = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
 my $res = $validator->($data); # => ["Must match regex pattern \\A(?:/|/?(?:[^/\\0]{1,255})(?:/[^/\\0]{1,255})*)\\z","aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"]
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.
=head2 Using with Params::Sah
To validate function parameters against this schema (requires L<Params::Sah>):
 use Params::Sah qw(gen_validator);
 sub myfunc {
     my @args = @_;
     state $validator = gen_validator("dirname::unix*");
     $validator->(\@args);
     ...
 }
=head2 Using with Perinci::CmdLine::Lite
To specify schema in L<Rinci> function metadata and use the metadata with
L<Perinci::CmdLine> (L<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 => ['dirname::unix*'],
         },
         ...
     },
 };
 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 ...
=head2 Using on the CLI with validate-with-sah
To validate some data on the CLI, you can use L<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 '"dirname::unix*"' '"data..."'
C<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.
=head2 Using with Type::Tiny
To create a type constraint and type library from a schema (requires
L<Type::Tiny> as well as L<Type::FromSah>):
 package My::Types {
     use Type::Library -base;
     use Type::FromSah qw( sah2type );
     __PACKAGE__->add_type(
         sah2type('dirname::unix*', name=>'DirnameUnix')
     );
 }
 use My::Types qw(DirnameUnix);
 DirnameUnix->assert_valid($data);
=head1 DESCRIPTION
This is like the C<dirname> schema but with extra checks relevant to the Unix,
(e.g. a path element cannot be longer than 255 characters) and prefilters (e.g.
multipile consecutive slashes C<//> will be normalized into a single one C</>).
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Sah-Schemas-Path>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Sah-Schemas-Path>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<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.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2023, 2020, 2019, 2018, 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Path>
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.
=cut