jipcode-address_locator 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7d724f508557838d4bed4046b14e273c16b799c8f9a057d2f45dfff947d0c2
-  data.tar.gz: 37a2b5adc599fc0dc8eed2795e723eab8a43ded8e0f225503835fe8bc3fe64f3
+  metadata.gz: ac96c49da433461acb724242cf9afda8895d00913c48c400ad75f4c2025d73e1
+  data.tar.gz: d43fcc25ec3303c54b392e6b73c739ca9da8543555f743d056008a01277d2ce6
 SHA512:
-  metadata.gz: 6d9570d78d16667257237650fe5ccb6fe1625b8f2b41caea7f7398d6bcbe6921b6c008e29fa576bce2ab5c9b532b31bb30358673170a606bbdd79fc3683b9594
-  data.tar.gz: db79b508751d18b87b1d29b820dbaf67d2cb32a730efb7c674c934b93cd856cf04cc27a6014e61637fbbbe85bd5a545692528e75a88cd9f3ce7d14137b37fc68
+  metadata.gz: 00a0d6342e9294be6902f52d32afdc9b4a347f8385a0cdeaed5c64027e020dc7575f83e210bc96d23811fa992576e3298c0340e81ae78f25a023aadb6a99d46e
+  data.tar.gz: 4132cdc0057bf44e954f64163c84742b648b91b80d648309c56afcf4becdb0c70e9a5256511ba88a253ab094826cad9e711704bbfd0d9db6191a7d5cdc6bbeef

data/.gitignore

@@ -12,4 +12,6 @@
 .rspec_status
 .byebug_history
 
+Gemfile.lock
+
 /zipcode/by_prefecture/

data/README.md

@@ -3,7 +3,7 @@
 
 # Jipcode::AddressLocator
 
-[Jipcode](http://rubygems.org/gems/jipcode)に住所から郵便番号データを検索するメソッド(`locate_by_address`)を追加します。
+[jipcode](http://rubygems.org/gems/jipcode)に住所から郵便番号データを検索するメソッド(`locate_by_address`)を追加します。
 
 ## Installation
 
@@ -28,9 +28,7 @@ $ gem install jipcode-address_locator
 
 ### 住所から郵便番号情報を検索する
 
-[Jaro-Winkler](https://rubygems.org/gems/jaro_winkler)距離計算の結果から近い順に郵便番号情報を返します。
-
-[Jipcode](http://rubygems.org/gems/jipcode)の最新郵便番号のインデックスをまだ持っていない場合インデックスファイルを作成します。なので初回の処理は重いです
+[jaro-winkler](https://rubygems.org/gems/jaro_winkler)距離計算の結果から近い順に郵便番号情報を返す。
 
 ```ruby
 require 'jipcode'
@@ -38,11 +36,36 @@ require 'jipcode/address_locator'
 
 Jipcode.locate_by_address '東京都千代田区千代田1-1', prefecture_code: true, distance: true
 # [
+#   {:zipcode=>"1008111", :prefecture=>"東京都", :city=>"千代田区", :town=>"千代田１−１", :prefecture_code=>13, :distance=>1.0},
 #   {:zipcode=>"1000001", :prefecture=>"東京都", :city=>"千代田区", :town=>"千代田", :prefecture_code=>13, :distance=>0.9538461538461538},
 #   {:zipcode=>"1000000", :prefecture=>"東京都", :city=>"千代田区", :town=>nil, :prefecture_code=>13, :distance=>0.9076923076923077}
 # ]
 ```
 
+#### 備考
+
+[jipcode](http://rubygems.org/gems/jipcode)の該当するバージョンのインデックスをまだ持っていない場合インデックスファイルを作成する。
+
+受け取った住所は以下の正規化を行う。(`Jipcode::AddressLocator.normalize_address()`)
+
+- 全角の数字とハイフンを半角にする
+- 「漢数字 + `丁目`」 を「半角数字 + ハイフン」 にする
+- `丁目`、`番地`、`号`などをハイフンにする
+
+例
+```ruby
+Jipcode::AddressLocator.normalize_address('稲穂県ミドリ市一番町一丁目２の3番')
+# => '稲穂県ミドリ市一番町1-2-3'
+```
+
+### インデックスを更新する
+
+明示的にインデックスを作り直す場合は以下を実行する。
+
+```ruby
+Jipcode::AddressLocator.create_index!
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/jipcode-address_locator.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'jaro_winkler', '~> 1.5.3'
   spec.add_dependency 'jipcode', '~> 1.5.0'
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
 end

data/lib/jipcode/address_locator/ext_jipcode.rb

@@ -14,7 +14,7 @@ module Jipcode
 
     AddressLocator.locate(search_address).map do |address_param|
       address = extended_address_from(address_param, opt)
-      address[:distance] = address_param[4] if opt[:distance]
+      address[:distance] = address_param['distance'] if opt[:distance]
       address
     end
   end

data/lib/jipcode/address_locator/indexer.rb

@@ -2,6 +2,7 @@
 
 require 'csv'
 require 'jipcode/address_locator/helper'
+require 'jipcode/address_locator/normalizer'
 
 module Jipcode
   module AddressLocator
@@ -25,8 +26,6 @@ module Jipcode
       File.open(INDEX_VERSION_FILE, 'w') do |f|
         f.write(Jipcode::VERSION)
       end
-    rescue StandardError => e
-      raise e, 'Failed to create index'
     end
 
     # @private
@@ -37,25 +36,26 @@ module Jipcode
 
     # @private
     def self.collect_index
-      # 都道府県コードは1から始まるので一つ余計に作る
-      index = Array.new(PREFECTURE_CODE.size + 1) { [] }
+      index = 47.times.each_with_object({}) { |item, memo| memo[item + 1] = []; }
 
       Dir.glob("#{ZIPCODE_PATH}/*.csv").each do |file_name|
         CSV.read(file_name).each do |row|
-          _zipcode, prefecture_name, _city, _town = row
+          _zipcode, prefecture_name, city, town = row
+          row << normalize_address("#{prefecture_name}#{city}#{town}")
           prefecture_code = extract_prefecture_code(prefecture_name)
           index[prefecture_code] << row
         end
       end
-      index.shift
+
       index
     end
 
     # @private
     def self.export_index(index)
-      index.each.with_index(1) do |rows, prefecture_code|
+      index.each do |prefecture_code, rows|
         rows.sort_by! { |row| [row[0], row[2], row[3]] }
         CSV.open("#{INDEX_PATH}/#{prefecture_code}.csv", 'wb') do |csv|
+          csv << %w[zipcode prefecture_name city town normalized_address]
           rows.each { |row| csv << row }
         end
       end

data/lib/jipcode/address_locator/locator.rb

@@ -3,6 +3,7 @@
 require 'csv'
 require 'jaro_winkler'
 require 'jipcode/address_locator/helper'
+require 'jipcode/address_locator/normalizer'
 
 module Jipcode
   module AddressLocator
@@ -10,9 +11,11 @@ module Jipcode
     # @param [String] search_address
     # @return [Array<Hash>] zipcode data
     def self.locate(search_address)
-      find_by_address(search_address)
-        .yield_self { |addresses| calc_and_add_distance(addresses, search_address) }
-        .sort_by(&:last)
+      normalized = normalize_address(search_address)
+
+      find_by_address(normalized)
+        .map { |address| calc_and_add_distance!(address, normalized) }
+        .sort_by { |address| address['distance'] }
         .reverse
     end
 
@@ -22,8 +25,8 @@ module Jipcode
       path = "#{INDEX_PATH}/#{prefecture_code}.csv"
       return [] if prefecture_code.nil?
 
-      CSV.read(path).select do |row|
-        address = row[1..3].join('')
+      CSV.read(path, headers: true).select do |row|
+        address = row['normalized_address']
         # 長いほうが短い方に含まれてるか判別
         long = [address, search_address].max
         short = [address, search_address].min
@@ -32,14 +35,12 @@ module Jipcode
     end
 
     # @private
-    def self.calc_and_add_distance(addresses, search_address)
-      addresses.map do |row|
-        combined = row[1..3].join('')
-        distance = JaroWinkler.distance(combined, search_address)
-        row << distance
-      end
+    def self.calc_and_add_distance!(address, search_address)
+      distance = JaroWinkler.distance(address['normalized_address'], search_address)
+      address['distance'] = distance
+      address
     end
 
-    private_class_method :calc_and_add_distance, :find_by_address
+    private_class_method :calc_and_add_distance!, :find_by_address
   end
 end

data/lib/jipcode/address_locator/normalizer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Jipcode
+  module AddressLocator
+    # Normalize japanese address for search.
+    # @example
+    #   Jipcode::AddressLocator.normalize_address('稲穂県ミドリ市一番町一丁目２の3番')
+    #   # => '稲穂県ミドリ市一番町1-2-3'
+    # @param [String] raw_address
+    # @return [String] normalized address
+    def self.normalize_address(raw_address)
+      zenkaku2hankaku(raw_address)
+        .yield_self { |address| kansuji2hankaku(address) }
+        .yield_self { |address| jukyohyouji2hyphen(address) }
+    end
+
+    # 全角数字ハイフン→半角数字ハイフン
+    # @private
+    def self.zenkaku2hankaku(string)
+      string.tr('０-９', '0-9')
+            .tr('–−', '-')
+    end
+
+    # 住居表示の漢数字を半角数字に置き換える
+    # @private
+    def self.kansuji2hankaku(string)
+      # 漢数字は「丁目」の前に使われてるもののみを半角にする
+      string.gsub(/[一二三四五六七八九十]+丁目/) do |match|
+        match.tr('一二三四五六七八九', '1-9')
+        # TODO: 十丁目 -> 10、十三丁目 -> 13 二十丁目 -> 20
+      end
+    end
+
+    # 丁目・番・号・地割・番地をハイフンに置換する
+    #       1丁目2番3号 -> 1-2-3
+    #       1丁目2番3 -> 1-2-3
+    #       1丁目2-3 -> 1-2-3
+    #       1丁目2番 -> 1-2
+    #       1地割2番地 -> 1-2
+    #       1丁目2番地の3 -> 1-2-3
+    #       etc..
+    # @private
+    # @see https://ja.wikipedia.org/wiki/%E4%BD%8F%E5%B1%85%E8%A1%A8%E7%A4%BA
+    GAIKU_HYOUJI = %w[
+      丁目
+      番地
+      番
+      号
+      地割
+      の
+    ].freeze
+    def self.jukyohyouji2hyphen(string)
+      string.gsub(/\d(#{GAIKU_HYOUJI.join('|')})/) { |match| match.gsub(/(#{GAIKU_HYOUJI.join('|')})/, '-') }
+            .gsub(/-$/, '')
+    end
+
+    private_class_method :jukyohyouji2hyphen, :kansuji2hankaku, :zenkaku2hankaku
+  end
+end

data/lib/jipcode/address_locator/version.rb

@@ -2,6 +2,6 @@
 
 module Jipcode
   module AddressLocator
-    VERSION = '0.0.2'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jipcode-address_locator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - oieioi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jaro_winkler
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +70,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +120,6 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -132,6 +131,7 @@ files:
 - lib/jipcode/address_locator/helper.rb
 - lib/jipcode/address_locator/indexer.rb
 - lib/jipcode/address_locator/locator.rb
+- lib/jipcode/address_locator/normalizer.rb
 - lib/jipcode/address_locator/version.rb
 - zipcode/by_prefecture/latest/.gitkeep
 homepage: https://github.com/oieioi/jipcode-address_locator

data/Gemfile.lock

@@ -1,56 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jipcode-address_locator (0.0.2)
-      jaro_winkler (~> 1.5.3)
-      jipcode (~> 1.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    byebug (11.0.1)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.3)
-    jipcode (1.5.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.73.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  byebug
-  jipcode-address_locator!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   1.17.2