/ 
MooseX-Types-Locale-Country-0.05
River stage one • 1 direct dependent • 2 total dependents
/ MooseX::Types::Locale::Country

NAME

MooseX::Types::Locale::Country - Locale::Country related constraints and coercions for Moose

VERSION

This document describes MooseX::Types::Locale::Country version 0.05.

SYNOPSIS

{
    package Foo;

    use Moose;
    use MooseX::Types::Locale::Country qw(
        CountryCode
        Alpha2Country
        Alpha3Country
        NumericCountry
        CountryName
    );

    has 'code'
        => ( isa => CountryCode,    is => 'rw', coerce => 1 );
    has 'alpha2'
        => ( isa => Alpha2Country,  is => 'rw', coerce => 1 );
    has 'alpha3'
        => ( isa => Alpha3Country,  is => 'rw', coerce => 1 );
    has 'numeric'
        => ( isa => NumericCountry, is => 'rw' ); # you can't coerce
    has 'name'
        => ( isa => CountryName,    is => 'rw', coerce => 1 );

    __PACKAGE__->meta->make_immutable;
}

my $foo = Foo->new(
    code    => 'jp',
    alpha2  => 'jp',
    alpha3  => 'jpn',
    numeric => 392,
    name    => 'JAPAN',
);
print $foo->code;       # 'JP'
print $foo->alpha2;     # 'JP'
print $foo->alpha3;     # 'JPN'
print $foo->numeric;    # 392
print $foo->name;       # 'Japan'

DESCRIPTION

This module packages several Moose::Util::TypeConstraints with coercions, designed to work with the values of Locale::Country.

CONSTRAINTS AND COERCIONS

Alpha2Country

A subtype of Str, which should be defined in country code of ISO 3166-1 alpha-2. If you turned coerce on, Str will be upper-case. For example, 'jp' will convert to 'JP'.

CountryCode

Alias of Alpha2Country.

Alpha3Country

A subtype of Str, which should be defined in country code of ISO 3166-1 alpha-3. If you turned coerce on, Str will be upper-case. For example, 'jpn' will convert to 'JPN'.

NumericCountry

A subtype of Int, which should be defined in country code of ISO 3166-1 numeric.

CountryName

A subtype of Str, which should be defined in ISO 3166-1 country name. If you turned coerce on, Str will be same case as canonical name. For example, 'JAPAN' will convert to 'Japan'.

NOTE

Code conversion is not supported

These coercions is not support code conversion. For example, from Alpha2Country to Alpha3Country.

has country
    => ( is => 'rw', isa => Alpha2Country, coerce => 1 );

...

$foo->country('US');    # does not convert to 'USA'

If you want conversion, could you implement an individual country class with several attributes?

See /examples/complex.pl in the distribution for more details.

The type mapping of MooseX::Getopt

This module provides you the optional type mapping of MooseX::Getopt when MooseX::Getopt was installed.

CountryCode, Alpha2Country, Alpha3Country and CountryName are String ("=s") type.

NumericCountry is Int ("=i") type.

SEE ALSO

INCOMPATIBILITIES

None reported.

TO DO

  • I may add grammatical aliases of constraints/coercions. For example, CountryAsAlpha2 as existent Alpha2Country.

  • I may add namespased types. For example, 'Locale::Country::Alpha2' as export type Alpha2Country.

BUGS AND LIMITATIONS

No bugs have been reported.

Making suggestions and reporting bugs

Please report any found bugs, feature requests, and ideas for improvements to bug-moosex-types-locale-country at rt.cpan.org, or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=MooseX-Types-Locale-Country.

I will be notified, and then you'll automatically be notified of progress on your bugs/requests as I make changes.

When reporting bugs, if possible, please add as small a sample as you can make of the code that produces the bug. And of course, suggestions and patches are welcome.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc MooseX::Types::Locale::Country

You can also look for information at:

RT: CPAN's request tracker

http://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-Types-Locale-Country

AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/MooseX-Types-Locale-Country

Search CPAN

http://search.cpan.org/dist/MooseX-Types-Locale-Country

CPAN Ratings

http://cpanratings.perl.org/dist/MooseX-Types-Locale-Country

VERSION CONTROL

This module is maintained using git. You can get the latest version from git://github.com/gardejo/p5-moosex-types-locale-country.git.

AUTHOR

MORIYA Masaki, alias Gardejo

<moriya at cpan dot org>, http://gardejo.org/

COPYRIGHT AND LICENSE

Copyright (c) 2009-2010 MORIYA Masaki, alias Gardejo

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlgpl and perlartistic.

The full text of the license can be found in the LICENSE file included with this distribution.