jp_prefecture 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+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/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 chocoby
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# JpPrefecture
+
+## jp_prefecture とは
+
+都道府県コードと都道府県名を変換するライブラリです。
+Ruby on Rails で使用することもできます。
+
+## インストール方法
+
+Gemfile に記述してインストールするか:
+
+    gem 'jp_prefecture'
+
+    $ bundle
+
+手動でインストールしてください:
+
+    $ gem install jp_prefecture
+
+## 使い方
+
+### 都道府県コードから都道府県名を取得
+
+    pref = JpPrefecture::Prefecture.find 13
+    # => #<JpPrefecture::Prefecture:0x007fd0a3d43fe8 @code=13, @name="東京都">
+    pref.code
+    # => 13
+    pref.name
+    # => "東京都"
+
+### 都道府県の一覧を取得
+
+    JpPrefecture::Prefecture.all
+    # => [#<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
+
+      include JpPrefecture
+      jp_prefecture
+    end
+
+`prefecture` というメソッドが生成され、都道府県コード、都道府県名が参照できるようになります。:
+
+    place = Place.new
+    place.prefecture_code = 13
+    place.prefecture.name
+    # => "東京都"
+
+### テンプレートで使用する
+
+`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)
+
+## TODO
+
+* 対象カラムを指定できるようにする
+  * 現在は `prefecture_code` 固定
+* 生成するメソッド名を指定できるようにする
+  * 現在は `prefecture` 固定
+* バリデーター
+* i18n?(tokyo などの文字列に対応)
+* ドキュメントをちゃんと書く
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/jp_prefecture.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jp_prefecture/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["chocoby"]
+  gem.email         = ["chocoby@gmail.com"]
+  gem.summary       = %q{Convert japan prefecture code into prefecture name}
+  gem.description   = %q{Convert japan prefecture code(JIS X 0402 based) into prefecture name.}
+  gem.homepage      = "https://github.com/chocoby/jp_prefecture"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jp_prefecture"
+  gem.require_paths = ["lib"]
+  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 "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

@@ -0,0 +1,14 @@
+# coding: utf-8
+require "jp_prefecture/version"
+require "jp_prefecture/mapping"
+require "jp_prefecture/prefecture"
+require "jp_prefecture/base"
+require "jp_prefecture/model"
+
+module JpPrefecture
+  def self.included(model_class)
+    model_class.instance_eval do
+      extend Base
+    end
+  end
+end

data/lib/jp_prefecture/base.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+module JpPrefecture
+  module Base
+    def jp_prefecture
+      include JpPrefecture::Model
+    end
+  end
+end

data/lib/jp_prefecture/mapping.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+module JpPrefecture
+  # コードと都道府県のマッピング
+  module Mapping
+    # JIS X 0402 で定義されている都道府県コードと都道府県名をベースに
+    # コードがゼロから始まるもの(09 など)を 1 ケタにしたもの
+    PREFECTURE_CODE_NAME = {
+      1   => '北海道',
+      2   => '青森県',
+      3   => '岩手県',
+      4   => '宮城県',
+      5   => '秋田県',
+      6   => '山形県',
+      7   => '福島県',
+      8   => '茨城県',
+      9   => '栃木県',
+      10  => '群馬県',
+      11  => '埼玉県',
+      12  => '千葉県',
+      13  => '東京都',
+      14  => '神奈川県',
+      15  => '新潟県',
+      16  => '富山県',
+      17  => '石川県',
+      18  => '福井県',
+      19  => '山梨県',
+      20  => '長野県',
+      21  => '岐阜県',
+      22  => '静岡県',
+      23  => '愛知県',
+      24  => '三重県',
+      25  => '滋賀県',
+      26  => '京都府',
+      27  => '大阪府',
+      28  => '兵庫県',
+      29  => '奈良県',
+      30  => '和歌山県',
+      31  => '鳥取県',
+      32  => '島根県',
+      33  => '岡山県',
+      34  => '広島県',
+      35  => '山口県',
+      36  => '徳島県',
+      37  => '香川県',
+      38  => '愛媛県',
+      39  => '高知県',
+      40  => '福岡県',
+      41  => '佐賀県',
+      42  => '長崎県',
+      43  => '熊本県',
+      44  => '大分県',
+      45  => '宮崎県',
+      46  => '鹿児島県',
+      47  => '沖縄県'
+    }
+  end
+end

data/lib/jp_prefecture/model.rb

@@ -0,0 +1,15 @@
+# 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
+      JpPrefecture::Prefecture.find(self.prefecture_code)
+    end
+  end
+end

data/lib/jp_prefecture/prefecture.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+module JpPrefecture
+  # 都道府県のコードと名前を扱うクラス
+  class Prefecture
+    include JpPrefecture::Mapping
+
+    attr_accessor :code, :name
+
+    # 配列から都道府県クラスを生成
+    #
+    # @example
+    #   # コード/名前から都道府県クラスを生成
+    #   JpPrefecture::Prefecture.build [1, '北海道']
+    #
+    # @param pref [Array] コード/名前の配列
+    def self.build(pref)
+      p = self.new
+      p.code = pref[0]
+      p.name = pref[1]
+
+      p
+    end
+
+    # 都道府県コードから都道府県を検索
+    #
+    # @example
+    #   JpPrefecture::Prefecture.find 1
+    #
+    # @param code [Integer] 都道府県コード
+    # @return [JpPrefecture::Prefecture] 都道府県が見つかった場合は都道府県クラス
+    # @return [nil] 都道府県が見つからない場合は nil
+    def self.find(code)
+      name = PREFECTURE_CODE_NAME[code]
+      return nil unless name
+
+      self.build([code, name])
+    end
+
+
+    # すべての都道府県クラスを返す
+    #
+    # @example
+    #   # 都道府県の一覧を取得
+    #   JpPrefecture::Prefecture.all
+    #
+    #   # collection_select で選択肢を生成
+    #   f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name
+    #
+    # @return [Array] 都道府県クラスの配列
+    def self.all
+      PREFECTURE_CODE_NAME.map do |pref|
+        self.build(pref)
+      end
+    end
+  end
+end

data/lib/jp_prefecture/version.rb

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

data/spec/active_record_spec.rb

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

data/spec/jp_prefecture_spec.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe JpPrefecture do
+  describe '.include' do
+    subject do
+      Class.new(ActiveRecord::Base) do
+        include JpPrefecture
+      end
+    end
+
+    it { should respond_to(:jp_prefecture) }
+  end
+end

data/spec/prefecture_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+require 'rubygems'
+require 'jp_prefecture'
+
+require "active_record"
+
+require 'awesome_print'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    setup_db
+  end
+
+  config.after(:suite) do
+    teardown_db
+  end
+end
+
+def setup_db
+  ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :places do |t|
+      t.integer :prefecture_code
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: jp_prefecture
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- chocoby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- jp_prefecture.gemspec
+- lib/jp_prefecture.rb
+- lib/jp_prefecture/base.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/spec_helper.rb
+homepage: https://github.com/chocoby/jp_prefecture
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+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/spec_helper.rb
+has_rdoc: