jp_prefecture 0.8.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a6fc2c7b381afa449625bf8295c9dde2e89025e
-  data.tar.gz: 8860880c91399cf152aed754e2206f48c399ed1e
+SHA256:
+  metadata.gz: 217106ade0af0e82af7aaedf8f8a102b0bc543f990377f67726c7d41eebcd019
+  data.tar.gz: a575cc752f1e40f38f241e88b98d53ce85d95878333aee142ea8882be9834f77
 SHA512:
-  metadata.gz: 2366a6fc0884ef37a5bb2f687d5afeb91397e6c18bc4c62edff017154039a3cf29801026b0b94a81c09cec47dc214612a27f3349b365ebdebd151d07c2b7a90a
-  data.tar.gz: 412f4586f1b44c6c2c13e22da5d906c85459f292849fed471945de8ec704279b0e6474c04be2f3fc422dfaded9f9770be5d3cadafdd772add8a78c6af9b9c88c
+  metadata.gz: babe85ea6e8e46444036676f877b5f584ef66f4723c328267512fc4b34f1819345e2191f11efe903336bf3c27a4fe9f852b86f7faf5519cc24b420c081a9605a
+  data.tar.gz: 62deb95e0a7c18a8b6120e1faf17627aef3021fb1930d8e3e0e09e075f184f7df7d33fa00c59213625a08db656c15e302a307928e8562abf96c58e83db5b4949

data/CHANGELOG.md

@@ -1,55 +1,112 @@
-## 0.8.0 (Sep 07, 2014)
+## Unreleased
+
+## 1.0.0.rc1 (2021-02-10)
+
+### Breaking changes
+
+* Ruby 1.9.3 - 2.3/Rails 3.2 - 4.2 のサポートを終了 (PR [#39](https://github.com/chocoby/jp_prefecture/pull/39)/[@chocoby](https://github.com/chocoby))
+
+  古い Ruby/Rails のサポートを終了しました。今後も大きな不具合が見つかった場合、可能な限りは対応する予定です。
+
+  サポートするバージョンの範囲は Ruby/Rails のメンテナンスポリシーに則るのがシンプルですが、この Gem では厳しくする必要はないと考えています。
+  Ruby/Rails のメンテナンスポリシーで決められているバージョンは最低限サポートし、実装やテストのメンテナンスが困難になったバージョンからサポートを終了する方針で検討しています。ご意見があればください。
+
+### Features
+
+* Ruby 3.0 をサポートに追加 (PR [#42](https://github.com/chocoby/jp_prefecture/pull/42)/[@chocoby](https://github.com/chocoby))
+* 郵便番号データを更新 (PR [#46](https://github.com/chocoby/jp_prefecture/pull/46)/[@chocoby](https://github.com/chocoby))
+* `JpPrefecture::Prefecture` クラスに都道府県コードから都道府県インスタンスを作成する `build_by_code` メソッドを追加 (PR [#44](https://github.com/chocoby/jp_prefecture/pull/44)/[@chocoby](https://github.com/chocoby))
+
+  都道府県コードを指定すると、それに対応した都道府県の `JpPrefecture::Prefecture` インスタンスを取得するメソッドを追加しました。
+  `JpPrefecture::Prefecture.build` メソッドは参照している処理がなくなったため、削除しました。
+
+### Fixes
+
+* 文字列による検索は項目を指定して検索する (Issue [#24](https://github.com/chocoby/jp_prefecture/issues/24), [#27](https://github.com/chocoby/jp_prefecture/issues/27)/PR [#43](https://github.com/chocoby/jp_prefecture/pull/43)/[@chocoby](https://github.com/chocoby))
+
+  `JpPrefecture::Prefecture.find(name: '東')` を実行すると、青森県が取得されていた問題への対応です。これはマッピングのすべての項目を検索していたためです。
+  対応として、`name` を指定した場合は漢字表記、`name_e` は英語表記など、指定した項目のみを検索するように変更しました。
+  すべての項目から検索したい場合は `JpPrefecture::Prefecture.find(all_fields: 'string')` を使用してください。
+
+### Documentation
+
+* CONTRIBUTING.md を追加 (PR [#41](https://github.com/chocoby/jp_prefecture/pull/41)/[@chocoby](https://github.com/chocoby))
+
+### Misc
+
+* RuboCop を導入 (PR [#40](https://github.com/chocoby/jp_prefecture/pull/40)/[@chocoby](https://github.com/chocoby))
+* Gem に含めるファイルを最低限のものにする (PR [#48](https://github.com/chocoby/jp_prefecture/pull/48)/[@chocoby](https://github.com/chocoby))
+
+## 0.11.0 (2020-12-18)
+
+* Rails 6.1 をサポート (PR [#37](https://github.com/chocoby/jp_prefecture/pull/37)/[@chocoby](https://github.com/chocoby))
+* GitHub Actions でビルドを実行するようにした (PR [#34](https://github.com/chocoby/jp_prefecture/pull/34)/[@chocoby](https://github.com/chocoby))
+
+## 0.10.0 (2019-08-19)
+
+* Rails 6.0 をサポート (PR [#33](https://github.com/chocoby/jp_prefecture/pull/33)/[@chocoby](https://github.com/chocoby))
+
+## 0.9.0 (2017-01-15)
+
+* Add English Readme (Issue [#21](https://github.com/chocoby/jp_prefecture/issues/21)/PR [#22](https://github.com/chocoby/jp_prefecture/pull/22)/[@PeterTeng](https://github.com/PeterTeng))
+* 都道府県情報に種類を追加 (PR [#23](https://github.com/chocoby/jp_prefecture/pull/23)/[@gazayas](https://github.com/gazayas))
+
+## 0.8.1 (2016-03-30)
+
+* `JpPrefecture::Prefecture.find(name: name)` に `nil` や空文字を渡した時に `nil` を返す (Issue [#18](https://github.com/chocoby/jp_prefecture/issues/18)/PR [#19](https://github.com/chocoby/jp_prefecture/pull/19)/[@k-motoyan](https://github.com/k-motoyan))
+
+## 0.8.0 (2014-09-07)
 
 * 都道府県情報に八地方区分情報を追加 (PR [#14](https://github.com/chocoby/jp_prefecture/pull/14)/[@kkosuge](https://github.com/kkosuge))
 
-## 0.7.0 (Jun 18, 2014)
+## 0.7.0 (2014-06-18)
 
 * 都道府県名にひらがな、カタカナを追加 (PR [#12](https://github.com/chocoby/jp_prefecture/pull/12)/[@yukihr](https://github.com/yukihr))
 
-## 0.6.0 (Mar 10, 2014)
+## 0.6.0 (2014-03-10)
 
 * 都道府県名を前方一致で検索できるようにした (PR [#11](https://github.com/chocoby/jp_prefecture/pull/11)/[@yuuna](https://github.com/yuuna))
 * 都道府県名の検索ロジックを高速化
 
-## 0.5.0 (Nov 30, 2013)
+## 0.5.0 (2013-11-30)
 
 * 郵便番号から都道府県を検索する機能の追加 (PR [#9](https://github.com/chocoby/jp_prefecture/pull/9)/[@fruwe](https://github.com/fruwe))
 
-## 0.4.0 (Jul 08, 2013)
+## 0.4.0 (2013-07-08)
 
 * 都道府県のマッピングを変更する機能の追加 (PR [#8](https://github.com/chocoby/jp_prefecture/pull/8)/[@mizoR](https://github.com/mizoR))
 
-## 0.3.2 (Jun 12, 2013)
+## 0.3.2 (2013-06-12)
 
 * 文字列を downcase してから都道府県の検索を行うようにした
 
-## 0.3.1 (Jun 11, 2013)
+## 0.3.1 (2013-06-11)
 
 * name で渡した文字列が変更されるバグを修正
 
-## 0.3.0 (Jun 11, 2013)
+## 0.3.0 (2013-06-11)
 
 * 都道府県名(英語表記含む)から都道府県を検索できるようにした
 * 都道府県名からの検索と同様の方法で、都道府県コードを検索できるようにした
 * String 型の都道府県コードに対応
 
-## 0.2.0 (Jun 09, 2013)
+## 0.2.0 (2013-06-09)
 
 * 英語表記を追加
 * Ruby 1.8.7 のサポートを終了
 
-## 0.1.1 (Mar 01, 2013)
+## 0.1.1 (2013-03-01)
 
 * モデルで使用する時に、生成するメソッド名を指定できるようにした
 * Configuration モデル/Model モジュールを廃止
 * extend による使用を廃止
 * Travis CI によるテストを行うようにした
 
-## 0.1.0 (Feb 17, 2013)
+## 0.1.0 (2013-02-17)
 
 * モデルで使用する時に、対象のカラム名を指定するようにした
 
-## 0.0.1 (Feb 14, 2013)
+## 0.0.1 (2013-02-14)
 
 * 都道府県の変換
 * 簡単な Rails サポート

data/LICENSE

@@ -1,22 +1,21 @@
-Copyright (c) 2013 chocoby
-
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2020 Kenta Okamoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,10 @@
 # JpPrefecture
 
-[![Build Status](http://img.shields.io/travis/chocoby/jp_prefecture/master.svg)](https://travis-ci.org/chocoby/jp_prefecture)
-[![Dependency Status](http://img.shields.io/gemnasium/chocoby/jp_prefecture.svg)](https://gemnasium.com/chocoby/jp_prefecture)
-[![Gem Version](http://img.shields.io/gem/v/jp_prefecture.svg)](https://rubygems.org/gems/jp_prefecture)
+[**English**](README_EN.md)
+
+[![Gem Version](http://img.shields.io/gem/v/jp_prefecture.svg?style=flat)](https://rubygems.org/gems/jp_prefecture)
+[![GitHub Actions](https://github.com/chocoby/jp_prefecture/workflows/Build/badge.svg)](https://github.com/chocoby/jp_prefecture)
+[![Coveralls](https://img.shields.io/coveralls/chocoby/jp_prefecture.svg)](https://coveralls.io/r/chocoby/jp_prefecture)
 
 https://rubygems.org/gems/jp_prefecture
 
@@ -25,21 +27,6 @@ JIS X 0402 で定義されている都道府県コードをベースに、
 
 また、Rails のプラグインとして使用することもできます。
 
-## インストール
-
-以下の行を `Gemfile` に記述してから:
-
-```
-gem 'jp_prefecture'
-```
-
-`bundle` を実行してください。
-
-または、手動でインストールしてください:
-
-```
-$ gem install jp_prefecture
-```
 
 ## 使い方
 
@@ -54,7 +41,7 @@ require 'jp_prefecture'
 都道府県コードを渡すと、都道府県コードから都道府県を検索します:
 
 ```ruby
-pref = JpPrefecture::Prefecture.find 13
+pref = JpPrefecture::Prefecture.find(13)
 # => #<JpPrefecture::Prefecture:0x007fceb11927d8 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035], @area="関東">
 pref.code
 # => 13
@@ -68,23 +55,34 @@ pref.name_k
 # => "トウキョウト"
 pref.area
 # => "関東"
+pref.type
+# => "都"
 ```
 
 以下のように書くことも可能です:
 
 ```ruby
-JpPrefecture::Prefecture.find code: 13
+JpPrefecture::Prefecture.find(code: 13)
 ```
 
 ### 都道府県名から都道府県を検索
 
+前方一致で都道府県を検索します:
+
 ```ruby
-JpPrefecture::Prefecture.find name: "東京都"
-JpPrefecture::Prefecture.find name: "Tokyo"
-JpPrefecture::Prefecture.find name: "tokyo"
-JpPrefecture::Prefecture.find name: "トウキョウト"
-JpPrefecture::Prefecture.find name: "とうきょうと"
-JpPrefecture::Prefecture.find name: "東京"
+# 漢字表記
+JpPrefecture::Prefecture.find(name: "東京都")
+JpPrefecture::Prefecture.find(name: "東京")
+
+# 英語表記
+JpPrefecture::Prefecture.find(name_e: "Tokyo")
+JpPrefecture::Prefecture.find(name_e: "tokyo")
+
+# ひらがな表記
+JpPrefecture::Prefecture.find(name_h: "とうきょうと")
+
+# カタカナ表記
+JpPrefecture::Prefecture.find(name_k: "トウキョウト")
 ```
 
 ### 都道府県の一覧を取得
@@ -161,49 +159,60 @@ end
 マッピングデータを指定することができます:
 
 ```ruby
-custom_mapping_path = "..." # /path/to/mapping_data
+custom_mapping_path = "/path/to/mapping_data.yml"
 
 JpPrefecture.setup do |config|
-  config.mapping_data = YAML.load_file custom_mapping_path
+  config.mapping_data = YAML.load_file(custom_mapping_path)
 end
 ```
 
 マッピングデータのフォーマットについては [prefecture.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/prefecture.yml) を参考にしてください。
 
-## ドキュメント
+### 郵便番号の情報を変更する
 
-[http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
+```ruby
+custom_zip_mapping_path = "/path/to/zip_mapping_data.yml"
 
-## TODO
+JpPrefecture.setup do |config|
+  config.zip_mapping_data = YAML.load_file(custom_zip_mapping_path)
+end
+```
 
-GitHub の [Issues](https://github.com/chocoby/jp_prefecture/issues) を参照してください。
+データのフォーマットについては [zip.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/zip.yml) を参考にしてください。
 
-## 対象バージョン
 
-* Ruby: 1.9.3 / 2.0 / 2.1
-* Rails: 3.2 / 4.0 / 4.1
+## インストール
 
-## Contributing
+以下の行を `Gemfile` に記述してから:
+
+```ruby
+gem 'jp_prefecture'
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+`bundle` を実行してください。
 
-## テスト
+または、手動でインストールしてください:
 
 ```
-git clone https://github.com/chocoby/jp_prefecture.git
-cd jp_prefecture
-bundle install --path .bundle
-bundle exec rspec
+$ gem install jp_prefecture
 ```
 
-## GitHub
 
-https://github.com/chocoby/jp_prefecture
+## ドキュメント
+
+[http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
+
+## サポートしているバージョン
+
+* Ruby: 2.4 - 3.0
+* Rails: 5.0 - 6.1
 
-## ライセンス
+これより古い Ruby/Rails バージョンを使用する場合は、[`v0.11.0`](https://github.com/chocoby/jp_prefecture/tree/0.x) を利用してください。
 
-MIT: http://chocoby.mit-license.org/
+## Contributing
+
+[CONTRIBUTING.md](https://github.com/chocoby/jp_prefecture/blob/master/CONTRIBUTING.md) を確認してください。
+
+## GitHub
+
+https://github.com/chocoby/jp_prefecture

data/README_EN.md

@@ -0,0 +1,221 @@
+# JpPrefecture
+
+[**Japanese**](README.md)
+
+[![Gem Version](http://img.shields.io/gem/v/jp_prefecture.svg?style=flat)](https://rubygems.org/gems/jp_prefecture)
+[![GitHub Actions](https://github.com/chocoby/jp_prefecture/workflows/Build/badge.svg)](https://github.com/chocoby/jp_prefecture)
+[![Coveralls](https://img.shields.io/coveralls/chocoby/jp_prefecture.svg)](https://coveralls.io/r/chocoby/jp_prefecture)
+
+https://rubygems.org/gems/jp_prefecture
+
+## Description
+
+Convert prefecture code to prefecture name in Japan.
+
+Based on JIS X 0402. Remove 0 when prefecture code start with 0.
+
+```
+Hokkaido: 01 -> 1
+Tokyo: 13 -> 13
+```
+
+Reference(Japanese): [Wikipedia: 全国地方公共団体コード](http://ja.wikipedia.org/wiki/%E5%85%A8%E5%9B%BD%E5%9C%B0%E6%96%B9%E5%85%AC%E5%85%B1%E5%9B%A3%E4%BD%93%E3%82%B3%E3%83%BC%E3%83%89#.E9.83.BD.E9.81.93.E5.BA.9C.E7.9C.8C.E3.82.B3.E3.83.BC.E3.83.89)
+
+You can change prefecture code and prefecture name's mapping data. Please check this [Customize mapping data](#customize-mapping-data)
+
+Also available as a Rails plugin
+
+## Usage
+
+### Requirement
+
+```ruby
+require 'jp_prefecture'
+```
+
+### Search Prefecture by Code
+
+Provide prefecture code to search prefecture's data
+
+```ruby
+pref = JpPrefecture::Prefecture.find(13)
+# => #<JpPrefecture::Prefecture:0x007fceb11927d8 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035], @area="関東">
+pref.code
+# => 13
+pref.name
+# => "東京都"
+pref.name_e
+# => "Tokyo"
+pref.name_h
+# => "とうきょうと"
+pref.name_k
+# => "トウキョウト"
+pref.area
+# => "関東"
+pref.type
+# => "都"
+```
+
+or
+
+```ruby
+JpPrefecture::Prefecture.find(code: 13)
+```
+
+### Search by Prefecture Name
+
+Search for a prefecture by forward match.
+
+```ruby
+# Kanji
+JpPrefecture::Prefecture.find(name: "東京都")
+JpPrefecture::Prefecture.find(name: "東京")
+
+# English
+JpPrefecture::Prefecture.find(name_e: "Tokyo")
+JpPrefecture::Prefecture.find(name_e: "tokyo")
+
+# Hiragana
+JpPrefecture::Prefecture.find(name_h: "とうきょうと")
+
+# Kakatana
+JpPrefecture::Prefecture.find(name_k: "トウキョウト")
+```
+
+### All Prefectures
+
+```ruby
+JpPrefecture::Prefecture.all
+# => [#<JpPrefecture::Prefecture:0x007fceb119a2a8 @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @zips=[10000..70895, 400000..996509], @area="北海道">, ...]
+```
+
+### Usage on Rails (ActiveRecord)
+
+Include JpPrefecture to Model which `ActiveRecord::Base` inherited.
+
+app/models/place.rb:
+
+```ruby
+class Place < ActiveRecord::Base
+  # prefecture_code:integer
+
+  include JpPrefecture
+  jp_prefecture :prefecture_code
+end
+```
+
+By JpPrefecture included, `prefecture` method will be generated:
+
+```ruby
+place = Place.new
+place.prefecture_code = 13
+place.prefecture.name_e
+# => "Tokyo"
+```
+
+Customize `prefecture` method name with `method_name` option:
+
+```ruby
+# model
+jp_prefecture :prefecture_code, method_name: :pref
+
+place = Place.new
+place.prefecture_code = 13
+place.pref.name_e
+# => "Tokyo"
+```
+
+### Template usage
+
+Use `collection_select` to generate selector in view:
+
+```ruby
+# Selector prefecture name in English
+f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name_e
+
+# Selector prefecture name in Japanese
+f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name
+```
+
+### Migration
+
+Set `prefecture_code` column type to `integer` or `string`.
+
+Example:
+
+```ruby
+class AddPrefectureCodeToPlaces < ActiveRecord::Migration
+  def change
+    add_column :places, :prefecture_code, :integer
+  end
+end
+```
+
+### Customize Mapping Data
+
+Customize mapping data with `mapping_data`.
+
+```ruby
+custom_mapping_path = "/path/to/mapping_data.yml"
+
+JpPrefecture.setup do |config|
+  config.mapping_data = YAML.load_file(custom_mapping_path)
+end
+```
+
+Check out [prefecture.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/prefecture.yml) for data format.
+
+### Customize Zip Code Data
+
+Customize zip code data with `zip_mapping_data`.
+
+```ruby
+custom_zip_mapping_path = "/path/to/zip_mapping_data.yml"
+
+JpPrefecture.setup do |config|
+  config.zip_mapping_data = YAML.load_file(custom_zip_mapping_path)
+end
+```
+
+Check out [zip.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/zip.yml) for data format.
+
+
+## Installation
+
+Add this line in Gemfile.
+
+```ruby
+gem 'jp_prefecture'
+```
+
+Run
+
+```
+$ bundle
+```
+
+Or install gem with `gem install`
+
+```
+$ gem install jp_prefecture
+```
+
+
+## Documentation
+
+[http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
+
+## Supported versions
+
+* Ruby: 2.4 - 3.0
+* Rails: 5.0 - 6.1
+
+If you are using an older Ruby/Rails version, please use [`v0.11.0`](https://github.com/chocoby/jp_prefecture/tree/0.x).
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/chocoby/jp_prefecture/blob/master/CONTRIBUTING.md).
+
+## GitHub
+
+https://github.com/chocoby/jp_prefecture