NAME

Sah::Schema::country::code::alpha2 - Country code (alpha-2)

VERSION

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

SYNOPSIS

Sample data and validation results against this schema

 ""  # INVALID

 "ID"  # valid, becomes "id"

 "IDN"  # INVALID (Only alpha-2 codes are allowed)

 "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::alpha2*");
 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::alpha2", {return_type=>'str_errmsg'});
 my $errmsg = $validator->($data);
 
 # a sample valid data
 $data = "ID";
 my $errmsg = $validator->($data); # => ""
 
 # a sample invalid data
 $data = "xx";
 my $errmsg = $validator->($data); # => "Must be one of [\"hu\",\"tv\",\"ca\",\"pk\",\"by\",\"tf\",\"pn\",\"tm\",\"bl\",\"ie\",\"pm\",\"tn\",\"lt\",\"pf\",\"tk\",\"cg\",\"ls\",\"ga\",\"mg\",\"mq\",\"ph\",\"jp\",\"fr\",\"dm\",\"yt\",\"ax\",\"as\",\"bb\",\"th\",\"sr\",\"kg\",\"dk\",\"us\",\"ma\",\"ee\",\"at\",\"gg\",\"io\",\"gq\",\"ec\",\"lv\",\"jo\",\"qa\",\"ps\",\"bi\",\"sa\",\"pt\",\"mr\",\"vn\",\"tt\",\"lk\",\"ro\",\"id\",\"gr\",\"kr\",\"sg\",\"am\",\"sj\",\"af\",\"um\",\"je\",\"nf\",\"bw\",\"fj\",\"re\",\"cr\",\"mx\",\"na\",\"gs\",\"aq\",\"gt\",\"il\",\"ag\",\"ug\",\"tr\",\"sh\",\"om\",\"ua\",\"mt\",\"pr\",\"rw\",\"ru\",\"be\",\"ng\",\"ms\",\"vg\",\"sn\",\"fm\",\"sk\",\"cx\",\"sm\",\"fk\",\"bo\",\"sv\",\"la\",\"va\",\"kn\",\"zw\",\"ch\",\"mv\",\"lr\",\"gn\",\"mf\",\"mm\",\"bd\",\"mn\",\"bz\",\"gf\",\"gm\",\"mk\",\"km\",\"tj\",\"ar\",\"pa\",\"ss\",\"cn\",\"tg\",\"ck\",\"kh\",\"gh\",\"st\",\"mh\",\"nr\",\"cv\",\"dj\",\"pg\",\"sx\",\"cm\",\"cf\",\"zm\",\"ci\",\"sl\",\"de\",\"rs\",\"sy\",\"ad\",\"uz\",\"az\",\"mu\",\"mw\",\"to\",\"gw\",\"gu\",\"lc\",\"vc\",\"kw\",\"nz\",\"np\",\"nc\",\"ki\",\"in\",\"gi\",\"do\",\"eh\",\"br\",\"sb\",\"pe\",\"im\",\"cu\",\"cw\",\"es\",\"hr\",\"jm\",\"dz\",\"cl\",\"cy\",\"ba\",\"et\",\"si\",\"ae\",\"bg\",\"bq\",\"fi\",\"ne\",\"ye\",\"tc\",\"gb\",\"ao\",\"it\",\"gl\",\"tz\",\"gy\",\"ve\",\"td\",\"bj\",\"ky\",\"is\",\"no\",\"ml\",\"my\",\"bh\",\"ni\",\"lu\",\"vu\",\"cz\",\"er\",\"cd\",\"se\",\"mc\",\"ht\",\"ai\",\"py\",\"au\",\"aw\",\"pl\",\"bn\",\"mz\",\"md\",\"mp\",\"fo\",\"cc\",\"bv\",\"so\",\"kp\",\"ws\",\"li\",\"vi\",\"kz\",\"nu\",\"bf\",\"bm\",\"tl\",\"gp\",\"gd\",\"ir\",\"nl\",\"lb\",\"hm\",\"tw\",\"mo\",\"uy\",\"pw\",\"al\",\"iq\",\"hn\",\"hk\",\"sd\",\"sz\",\"sc\",\"me\",\"wf\",\"bt\",\"bs\",\"ke\",\"za\",\"ge\",\"eg\",\"co\",\"ly\"]"

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::alpha2", {return_type=>'str_errmsg+val'});
 my $res = $validator->($data); # [$errmsg, $validated_val]
 
 # a sample valid data
 $data = "ID";
 my $res = $validator->($data); # => ["","id"]
 
 # a sample invalid data
 $data = "xx";
 my $res = $validator->($data); # => ["Must be one of [\"hu\",\"tv\",\"ca\",\"pk\",\"by\",\"tf\",\"pn\",\"tm\",\"bl\",\"ie\",\"pm\",\"tn\",\"lt\",\"pf\",\"tk\",\"cg\",\"ls\",\"ga\",\"mg\",\"mq\",\"ph\",\"jp\",\"fr\",\"dm\",\"yt\",\"ax\",\"as\",\"bb\",\"th\",\"sr\",\"kg\",\"dk\",\"us\",\"ma\",\"ee\",\"at\",\"gg\",\"io\",\"gq\",\"ec\",\"lv\",\"jo\",\"qa\",\"ps\",\"bi\",\"sa\",\"pt\",\"mr\",\"vn\",\"tt\",\"lk\",\"ro\",\"id\",\"gr\",\"kr\",\"sg\",\"am\",\"sj\",\"af\",\"um\",\"je\",\"nf\",\"bw\",\"fj\",\"re\",\"cr\",\"mx\",\"na\",\"gs\",\"aq\",\"gt\",\"il\",\"ag\",\"ug\",\"tr\",\"sh\",\"om\",\"ua\",\"mt\",\"pr\",\"rw\",\"ru\",\"be\",\"ng\",\"ms\",\"vg\",\"sn\",\"fm\",\"sk\",\"cx\",\"sm\",\"fk\",\"bo\",\"sv\",\"la\",\"va\",\"kn\",\"zw\",\"ch\",\"mv\",\"lr\",\"gn\",\"mf\",\"mm\",\"bd\",\"mn\",\"bz\",\"gf\",\"gm\",\"mk\",\"km\",\"tj\",\"ar\",\"pa\",\"ss\",\"cn\",\"tg\",\"ck\",\"kh\",\"gh\",\"st\",\"mh\",\"nr\",\"cv\",\"dj\",\"pg\",\"sx\",\"cm\",\"cf\",\"zm\",\"ci\",\"sl\",\"de\",\"rs\",\"sy\",\"ad\",\"uz\",\"az\",\"mu\",\"mw\",\"to\",\"gw\",\"gu\",\"lc\",\"vc\",\"kw\",\"nz\",\"np\",\"nc\",\"ki\",\"in\",\"gi\",\"do\",\"eh\",\"br\",\"sb\",\"pe\",\"im\",\"cu\",\"cw\",\"es\",\"hr\",\"jm\",\"dz\",\"cl\",\"cy\",\"ba\",\"et\",\"si\",\"ae\",\"bg\",\"bq\",\"fi\",\"ne\",\"ye\",\"tc\",\"gb\",\"ao\",\"it\",\"gl\",\"tz\",\"gy\",\"ve\",\"td\",\"bj\",\"ky\",\"is\",\"no\",\"ml\",\"my\",\"bh\",\"ni\",\"lu\",\"vu\",\"cz\",\"er\",\"cd\",\"se\",\"mc\",\"ht\",\"ai\",\"py\",\"au\",\"aw\",\"pl\",\"bn\",\"mz\",\"md\",\"mp\",\"fo\",\"cc\",\"bv\",\"so\",\"kp\",\"ws\",\"li\",\"vi\",\"kz\",\"nu\",\"bf\",\"bm\",\"tl\",\"gp\",\"gd\",\"ir\",\"nl\",\"lb\",\"hm\",\"tw\",\"mo\",\"uy\",\"pw\",\"al\",\"iq\",\"hn\",\"hk\",\"sd\",\"sz\",\"sc\",\"me\",\"wf\",\"bt\",\"bs\",\"ke\",\"za\",\"ge\",\"eg\",\"co\",\"ly\"]","xx"]

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::alpha2*");
     $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::alpha2*'],
         },
         ...
     },
 };
 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::alpha2*"' '"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::alpha2*', name=>'CountryCodeAlpha2')
     );
 }

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

DESCRIPTION

Accept only current (not retired) codes. Only alpha-2 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)