jp_prefecture 0.7.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f8b93831e7f498063dae032c81111f89148be1ca
-  data.tar.gz: 79d7d9f7578665c10f9bd3ad1b181dee94bcfd1b
+SHA256:
+  metadata.gz: c16ea4e0cdab390ac0f2e7ce37db364d1e9d7dbb7c9cb1ccdb80aa9dc0da4e62
+  data.tar.gz: 566e0820a0aef1caa58dc22ef002a72f44f9b96f1457448ea9721c96717cf076
 SHA512:
-  metadata.gz: a69bc4f6d25791bc2495b1d1d8523c5fa6de4ac3b072cca48f4e978f3462c900b4e41e0578b4a912ae41a2519db6c983c904b2f6254ca40fbcd036a8943a660d
-  data.tar.gz: 78fcf9930d2547d8aa73180e71ace4015f268a3f59baf92f14c910b8b283d8a757cddd2ef93461e2b28402affb10ea4fa79e2f19a438473aaca84b9ed356bf99
+  metadata.gz: 148c89e504aa745015e8eeaed0460be88bc4d23094a98a248d739cb67bceeeaaa5c971cd74d902565b4d8c2c6b636066479c725936e7454b30cb8b0cff81b2f2
+  data.tar.gz: a9408dcea7c0ec9725719c510b594c21d14bf85eb74f57c9dfbc252dda724163133c07dd43aee44df2907f4c01e944d57261fedca489ecb825ff1c9a40edf851

data/.github/workflows/build.yml

@@ -0,0 +1,78 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  matrix:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        gemfile:
+          - rails42.gemfile
+          - rails50.gemfile
+          - rails51.gemfile
+          - rails52.gemfile
+          - rails60.gemfile
+          - rails61.gemfile
+        exclude:
+          - ruby: 2.4
+            gemfile: rails60.gemfile
+          - ruby: 2.4
+            gemfile: rails61.gemfile
+          - ruby: 2.5
+            gemfile: rails60.gemfile
+          - ruby: 2.5
+            gemfile: rails61.gemfile
+          - ruby: 2.7
+            gemfile: rails42.gemfile
+
+    env:
+      CI: true
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup System
+        run: |
+          sudo apt-get update
+          sudo apt-get install libsqlite3-dev
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Build
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Test
+        run: |
+          bundle exec rspec
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel: true
+          path-to-lcov: ./coverage/lcov.info
+
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.ruby-version
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,3 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 Guardfile
+gemfiles/*.lock

data/.rspec

@@ -1,2 +1,2 @@
---colour
+--color
 --format documentation

data/Appraisals

@@ -0,0 +1,46 @@
+appraise 'rails32' do
+  gem 'activerecord', '~> 3.2.0'
+  gem 'sqlite3', '< 1.4'
+end
+
+appraise 'rails40' do
+  gem 'activerecord', '~> 4.0.0'
+  gem 'sqlite3', '< 1.4'
+end
+
+appraise 'rails41' do
+  gem 'activerecord', '~> 4.1.0'
+  gem 'sqlite3', '< 1.4'
+end
+
+appraise 'rails42' do
+  gem 'activerecord', '~> 4.2.0'
+  gem 'sqlite3', '< 1.4'
+end
+
+if RUBY_VERSION >= '2.2.2'
+  appraise 'rails50' do
+    gem 'activerecord', '~> 5.0.0'
+    gem 'sqlite3', '< 1.4'
+  end
+
+  appraise 'rails51' do
+    gem 'activerecord', '~> 5.1.0'
+    gem 'sqlite3', '< 1.4'
+  end
+
+  appraise 'rails52' do
+    gem 'activerecord', '~> 5.2.0'
+    gem 'sqlite3', '< 1.4'
+  end
+end
+
+if RUBY_VERSION >= '2.6.0'
+  appraise 'rails60' do
+    gem 'activerecord', '~> 6.0.0'
+  end
+
+  appraise 'rails61' do
+    gem 'activerecord', '~> 6.1.0'
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## Unreleased
+
+## 0.11.0 (Dec 18, 2020)
+
+* 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)
+
+* Rails 6.0 をサポート (PR [#33](https://github.com/chocoby/jp_prefecture/pull/33)/[@chocoby](https://github.com/chocoby))
+
+## 0.9.0 (Jan 15, 2017)
+
+* 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)
+
+* `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)
+
+* 都道府県情報に八地方区分情報を追加 (PR [#14](https://github.com/chocoby/jp_prefecture/pull/14)/[@kkosuge](https://github.com/kkosuge))
+
 ## 0.7.0 (Jun 18, 2014)
 
 * 都道府県名にひらがな、カタカナを追加 (PR [#12](https://github.com/chocoby/jp_prefecture/pull/12)/[@yukihr](https://github.com/yukihr))

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
-```
 
 ## 使い方
 
@@ -51,11 +38,11 @@ require 'jp_prefecture'
 
 ### 都道府県コードから都道府県を検索
 
-単純に都道府県コードを渡すと、都道府県コードから都道府県を検索します:
+都道府県コードを渡すと、都道府県コードから都道府県を検索します:
 
 ```ruby
 pref = JpPrefecture::Prefecture.find 13
-# => #<JpPrefecture::Prefecture:0x007fd3c1838208 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
+# => #<JpPrefecture::Prefecture:0x007fceb11927d8 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035], @area="関東">
 pref.code
 # => 13
 pref.name
@@ -66,9 +53,13 @@ pref.name_h
 # => "とうきょうと"
 pref.name_k
 # => "トウキョウト"
+pref.area
+# => "関東"
+pref.type
+# => "都"
 ```
 
-以下のように渡すことも可能です:
+以下のように書くことも可能です:
 
 ```ruby
 JpPrefecture::Prefecture.find code: 13
@@ -78,32 +69,21 @@ JpPrefecture::Prefecture.find code: 13
 
 ```ruby
 JpPrefecture::Prefecture.find name: "東京都"
-# => #<JpPrefecture::Prefecture:0x007fe7bb033040 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
-
 JpPrefecture::Prefecture.find name: "Tokyo"
-# => #<JpPrefecture::Prefecture:0x007fe7bb032758 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
-
 JpPrefecture::Prefecture.find name: "tokyo"
-# => #<JpPrefecture::Prefecture:0x007fe7bb031e70 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
-
 JpPrefecture::Prefecture.find name: "トウキョウト"
-# => #<JpPrefecture::Prefecture:0x007f8cc2038210 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
-
 JpPrefecture::Prefecture.find name: "とうきょうと"
-# => #<JpPrefecture::Prefecture:0x007f8cc2033760 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
-
 JpPrefecture::Prefecture.find name: "東京"
-# => #<JpPrefecture::Prefecture:0x007fe7bb0305c0 @code=13, @name="東京都", @name_e="Tokyo", @name_h="とうきょうと", @name_k="トウキョウト", @zips=[1000000..2080035]>
 ```
 
 ### 都道府県の一覧を取得
 
 ```ruby
 JpPrefecture::Prefecture.all
-# => [#<JpPrefecture::Prefecture:0x007fea13830158 @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @zips=[10000..70895, 400000..996509]>, ...]
+# => [#<JpPrefecture::Prefecture:0x007fceb119a2a8 @code=1, @name="北海道", @name_e="Hokkaido", @name_h="ほっかいどう", @name_k="ホッカイドウ", @zips=[10000..70895, 400000..996509], @area="北海道">, ...]
 ```
 
-### Rails(ActiveRecord) で使用する
+### Rails (ActiveRecord) で使用する
 
 `ActiveRecord::Base` を継承した Model で、都道府県コードを扱うことができます。
 
@@ -179,18 +159,33 @@ end
 
 マッピングデータのフォーマットについては [prefecture.yml](https://github.com/chocoby/jp_prefecture/blob/master/data/prefecture.yml) を参考にしてください。
 
+
+## インストール
+
+以下の行を `Gemfile` に記述してから:
+
+```
+gem 'jp_prefecture'
+```
+
+`bundle` を実行してください。
+
+または、手動でインストールしてください:
+
+```
+$ gem install jp_prefecture
+```
+
+
 ## ドキュメント
 
 [http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
 
-## TODO
+## サポートしているバージョン
 
-GitHub の [Issues](https://github.com/chocoby/jp_prefecture/issues) を参照してください。
+* 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: 1.9.3 / 2.0 / 2.1
-* Rails: 3.2 / 4.0 / 4.1
 
 ## Contributing
 
@@ -200,10 +195,24 @@ GitHub の [Issues](https://github.com/chocoby/jp_prefecture/issues) を参照
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## GitHub
 
-https://github.com/chocoby/jp_prefecture
+## テスト
 
-## ライセンス
+```
+git clone https://github.com/chocoby/jp_prefecture.git
+cd jp_prefecture
+bundle install
+bundle exec rspec
+```
+
+複数バージョンの Active Record でテストを実行:
 
-MIT: http://chocoby.mit-license.org/
+```
+bundle exec appraisal install
+bundle exec appraisal rspec
+```
+
+
+## GitHub
+
+https://github.com/chocoby/jp_prefecture

data/README_EN.md

@@ -0,0 +1,219 @@
+# 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
+
+```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: "東京"
+```
+
+### 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 `custom_mapping_path`.
+
+```ruby
+custom_mapping_path = "..." # /path/to/mapping_data
+
+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.
+
+
+## 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)
+
+## Supports
+
+* 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
+
+
+## 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
+```
+
+
+## GitHub
+
+https://github.com/chocoby/jp_prefecture