jp_prefecture 0.0.1 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Guardfile

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in jp_prefecture.gemspec
 gemspec

data/README.md

@@ -1,9 +1,20 @@
 # JpPrefecture
 
+https://rubygems.org/gems/jp_prefecture
+
 ## jp_prefecture とは
 
 都道府県コードと都道府県名を変換するライブラリです。
-Ruby on Rails で使用することもできます。
+
+JIS X 0402 で定義されている都道府県コードをベースに、
+ゼロから始まるものはゼロを削除して使用しています。
+
+    北海道: 01 -> 1
+    東京都: 13 -> 13
+
+参考: [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)
+
+また、Rails のプラグインとして使用することもできます。
 
 ## インストール方法
 
@@ -31,22 +42,20 @@ Gemfile に記述してインストールするか:
 ### 都道府県の一覧を取得
 
     JpPrefecture::Prefecture.all
-    # => [#<JpPrefecture::Prefecture:0x007fd0a3d78d38 @code=1, @name="北海道">, ...
+    # => [#<JpPrefecture::Prefecture:0x007fd0a3d78d38 @code=1, @name="北海道">, ...]
 
 ### ActiveRecord で使用する
 
 `ActiveRecord::Base` を継承した Model に include し、`jp_prefecture` を呼び出すことで、
 都道府県コードを扱うことができます。
 
-**NOTE:** 現在、カラム名は `prefecture_code` 固定です。(変更できるようにします)
-
 app/models/place.rb:
 
     class Place < ActiveRecord::Base
-      # prefecture_code:string
+      # prefecture_code:integer
 
       include JpPrefecture
-      jp_prefecture
+      jp_prefecture :prefecture_code
     end
 
 `prefecture` というメソッドが生成され、都道府県コード、都道府県名が参照できるようになります。:
@@ -58,35 +67,22 @@ app/models/place.rb:
 
 ### テンプレートで使用する
 
-`collection_select` を使用して、都道府県のセレクトボックスを生成することができます。
+`collection_select` を使用して、都道府県のセレクトボックスを生成することができます。:
 
     f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name
 
-## 都道府県コードと都道府県名のマッピングについて
-
-JIS X 0402 で定義されている都道府県コードをベースに、
-ゼロから始まるものはゼロを削除して使用しています。
-
-    北海道 01 -> 1
-    東京都 13 -> 13
-
-要望があれば JIS X 0402 で定義されている正規のコードもサポートするようにします。
-
-参考: [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)
-
 ## ドキュメント
 
-[http://rdoc.info/github/chocoby/jp_prefecture/master/index](http://rdoc.info/github/chocoby/jp_prefecture/master/index)
+[http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index](http://rdoc.info/github/chocoby/jp_prefecture/master/frames/index)
 
 ## TODO
 
-* 対象カラムを指定できるようにする
-  * 現在は `prefecture_code` 固定
 * 生成するメソッド名を指定できるようにする
   * 現在は `prefecture` 固定
 * バリデーター
 * i18n?(tokyo などの文字列に対応)
-* ドキュメントをちゃんと書く
+* ドキュメントを書く
+* JIS X 0402 で定義されている正規のコードをサポート？
 
 ## Contributing
 

data/jp_prefecture.gemspec

@@ -16,15 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = JpPrefecture::VERSION
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
-
-  gem.add_development_dependency "awesome_print"
-
+  gem.add_development_dependency "rspec", "~> 2.12.0"
   gem.add_development_dependency "activerecord", ">= 3.2.0"
   gem.add_development_dependency "sqlite3"
-
-  gem.add_development_dependency "rspec", "~> 2.12.0"
-  gem.add_development_dependency "guard-rspec", "~> 2.4.0"
-  gem.add_development_dependency "growl-rspec", "~> 0.0.1"
 end

data/lib/jp_prefecture.rb

@@ -1,14 +1,18 @@
 # coding: utf-8
-require "jp_prefecture/version"
-require "jp_prefecture/mapping"
-require "jp_prefecture/prefecture"
 require "jp_prefecture/base"
-require "jp_prefecture/model"
+require "jp_prefecture/configuration"
+require "jp_prefecture/prefecture"
+require "jp_prefecture/version"
 
 module JpPrefecture
   def self.included(model_class)
+    model_class.extend self
+  end
+
+  def self.extended(model_class)
     model_class.instance_eval do
       extend Base
+      @jp_prefecture_config = Class.new(Configuration).new(self)
     end
   end
 end

data/lib/jp_prefecture/base.rb

@@ -1,8 +1,31 @@
 # coding: utf-8
+require "jp_prefecture/model"
+
 module JpPrefecture
   module Base
-    def jp_prefecture
+    # モデル内の設定を行う
+    #
+    # 第 1 引数には変換対象のカラムを指定する:
+    #
+    #   class Place < ActiveRecord::Base
+    #     include JpPrefecture
+    #     jp_prefecture :prefecture_code
+    #   end
+    #
+    # @param [Symbol] column_name 変換対象のカラム
+    def jp_prefecture(column_name, options = {})
+      column_name = column_name.to_sym if column_name.is_a?(String)
+      options.merge!(:column_name => column_name)
+      jp_prefecture_config.send(:set, options)
+
       include JpPrefecture::Model
     end
+
+    # モデルクラスの設定を返す
+    #
+    # @return [JpPrefecture::Configuration]
+    def jp_prefecture_config
+      @jp_prefecture_config
+    end
   end
 end

data/lib/jp_prefecture/configuration.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+module JpPrefecture
+  class Configuration
+    # モデルクラス
+    # @return ActiveRecord::Base
+    attr_accessor :model_class
+
+    # 変換対象のカラム
+    # @return [Symbol]
+    attr_accessor :column_name
+
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    private
+
+    # オプションをセットする
+    def set(values)
+      values && values.each { |name, value| self.send :"#{name}=", value }
+    end
+  end
+end

data/lib/jp_prefecture/model.rb

@@ -6,10 +6,18 @@ module JpPrefecture
   #   p = Place.new
   #   p.prefecture_code = 1
   #   p.prefecture
-  #   # => #<JpPrefecture::Prefecture:0x007fd0a3d10f30 @code=1, @name="北海道"> >
+  #   # => #<JpPrefecture::Prefecture:0x007fd0a3d10f30 @code=1, @name="北海道">
   module Model
     def prefecture
-      JpPrefecture::Prefecture.find(self.prefecture_code)
+      column_name = jp_prefecture_config.column_name
+      JpPrefecture::Prefecture.find(self.send(column_name))
+    end
+
+    # モデルクラスの設定を返す
+    #
+    # @return [JpPrefecture::Configuration]
+    def jp_prefecture_config
+      self.class.jp_prefecture_config
     end
   end
 end

data/lib/jp_prefecture/prefecture.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+require "jp_prefecture/mapping"
 
 module JpPrefecture
   # 都道府県のコードと名前を扱うクラス

data/lib/jp_prefecture/version.rb

@@ -1,3 +1,3 @@
 module JpPrefecture
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/jp_prefecture_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe JpPrefecture do
-  describe '.include' do
+  describe '.included' do
     subject do
       Class.new(ActiveRecord::Base) do
         include JpPrefecture
@@ -11,4 +11,19 @@ describe JpPrefecture do
 
     it { should respond_to(:jp_prefecture) }
   end
+
+  describe '.extended' do
+    subject do
+      Class.new(ActiveRecord::Base) do
+        extend JpPrefecture
+      end
+    end
+
+    it { should respond_to(:jp_prefecture) }
+  end
+
+  describe 'include されていない' do
+    subject { Class.new(ActiveRecord::Base) }
+    it { should_not respond_to(:jp_prefecture) }
+  end
 end

data/spec/lib/base_spec.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture::Base do
+  describe '#jp_prefecture' do
+    before do
+      @model_class = Class.new(ActiveRecord::Base) do
+        self.abstract_class = true
+        include JpPrefecture
+        jp_prefecture 'aiueo'
+      end
+    end
+
+    it { @model_class.jp_prefecture_config.column_name.should eq :aiueo }
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture::Configuration do
+  before do
+    @model_class = Class.new(ActiveRecord::Base) do
+      self.abstract_class = true
+    end
+  end
+
+  describe '#initialize' do
+    describe 'モデルクラスについて' do
+      before { @config = JpPrefecture::Configuration.new(@model_class) }
+      it { @config.model_class.should eq @model_class }
+    end
+  end
+end

data/spec/lib/model_spec.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture::Model do
+  describe '#prefecture' do
+    describe 'カラム名の指定について' do
+      context 'prefecture_code' do
+        before do
+          class Place < ActiveRecord::Base
+            include JpPrefecture
+            jp_prefecture :prefecture_code
+          end
+
+          @model_class = Place.new(:prefecture_code => 1)
+        end
+
+        it { @model_class.prefecture.name.should eq '北海道' }
+      end
+
+      context 'prefecture_id' do
+        before do
+          class Place < ActiveRecord::Base
+            include JpPrefecture
+            jp_prefecture :prefecture_id
+          end
+
+          @model_class = Place.new(:prefecture_id => 1)
+        end
+
+        it { @model_class.prefecture.name.should eq '北海道' }
+      end
+    end
+
+    describe '検索について' do
+      before do
+        class Place < ActiveRecord::Base
+          include JpPrefecture
+          jp_prefecture :prefecture_code
+        end
+      end
+
+      context '都道府県が見つかった' do
+        before do
+          @model_class = Place.new(:prefecture_code => 1)
+        end
+
+        it { @model_class.should respond_to(:prefecture) }
+        it { @model_class.prefecture.should be_an_instance_of(JpPrefecture::Prefecture) }
+        it { @model_class.prefecture.name.should eq '北海道' }
+      end
+
+      context '都道府県が見つからなかった' do
+        before do
+          @model_class = Place.new(:prefecture_code => 999)
+        end
+
+        it { @model_class.should respond_to(:prefecture) }
+        it { @model_class.prefecture.should be_nil }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,11 +1,7 @@
 # coding: utf-8
-require 'rubygems'
 require 'jp_prefecture'
-
 require "active_record"
 
-require 'awesome_print'
-
 RSpec.configure do |config|
   config.before(:suite) do
     setup_db
@@ -22,6 +18,7 @@ def setup_db
   ActiveRecord::Schema.define(:version => 1) do
     create_table :places do |t|
       t.integer :prefecture_code
+      t.integer :prefecture_id
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jp_prefecture
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,53 +28,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -107,54 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-- !ruby/object:Gem::Dependency
-  name: growl-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.1
 description: Convert japan prefecture code(JIS X 0402 based) into prefecture name.
 email:
 - chocoby@gmail.com
@@ -165,20 +85,22 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
-- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - jp_prefecture.gemspec
 - lib/jp_prefecture.rb
 - lib/jp_prefecture/base.rb
+- lib/jp_prefecture/configuration.rb
 - lib/jp_prefecture/mapping.rb
 - lib/jp_prefecture/model.rb
 - lib/jp_prefecture/prefecture.rb
 - lib/jp_prefecture/version.rb
-- spec/active_record_spec.rb
 - spec/jp_prefecture_spec.rb
-- spec/prefecture_spec.rb
+- spec/lib/base_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/model_spec.rb
+- spec/lib/prefecture_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/chocoby/jp_prefecture
 licenses: []
@@ -205,8 +127,10 @@ signing_key:
 specification_version: 3
 summary: Convert japan prefecture code into prefecture name
 test_files:
-- spec/active_record_spec.rb
 - spec/jp_prefecture_spec.rb
-- spec/prefecture_spec.rb
+- spec/lib/base_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/model_spec.rb
+- spec/lib/prefecture_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/Guardfile

@@ -1,5 +0,0 @@
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/spec/active_record_spec.rb

@@ -1,35 +0,0 @@
-# coding: utf-8
-require 'spec_helper'
-
-class Place < ActiveRecord::Base
-  include JpPrefecture
-  jp_prefecture
-end
-
-describe ActiveRecord do
-  describe 'include されていない' do
-    before { @klass = Class.new(ActiveRecord::Base) }
-    it { @klass.should_not respond_to(:jp_prefecture) }
-  end
-
-  describe '普通のモデル' do
-    context '都道府県が見つかった場合' do
-      before do
-        @model_class = Place.new(:prefecture_code => 1)
-      end
-
-      it { @model_class.should respond_to(:prefecture) }
-      it { @model_class.prefecture.should be_an_instance_of(JpPrefecture::Prefecture) }
-      it { @model_class.prefecture.name.should eq '北海道' }
-    end
-
-    context '都道府県が見つからなかった場合' do
-      before do
-        @model_class = Place.new(:prefecture_code => 999)
-      end
-
-      it { @model_class.should respond_to(:prefecture) }
-      it { @model_class.prefecture.should be_nil }
-    end
-  end
-end