jp_prefecture 0.11.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16ea4e0cdab390ac0f2e7ce37db364d1e9d7dbb7c9cb1ccdb80aa9dc0da4e62
-  data.tar.gz: 566e0820a0aef1caa58dc22ef002a72f44f9b96f1457448ea9721c96717cf076
+  metadata.gz: 1e56e5934f4a9edbc985a3981f34158532b196b931e48a87f880dca4e110058a
+  data.tar.gz: 77c5afce644db03f513772371addec79d580aa9871a8c2dd4a69179ff2ddeac2
 SHA512:
-  metadata.gz: 148c89e504aa745015e8eeaed0460be88bc4d23094a98a248d739cb67bceeeaaa5c971cd74d902565b4d8c2c6b636066479c725936e7454b30cb8b0cff81b2f2
-  data.tar.gz: a9408dcea7c0ec9725719c510b594c21d14bf85eb74f57c9dfbc252dda724163133c07dd43aee44df2907f4c01e944d57261fedca489ecb825ff1c9a40edf851
+  metadata.gz: d029ccc7550e3c0196004e14a2ecab7b9a4835497689ca76ad654299359b637f34848822869724d9e55b82de410317e6063a77101b0c664f625a6fa59cba5bcc
+  data.tar.gz: da4f9b9c14d16f3ac00e34daf3cbc9a2cc5a7016851450d8441344c6de12515df14bbde206145bdf004aaff25e4b72dbc910f904ce09481bcfe085ce90e6413d

data/CHANGELOG.md

@@ -1,75 +1,124 @@
 ## Unreleased
 
-## 0.11.0 (Dec 18, 2020)
+## 1.1.0 (2022-03-17)
+
+### Features
+
+* 都道府県情報にローマ字表記を追加 (PR [#57](https://github.com/chocoby/jp_prefecture/pull/57)/[@sondh5](https://github.com/sondh5))
+* Ruby 3.1 をサポートに追加 (PR [#54](https://github.com/chocoby/jp_prefecture/pull/54)/[@chocoby](https://github.com/chocoby))
+* Rails 7.0 をサポート (PR [#55](https://github.com/chocoby/jp_prefecture/pull/55)/[@chocoby](https://github.com/chocoby))
+
+## 1.0.0 (2021-02-24)
+
+### Misc
+
+* 毎週月曜日の 09:00 (JST) にテストを実行する (PR [#52](https://github.com/chocoby/jp_prefecture/pull/52)/[@chocoby](https://github.com/chocoby))
+
+## 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 のメンテナンスポリシーで決められているバージョンは最低限サポートし、実装やテストのメンテナンスが困難になったバージョンからサポートを終了する方針で検討しています。ご意見があればください。
+
+* 文字列による検索は項目を指定して検索する (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` は英語表記など、指定した項目のみを検索するように変更しました。詳しい使い方は README を参照してください。
+  以前のように、すべての項目から検索したい場合は `JpPrefecture::Prefecture.find(all_fields: 'string')` を使用してください。
+
+### 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` メソッドは参照している処理がなくなったため、削除しました。
+
+### 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 (Aug 19, 2019)
+## 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 (Jan 15, 2017)
+## 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 (Mar 30, 2016)
+## 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 (Sep 07, 2014)
+## 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

@@ -0,0 +1,21 @@
+MIT License
+
+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 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

@@ -41,14 +41,16 @@ require 'jp_prefecture'
 都道府県コードを渡すと、都道府県コードから都道府県を検索します:
 
 ```ruby
-pref = JpPrefecture::Prefecture.find 13
-# => #<JpPrefecture::Prefecture:0x007fceb11927d8 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035], @area="関東">
+pref = JpPrefecture::Prefecture.find(13)
+# => #<JpPrefecture::Prefecture:0x00000001126b6558 @area="関東", @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @name_r="Tōkyō", @type="都", @zips=[1000000..2080035]>
 pref.code
 # => 13
 pref.name
 # => "東京都"
 pref.name_e
 # => "Tokyo"
+pref.name_r
+# => "Tōkyō"
 pref.name_h
 # => "とうきょうと"
 pref.name_k
@@ -62,25 +64,44 @@ 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_r: "Tōkyō")
+JpPrefecture::Prefecture.find(name_r: "tōkyō")
+
+# ひらがな表記
+JpPrefecture::Prefecture.find(name_h: "とうきょうと")
+
+# カタカナ表記
+JpPrefecture::Prefecture.find(name_k: "トウキョウト")
+```
+
+マッピングのすべての項目を検索します (推奨しません):
+
+```ruby
+JpPrefecture::Prefecture.find(all_fields: "東京")
 ```
 
 ### 都道府県の一覧を取得
 
 ```ruby
 JpPrefecture::Prefecture.all
-# => [#<JpPrefecture::Prefecture:0x007fceb119a2a8 @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @zips=[10000..70895, 400000..996509], @area="北海道">, ...]
+# => [#<JpPrefecture::Prefecture:0x0000000112555ab0 @area="北海道", @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @name_r="Hokkaidō", @type="道", @zips=[10000..70895, 400000..996509]>, ...]
 ```
 
 ### Rails (ActiveRecord) で使用する
@@ -150,21 +171,33 @@ 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) を参考にしてください。
+マッピングデータのフォーマットについては [prefecture.yml](https://github.com/chocoby/jp_prefecture/blob/main/data/prefecture.yml) を参考にしてください。
+
+### 郵便番号の情報を変更する
+
+```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
+```
+
+データのフォーマットについては [zip.yml](https://github.com/chocoby/jp_prefecture/blob/main/data/zip.yml) を参考にしてください。
 
 
 ## インストール
 
 以下の行を `Gemfile` に記述してから:
 
-```
+```ruby
 gem 'jp_prefecture'
 ```
 
@@ -179,39 +212,18 @@ $ gem install jp_prefecture
 
 ## ドキュメント
 
-[http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
+[http://rdoc.info/github/chocoby/jp_prefecture/main/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/main/frames/index)
 
 ## サポートしているバージョン
 
-* Ruby: 1.9.3 / 2.0 / 2.1 / 2.2 / 2.3 / 2.4 / 2.5 / 2.6 / 2.7
-* Rails: 3.2 / 4.0 / 4.1 / 4.2 / 5.0 / 5.1 / 5.2 / 6.0 / 6.1
+* Ruby: 2.4 - 3.1
+* Rails: 5.0 - 7.0
 
+これより古い Ruby/Rails バージョンを使用する場合は、[`v0.11.0`](https://github.com/chocoby/jp_prefecture/tree/0.x) を利用してください。
 
 ## Contributing
 
-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
-
-
-## テスト
-
-```
-git clone https://github.com/chocoby/jp_prefecture.git
-cd jp_prefecture
-bundle install
-bundle exec rspec
-```
-
-複数バージョンの Active Record でテストを実行:
-
-```
-bundle exec appraisal install
-bundle exec appraisal rspec
-```
-
+[CONTRIBUTING.md](https://github.com/chocoby/jp_prefecture/blob/main/CONTRIBUTING.md) を確認してください。
 
 ## GitHub
 

data/README_EN.md

@@ -38,14 +38,16 @@ require 'jp_prefecture'
 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 = JpPrefecture::Prefecture.find(13)
+# => #<JpPrefecture::Prefecture:0x00000001126b6558 @area="関東", @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @name_r="Tōkyō", @type="都", @zips=[1000000..2080035]>
 pref.code
 # => 13
 pref.name
 # => "東京都"
 pref.name_e
 # => "Tokyo"
+pref.name_r
+# => "Tōkyō"
 pref.name_h
 # => "とうきょうと"
 pref.name_k
@@ -59,25 +61,44 @@ pref.type
 or
 
 ```ruby
-JpPrefecture::Prefecture.find code: 13
+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")
+
+# Romaji
+JpPrefecture::Prefecture.find(name_r: "Tōkyō")
+JpPrefecture::Prefecture.find(name_r: "tōkyō")
+
+# Hiragana
+JpPrefecture::Prefecture.find(name_h: "とうきょうと")
+
+# Katakana
+JpPrefecture::Prefecture.find(name_k: "トウキョウト")
+```
+
+Search all items in the mapping (not recommended).
+
 ```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(all_fields: "東京")
 ```
 
 ### 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="北海道">, ...]
+# => [#<JpPrefecture::Prefecture:0x0000000112555ab0 @area="北海道", @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @name_r="Hokkaidō", @type="道", @zips=[10000..70895, 400000..996509]>, ...]
 ```
 
 ### Usage on Rails (ActiveRecord)
@@ -144,17 +165,31 @@ end
 
 ### Customize Mapping Data
 
-Customize mapping data with `custom_mapping_path`.
+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/main/data/prefecture.yml) for data format.
+
+### Customize Zip Code Data
+
+Customize zip code data with `zip_mapping_data`.
 
 ```ruby
-custom_mapping_path = "..." # /path/to/mapping_data
+custom_zip_mapping_path = "/path/to/zip_mapping_data.yml"
 
 JpPrefecture.setup do |config|
-  config.mapping_data = YAML.load_file custom_mapping_path
+  config.zip_mapping_data = YAML.load_file(custom_zip_mapping_path)
 end
 ```
 
-Check out [prefecture.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/prefecture.yml) for data format.
+Check out [zip.yml](https://github.com/chocoby/jp_prefecture/blob/main/data/zip.yml) for data format.
 
 
 ## Installation
@@ -180,39 +215,18 @@ $ 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)
+[http://rdoc.info/github/chocoby/jp_prefecture/main/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/main/frames/index)
 
-## Supports
+## Supported versions
 
-* Ruby: 1.9.3 / 2.0 / 2.1 / 2.2 / 2.3 / 2.4 / 2.5 / 2.6 / 2.7
-* Rails: 3.2 / 4.0 / 4.1 / 4.2 / 5.0 / 5.1 / 5.2 / 6.0 / 6.1
+* Ruby: 2.4 - 3.1
+* Rails: 5.0 - 7.0
 
+If you are using an older Ruby/Rails version, please use [`v0.11.0`](https://github.com/chocoby/jp_prefecture/tree/0.x).
 
 ## Contributing
 
-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
-
-
-## Test
-
-```
-git clone https://github.com/chocoby/jp_prefecture.git
-cd jp_prefecture
-bundle install
-bundle exec rspec
-```
-
-Run test in multiple `ActiveRecord` versions
-
-```
-bundle exec appraisal install
-bundle exec appraisal rspec
-```
-
+See [CONTRIBUTING.md](https://github.com/chocoby/jp_prefecture/blob/main/CONTRIBUTING.md).
 
 ## GitHub