NAME
Sah::Schema::country::code::alpha2 - Country code (alpha-2)
VERSION
This document describes version 0.010 of Sah::Schema::country::code::alpha2 (from Perl distribution Sah-SchemaBundle-Country), released on 2024-06-26.
SAH SCHEMA DEFINITION
["str",{"in"=> ["et","pg","au","je","vg","hn","bo","bj","kh","bm","bt","fi","to","so","ng","ws","lt","cv","sj","sm","tt","gb","cg","tm","ax","st","my","tj","hr","ai","bd","gs","pk","gn","ba","cw","cf","gq","bl","ve","mh","ye","nf","pe","ki","ie","qa","mu","mc","sd","mx","sa","td","ro","sl","ne","ug","pf","ky","ck","la","gr","tl","pw","bn","ae","lr","ga","mg","gd","cy","bs","vi","ht","es","sz","sr","zm","tz","bq","tr","gl","ke","hm","mv","sn","af","aw","ss","tn","er","ci","br","bz","ni","ls","kw","py","kg","dk","za","lb","fk","uy","mk","ph","gt","vu","vc","de","cx","ag","me","gm","sb","ch","cu","cc","rs","nc","nu","mw","mf","gp","bb","mz","mr","fr","tv","co","dz","sv","ua","no","cm","sg","re","lv","tg","gu","pm","yt","im","gh","pt","bv","np","eg","it","mq","bg","rw","mn","ms","io","cd","kr","kz","gy","se","bf","nl","lk","ca","bw","um","tk","na","cl","jp","sk","az","ar","il","tw","hu","pl","gi","jo","tf","as","be","om","va","ee","kn","id","aq","pa","jm","gf","mp","pr","cn","gw","ir","si","by","ru","li","ge","mm","fj","fm","nr","nz","ad","dm","bi","iq","mt","dj","sy","pn","cz","cr","in","do","mo","al","ly","vn","ps","is","fo","sh","tc","kp","sc","us","th","zw","lc","lu","bh","ml","ao","km","wf","ec","uz","sx","hk","at","md","eh","gg","am","ma",],"match"=>"\\A[a-z]{2}\\z","x.in.summaries"=> ["Ethiopia","Papua New Guinea","Australia","Jersey","Virgin Islands (British)","Honduras","Bolivia (Plurinational State of)","Benin","Cambodia","Bermuda","Bhutan","Finland","Tonga","Somalia","Nigeria","Samoa","Lithuania","Cabo Verde","Svalbard and Jan Mayen","San Marino","Trinidad and Tobago","United Kingdom of Great Britain and Northern Ireland","Congo","Turkmenistan","Aland Islands","Sao Tome and Principe","Malaysia","Tajikistan","Croatia","Anguilla","Bangladesh","South Georgia and the South Sandwich Islands","Pakistan","Guinea","Bosnia and Herzegovina","Curacao","Central African Republic","Equatorial Guinea","Saint Barthelemy","Venezuela (Bolivarian Republic of)","Marshall Islands","Yemen","Norfolk Island","Peru","Kiribati","Ireland","Qatar","Mauritius","Monaco","Sudan","Mexico","Saudi Arabia","Chad","Romania","Sierra Leone","Niger","Uganda","French Polynesia","Cayman Islands","Cook Islands","Lao People's Democratic Republic","Greece","Timor-Leste","Palau","Brunei Darussalam","United Arab Emirates","Liberia","Gabon","Madagascar","Grenada","Cyprus","Bahamas","Virgin Islands (U.S.)","Haiti","Spain","Eswatini","Suriname","Zambia","Tanzania, the United Republic of","Bonaire, Sint Eustatius and Saba","Turkiye","Greenland","Kenya","Heard Island and McDonald Islands","Maldives","Senegal","Afghanistan","Aruba","South Sudan","Tunisia","Eritrea","Cote d'Ivoire","Brazil","Belize","Nicaragua","Lesotho","Kuwait","Paraguay","Kyrgyzstan","Denmark","South Africa","Lebanon","Falkland Islands (The) [Malvinas]","Uruguay","North Macedonia","Philippines","Guatemala","Vanuatu","Saint Vincent and the Grenadines","Germany","Christmas Island","Antigua and Barbuda","Montenegro","Gambia","Solomon Islands","Switzerland","Cuba","Cocos (Keeling) Islands","Serbia","New Caledonia","Niue","Malawi","Saint Martin (French part)","Guadeloupe","Barbados","Mozambique","Mauritania","France","Tuvalu","Colombia","Algeria","El Salvador","Ukraine","Norway","Cameroon","Singapore","Reunion","Latvia","Togo","Guam","Saint Pierre and Miquelon","Mayotte","Isle of Man","Ghana","Portugal","Bouvet Island","Nepal","Egypt","Italy","Martinique","Bulgaria","Rwanda","Mongolia","Montserrat","British Indian Ocean Territory","Congo (The Democratic Republic of the)","Korea, The Republic of","Kazakhstan","Guyana","Sweden","Burkina Faso","Netherlands (Kingdom of the)","Sri Lanka","Canada","Botswana","United States Minor Outlying Islands","Tokelau","Namibia","Chile","Japan","Slovakia","Azerbaijan","Argentina","Israel","Taiwan (Province of China)","Hungary","Poland","Gibraltar","Jordan","French Southern Territories","American Samoa","Belgium","Oman","Holy See","Estonia","Saint Kitts and Nevis","Indonesia","Antarctica","Panama","Jamaica","French Guiana","Northern Mariana Islands","Puerto Rico","China","Guinea-Bissau","Iran (Islamic Republic of)","Slovenia","Belarus","Russian Federation","Liechtenstein","Georgia","Myanmar","Fiji","Micronesia (Federated States of)","Nauru","New Zealand","Andorra","Dominica","Burundi","Iraq","Malta","Djibouti","Syrian Arab Republic","Pitcairn","Czechia","Costa Rica","India","Dominican Republic","Macao","Albania","Libya","Viet Nam","Palestine, State of","Iceland","Faroe Islands","Saint Helena, Ascension and Tristan da Cunha","Turks and Caicos Islands","Korea, The Democratic People's Republic of","Seychelles","United States of America","Thailand","Zimbabwe","Saint Lucia","Luxembourg","Bahrain","Mali","Angola","Comoros","Wallis and Futuna","Ecuador","Uzbekistan","Sint Maarten (Dutch part)","Hong Kong","Austria","Moldova, The Republic of","Western Sahara","Guernsey","Armenia","Morocco",],"x.perl.coerce_rules"=> ["From_str::to_lower"],},]
Base type: str
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):
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="xxx";my$errmsg=$validator->($data);# => "Must be one of [\"et\",\"pg\",\"au\",\"je\",\"vg\",\"hn\",\"bo\",\"bj\",\"kh\",\"bm\",\"bt\",\"fi\",\"to\",\"so\",\"ng\",\"ws\",\"lt\",\"cv\",\"sj\",\"sm\",\"tt\",\"gb\",\"cg\",\"tm\",\"ax\",\"st\",\"my\",\"tj\",\"hr\",\"ai\",\"bd\",\"gs\",\"pk\",\"gn\",\"ba\",\"cw\",\"cf\",\"gq\",\"bl\",\"ve\",\"mh\",\"ye\",\"nf\",\"pe\",\"ki\",\"ie\",\"qa\",\"mu\",\"mc\",\"sd\",\"mx\",\"sa\",\"td\",\"ro\",\"sl\",\"ne\",\"ug\",\"pf\",\"ky\",\"ck\",\"la\",\"gr\",\"tl\",\"pw\",\"bn\",\"ae\",\"lr\",\"ga\",\"mg\",\"gd\",\"cy\",\"bs\",\"vi\",\"ht\",\"es\",\"sz\",\"sr\",\"zm\",\"tz\",\"bq\",\"tr\",\"gl\",\"ke\",\"hm\",\"mv\",\"sn\",\"af\",\"aw\",\"ss\",\"tn\",\"er\",\"ci\",\"br\",\"bz\",\"ni\",\"ls\",\"kw\",\"py\",\"kg\",\"dk\",\"za\",\"lb\",\"fk\",\"uy\",\"mk\",\"ph\",\"gt\",\"vu\",\"vc\",\"de\",\"cx\",\"ag\",\"me\",\"gm\",\"sb\",\"ch\",\"cu\",\"cc\",\"rs\",\"nc\",\"nu\",\"mw\",\"mf\",\"gp\",\"bb\",\"mz\",\"mr\",\"fr\",\"tv\",\"co\",\"dz\",\"sv\",\"ua\",\"no\",\"cm\",\"sg\",\"re\",\"lv\",\"tg\",\"gu\",\"pm\",\"yt\",\"im\",\"gh\",\"pt\",\"bv\",\"np\",\"eg\",\"it\",\"mq\",\"bg\",\"rw\",\"mn\",\"ms\",\"io\",\"cd\",\"kr\",\"kz\",\"gy\",\"se\",\"bf\",\"nl\",\"lk\",\"ca\",\"bw\",\"um\",\"tk\",\"na\",\"cl\",\"jp\",\"sk\",\"az\",\"ar\",\"il\",\"tw\",\"hu\",\"pl\",\"gi\",\"jo\",\"tf\",\"as\",\"be\",\"om\",\"va\",\"ee\",\"kn\",\"id\",\"aq\",\"pa\",\"jm\",\"gf\",\"mp\",\"pr\",\"cn\",\"gw\",\"ir\",\"si\",\"by\",\"ru\",\"li\",\"ge\",\"mm\",\"fj\",\"fm\",\"nr\",\"nz\",\"ad\",\"dm\",\"bi\",\"iq\",\"mt\",\"dj\",\"sy\",\"pn\",\"cz\",\"cr\",\"in\",\"do\",\"mo\",\"al\",\"ly\",\"vn\",\"ps\",\"is\",\"fo\",\"sh\",\"tc\",\"kp\",\"sc\",\"us\",\"th\",\"zw\",\"lc\",\"lu\",\"bh\",\"ml\",\"ao\",\"km\",\"wf\",\"ec\",\"uz\",\"sx\",\"hk\",\"at\",\"md\",\"eh\",\"gg\",\"am\",\"ma\"]"
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="xxx";my$res=$validator->($data);# => ["Must be one of [\"et\",\"pg\",\"au\",\"je\",\"vg\",\"hn\",\"bo\",\"bj\",\"kh\",\"bm\",\"bt\",\"fi\",\"to\",\"so\",\"ng\",\"ws\",\"lt\",\"cv\",\"sj\",\"sm\",\"tt\",\"gb\",\"cg\",\"tm\",\"ax\",\"st\",\"my\",\"tj\",\"hr\",\"ai\",\"bd\",\"gs\",\"pk\",\"gn\",\"ba\",\"cw\",\"cf\",\"gq\",\"bl\",\"ve\",\"mh\",\"ye\",\"nf\",\"pe\",\"ki\",\"ie\",\"qa\",\"mu\",\"mc\",\"sd\",\"mx\",\"sa\",\"td\",\"ro\",\"sl\",\"ne\",\"ug\",\"pf\",\"ky\",\"ck\",\"la\",\"gr\",\"tl\",\"pw\",\"bn\",\"ae\",\"lr\",\"ga\",\"mg\",\"gd\",\"cy\",\"bs\",\"vi\",\"ht\",\"es\",\"sz\",\"sr\",\"zm\",\"tz\",\"bq\",\"tr\",\"gl\",\"ke\",\"hm\",\"mv\",\"sn\",\"af\",\"aw\",\"ss\",\"tn\",\"er\",\"ci\",\"br\",\"bz\",\"ni\",\"ls\",\"kw\",\"py\",\"kg\",\"dk\",\"za\",\"lb\",\"fk\",\"uy\",\"mk\",\"ph\",\"gt\",\"vu\",\"vc\",\"de\",\"cx\",\"ag\",\"me\",\"gm\",\"sb\",\"ch\",\"cu\",\"cc\",\"rs\",\"nc\",\"nu\",\"mw\",\"mf\",\"gp\",\"bb\",\"mz\",\"mr\",\"fr\",\"tv\",\"co\",\"dz\",\"sv\",\"ua\",\"no\",\"cm\",\"sg\",\"re\",\"lv\",\"tg\",\"gu\",\"pm\",\"yt\",\"im\",\"gh\",\"pt\",\"bv\",\"np\",\"eg\",\"it\",\"mq\",\"bg\",\"rw\",\"mn\",\"ms\",\"io\",\"cd\",\"kr\",\"kz\",\"gy\",\"se\",\"bf\",\"nl\",\"lk\",\"ca\",\"bw\",\"um\",\"tk\",\"na\",\"cl\",\"jp\",\"sk\",\"az\",\"ar\",\"il\",\"tw\",\"hu\",\"pl\",\"gi\",\"jo\",\"tf\",\"as\",\"be\",\"om\",\"va\",\"ee\",\"kn\",\"id\",\"aq\",\"pa\",\"jm\",\"gf\",\"mp\",\"pr\",\"cn\",\"gw\",\"ir\",\"si\",\"by\",\"ru\",\"li\",\"ge\",\"mm\",\"fj\",\"fm\",\"nr\",\"nz\",\"ad\",\"dm\",\"bi\",\"iq\",\"mt\",\"dj\",\"sy\",\"pn\",\"cz\",\"cr\",\"in\",\"do\",\"mo\",\"al\",\"ly\",\"vn\",\"ps\",\"is\",\"fo\",\"sh\",\"tc\",\"kp\",\"sc\",\"us\",\"th\",\"zw\",\"lc\",\"lu\",\"bh\",\"ml\",\"ao\",\"km\",\"wf\",\"ec\",\"uz\",\"sx\",\"hk\",\"at\",\"md\",\"eh\",\"gg\",\"am\",\"ma\"]","xxx"]
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):
submyfunc {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.pmpackageMyApp;our%SPEC;$SPEC{myfunc} = {v=> 1.1,summary=>'Routine to do blah ...',args=> {arg1=> {summary=>'The blah blah argument',schema=> ['country::code::alpha2*'],},...},};submyfunc {my%args=@_;...}1;# in myapp.plpackagemain;Perinci::CmdLine::Any->new(url=>'/MyApp/myfunc')->run;# in command-line% ./myapp.pl --helpmyapp - Routine todoblah ......% ./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):
packageMy::Types {__PACKAGE__->add_type(sah2type('country::code::alpha2*',name=>'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-SchemaBundle-Country.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-SchemaBundle-Country.
SEE ALSO
Sah::Schema::country::code::alpha3
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 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.