jipcode-address_locator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29133c15968ba53a9a3184f33d98e3758abf44b9ff0e6d17cd2c168e50b6dea4
+  data.tar.gz: a73ff328a9fb2dbcbee58606f18ecb9a79fceb245f0537500ac2edcf54deeac1
+SHA512:
+  metadata.gz: 74a9c74f430c5e1d03df327f15577e3f3447d3c76c41b994a8101fcfb264c010a3c9bdd8d3949ac7f6a99b81c7eaf729bd20e578c9d9ff63975d3ec5ede21361
+  data.tar.gz: adfc4b5bbb956dc2d5b866427fcc461ca1c2b5b79ef6e732a27b69a89fee37c94704493b926103ffed07ec00a04ffe102e4cc375d88e38bf834e80d4d617ecf5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+
+/zipcode/by_prefecture/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Naming/FileName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 130
+
+Style/Documentation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install:
+  - gem install bundler -v 1.16.1
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jipcode.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    jipcode-address_locator (0.0.1)
+      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

data/LICENSE

@@ -0,0 +1,43 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kei Hayashi
+
+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.
+
+MIT License
+
+Copyright (c) 2019 oieioi
+
+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,47 @@
+[![Build Status](https://travis-ci.com/oieioi/jipcode-address_locator.svg?branch=master)](https://travis-ci.com/oieioi/jipcode-address_locator)
+
+# Jipcode::AddressLocator
+
+[Jipcode](http://rubygems.org/gems/jipcode)に住所から郵便番号データを検索するメソッド(`locate_by_address`)を追加します。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jipcode-address_locator'
+```
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install jipcode-address_locator
+```
+
+## 使用方法
+
+### 住所から郵便番号情報を検索する
+
+[Jaro-Winkler](https://rubygems.org/gems/jaro_winkler)距離計算の結果から近い順に郵便番号情報を返します。
+
+[Jipcode](http://rubygems.org/gems/jipcode)の最新郵便番号のインデックスをまだ持っていない場合インデックスファイルを作成します。なので初回の処理は重いです
+
+```ruby
+require 'jipcode'
+require 'jipcode/address_locator'
+
+Jipcode.locate_by_address '東京都千代田区千代田1-1', prefecture_code: true, distance: true
+# [
+#   {:zipcode=>"1000001", :prefecture=>"東京都", :city=>"千代田区", :town=>"千代田", :prefecture_code=>13, :distance=>0.9538461538461538},
+#   {:zipcode=>"1000000", :prefecture=>"東京都", :city=>"千代田区", :town=>nil, :prefecture_code=>13, :distance=>0.9076923076923077}
+# ]
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'jipcode-address_locator'
+require 'byebug'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jipcode-address_locator.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jipcode/address_locator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jipcode-address_locator'
+  spec.version       = Jipcode::AddressLocator::VERSION
+  spec.authors       = ['oieioi']
+  spec.email         = ['atsuinatsu.samuifuyu@gmail.com']
+
+  spec.summary       = 'Extend jipcode.gem to locate zipcode data by address'
+  spec.description   = 'Extend jipcode.gem to locate zipcode data by address'
+  spec.homepage      = 'https://github.com/oieioi/jipcode-address_locator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  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 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/jipcode/address_locator/helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Jipcode
+  module AddressLocator
+    # @private
+    def self.extract_prefecture_code(address)
+      prefecture_name = address.match(/\A(#{prefecture_names.join('|')})/).to_s
+      PREFECTURE_CODE.invert[prefecture_name]
+    end
+
+    # @private
+    def self.prefecture_names
+      PREFECTURE_CODE.values
+    end
+
+    private_class_method :prefecture_names, :extract_prefecture_code
+  end
+end

data/lib/jipcode/address_locator/indexer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'jipcode/address_locator/helper'
+
+module Jipcode
+  module AddressLocator
+    # Make sure Jipcode version and index version are the same.
+    # @return [Boolean] result
+    def self.exist_latest_index?
+      return false unless File.exist?(INDEX_VERSION_FILE)
+
+      version = File.read(INDEX_VERSION_FILE)
+      version == Jipcode::VERSION
+    end
+
+    # Create index files by Jipcode data.
+    def self.create_index!
+      refresh_index_dir
+
+      index = collect_index
+
+      export_index(index)
+
+      File.open(INDEX_VERSION_FILE, 'w') do |f|
+        f.write(Jipcode::VERSION)
+      end
+    rescue StandardError => e
+      raise e, 'Failed to create index'
+    end
+
+    # @private
+    def self.refresh_index_dir
+      FileUtils.rm_rf(INDEX_PATH) if File.exist?(INDEX_PATH)
+      Dir.mkdir(INDEX_PATH)
+    end
+
+    # @private
+    def self.collect_index
+      # 都道府県コードは1から始まるので一つ余計に作る
+      index = Array.new(PREFECTURE_CODE.size + 1) { [] }
+
+      Dir.glob("#{ZIPCODE_PATH}/*.csv").each do |file_name|
+        CSV.read(file_name).each do |row|
+          _zipcode, prefecture_name, _city, _town = row
+          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|
+        rows.sort_by! { |row| [row[0], row[2], row[3]] }
+        CSV.open("#{INDEX_PATH}/#{prefecture_code}.csv", 'wb') do |csv|
+          rows.each { |row| csv << row }
+        end
+      end
+    end
+
+    private_class_method :refresh_index_dir, :collect_index, :export_index
+  end
+end

data/lib/jipcode/address_locator/locator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'jaro_winkler'
+require 'jipcode/address_locator/helper'
+
+module Jipcode
+  module AddressLocator
+    # Locate zipcode data by address
+    # @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)
+        .reverse
+    end
+
+    # @private
+    def self.find_by_address(search_address)
+      prefecture_code = extract_prefecture_code(search_address)
+      path = "#{INDEX_PATH}/#{prefecture_code}.csv"
+      return [] if prefecture_code.nil?
+
+      CSV.read(path).select do |row|
+        address = row[1..3].join('')
+        # 長いほうが短い方に含まれてるか判別
+        long = [address, search_address].max
+        short = [address, search_address].min
+        long.start_with?(short)
+      end
+    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
+    end
+
+    private_class_method :calc_and_add_distance, :find_by_address
+  end
+end

data/lib/jipcode/address_locator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jipcode
+  module AddressLocator
+    VERSION = '0.0.1'
+  end
+end

data/lib/jipcode/address_locator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'jipcode/address_locator/locator'
+require 'jipcode/address_locator/indexer'
+require 'jipcode/address_locator/version'
+
+module Jipcode
+  module AddressLocator
+    INDEX_PATH = "#{File.dirname(__FILE__)}/../../zipcode/by_prefecture/latest"
+    INDEX_VERSION_FILE = "#{File.dirname(__FILE__)}/../../zipcode/by_prefecture/version"
+  end
+end

data/lib/jipcode-address_locator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'jipcode/address_locator'
+
+module Jipcode
+  # Find zipcode data by address.
+  # @note If there are no index files, this method creates them from jipcode.gem data.
+  # @param [String] search_address
+  # @param [Hash] opt the options to create results.
+  # @option opt [String] :distance return with jaro winkler distance
+  # @return [Array<Hash>] zipcode data
+  def self.locate_by_address(search_address, opt = {})
+    AddressLocator.create_index! unless AddressLocator.exist_latest_index?
+
+    AddressLocator.locate(search_address).map do |address_param|
+      address = extended_address_from(address_param, opt)
+      address[:distance] = address_param[4] if opt[:distance]
+      address
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: jipcode-address_locator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- oieioi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jaro_winkler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: jipcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: Extend jipcode.gem to locate zipcode data by address
+email:
+- atsuinatsu.samuifuyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jipcode-address_locator.gemspec
+- lib/jipcode-address_locator.rb
+- lib/jipcode/address_locator.rb
+- lib/jipcode/address_locator/helper.rb
+- lib/jipcode/address_locator/indexer.rb
+- lib/jipcode/address_locator/locator.rb
+- lib/jipcode/address_locator/version.rb
+- zipcode/by_prefecture/latest/.gitkeep
+homepage: https://github.com/oieioi/jipcode-address_locator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extend jipcode.gem to locate zipcode data by address
+test_files: []