NAME
Sah::Schema::country::code::alpha3 - Country code (alpha-3)
VERSION
This document describes version 0.010 of Sah::Schema::country::code::alpha3 (from Perl distribution Sah-SchemaBundle-Country), released on 2024-06-26.
SAH SCHEMA DEFINITION
[
"str",
{
"in" => [
"pri",
"cck",
"mkd",
"ken",
"abw",
"uzb",
"sle",
"mlt",
"irl",
"isl",
"fji",
"syc",
"dji",
"brn",
"jor",
"nzl",
"eth",
"nru",
"cri",
"hrv",
"cym",
"pcn",
"geo",
"alb",
"lbn",
"hmd",
"tza",
"nor",
"cmr",
"sgp",
"gtm",
"swz",
"mli",
"ssd",
"lby",
"ecu",
"plw",
"msr",
"slv",
"mex",
"mnp",
"mac",
"chn",
"bra",
"bgr",
"prt",
"btn",
"fin",
"sjm",
"sur",
"tur",
"aia",
"reu",
"vat",
"col",
"zaf",
"gib",
"mus",
"som",
"che",
"wsm",
"esh",
"jey",
"khm",
"afg",
"spm",
"pol",
"civ",
"wlf",
"bhr",
"npl",
"grd",
"kor",
"mar",
"tls",
"moz",
"kaz",
"ton",
"nfk",
"uga",
"iot",
"hnd",
"aus",
"ven",
"tkl",
"tjk",
"bvt",
"umi",
"blm",
"syr",
"yem",
"pyf",
"nga",
"gnq",
"mmr",
"fro",
"mys",
"isr",
"bel",
"tgo",
"sdn",
"mrt",
"usa",
"dom",
"tha",
"vnm",
"tcd",
"tca",
"flk",
"mtq",
"cog",
"caf",
"per",
"hti",
"kir",
"lca",
"swe",
"cub",
"blr",
"irn",
"pry",
"irq",
"are",
"aze",
"vut",
"vct",
"niu",
"bhs",
"gmb",
"eri",
"nic",
"ago",
"mng",
"cpv",
"ner",
"ata",
"mda",
"sxm",
"brb",
"kwt",
"deu",
"phl",
"mne",
"lso",
"ury",
"shn",
"arg",
"tun",
"blz",
"ggy",
"rus",
"zmb",
"srb",
"dma",
"prk",
"ncl",
"est",
"ala",
"ukr",
"gab",
"lux",
"stp",
"smr",
"gbr",
"guf",
"ind",
"mwi",
"chl",
"bfa",
"nld",
"lbr",
"slb",
"guy",
"lka",
"bwa",
"bmu",
"egy",
"fsm",
"gum",
"svn",
"pak",
"jam",
"bol",
"lao",
"cxr",
"bih",
"bes",
"maf",
"and",
"qat",
"atf",
"ltu",
"zwe",
"png",
"mco",
"com",
"kna",
"gnb",
"imn",
"tuv",
"myt",
"jpn",
"dza",
"pse",
"cyp",
"cod",
"bdi",
"cze",
"mhl",
"kgz",
"fra",
"sen",
"dnk",
"lva",
"glp",
"asm",
"can",
"sgs",
"esp",
"vir",
"tto",
"gha",
"ita",
"pan",
"tkm",
"lie",
"svk",
"nam",
"cok",
"grl",
"idn",
"rou",
"arm",
"mdv",
"omn",
"ben",
"mdg",
"atg",
"sau",
"hkg",
"grc",
"aut",
"hun",
"twn",
"gin",
"rwa",
"bgd",
"cuw",
"vgb",
],
"match" => "\\A[a-z]{3}\\z",
"x.in.summaries" => [
"Puerto Rico",
"Cocos (Keeling) Islands",
"North Macedonia",
"Kenya",
"Aruba",
"Uzbekistan",
"Sierra Leone",
"Malta",
"Ireland",
"Iceland",
"Fiji",
"Seychelles",
"Djibouti",
"Brunei Darussalam",
"Jordan",
"New Zealand",
"Ethiopia",
"Nauru",
"Costa Rica",
"Croatia",
"Cayman Islands",
"Pitcairn",
"Georgia",
"Albania",
"Lebanon",
"Heard Island and McDonald Islands",
"Tanzania, the United Republic of",
"Norway",
"Cameroon",
"Singapore",
"Guatemala",
"Eswatini",
"Mali",
"South Sudan",
"Libya",
"Ecuador",
"Palau",
"Montserrat",
"El Salvador",
"Mexico",
"Northern Mariana Islands",
"Macao",
"China",
"Brazil",
"Bulgaria",
"Portugal",
"Bhutan",
"Finland",
"Svalbard and Jan Mayen",
"Suriname",
"Turkiye",
"Anguilla",
"Reunion",
"Holy See",
"Colombia",
"South Africa",
"Gibraltar",
"Mauritius",
"Somalia",
"Switzerland",
"Samoa",
"Western Sahara",
"Jersey",
"Cambodia",
"Afghanistan",
"Saint Pierre and Miquelon",
"Poland",
"Cote d'Ivoire",
"Wallis and Futuna",
"Bahrain",
"Nepal",
"Grenada",
"Korea, The Republic of",
"Morocco",
"Timor-Leste",
"Mozambique",
"Kazakhstan",
"Tonga",
"Norfolk Island",
"Uganda",
"British Indian Ocean Territory",
"Honduras",
"Australia",
"Venezuela (Bolivarian Republic of)",
"Tokelau",
"Tajikistan",
"Bouvet Island",
"United States Minor Outlying Islands",
"Saint Barthelemy",
"Syrian Arab Republic",
"Yemen",
"French Polynesia",
"Nigeria",
"Equatorial Guinea",
"Myanmar",
"Faroe Islands",
"Malaysia",
"Israel",
"Belgium",
"Togo",
"Sudan",
"Mauritania",
"United States of America",
"Dominican Republic",
"Thailand",
"Viet Nam",
"Chad",
"Turks and Caicos Islands",
"Falkland Islands (The) [Malvinas]",
"Martinique",
"Congo",
"Central African Republic",
"Peru",
"Haiti",
"Kiribati",
"Saint Lucia",
"Sweden",
"Cuba",
"Belarus",
"Iran (Islamic Republic of)",
"Paraguay",
"Iraq",
"United Arab Emirates",
"Azerbaijan",
"Vanuatu",
"Saint Vincent and the Grenadines",
"Niue",
"Bahamas",
"Gambia",
"Eritrea",
"Nicaragua",
"Angola",
"Mongolia",
"Cabo Verde",
"Niger",
"Antarctica",
"Moldova, The Republic of",
"Sint Maarten (Dutch part)",
"Barbados",
"Kuwait",
"Germany",
"Philippines",
"Montenegro",
"Lesotho",
"Uruguay",
"Saint Helena, Ascension and Tristan da Cunha",
"Argentina",
"Tunisia",
"Belize",
"Guernsey",
"Russian Federation",
"Zambia",
"Serbia",
"Dominica",
"Korea, The Democratic People's Republic of",
"New Caledonia",
"Estonia",
"Aland Islands",
"Ukraine",
"Gabon",
"Luxembourg",
"Sao Tome and Principe",
"San Marino",
"United Kingdom of Great Britain and Northern Ireland",
"French Guiana",
"India",
"Malawi",
"Chile",
"Burkina Faso",
"Netherlands (Kingdom of the)",
"Liberia",
"Solomon Islands",
"Guyana",
"Sri Lanka",
"Botswana",
"Bermuda",
"Egypt",
"Micronesia (Federated States of)",
"Guam",
"Slovenia",
"Pakistan",
"Jamaica",
"Bolivia (Plurinational State of)",
"Lao People's Democratic Republic",
"Christmas Island",
"Bosnia and Herzegovina",
"Bonaire, Sint Eustatius and Saba",
"Saint Martin (French part)",
"Andorra",
"Qatar",
"French Southern Territories",
"Lithuania",
"Zimbabwe",
"Papua New Guinea",
"Monaco",
"Comoros",
"Saint Kitts and Nevis",
"Guinea-Bissau",
"Isle of Man",
"Tuvalu",
"Mayotte",
"Japan",
"Algeria",
"Palestine, State of",
"Cyprus",
"Congo (The Democratic Republic of the)",
"Burundi",
"Czechia",
"Marshall Islands",
"Kyrgyzstan",
"France",
"Senegal",
"Denmark",
"Latvia",
"Guadeloupe",
"American Samoa",
"Canada",
"South Georgia and the South Sandwich Islands",
"Spain",
"Virgin Islands (U.S.)",
"Trinidad and Tobago",
"Ghana",
"Italy",
"Panama",
"Turkmenistan",
"Liechtenstein",
"Slovakia",
"Namibia",
"Cook Islands",
"Greenland",
"Indonesia",
"Romania",
"Armenia",
"Maldives",
"Oman",
"Benin",
"Madagascar",
"Antigua and Barbuda",
"Saudi Arabia",
"Hong Kong",
"Greece",
"Austria",
"Hungary",
"Taiwan (Province of China)",
"Guinea",
"Rwanda",
"Bangladesh",
"Curacao",
"Virgin Islands (British)",
],
"x.perl.coerce_rules" => ["From_str::to_lower"],
},
]Base type: str
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" # INVALIDUsing 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 [\"pri\",\"cck\",\"mkd\",\"ken\",\"abw\",\"uzb\",\"sle\",\"mlt\",\"irl\",\"isl\",\"fji\",\"syc\",\"dji\",\"brn\",\"jor\",\"nzl\",\"eth\",\"nru\",\"cri\",\"hrv\",\"cym\",\"pcn\",\"geo\",\"alb\",\"lbn\",\"hmd\",\"tza\",\"nor\",\"cmr\",\"sgp\",\"gtm\",\"swz\",\"mli\",\"ssd\",\"lby\",\"ecu\",\"plw\",\"msr\",\"slv\",\"mex\",\"mnp\",\"mac\",\"chn\",\"bra\",\"bgr\",\"prt\",\"btn\",\"fin\",\"sjm\",\"sur\",\"tur\",\"aia\",\"reu\",\"vat\",\"col\",\"zaf\",\"gib\",\"mus\",\"som\",\"che\",\"wsm\",\"esh\",\"jey\",\"khm\",\"afg\",\"spm\",\"pol\",\"civ\",\"wlf\",\"bhr\",\"npl\",\"grd\",\"kor\",\"mar\",\"tls\",\"moz\",\"kaz\",\"ton\",\"nfk\",\"uga\",\"iot\",\"hnd\",\"aus\",\"ven\",\"tkl\",\"tjk\",\"bvt\",\"umi\",\"blm\",\"syr\",\"yem\",\"pyf\",\"nga\",\"gnq\",\"mmr\",\"fro\",\"mys\",\"isr\",\"bel\",\"tgo\",\"sdn\",\"mrt\",\"usa\",\"dom\",\"tha\",\"vnm\",\"tcd\",\"tca\",\"flk\",\"mtq\",\"cog\",\"caf\",\"per\",\"hti\",\"kir\",\"lca\",\"swe\",\"cub\",\"blr\",\"irn\",\"pry\",\"irq\",\"are\",\"aze\",\"vut\",\"vct\",\"niu\",\"bhs\",\"gmb\",\"eri\",\"nic\",\"ago\",\"mng\",\"cpv\",\"ner\",\"ata\",\"mda\",\"sxm\",\"brb\",\"kwt\",\"deu\",\"phl\",\"mne\",\"lso\",\"ury\",\"shn\",\"arg\",\"tun\",\"blz\",\"ggy\",\"rus\",\"zmb\",\"srb\",\"dma\",\"prk\",\"ncl\",\"est\",\"ala\",\"ukr\",\"gab\",\"lux\",\"stp\",\"smr\",\"gbr\",\"guf\",\"ind\",\"mwi\",\"chl\",\"bfa\",\"nld\",\"lbr\",\"slb\",\"guy\",\"lka\",\"bwa\",\"bmu\",\"egy\",\"fsm\",\"gum\",\"svn\",\"pak\",\"jam\",\"bol\",\"lao\",\"cxr\",\"bih\",\"bes\",\"maf\",\"and\",\"qat\",\"atf\",\"ltu\",\"zwe\",\"png\",\"mco\",\"com\",\"kna\",\"gnb\",\"imn\",\"tuv\",\"myt\",\"jpn\",\"dza\",\"pse\",\"cyp\",\"cod\",\"bdi\",\"cze\",\"mhl\",\"kgz\",\"fra\",\"sen\",\"dnk\",\"lva\",\"glp\",\"asm\",\"can\",\"sgs\",\"esp\",\"vir\",\"tto\",\"gha\",\"ita\",\"pan\",\"tkm\",\"lie\",\"svk\",\"nam\",\"cok\",\"grl\",\"idn\",\"rou\",\"arm\",\"mdv\",\"omn\",\"ben\",\"mdg\",\"atg\",\"sau\",\"hkg\",\"grc\",\"aut\",\"hun\",\"twn\",\"gin\",\"rwa\",\"bgd\",\"cuw\",\"vgb\"]"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 [\"pri\",\"cck\",\"mkd\",\"ken\",\"abw\",\"uzb\",\"sle\",\"mlt\",\"irl\",\"isl\",\"fji\",\"syc\",\"dji\",\"brn\",\"jor\",\"nzl\",\"eth\",\"nru\",\"cri\",\"hrv\",\"cym\",\"pcn\",\"geo\",\"alb\",\"lbn\",\"hmd\",\"tza\",\"nor\",\"cmr\",\"sgp\",\"gtm\",\"swz\",\"mli\",\"ssd\",\"lby\",\"ecu\",\"plw\",\"msr\",\"slv\",\"mex\",\"mnp\",\"mac\",\"chn\",\"bra\",\"bgr\",\"prt\",\"btn\",\"fin\",\"sjm\",\"sur\",\"tur\",\"aia\",\"reu\",\"vat\",\"col\",\"zaf\",\"gib\",\"mus\",\"som\",\"che\",\"wsm\",\"esh\",\"jey\",\"khm\",\"afg\",\"spm\",\"pol\",\"civ\",\"wlf\",\"bhr\",\"npl\",\"grd\",\"kor\",\"mar\",\"tls\",\"moz\",\"kaz\",\"ton\",\"nfk\",\"uga\",\"iot\",\"hnd\",\"aus\",\"ven\",\"tkl\",\"tjk\",\"bvt\",\"umi\",\"blm\",\"syr\",\"yem\",\"pyf\",\"nga\",\"gnq\",\"mmr\",\"fro\",\"mys\",\"isr\",\"bel\",\"tgo\",\"sdn\",\"mrt\",\"usa\",\"dom\",\"tha\",\"vnm\",\"tcd\",\"tca\",\"flk\",\"mtq\",\"cog\",\"caf\",\"per\",\"hti\",\"kir\",\"lca\",\"swe\",\"cub\",\"blr\",\"irn\",\"pry\",\"irq\",\"are\",\"aze\",\"vut\",\"vct\",\"niu\",\"bhs\",\"gmb\",\"eri\",\"nic\",\"ago\",\"mng\",\"cpv\",\"ner\",\"ata\",\"mda\",\"sxm\",\"brb\",\"kwt\",\"deu\",\"phl\",\"mne\",\"lso\",\"ury\",\"shn\",\"arg\",\"tun\",\"blz\",\"ggy\",\"rus\",\"zmb\",\"srb\",\"dma\",\"prk\",\"ncl\",\"est\",\"ala\",\"ukr\",\"gab\",\"lux\",\"stp\",\"smr\",\"gbr\",\"guf\",\"ind\",\"mwi\",\"chl\",\"bfa\",\"nld\",\"lbr\",\"slb\",\"guy\",\"lka\",\"bwa\",\"bmu\",\"egy\",\"fsm\",\"gum\",\"svn\",\"pak\",\"jam\",\"bol\",\"lao\",\"cxr\",\"bih\",\"bes\",\"maf\",\"and\",\"qat\",\"atf\",\"ltu\",\"zwe\",\"png\",\"mco\",\"com\",\"kna\",\"gnb\",\"imn\",\"tuv\",\"myt\",\"jpn\",\"dza\",\"pse\",\"cyp\",\"cod\",\"bdi\",\"cze\",\"mhl\",\"kgz\",\"fra\",\"sen\",\"dnk\",\"lva\",\"glp\",\"asm\",\"can\",\"sgs\",\"esp\",\"vir\",\"tto\",\"gha\",\"ita\",\"pan\",\"tkm\",\"lie\",\"svk\",\"nam\",\"cok\",\"grl\",\"idn\",\"rou\",\"arm\",\"mdv\",\"omn\",\"ben\",\"mdg\",\"atg\",\"sau\",\"hkg\",\"grc\",\"aut\",\"hun\",\"twn\",\"gin\",\"rwa\",\"bgd\",\"cuw\",\"vgb\"]",""]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-SchemaBundle-Country.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-SchemaBundle-Country.
SEE ALSO
Sah::Schema::country::code::alpha2
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 -lIf 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 software is copyright (c) 2024, 2023, 2020, 2019, 2018 by perlancar <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.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-SchemaBundle-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.