/ 
Sah-Schemas-Unix-0.017
River stage two • 11 direct dependents • 13 total dependents
/ Sah::Schema::unix::groupname

NAME

Sah::Schema::unix::groupname - Unix group name

VERSION

This document describes version 0.017 of Sah::Schema::unix::groupname (from Perl distribution Sah-Schemas-Unix), released on 2021-07-22.

SYNOPSIS

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

use Data::Sah qw(gen_validator);
my $validator = gen_validator("unix::groupname*");
say $validator->($data) ? "valid" : "INVALID!";

# Data::Sah can also create validator that returns nice error message string
# and/or coerced value. Data::Sah can even create validator that targets other
# language, like JavaScript. All from the same 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("unix::groupname*");
    $validator->(\@args);
    ...
}

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine 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 => ['unix::groupname*'],
        },
        ...
    },
};
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 ...

Sample data:

""  # INVALID

"foo"  # valid

"-andy"  # INVALID

1234  # INVALID

"andy2"  # valid

"an dy"  # INVALID

"an.dy"  # valid

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  # INVALID (Too long)

DESCRIPTION

The checking follows POSIX rules: does not begin with a hyphen and only contains [A-Za-z0-9._-].

The above rule allows integers like 1234, which can be confused with GID, so this schema disallows pure integers.

The maximum length is 32 following libc6's limit.

HOMEPAGE

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

SOURCE

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Unix

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2019 by 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.