NAME

Sah::Schema::country::code::alpha3 - Country code (alpha-3)

VERSION

This document describes version 0.009 of Sah::Schema::country::code::alpha3 (from Perl distribution Sah-Schemas-Country), released on 2023-08-07.

SYNOPSIS

Sample data and validation results against this schema

 ""  # INVALID

 "ID"  # INVALID (Only alpha-3 codes are allowed)

 "IDN"  # valid, becomes "idn"

 "xx"  # INVALID

 "xxx"  # INVALID

Using with Data::Sah

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

 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("country::code::alpha3*");
 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("country::code::alpha3", {return_type=>'str_errmsg'});
 my $errmsg = $validator->($data);
 
 # a sample valid data
 $data = "IDN";
 my $errmsg = $validator->($data); # => ""
 
 # a sample invalid data
 $data = "";
 my $errmsg = $validator->($data); # => "Must be one of [\"phl\",\"esp\",\"tkm\",\"ago\",\"jor\",\"cyp\",\"cuw\",\"blm\",\"can\",\"aia\",\"hun\",\"atg\",\"vat\",\"esh\",\"glp\",\"mli\",\"mda\",\"ind\",\"eth\",\"png\",\"asm\",\"bfa\",\"guy\",\"deu\",\"ukr\",\"jpn\",\"prt\",\"cck\",\"lao\",\"tkl\",\"blr\",\"afg\",\"are\",\"gab\",\"swz\",\"vnm\",\"idn\",\"tcd\",\"bgd\",\"srb\",\"ala\",\"mwi\",\"rus\",\"bes\",\"tgo\",\"che\",\"zwe\",\"cok\",\"mne\",\"mar\",\"guf\",\"grl\",\"sjm\",\"mmr\",\"flk\",\"plw\",\"ben\",\"bmu\",\"gnq\",\"bol\",\"lca\",\"sgs\",\"zaf\",\"omn\",\"shn\",\"gtm\",\"nam\",\"lso\",\"iot\",\"svn\",\"gnb\",\"fro\",\"cmr\",\"bra\",\"grc\",\"bel\",\"niu\",\"gmb\",\"eri\",\"pyf\",\"arg\",\"abw\",\"nld\",\"hmd\",\"vgb\",\"dza\",\"hti\",\"hnd\",\"mac\",\"msr\",\"mtq\",\"tto\",\"tca\",\"chn\",\"mhl\",\"egy\",\"sxm\",\"pse\",\"qat\",\"fsm\",\"lby\",\"tza\",\"chl\",\"ita\",\"mrt\",\"moz\",\"mng\",\"cod\",\"pan\",\"khm\",\"smr\",\"arm\",\"cxr\",\"aut\",\"prk\",\"uga\",\"gum\",\"kgz\",\"ncl\",\"kaz\",\"bvt\",\"gbr\",\"lie\",\"nga\",\"ton\",\"ner\",\"mco\",\"ggy\",\"sgp\",\"bgr\",\"rwa\",\"brn\",\"isr\",\"civ\",\"ltu\",\"imn\",\"slv\",\"bih\",\"fji\",\"vut\",\"svk\",\"cri\",\"blz\",\"gin\",\"nzl\",\"wlf\",\"cze\",\"dom\",\"umi\",\"npl\",\"nor\",\"sur\",\"pol\",\"gib\",\"yem\",\"isl\",\"syr\",\"jey\",\"kna\",\"tjk\",\"fin\",\"reu\",\"bhs\",\"brb\",\"cym\",\"cub\",\"maf\",\"pcn\",\"grd\",\"atf\",\"hrv\",\"gha\",\"uzb\",\"rou\",\"nic\",\"aus\",\"zmb\",\"caf\",\"kir\",\"slb\",\"tls\",\"sau\",\"and\",\"per\",\"pak\",\"ecu\",\"geo\",\"ven\",\"tur\",\"bdi\",\"mdv\",\"sen\",\"mdg\",\"lbr\",\"mnp\",\"kor\",\"irl\",\"fra\",\"dma\",\"sle\",\"dnk\",\"irn\",\"jam\",\"wsm\",\"stp\",\"aze\",\"dji\",\"som\",\"pry\",\"mys\",\"cpv\",\"ata\",\"tha\",\"vct\",\"kwt\",\"mex\",\"alb\",\"usa\",\"ury\",\"nru\",\"sdn\",\"spm\",\"pri\",\"mus\",\"lva\",\"bhr\",\"swe\",\"lux\",\"tun\",\"twn\",\"col\",\"lka\",\"mlt\",\"lbn\",\"myt\",\"cog\",\"mkd\",\"com\",\"nfk\",\"est\",\"ssd\",\"ken\",\"tuv\",\"syc\",\"bwa\",\"hkg\",\"vir\",\"irq\",\"btn\"]"

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("country::code::alpha3", {return_type=>'str_errmsg+val'});
 my $res = $validator->($data); # [$errmsg, $validated_val]
 
 # a sample valid data
 $data = "IDN";
 my $res = $validator->($data); # => ["","idn"]
 
 # a sample invalid data
 $data = "";
 my $res = $validator->($data); # => ["Must be one of [\"phl\",\"esp\",\"tkm\",\"ago\",\"jor\",\"cyp\",\"cuw\",\"blm\",\"can\",\"aia\",\"hun\",\"atg\",\"vat\",\"esh\",\"glp\",\"mli\",\"mda\",\"ind\",\"eth\",\"png\",\"asm\",\"bfa\",\"guy\",\"deu\",\"ukr\",\"jpn\",\"prt\",\"cck\",\"lao\",\"tkl\",\"blr\",\"afg\",\"are\",\"gab\",\"swz\",\"vnm\",\"idn\",\"tcd\",\"bgd\",\"srb\",\"ala\",\"mwi\",\"rus\",\"bes\",\"tgo\",\"che\",\"zwe\",\"cok\",\"mne\",\"mar\",\"guf\",\"grl\",\"sjm\",\"mmr\",\"flk\",\"plw\",\"ben\",\"bmu\",\"gnq\",\"bol\",\"lca\",\"sgs\",\"zaf\",\"omn\",\"shn\",\"gtm\",\"nam\",\"lso\",\"iot\",\"svn\",\"gnb\",\"fro\",\"cmr\",\"bra\",\"grc\",\"bel\",\"niu\",\"gmb\",\"eri\",\"pyf\",\"arg\",\"abw\",\"nld\",\"hmd\",\"vgb\",\"dza\",\"hti\",\"hnd\",\"mac\",\"msr\",\"mtq\",\"tto\",\"tca\",\"chn\",\"mhl\",\"egy\",\"sxm\",\"pse\",\"qat\",\"fsm\",\"lby\",\"tza\",\"chl\",\"ita\",\"mrt\",\"moz\",\"mng\",\"cod\",\"pan\",\"khm\",\"smr\",\"arm\",\"cxr\",\"aut\",\"prk\",\"uga\",\"gum\",\"kgz\",\"ncl\",\"kaz\",\"bvt\",\"gbr\",\"lie\",\"nga\",\"ton\",\"ner\",\"mco\",\"ggy\",\"sgp\",\"bgr\",\"rwa\",\"brn\",\"isr\",\"civ\",\"ltu\",\"imn\",\"slv\",\"bih\",\"fji\",\"vut\",\"svk\",\"cri\",\"blz\",\"gin\",\"nzl\",\"wlf\",\"cze\",\"dom\",\"umi\",\"npl\",\"nor\",\"sur\",\"pol\",\"gib\",\"yem\",\"isl\",\"syr\",\"jey\",\"kna\",\"tjk\",\"fin\",\"reu\",\"bhs\",\"brb\",\"cym\",\"cub\",\"maf\",\"pcn\",\"grd\",\"atf\",\"hrv\",\"gha\",\"uzb\",\"rou\",\"nic\",\"aus\",\"zmb\",\"caf\",\"kir\",\"slb\",\"tls\",\"sau\",\"and\",\"per\",\"pak\",\"ecu\",\"geo\",\"ven\",\"tur\",\"bdi\",\"mdv\",\"sen\",\"mdg\",\"lbr\",\"mnp\",\"kor\",\"irl\",\"fra\",\"dma\",\"sle\",\"dnk\",\"irn\",\"jam\",\"wsm\",\"stp\",\"aze\",\"dji\",\"som\",\"pry\",\"mys\",\"cpv\",\"ata\",\"tha\",\"vct\",\"kwt\",\"mex\",\"alb\",\"usa\",\"ury\",\"nru\",\"sdn\",\"spm\",\"pri\",\"mus\",\"lva\",\"bhr\",\"swe\",\"lux\",\"tun\",\"twn\",\"col\",\"lka\",\"mlt\",\"lbn\",\"myt\",\"cog\",\"mkd\",\"com\",\"nfk\",\"est\",\"ssd\",\"ken\",\"tuv\",\"syc\",\"bwa\",\"hkg\",\"vir\",\"irq\",\"btn\"]",""]

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.

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("country::code::alpha3*");
     $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 => ['country::code::alpha3*'],
         },
         ...
     },
 };
 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 ...

Using on the CLI with validate-with-sah

To validate some data on the CLI, you can use 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 '"country::code::alpha3*"' '"data..."'

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.

Using with Type::Tiny

To create a type constraint and type library from a schema (requires Type::Tiny as well as Type::FromSah):

 package My::Types {
     use Type::Library -base;
     use Type::FromSah qw( sah2type );

     __PACKAGE__->add_type(
         sah2type('country::code::alpha3*', name=>'CountryCodeAlpha3')
     );
 }

 use My::Types qw(CountryCodeAlpha3);
 CountryCodeAlpha3->assert_valid($data);

DESCRIPTION

Accept only current (not retired) codes. Only alpha-3 codes are accepted.

Code will be converted to lowercase.

HOMEPAGE

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

SOURCE

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

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 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=Sah-Schemas-Country

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.

To install Sah::Schemas::Country, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Sah::Schemas::Country

CPAN shell

perl -MCPAN -e shell
install Sah::Schemas::Country

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)