jp_prefecture 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,4 +1,3 @@
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -1,6 +1,13 @@
+## 0.3.0 (June 11, 2013) ##
+
+* 都道府県名(英語表記含む)から都道府県を検索できるようにした
+* 都道府県名からの検索と同様の方法で、都道府県コードを検索できるようにした
+* String 型の都道府県コードに対応
+
 ## 0.2.0 (June 9, 2013) ##
 
 * 英語表記を追加
+* Ruby 1.8.7 のサポートを終了
 
 ## 0.1.1 (March 1, 2013) ##
 

data/README.md

@@ -33,10 +33,14 @@ JIS X 0402 で定義されている都道府県コードをベースに、
 
 ## 使い方
 
-### 都道府県コードから都道府県名を取得
+### ライブラリの読み込み
 
     require 'jp_prefecture'
 
+### 都道府県コードから都道府県を検索
+
+単純に都道府県コードを渡すと、都道府県コードから都道府県を検索します:
+
     pref = JpPrefecture::Prefecture.find 13
     # => #<JpPrefecture::Prefecture:0x007fd0a3d43fe8 @code=13, @name="東京都", @name_e="Tokyo">
     pref.code
@@ -46,6 +50,21 @@ JIS X 0402 で定義されている都道府県コードをベースに、
     pref.name_e
     # => "Tokyo"
 
+以下のように渡すことも可能です:
+
+    JpPrefecture::Prefecture.find code: 13
+
+### 都道府県名から都道府県を検索
+
+    JpPrefecture::Prefecture.find name: "東京都"
+    # => #<JpPrefecture::Prefecture:0x007ff672271800 @code=13, @name="東京都", @name_e="Tokyo">
+
+    JpPrefecture::Prefecture.find name: "Tokyo"
+    # => #<JpPrefecture::Prefecture:0x007fb3c2828b10 @code=13, @name="東京都", @name_e="Tokyo">
+
+    JpPrefecture::Prefecture.find name: "tokyo"
+    # => #<JpPrefecture::Prefecture:0x007f965c0c5a40 @code=13, @name="東京都", @name_e="Tokyo">
+
 ### 都道府県の一覧を取得
 
     JpPrefecture::Prefecture.all
@@ -74,7 +93,7 @@ app/models/place.rb:
 生成されるメソッド名は `method_name` というオプションで指定することができます:
 
     # model
-    jp_prefecture :prefecture_code, :method_name => :pref
+    jp_prefecture :prefecture_code, method_name: :pref
 
     place = Place.new
     place.prefecture_code = 13
@@ -87,9 +106,21 @@ app/models/place.rb:
 
     f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name
 
-    # 英語表記
+    # 英語表記で出力
     f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name_e
 
+### マイグレーション
+
+カラムのタイプは `integer` か `string` で作成してください。
+
+マイグレーションのサンプル:
+
+    class AddPrefectureCodeToPlaces < ActiveRecord::Migration
+      def change
+        add_column :places, :prefecture_code, :integer
+      end
+    end
+
 ## ドキュメント
 
 [http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
@@ -98,6 +129,13 @@ app/models/place.rb:
 
 GitHub の [Issues](https://github.com/chocoby/jp_prefecture/issues) を参照してください。
 
+## 対象バージョン
+
+* Ruby: 1.9.3 / 2.0.0 以上
+* Rails: 3.2 以上
+
+Ruby 1.8.7 のサポートは [v0.1.1](https://github.com/chocoby/jp_prefecture/tree/v0.1.1) で終了しました。
+
 ## Contributing
 
 1. Fork it

data/lib/jp_prefecture/prefecture.rb

@@ -12,7 +12,7 @@ module JpPrefecture
     #
     # @example
     #   # コード/名前から都道府県クラスを生成
-    #   JpPrefecture::Prefecture.build 1, '北海道', 'Hokkaido'
+    #   JpPrefecture::Prefecture.build(1, '北海道', 'Hokkaido')
     #
     # @param pref [Integer] 都道府県コード
     # @param name [String] 都道府県名
@@ -27,17 +27,44 @@ module JpPrefecture
       p
     end
 
-    # 都道府県コードから都道府県を検索
+    # 都道府県を検索
     #
     # @example
-    #   JpPrefecture::Prefecture.find 1
+    #   # 都道府県コードから検索
+    #   JpPrefecture::Prefecture.find(1)
+    #   JpPrefecture::Prefecture.find(code: 1)
     #
-    # @param code [Integer] 都道府県コード
+    #   # 都道府県名から検索
+    #   JpPrefecture::Prefecture.find(name: '北海道')
+    #
+    #   # 英語表記の都道府県名から検索
+    #   JpPrefecture::Prefecture.find(name: 'Hokkaido')
+    #   JpPrefecture::Prefecture.find(name: 'hokkaido')
+    #
+    # @param args [Integer] 都道府県コード
+    # @param [Hash] args 検索条件
+    # @option args [Integer] :code 都道府県コード
+    # @option args [String] :name 都道府県名/英語表記の都道府県名
     # @return [JpPrefecture::Prefecture] 都道府県が見つかった場合は都道府県クラス
     # @return [nil] 都道府県が見つからない場合は nil
-    def self.find(code)
+    def self.find(args)
+      return if args.nil?
+
+      if args.is_a?(Integer) || args.is_a?(String)
+        code = args.to_i
+      else
+        code =
+          case args.keys[0]
+          when :name
+            self.find_code_by_name(args[:name])
+          when :code
+            args[:code].to_i
+          end
+      end
+
       names = PREFECTURE_CODE_NAME[code]
-      return nil unless names
+
+      return unless names
 
       self.build(code, names[:name], names[:name_e])
     end
@@ -62,5 +89,18 @@ module JpPrefecture
         self.build(pref[0], names[:name], names[:name_e])
       end
     end
+
+  protected
+
+    # 名前から都道府県コードを検索
+    def self.find_code_by_name(name)
+      name.capitalize!
+
+      result = PREFECTURE_CODE_NAME.select { |_, v| v.has_value?(name) }.first
+      return if result.nil?
+
+      result[0]
+    end
+
   end
 end

data/lib/jp_prefecture/version.rb

@@ -1,3 +1,3 @@
 module JpPrefecture
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/prefecture_spec.rb

@@ -10,17 +10,48 @@ describe JpPrefecture::Prefecture do
   end
 
   describe '.find' do
-    context '都道府県が見つかった場合' do
-      let(:pref) { JpPrefecture::Prefecture.find(1) }
+    shared_examples "都道府県が見つかる" do |arg|
+      let(:pref) { JpPrefecture::Prefecture.find(arg) }
       it { pref.code.should eq 1 }
       it { pref.name.should eq '北海道' }
       it { pref.name_e.should eq 'Hokkaido' }
     end
 
-    context '都道府県が見つからなかった場合' do
-      let(:pref) { JpPrefecture::Prefecture.find(99) }
+    shared_examples '都道府県が見つからない' do |arg|
+      let(:pref) { JpPrefecture::Prefecture.find(arg) }
       it { pref.should be_nil }
     end
+
+    describe '都道府県コード' do
+      it_behaves_like "都道府県が見つかる", 1
+      it_behaves_like "都道府県が見つからない", 99
+      it_behaves_like "都道府県が見つかる", "1"
+      it_behaves_like "都道府県が見つかる", "01"
+      it_behaves_like "都道府県が見つからない", "99"
+    end
+
+    describe '都道府県コード(キーワード引数)' do
+      it_behaves_like "都道府県が見つかる", code: 1
+      it_behaves_like "都道府県が見つからない", code: 99
+      it_behaves_like "都道府県が見つかる", code: "1"
+      it_behaves_like "都道府県が見つかる", code: "01"
+      it_behaves_like "都道府県が見つからない", code: "99"
+    end
+
+    describe '都道府県名' do
+      it_behaves_like "都道府県が見つかる", name: "北海道"
+      it_behaves_like "都道府県が見つからない", name: "うどん県"
+    end
+
+    describe '都道府県名(英語表記)' do
+      it_behaves_like "都道府県が見つかる", name: "Hokkaido"
+      it_behaves_like "都道府県が見つからない", name: "Udon"
+    end
+
+    describe '都道府県名(英語表記-小文字)' do
+      it_behaves_like "都道府県が見つかる", name: "hokkaido"
+      it_behaves_like "都道府県が見つからない", name: "udon"
+    end
   end
 
   describe '.all' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jp_prefecture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -130,4 +130,3 @@ test_files:
 - spec/jp_prefecture_spec.rb
 - spec/prefecture_spec.rb
 - spec/spec_helper.rb
-has_rdoc: