0.0
No commit activity in last 3 years
No release in over 3 years
ISO3166-2 JP prefecture codes.\nSee https://www.iso.org/obp/ui/#iso:code:3166:JP
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0
~> 3.0
 Project Readme

ISO 3166:2 JP

TravisCI

Ruby gem of retrieve all 47 code of Japanese prefectures(subdivisions).

Codes are defined at: https://www.iso.org/obp/ui/#iso:code:3166:JP

Installation

Add this line to your application's Gemfile:

gem 'iso_3166_2_jp'

And then execute:

$ bundle

Or install it yourself as:

$ gem install iso_3166_2_jp

Usage

Retrieve all codes

irb(main):001:0> ISO3166_2JP::Subdivision.all
[#<ISO3166_2JP::Subdivision:0x007fa579a4c920
  @code="JP-01",
  @name_en="Hokkaido",
  @name_ja="北海道",
  @numeric=1>,
 #<ISO3166_2JP::Subdivision:0x007fa579a4c5b0
  @code="JP-02",
  @name_en="Aomori",
  @name_ja="青森",
  @numeric=2>,
  ...

Retrieve a subdivision by code

The code format is /\ZJP-\d{2}\z/ (JP-01,JP-02,..,JP-47)

irb(main):001:0> ISO3166_2JP::Subdivision.by_code('JP-13')
#<ISO3166_2JP::Subdivision:0x007fa579a477e0
 @code="JP-13",
 @name_en="Tokyo",
 @name_ja="東京",
 @numeric=13>

Retrieve a subdivision by numeric

The 'numeric' is a numeric contained by a code. For example, the 'numeric' of codeJP-01 is 1.

irb(main):001:0> ISO3166_2JP::Subdivision.by_numeric(13)
=> #<ISO3166_2JP::Subdivision:0x007fa579a477e0
 @code="JP-13",
 @name_en="Tokyo",
 @name_ja="東京",
 @numeric=13>

Retrieve a subdivision by name in Japanese

irb(main):001:0> ISO3166_2JP::Subdivision.by_name_ja('東京')
=> #<ISO3166_2JP::Subdivision:0x007fa579a477e0
 @code="JP-13",
 @name_en="Tokyo",
 @name_ja="東京",
 @numeric=13>

Retrieve a subdivision by name in English

irb(main):001:0> ISO3166_2JP::Subdivision.by_name_en('Tokyo')
#<ISO3166_2JP::Subdivision:0x007fa579a477e0
 @code="JP-13",
 @name_en="Tokyo",
 @name_ja="東京",
 @numeric=13>
 
irb(main):002:0> ISO3166_2JP::Subdivision.by_name_en('tokyo')
#<ISO3166_2JP::Subdivision:0x007fa579a477e0
 @code="JP-13",
 @name_en="Tokyo",
 @name_ja="東京",
 @numeric=13>

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ecpplus/iso_3166_2_jp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.