jp_prefecture 0.11.0 → 1.0.0.rc1

data/lib/jp_prefecture.rb

@@ -1,8 +1,9 @@
-# coding: utf-8
-require "jp_prefecture/base"
-require "jp_prefecture/config"
-require "jp_prefecture/prefecture"
-require "jp_prefecture/version"
+# frozen_string_literal: true
+
+require 'jp_prefecture/base'
+require 'jp_prefecture/config'
+require 'jp_prefecture/prefecture'
+require 'jp_prefecture/version'
 
 module JpPrefecture
   @config = Config.new

data/lib/jp_prefecture/base.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module JpPrefecture
   module Base
     # モデル内で使用するための設定を行う
@@ -34,7 +35,7 @@ module JpPrefecture
       method_name = options[:method_name] || :prefecture
 
       define_method method_name do
-        JpPrefecture::Prefecture.find(self.send(column_name))
+        JpPrefecture::Prefecture.find(send(column_name))
       end
     end
   end

data/lib/jp_prefecture/config.rb

@@ -1,9 +1,7 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 module JpPrefecture
   class Config
-    attr_accessor :mapping_data
-    attr_accessor :zip_mapping_data
+    attr_accessor :mapping_data, :zip_mapping_data
   end
 end
-

data/lib/jp_prefecture/mapping.rb

@@ -1,10 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'yaml'
 
 module JpPrefecture
   # コードと都道府県のマッピング
   module Mapping
-
     filepath = File.join(File.dirname(__FILE__), '../../data/prefecture.yml')
     @data = YAML.load_file(filepath)
 

data/lib/jp_prefecture/prefecture.rb

@@ -1,98 +1,46 @@
-# coding: utf-8
-require "jp_prefecture/mapping"
-require "jp_prefecture/zip_mapping"
+# frozen_string_literal: true
+
+require 'jp_prefecture/prefecture/finder'
+require 'jp_prefecture/mapping'
+require 'jp_prefecture/zip_mapping'
 
 module JpPrefecture
   # 都道府県のコードと名前を扱うクラス
   class Prefecture
-
     attr_accessor :code, :name, :name_e, :name_h, :name_k, :zips, :area, :type
 
-    # 配列から都道府県クラスを生成
+    # 都道府県コードから都道府県インスタンスを作成
     #
     # @example
-    #   # コード/名前から都道府県クラスを生成
-    #   JpPrefecture::Prefecture.build(1, '北海道', 'Hokkaido')
+    #   # 都道府県コードから都道府県インスタンスを生成
+    #   JpPrefecture::Prefecture.build_by_code(1)
     #
-    # @param pref [Integer] 都道府県コード
-    # @param name [String] 都道府県名
-    # @param name_e [String] 都道府県名(英語表記)
-    # @param optional name_h [String] 都道府県名(ひらがな表記)
-    # @param optional name_k [String] 都道府県名(カタカナ表記)
-    # @param optional area [String] 地方名
-    # @param zips [Array] 郵便番号の配列 (array of ranges, can be used in ARel, e.g. User.where(zip: prefecture.zips))
-    def self.build(code, name, name_e, name_h = nil, name_k = nil, area = nil)
-      pref = self.new
-
-      pref.code    = code
-      pref.name    = name
-      pref.name_e  = name_e.capitalize
-      pref.name_h  = name_h
-      pref.name_k  = name_k
-      pref.zips    = ZipMapping.data[code]
-      pref.area    = area
-      pref.type    =
+    # @param code [Integer] 都道府県コード
+    # @return [JpPrefecture::Prefecture] 都道府県インスタンス
+    # @return [nil] 都道府県が見つからない場合は nil
+    def self.build_by_code(code) # rubocop:disable Metrics/AbcSize
+      result = Mapping.data[code]
+      return unless result
+
+      pref = new
+
+      pref.code = code
+      pref.name = result[:name]
+      pref.name_e = result[:name_e].capitalize
+      pref.name_h = result[:name_h]
+      pref.name_k = result[:name_k]
+      pref.zips = ZipMapping.data[code]
+      pref.area = result[:area]
+      pref.type =
         case pref.name[-1]
-        when "都", "道", "府", "県"
+        when '都', '道', '府', '県'
           pref.name[-1]
-        else
-          nil
         end
 
       pref
     end
 
-    # 都道府県を検索
-    #
-    # @example
-    #   # 都道府県コードから検索
-    #   JpPrefecture::Prefecture.find(1)
-    #   JpPrefecture::Prefecture.find(code: 1)
-    #
-    #   # 都道府県名から検索
-    #   JpPrefecture::Prefecture.find(name: '北海道')
-    #
-    #   # 都道府県名から検索(前方一致)
-    #   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 都道府県名/英語/ひらがな/カタカナ表記の都道府県名
-    # @option args [Integer] :zip 郵便番号
-    # @return [JpPrefecture::Prefecture] 都道府県が見つかった場合は都道府県クラス
-    # @return [nil] 都道府県が見つからない場合は nil
-    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
-          when :zip
-            ZipMapping.code_for_zip(args[:zip].to_i)
-          end
-      end
-
-      names = Mapping.data[code]
-
-      return unless names
-
-      self.build(code,
-                 names[:name], names[:name_e],
-                 names[:name_h], names[:name_k], names[:area])
-    end
-
-    # すべての都道府県クラスを返す
+    # すべての都道府県を取得
     #
     # @example
     #   # 都道府県の一覧を取得
@@ -104,38 +52,56 @@ module JpPrefecture
     #   # collection_select で選択肢を生成(英語表記)
     #   f.collection_select :prefecture_code, JpPrefecture::Prefecture.all, :code, :name_e
     #
-    # @return [Array] 都道府県クラスの配列
+    # @return [Array<JpPrefecture::Prefecture>] 都道府県インスタンスの配列
     def self.all
-      Mapping.data.map do |pref|
-        names = pref[1]
-        self.build(pref[0],
-                   names[:name], names[:name_e],
-                   names[:name_h], names[:name_k], names[:area])
-      end
+      Mapping.data.map { |code, _| build_by_code(code) }
     end
 
-  protected
-
-    # 名前から都道府県コードを前方一致で検索
+    # 都道府県を検索
+    #
+    # 文字列は前方一致で検索する
+    #
+    # @example
+    #   # 都道府県コードを検索
+    #   JpPrefecture::Prefecture.find(1)
+    #   JpPrefecture::Prefecture.find(code: 1)
+    #
+    #   # 都道府県名を検索
+    #   JpPrefecture::Prefecture.find(name: '北海道')
+    #   JpPrefecture::Prefecture.find(name: '東京')
+    #
+    #   # 英語表記の都道府県名を検索
+    #   JpPrefecture::Prefecture.find(name_e: 'Hokkaido')
+    #   JpPrefecture::Prefecture.find(name_e: 'hokkaido')
+    #
+    #   # ひらがな表記の都道府県名を検索
+    #   JpPrefecture::Prefecture.find(name_h: 'ほっかいどう')
     #
-    # @param name [String] 検索する都道府県名
-    # @return [Integer] 見つかった場合は都道府県コード
-    # @return [nil] 見つからない場合は nil
-    def self.find_code_by_name(name)
-      return nil if name.nil? || name.empty?
+    #   # カタカナ表記の都道府県名を検索
+    #   JpPrefecture::Prefecture.find(name_k: 'ホッカイドウ')
+    #
+    #   # すべての項目を検索
+    #   JpPrefecture::Prefecture.find(all_fields: '東')
+    #
+    # @param args [Integer] 都道府県コード
+    # @param args [Hash<Symbol, Integer>] :code 都道府県コード
+    # @param args [Hash<Symbol, String>] :name 漢字表記/:name_e 英語表記/:name_h ひらがな表記/:name_k カタカナ表記
+    # @param args [Hash<Symbol, Integer>] :zip 郵便番号
+    # @param args [Hash<Symbol, (String, Integer)>] :all_fields マッピングに定義しているすべてのフィールドから検索
+    # @return [JpPrefecture::Prefecture] 都道府県が見つかった場合は都道府県インスタンス
+    # @return [nil] 都道府県が見つからない場合は nil
+    def self.find(args)
+      return if args.nil?
 
-      name = name.downcase
+      case args
+      when Integer, String
+        JpPrefecture::Prefecture::Finder.new.find(field: nil, value: args)
+      when Hash
+        search_field = args.keys.first
+        search_value = args.values.first
 
-      Mapping.data.each do |m|
-        m[1].values.each do |v|
-          if v.start_with?(name)
-            return m[0]
-          end
-        end
+        JpPrefecture::Prefecture::Finder.new.find(field: search_field, value: search_value)
       end
-
-      nil
     end
-
   end
 end

data/lib/jp_prefecture/prefecture/finder.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'jp_prefecture/mapping'
+require 'jp_prefecture/zip_mapping'
+
+module JpPrefecture
+  class Prefecture
+    # 都道府県の検索を行うクラス
+    class Finder
+      def initialize
+        @mapping = Mapping.data
+      end
+
+      # 指定した項目を検索
+      #
+      # @param field [Symbol] 検索する項目。nil の場合は都道府県コードとして扱う
+      # @param value [String, Integer] 検索する内容
+      # @return [JpPrefecture::Prefecture] 都道府県が見つかった場合は都道府県インスタンス
+      # @return [nil] 都道府県が見つからない場合は nil
+      def find(field:, value:)
+        code = find_code(field, value)
+        JpPrefecture::Prefecture.build_by_code(code)
+      end
+
+      private
+
+      # @param field [Symbol] 検索する項目
+      # @param value [String, Integer] 検索する内容
+      # @return [Integer] 見つかった場合は都道府県コード
+      # @return [nil] 見つからない場合は nil
+      def find_code(field, value)
+        return value.to_i if field.nil?
+
+        case field
+        when :all_fields
+          find_code_by_name_from_all_fields(value)
+        when :name, :name_h, :name_k, :name_e
+          find_code_by_name(field, value)
+        when :code
+          value.to_i
+        when :zip
+          ZipMapping.code_for_zip(value.to_i)
+        end
+      end
+
+      # すべての項目を前方一致で検索
+      def find_code_by_name_from_all_fields(value)
+        return if value.nil? || value.empty?
+
+        value = value.downcase
+
+        @mapping.each do |m|
+          m[1].each_value do |v|
+            return m[0] if v.start_with?(value)
+          end
+        end
+      end
+
+      # 指定した項目を前方一致で検索
+      def find_code_by_name(field, value)
+        return if value.nil? || value.empty?
+
+        value = value.downcase
+
+        @mapping.each do |m|
+          return m[0] if m[1][field].start_with?(value)
+        end
+      end
+    end
+  end
+end

data/lib/jp_prefecture/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JpPrefecture
-  VERSION = '0.11.0'
+  VERSION = '1.0.0.rc1'
 end

data/lib/jp_prefecture/zip_mapping.rb

@@ -1,21 +1,21 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'yaml'
 
 module JpPrefecture
   # コードと郵便番号のマッピング
   module ZipMapping
-
     filepath = File.join(File.dirname(__FILE__), '../../data/zip.yml')
     @data = YAML.load_file(filepath)
-    @data = Hash[*@data.collect{|code, arr|[code, arr.collect{|zip_from, zip_to|zip_from..zip_to}]}.flatten(1)]
+    @data = Hash[*@data.collect { |code, arr| [code, arr.collect { |zip_from, zip_to| zip_from..zip_to }] }.flatten(1)]
 
     def self.data
       JpPrefecture.config.zip_mapping_data || @data
     end
 
-    def self.code_for_zip zip
-      self.data.select do |code, zip_ranges|
-        zip_ranges.find{|range|range.include? zip}
+    def self.code_for_zip(zip)
+      data.select do |_code, zip_ranges|
+        zip_ranges.find { |range| range.include? zip }
       end.keys.first
     end
   end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jp_prefecture
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
-- chocoby
+- "@chocoby"
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,21 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop-performance
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,51 +164,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Convert japan prefecture code(JIS X 0402 based) into prefecture name.
+description: Convert japan prefecture code (JIS X 0402 based) into prefecture name.
 email:
 - chocoby@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".rspec"
-- ".yardopts"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
-- MIT-LICENSE
+- 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
-- gemfiles/rails51.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/rails60.gemfile
-- gemfiles/rails61.gemfile
-- jp_prefecture.gemspec
 - lib/jp_prefecture.rb
 - lib/jp_prefecture/base.rb
 - lib/jp_prefecture/config.rb
 - lib/jp_prefecture/mapping.rb
 - lib/jp_prefecture/prefecture.rb
+- lib/jp_prefecture/prefecture/finder.rb
 - lib/jp_prefecture/version.rb
 - lib/jp_prefecture/zip_mapping.rb
-- spec/base_spec.rb
-- spec/config_spec.rb
-- spec/fixtures/prefecture.yml
-- spec/jp_prefecture_spec.rb
-- spec/mapping_spec.rb
-- spec/prefecture_spec.rb
-- spec/spec_helper.rb
-- spec/zip_mapping_spec.rb
 homepage: https://github.com/chocoby/jp_prefecture
 licenses:
 - MIT
@@ -165,23 +197,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Convert japan prefecture code into prefecture name
-test_files:
-- spec/base_spec.rb
-- spec/config_spec.rb
-- spec/fixtures/prefecture.yml
-- spec/jp_prefecture_spec.rb
-- spec/mapping_spec.rb
-- spec/prefecture_spec.rb
-- spec/spec_helper.rb
-- spec/zip_mapping_spec.rb
+test_files: []