https://github.com/yuzurus/jp_jis_code
全国地方公共団体コードから住所を取得するgem
https://github.com/yuzurus/jp_jis_code
address-code gem jis-code ruby
Last synced: about 1 year ago
JSON representation
全国地方公共団体コードから住所を取得するgem
- Host: GitHub
- URL: https://github.com/yuzurus/jp_jis_code
- Owner: YuzuruS
- License: mit
- Created: 2018-02-01T11:54:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T08:36:50.000Z (about 8 years ago)
- Last Synced: 2025-04-11T04:43:01.373Z (about 1 year ago)
- Topics: address-code, gem, jis-code, ruby
- Language: Ruby
- Size: 110 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# JpJisCode
[](https://badge.fury.io/rb/jp_jis_code)
[](https://travis-ci.org/YuzuruS/jp_jis_code)
[](https://codeclimate.com/github/YuzuruS/jp_jis_code/maintainability)
[](https://coveralls.io/github/YuzuruS/jp_jis_code)
[](https://beta.gemnasium.com/projects/github.com/YuzuruS/jp_jis_code)
全国地方公共団体コード(JIS地名コード、地方自治体コード、都道府県コード、市町村コードなどと呼ばれることもある。)から都道府県、市区町村を取得するライブラリです。
参考: [全国地方公共団体コード](https://ja.wikipedia.org/wiki/全国地方公共団体コード)
## インストール方法
Gemfileに下記の行を追加してください。
```ruby
gem 'jp_jis_code'
```
それから下記を実行してください。
$ bundle
もしくは下記のようなコマンドでもインストールできます。
$ gem install jp_jis_code
## 使用方法
市区町村コードには5桁のものと6桁のものがありますが、
両方対応しています。
```ruby
code = JpJisCode::Code.find('011002')
code.prefecture_name
# => '北海道'
code.prefecture_name_h
# => 'ほっかいどう'
code.city_name
# => '札幌市'
code.city_name_h
# => 'さっぽろし'
code = JpJisCode::Code.find('01100')
code.prefecture_name
# => '北海道'
code.prefecture_name_h
# => 'ほっかいどう'
code.city_name
# => '札幌市'
code.city_name_h
# => 'さっぽろし'
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/YuzuruS/jp_jis_code. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the JpJisCode project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/YuzuruS/jp_jis_code/blob/master/CODE_OF_CONDUCT.md).