-
-
04 Aug 2021 12:10:06 UTC
- Distribution: Sah-Schemas-Date-ID
- Module version: 0.007
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (104 / 0 / 2)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (26.83KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Sah::Schema::date::dow_nums::id - Array of required day-of-week numbers (1-7, 1=Monday, like DateTime, with coercions)
VERSION
This document describes version 0.007 of Sah::Schema::date::dow_nums::id (from Perl distribution Sah-Schemas-Date-ID), released on 2021-08-04.
SYNOPSIS
Sample data and validation results against this schema
"" # valid, becomes [] 0 # INVALID (Has number not in 1-7) 1 # valid, becomes [1] "1,7" # valid, becomes [1,7] [1,undef] # INVALID (Contains undef) [1,7] # valid ["Sen","MinggU"] # valid, becomes [1,7] "Sn,MG" # valid, becomes [1,7] "1,7,8" # INVALID (Has number not in 1-7) [1,7,8] # INVALID (Has number not in 1-7)
Using with Data::Sah
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("date::dow_nums::id*"); say $validator->($data) ? "valid" : "INVALID!";
The above schema returns a boolean value (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("date::dow_nums::id", {return_type=>'str_errmsg'}); my $errmsg = $validator->($data); # a sample valid data $data = ["Sen","MinggU"]; my $errmsg = $validator->($data); # => "" # a sample invalid data $data = 0; my $errmsg = $validator->($data); # => "\@[0]: Must be at least 1"
Often a schema has coercion rule or default value, so after validation the validated value is different. To return the validated (set-as-default, coerced, prefiltered) value:
my $validator = gen_validator("date::dow_nums::id", {return_type=>'str_errmsg+val'}); my $res = $validator->($data); # [$errmsg, $validated_val] # a sample valid data $data = [1,7]; my $res = $validator->($data); # => ["",[1,7]] # a sample invalid data $data = 0; my $res = $validator->($data); # => ["\@[0]: Must be at least 1",[0]]
Data::Sah can also create validator that returns a hash of detaild 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("date::dow_nums::id*"); $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 => ['date::dow_nums::id*'], }, ... }, }; 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 ...
DESCRIPTION
Like the date::dow_nums except the elements are date::dow_num::id instead of date::dow_num.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Date-ID.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Date-ID.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Date-ID
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.
SEE ALSO
Sah::Schema::date::dow_nums::en_or_id
Sah::Schema::date::dow_num::id
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.
Module Install Instructions
To install Sah::Schemas::Date::ID, copy and paste the appropriate command in to your terminal.
cpanm Sah::Schemas::Date::ID
perl -MCPAN -e shell install Sah::Schemas::Date::ID
For more information on module installation, please visit the detailed CPAN module installation guide.