jp_prefecture 0.1.0 → 0.1.1

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,2 @@
+-
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 0.1.1 (March 1, 2013) ##
+
+* モデルで使用する時に、生成するメソッド名を指定できるようにした
+* Configuration モデル/Model モジュールを廃止
+* extend による使用を廃止
+* Travis CI によるテストを行うようにした
+
+## 0.1.0 (February 17, 2013) ##
+
+* モデルで使用する時に、対象のカラム名を指定するようにした
+
+## 0.0.1 (February 14, 2013) ##
+
+* 都道府県の変換
+* 簡単な Rails サポート

data/README.md

@@ -1,5 +1,7 @@
 # JpPrefecture
 
+[![Build Status](https://travis-ci.org/chocoby/jp_prefecture.png?branch=master)](https://travis-ci.org/chocoby/jp_prefecture)
+
 https://rubygems.org/gems/jp_prefecture
 
 ## jp_prefecture とは
@@ -16,15 +18,15 @@ JIS X 0402 で定義されている都道府県コードをベースに、
 
 また、Rails のプラグインとして使用することもできます。
 
-## インストール方法
+## インストール
 
-Gemfile に記述してインストールするか:
+以下の行を `Gemfile` に記述してから:
 
     gem 'jp_prefecture'
 
-    $ bundle
+`bundle` を実行してください。
 
-手動でインストールしてください:
+または、手動でインストールしてください:
 
     $ gem install jp_prefecture
 
@@ -32,6 +34,8 @@ Gemfile に記述してインストールするか:
 
 ### 都道府県コードから都道府県名を取得
 
+    require 'jp_prefecture'
+
     pref = JpPrefecture::Prefecture.find 13
     # => #<JpPrefecture::Prefecture:0x007fd0a3d43fe8 @code=13, @name="東京都">
     pref.code
@@ -44,10 +48,9 @@ Gemfile に記述してインストールするか:
     JpPrefecture::Prefecture.all
     # => [#<JpPrefecture::Prefecture:0x007fd0a3d78d38 @code=1, @name="北海道">, ...]
 
-### ActiveRecord で使用する
+### Rails(ActiveRecord) で使用する
 
-`ActiveRecord::Base` を継承した Model に include し、`jp_prefecture` を呼び出すことで、
-都道府県コードを扱うことができます。
+`ActiveRecord::Base` を継承した Model で、都道府県コードを扱うことができます。
 
 app/models/place.rb:
 
@@ -58,13 +61,23 @@ app/models/place.rb:
       jp_prefecture :prefecture_code
     end
 
-`prefecture` というメソッドが生成され、都道府県コード、都道府県名が参照できるようになります。:
+`prefecture` というメソッドが生成され、都道府県コード、都道府県名が参照できるようになります:
 
     place = Place.new
     place.prefecture_code = 13
     place.prefecture.name
     # => "東京都"
 
+生成されるメソッド名は `method_name` というオプションで指定することができます:
+
+    # model
+    jp_prefecture :prefecture_code, :method_name => :pref
+
+    place = Place.new
+    place.prefecture_code = 13
+    place.pref.name
+    # => "東京都"
+
 ### テンプレートで使用する
 
 `collection_select` を使用して、都道府県のセレクトボックスを生成することができます。:
@@ -77,11 +90,9 @@ app/models/place.rb:
 
 ## TODO
 
-* 生成するメソッド名を指定できるようにする
-  * 現在は `prefecture` 固定
 * バリデーター
 * i18n?(tokyo などの文字列に対応)
-* ドキュメントを書く
+* 一つのモデルで複数のカラムをサポート？
 * JIS X 0402 で定義されている正規のコードをサポート？
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-cfs']
+  end
+rescue LoadError => e
+end

data/lib/jp_prefecture/base.rb

@@ -1,31 +1,41 @@
 # coding: utf-8
-require "jp_prefecture/model"
-
 module JpPrefecture
   module Base
-    # モデル内の設定を行う
+    # モデル内で使用するための設定を行う
     #
-    # 第 1 引数には変換対象のカラムを指定する:
+    # 変換対象のカラムを指定する:
     #
     #   class Place < ActiveRecord::Base
     #     include JpPrefecture
     #     jp_prefecture :prefecture_code
     #   end
     #
+    #   p = Place.new
+    #   p.prefecture_code = 1
+    #   p.prefecture
+    #   # => #<JpPrefecture::Prefecture:0x007fd0a3d10f30 @code=1, @name="北海道">
+    #
+    # 生成するメソッド名は method_name で指定する:
+    #
+    #   class Place < ActiveRecord::Base
+    #     include JpPrefecture
+    #     jp_prefecture :prefecture_code, method_name: :pref
+    #   end
+    #
+    #   p = Place.new
+    #   p.prefecture_code = 1
+    #   p.pref
+    #   # => #<JpPrefecture::Prefecture:0x007fcb8444dcc8 @code=1, @name="北海道">
+    #
     # @param [Symbol] column_name 変換対象のカラム
+    # @option options [Symbol] :method_name 生成するメソッド名。デフォルト: +:prefecture+
     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)
+      method_name = options[:method_name] || :prefecture
 
-      include JpPrefecture::Model
-    end
-
-    # モデルクラスの設定を返す
-    #
-    # @return [JpPrefecture::Configuration]
-    def jp_prefecture_config
-      @jp_prefecture_config
+      define_method method_name do
+        JpPrefecture::Prefecture.find(self.send(column_name))
+      end
     end
   end
 end

data/lib/jp_prefecture/version.rb

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

data/lib/jp_prefecture.rb

@@ -1,18 +1,10 @@
 # coding: utf-8
 require "jp_prefecture/base"
-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
+    model_class.extend Base
   end
 end

data/spec/base_spec.rb

@@ -0,0 +1,81 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture::Base do
+  describe '#jp_prefecture' do
+    describe 'カラム名の指定について' do
+      context 'prefecture_code を指定した場合' do
+        let(:model_class) do
+          klass = Class.new(ActiveRecord::Base) do
+            self.table_name = :places
+            include JpPrefecture
+            jp_prefecture :prefecture_code
+          end
+
+          klass.new(:prefecture_code => 1)
+        end
+
+        it 'prefecture_code のコードが変換できること' do
+          model_class.prefecture.name.should eq '北海道'
+        end
+      end
+
+      context 'prefecture_id を指定した場合' do
+        let(:model_class) do
+          klass = Class.new(ActiveRecord::Base) do
+            self.table_name = :places
+            include JpPrefecture
+            jp_prefecture :prefecture_id
+          end
+
+          klass.new(:prefecture_id => 1)
+        end
+
+        it 'prefecture_id のコードが変換できること' do
+          model_class.prefecture.name.should eq '北海道'
+        end
+      end
+    end
+
+    describe '生成するメソッド名の指定について' do
+      context 'prefecture_method を指定した場合' do
+        let(:model_class) do
+          klass = Class.new(ActiveRecord::Base) do
+            self.table_name = :places
+            include JpPrefecture
+            jp_prefecture :prefecture_code, :method_name => :prefecture_method
+          end
+
+          klass.new(:prefecture_code => 1)
+        end
+
+        it 'prefecture_method で結果が参照できること' do
+          model_class.prefecture_method.name.should eq '北海道'
+        end
+      end
+    end
+
+    describe '都道府県の検索について' do
+      let(:klass) do
+        Class.new(ActiveRecord::Base) do
+          self.table_name = :places
+          include JpPrefecture
+          jp_prefecture :prefecture_code
+        end
+      end
+
+      context '都道府県が見つかった場合' do
+        let(:model_class) { klass.new(:prefecture_code => 1) }
+        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
+        let(:model_class) { klass.new(:prefecture_code => 99) }
+        it { model_class.should respond_to(:prefecture) }
+        it { model_class.prefecture.should be_nil }
+      end
+    end
+  end
+end

data/spec/jp_prefecture_spec.rb

@@ -12,16 +12,6 @@ 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) }

data/spec/prefecture_spec.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture::Prefecture do
+  describe '.build' do
+    let(:pref) { JpPrefecture::Prefecture.build([1, '北海道']) }
+    it { pref.code.should eq 1 }
+    it { pref.name.should eq '北海道' }
+  end
+
+  describe '.find' do
+    context '都道府県が見つかった場合' do
+      let(:pref) { JpPrefecture::Prefecture.find(1) }
+      it { pref.code.should eq 1 }
+      it { pref.name.should eq '北海道' }
+    end
+
+    context '都道府県が見つからなかった場合' do
+      let(:pref) { JpPrefecture::Prefecture.find(99) }
+      it { pref.should be_nil }
+    end
+  end
+
+  describe '.all' do
+    let(:prefs) { JpPrefecture::Prefecture.all }
+    it { prefs.first.should be_an_instance_of(JpPrefecture::Prefecture) }
+    it '都道府県の数が 47 であること' do
+      prefs.count.should eq 47
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jp_prefecture
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,6 +84,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -91,16 +94,12 @@ files:
 - 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/base_spec.rb
 - spec/jp_prefecture_spec.rb
-- spec/lib/base_spec.rb
-- spec/lib/configuration_spec.rb
-- spec/lib/model_spec.rb
-- spec/lib/prefecture_spec.rb
+- spec/prefecture_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/chocoby/jp_prefecture
 licenses: []
@@ -127,10 +126,8 @@ signing_key:
 specification_version: 3
 summary: Convert japan prefecture code into prefecture name
 test_files:
+- spec/base_spec.rb
 - spec/jp_prefecture_spec.rb
-- spec/lib/base_spec.rb
-- spec/lib/configuration_spec.rb
-- spec/lib/model_spec.rb
-- spec/lib/prefecture_spec.rb
+- spec/prefecture_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/jp_prefecture/configuration.rb

@@ -1,23 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# coding: utf-8
-module JpPrefecture
-  # このモジュールが include されると、prefecture メソッドを呼び出せるようになります。
-  # prefecture メソッドを呼び出すと都道府県コードと名前が参照できます。
-  #
-  #   p = Place.new
-  #   p.prefecture_code = 1
-  #   p.prefecture
-  #   # => #<JpPrefecture::Prefecture:0x007fd0a3d10f30 @code=1, @name="北海道">
-  module Model
-    def prefecture
-      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/spec/lib/base_spec.rb

@@ -1,16 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,62 +0,0 @@
-# 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/lib/prefecture_spec.rb

@@ -1,28 +0,0 @@
-# coding: utf-8
-require 'spec_helper'
-
-describe JpPrefecture::Prefecture do
-  describe '.build' do
-    before { @pref = JpPrefecture::Prefecture.build([1, '北海道']) }
-    it { @pref.code.should eq 1 }
-    it { @pref.name.should eq '北海道' }
-  end
-
-  describe '.find' do
-    context '都道府県が見つかった' do
-      before { @pref = JpPrefecture::Prefecture.find(1) }
-      it { @pref.code.should eq 1 }
-      it { @pref.name.should eq '北海道' }
-    end
-
-    context '都道府県が見つからなかった' do
-      it { JpPrefecture::Prefecture.find(999).should be_nil }
-    end
-  end
-
-  describe '.all' do
-    before { @prefs = JpPrefecture::Prefecture.all }
-    it { @prefs.count.should eq 47 }
-    it { @prefs.first.should be_an_instance_of(JpPrefecture::Prefecture) }
-  end
-end