jp_prefecture 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6636c60d594d140725ac2f9b01c6724b66328e3
-  data.tar.gz: dfb83ab23f2bb8be09afc748d17f3b51180e2e7b
+  metadata.gz: 2969a6cc0162ae5a97f2bd4205ae05ce500a2124
+  data.tar.gz: 347d5c47c228762af40e5804d476dc94d8f6e2ea
 SHA512:
-  metadata.gz: d8e91fddb44bc5cfbce465c541a5ca3312afaf8412900fbf122591a64a2215f1b29900d4437149a800be5d67ba28e0ceaaa37cae7c1c7cfe8d2eeafdfaa257d8
-  data.tar.gz: c5fa940c3614cb491f32f5bf740e2140a02dde3ca8f42af4bb8adcdf5da941ad09470f298042702760a07afeabc3d507237e6349805655368d801e0b286f3791
+  metadata.gz: 5856a351b31f85dd6691f3b0494867023c2d60ccd099d165f5f511a06edc628f67227dd3bc96fd5029a2a8cacc70e21a3d8a3aa3209204fcf8f01f14d885edee
+  data.tar.gz: fd18d884336e9b812daa06b1ad4b9af27838bdacf1daf0367030ff5ad981297a2a48f9523279b8b3244cd29ccfa340a2285c1af290e2a6b1905a13fe222c894c

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/.travis.yml

@@ -1,13 +1,32 @@
 language: ruby
 sudo: false
+cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.8
   - 2.2.4
-  - 2.3.0
+  - 2.3.3
+  - 2.4.0
   - ruby-head
+gemfile:
+  - gemfiles/rails32.gemfile
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
 matrix:
   allow_failures:
+    - rvm: 1.9.3
     - rvm: ruby-head
   fast_finish: true
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1.8
+      gemfile: gemfiles/rails50.gemfile
+notifications:
+  email:
+    - false

data/Appraisals

@@ -0,0 +1,21 @@
+appraise 'rails32' do
+  gem 'activerecord', '~> 3.2.0'
+end
+
+appraise 'rails40' do
+  gem 'activerecord', '~> 4.0.0'
+end
+
+appraise 'rails41' do
+  gem 'activerecord', '~> 4.1.0'
+end
+
+appraise 'rails42' do
+  gem 'activerecord', '~> 4.2.0'
+end
+
+if RUBY_VERSION >= '2.2.2'
+  appraise 'rails50' do
+    gem 'activerecord', '~> 5.0.0'
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Unreleased
+
+## 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))

data/README.md

@@ -1,5 +1,7 @@
 # JpPrefecture
 
+[**English**](README_EN.md)
+
 [![Gem Version](http://img.shields.io/gem/v/jp_prefecture.svg?style=flat)](https://rubygems.org/gems/jp_prefecture)
 [![Build Status](http://img.shields.io/travis/chocoby/jp_prefecture/master.svg?style=flat)](https://travis-ci.org/chocoby/jp_prefecture)
 [![Coveralls](https://img.shields.io/coveralls/chocoby/jp_prefecture.svg)](https://coveralls.io/r/chocoby/jp_prefecture)
@@ -27,21 +29,6 @@ JIS X 0402 で定義されている都道府県コードをベースに、
 
 また、Rails のプラグインとして使用することもできます。
 
-## インストール
-
-以下の行を `Gemfile` に記述してから:
-
-```
-gem 'jp_prefecture'
-```
-
-`bundle` を実行してください。
-
-または、手動でインストールしてください:
-
-```
-$ gem install jp_prefecture
-```
 
 ## 使い方
 
@@ -70,6 +57,8 @@ pref.name_k
 # => "トウキョウト"
 pref.area
 # => "関東"
+pref.type
+# => "都"
 ```
 
 以下のように書くことも可能です:
@@ -172,18 +161,33 @@ 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)
+## インストール
 
-## TODO
+以下の行を `Gemfile` に記述してから:
 
-GitHub の [Issues](https://github.com/chocoby/jp_prefecture/issues) を参照してください。
+```
+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)
 
 ## サポートしているバージョン
 
-* Ruby: 1.9.3 / 2.0.0 / 2.1 / 2.2 / 2.3
-* Rails: 3.2 / 4.0 / 4.1 / 4.2
+* Ruby: 1.9.3 / 2.0.0 / 2.1 / 2.2 / 2.3 / 2.4
+* Rails: 3.2 / 4.0 / 4.1 / 4.2 / 5.0
+
 
 ## Contributing
 
@@ -193,6 +197,7 @@ 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
 
+
 ## テスト
 
 ```
@@ -202,10 +207,14 @@ bundle install --path .bundle
 bundle exec rspec
 ```
 
-## GitHub
+複数バージョンの Active Record でテストを実行:
 
-https://github.com/chocoby/jp_prefecture
+```
+bundle exec appraisal install
+bundle exec appraisal rake spec
+```
 
-## ライセンス
 
-[MIT License](http://chocoby.mit-license.org/)
+## GitHub
+
+https://github.com/chocoby/jp_prefecture

data/README_EN.md

@@ -0,0 +1,219 @@
+# JpPrefecture
+
+[![Gem Version](http://img.shields.io/gem/v/jp_prefecture.svg?style=flat)](https://rubygems.org/gems/jp_prefecture)
+[![Build Status](http://img.shields.io/travis/chocoby/jp_prefecture/master.svg?style=flat)](https://travis-ci.org/chocoby/jp_prefecture)
+[![Coveralls](https://img.shields.io/coveralls/chocoby/jp_prefecture.svg)](https://coveralls.io/r/chocoby/jp_prefecture)
+[![Code Climate](https://img.shields.io/codeclimate/github/chocoby/jp_prefecture.svg)](https://codeclimate.com/github/chocoby/jp_prefecture)
+[![Dependency Status](http://img.shields.io/gemnasium/chocoby/jp_prefecture.svg?style=flat)](https://gemnasium.com/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.0 / 2.1 / 2.2 / 2.3
+* Rails: 3.2 / 4.0 / 4.1 / 4.2 / 5.0
+
+
+## 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 --path .bundle
+bundle exec rspec
+```
+
+Run test in multiple `ActiveRecord` versions
+
+```
+bundle exec appraisal install
+bundle exec appraisal rake spec
+```
+
+
+## GitHub
+
+https://github.com/chocoby/jp_prefecture

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+
+gemspec :path => "../"

data/jp_prefecture.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'activerecord', '>= 3.2.0'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'appraisal'
 end

data/lib/jp_prefecture/prefecture.rb

@@ -6,7 +6,7 @@ module JpPrefecture
   # 都道府県のコードと名前を扱うクラス
   class Prefecture
 
-    attr_accessor :code, :name, :name_e, :name_h, :name_k, :zips, :area
+    attr_accessor :code, :name, :name_e, :name_h, :name_k, :zips, :area, :type
 
     # 配列から都道府県クラスを生成
     #
@@ -31,6 +31,13 @@ module JpPrefecture
       pref.name_k  = name_k
       pref.zips    = ZipMapping.data[code]
       pref.area    = area
+      pref.type    =
+        case pref.name[-1]
+        when "都", "道", "府", "県"
+          pref.name[-1]
+        else
+          nil
+        end
 
       pref
     end

data/lib/jp_prefecture/version.rb

@@ -1,3 +1,3 @@
 module JpPrefecture
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

data/spec/prefecture_spec.rb

@@ -11,6 +11,17 @@ describe JpPrefecture::Prefecture do
     it { expect(pref.name_k).to eq 'ホッカイドウ' }
     it { expect(pref.zips).to eq [10000..70895, 400000..996509] }
     it { expect(pref.area).to eq '北海道' }
+    it { expect(pref.type).to eq '道' }
+
+    let(:nil_type_pref) { JpPrefecture::Prefecture.build(13, '東京', 'Tokyo', 'とうきょう', 'トウキョウ', '関東') }
+    it { expect(nil_type_pref.code).to eq 13 }
+    it { expect(nil_type_pref.name).to eq '東京' }
+    it { expect(nil_type_pref.name_e).to eq 'Tokyo' }
+    it { expect(nil_type_pref.name_h).to eq 'とうきょう' }
+    it { expect(nil_type_pref.name_k).to eq 'トウキョウ' }
+    it { expect(nil_type_pref.zips).to eq [1000000..2080035] }
+    it { expect(nil_type_pref.area).to eq '関東' }
+    it { expect(nil_type_pref.type).to eq nil }
   end
 
   describe '.find' do
@@ -24,6 +35,7 @@ describe JpPrefecture::Prefecture do
         it { expect(pref.name_k).to eq 'ホッカイドウ' }
         it { expect(pref.zips).to eq [10000..70895, 400000..996509] }
         it { expect(pref.area).to eq '北海道' }
+        it { expect(pref.type).to eq '道' }
       end
 
       shared_examples '都道府県が見つからない' do |arg|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jp_prefecture
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - chocoby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convert japan prefecture code(JIS X 0402 based) into prefecture name.
 email:
 - chocoby@gmail.com
@@ -91,13 +105,20 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
-- LICENSE
+- MIT-LICENSE
 - README.md
+- README_EN.md
 - Rakefile
 - data/prefecture.yml
 - data/zip.yml
+- gemfiles/rails32.gemfile
+- gemfiles/rails40.gemfile
+- gemfiles/rails41.gemfile
+- gemfiles/rails42.gemfile
+- gemfiles/rails50.gemfile
 - jp_prefecture.gemspec
 - lib/jp_prefecture.rb
 - lib/jp_prefecture/base.rb
@@ -133,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Convert japan prefecture code into prefecture name