/ 
Sah-Schemas-Date-0.017
River stage one • 6 direct dependents • 9 total dependents
/ Sah::Schema::date::tz_offset

NAME

Sah::Schema::date::tz_offset - Timezone offset in seconds from UTC

VERSION

This document describes version 0.017 of Sah::Schema::date::tz_offset (from Perl distribution Sah-Schemas-Date), released on 2021-08-04.

SYNOPSIS

Sample data and validation results against this schema

""  # INVALID

"UTC"  # valid, becomes 0

3600  # valid, becomes 3600

-43200  # valid, becomes -43200

-12  # valid, becomes -43200

-1200  # valid, becomes -43200

"-12:00"  # valid, becomes -43200

"UTC-12"  # valid, becomes -43200

"UTC-1200"  # valid, becomes -43200

"UTC+12:45"  # valid, becomes 45900

"UTC-13"  # INVALID

"UTC+12:01"  # INVALID (Unknown offset)

Using with Data::Sah

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

use Data::Sah qw(gen_validator);
my $validator = gen_validator("date::tz_offset*");
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::tz_offset", {return_type=>'str_errmsg'});
my $errmsg = $validator->($data);

# a sample valid data
$data = "UTC-12";
my $errmsg = $validator->($data); # => ""

# a sample invalid data
$data = "UTC+12:01";
my $errmsg = $validator->($data); # => "Must be one of [-43200,-39600,-37800,-36000,-34200,-32400,-30600,-28800,-25200,-21600,-18000,-16200,-14400,-12600,-10800,-9000,-7200,-3600,-2640,-1521,0,0,1200,1800,3600,5040,5400,7200,9000,10800,12600,14400,16200,17460,18000,19800,20400,20700,21600,23400,25200,26400,27000,28800,30600,31500,32400,34200,35100,36000,37800,39600,41400,43200,45900,46800,49500,50400]"

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::tz_offset", {return_type=>'str_errmsg+val'});
my $res = $validator->($data); # [$errmsg, $validated_val]

# a sample valid data
$data = "UTC-12";
my $res = $validator->($data); # => ["",-43200]

# a sample invalid data
$data = "UTC+12:01";
my $res = $validator->($data); # => ["Must be one of [-43200,-39600,-37800,-36000,-34200,-32400,-30600,-28800,-25200,-21600,-18000,-16200,-14400,-12600,-10800,-9000,-7200,-3600,-2640,-1521,0,0,1200,1800,3600,5040,5400,7200,9000,10800,12600,14400,16200,17460,18000,19800,20400,20700,21600,23400,25200,26400,27000,28800,30600,31500,32400,34200,35100,36000,37800,39600,41400,43200,45900,46800,49500,50400]",43260]

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::tz_offset*");
    $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::tz_offset*'],
        },
        ...
    },
};
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

Only timezone offsets that are known to exist are allowed. For example, 1 second (+00:00:01) is not allowed. See date::tz_offset_lax for a more relaxed validation.

A coercion from these form of string is provided:

UTC

UTC-14 or UTC+12 or UTC+12:45 or UTC-00:25:21
-14 or +12, -1400 or +12:00

A coercion from timezone name is also provided.

HOMEPAGE

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

SOURCE

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

BUGS

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

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.