japanese_address_parser 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4b877e72c86cffe1eb4df73573840a2be13e223310239f390cbfa377229eb5a
-  data.tar.gz: 7f24361d7258becc95379c2479b5dfcece30290ec22d031e8e56cdbb9e6147b9
+  metadata.gz: dcce626ea8eb1f3c3e2099781dbe27a1e8ec4c8b9ef8256382ced63481f83849
+  data.tar.gz: 9445753fbce527763ed50cb88adb1f1f00c7fedc1c21cc959c7f6c7c7b1fbfe4
 SHA512:
-  metadata.gz: 28b4114891fe592f84c6c4b257b8c0366c5248d36c132f54e8915f2b762be8a11cd3b83c7432d41b0ceb0258ad3aaf86e9bd81c674a09796cb479e60708f2b03
-  data.tar.gz: ce6f745d663fd224f5b34e47fd85364244ad028ef0d771a3fd527e23dbf54b836258be64d874e6f9ba74ec0ee162016e7df3a711034dae0ba8cfa675487ba586
+  metadata.gz: 6eb0c0f7aa0dc7775cd28b6f246a307c91d612429b086422406d562f68dd7c992dcccc05be5c2cef13319dd0e98a2748be50808dd14bcff18a169370b59e17d1
+  data.tar.gz: 23f4f05762a7c9bf71f074defca75b6a09bb3d63fc0bb6b1d42cbcb8169c231aa3d09667fa6d54d4791953ec27806b457feb82be2a557f8c09d02865982e03cd

data/.rubocop.yml

@@ -24,11 +24,14 @@ Style/Copyright:
 Style/AsciiComments:
   Enabled: false
 
-# CSVのヘッダーの日本語を解釈するために日本語文字列のハッシュを許容する。
 Style/StringHashKeys:
   Exclude:
+    # CSVのヘッダーの日本語を解釈するために日本語文字列のハッシュを許容する。
     - lib/japanese_address_parser/csv_parser.rb
 
+    # ライブラリが返すハッシュのキーが文字列なので許容する。
+    - spec/japanese_address_parser/address_normalizer_spec.rb
+
 # elseがない場合にはcase文ではなくif文を許容する。
 Style/MissingElse:
   EnforcedStyle: case

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-01-08 06:12:26 UTC using RuboCop version 1.24.1.
+# on 2022-02-05 13:11:56 UTC using RuboCop version 1.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,44 +13,34 @@ Layout/RedundantLineBreak:
   Exclude:
     - 'lib/japanese_address_parser/csv_parser.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 39
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 27
 
-# Offense count: 5
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 36
+  Max: 13
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 308
+  Max: 117
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 9
-
-# Offense count: 6
+# Offense count: 4
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 287
+  Max: 6
 
-# Offense count: 10
+# Offense count: 4
 RSpec/MultipleExpectations:
-  Max: 287
+  Max: 5
 
 # Offense count: 9
 # Configuration parameters: AllowedConstants.
@@ -59,31 +49,32 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/japanese_address_parser.rb'
+    - 'lib/japanese_address_parser/address_normalizer.rb'
+    - 'lib/japanese_address_parser/address_normalizer/normalize_japanese_addresses_schmoozer.rb'
     - 'lib/japanese_address_parser/address_parser.rb'
-    - 'lib/japanese_address_parser/address_parser/pattern_creator.rb'
-    - 'lib/japanese_address_parser/address_parser/town_and_after_normalizer.rb'
     - 'lib/japanese_address_parser/csv_parser.rb'
     - 'lib/japanese_address_parser/models/address.rb'
     - 'lib/japanese_address_parser/models/city.rb'
     - 'lib/japanese_address_parser/models/prefecture.rb'
     - 'lib/japanese_address_parser/models/town.rb'
 
-# Offense count: 26
+# Offense count: 27
 # Configuration parameters: RequireForNonPublicMethods.
 Style/DocumentationMethod:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/japanese_address_parser.rb'
+    - 'lib/japanese_address_parser/address_normalizer.rb'
+    - 'lib/japanese_address_parser/address_normalizer/normalize_japanese_addresses_schmoozer.rb'
     - 'lib/japanese_address_parser/address_parser.rb'
-    - 'lib/japanese_address_parser/address_parser/town_and_after_normalizer.rb'
     - 'lib/japanese_address_parser/csv_parser.rb'
     - 'lib/japanese_address_parser/models/address.rb'
     - 'lib/japanese_address_parser/models/city.rb'
     - 'lib/japanese_address_parser/models/prefecture.rb'
     - 'lib/japanese_address_parser/models/town.rb'
 
-# Offense count: 8
+# Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -17,6 +17,11 @@ Change Log の形式は [Keep a Changelog](http://keepachangelog.com/) に従い
 
 ### Security
 
+## [2.1.0] - 2022-02-05
+### Changed
+
+- [#38](https://github.com/yamat47/japanese_address_parser/pull/38) 住所の解析に失敗したときに発生する例外のクラスを`JapaneseAddressParser::NormalizeError`に固定した。([@yamat47](https://github.com/yamat47))
+
 ## [2.0.0] - 2022-01-31
 ### Added
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    japanese_address_parser (2.0.0)
+    japanese_address_parser (2.1.0)
       schmooze
 
 GEM

data/README.md

@@ -88,23 +88,9 @@ address.furigana #=> "トウキョウトミナトクシバコウエン 4"
 | `longitude` | 経度 | `"141.319722"` |
 </details>
 
-都道府県や市区町村、町域のそれぞれの属性の値は geolonia/japanese-addresses が提供している CSV ファイルの値そのままです。
+都道府県や市区町村、町域のそれぞれの属性の値は [geolonia/japanese-addresses](https://github.com/geolonia/japanese-addresses) が提供している CSV ファイルの値そのままです。
 
-与えられた住所からうまく地名が見つけられないときはそれ以降の探索を中止します。
-見つけられた地名のデータだけを含んだデータを返します。
-
-```ruby
-musashi = JapaneseAddressParser.call('武蔵国港区芝公園4-2-8')
-musashi.prefecture #=> nil
-musashi.city #=> nil
-musashi.town #=> nil
-
-kounan = JapaneseAddressParser.call('東京都港南区芝公園4-2-8')
-kounan.prefecture.name #=> "東京都"
-kounan.city #=> nil
-kounan.town #=> nil
-kounan.furigana #=> "トウキョウト"
-```
+何らかの理由で住所の解析に失敗したときは `JapaneseAddressParser::NormalizeError` を `raise` します。
 
 ## 開発
 開発に必要なライブラリをインストールするには、このコマンドを実行してください：

data/lib/japanese_address_parser/address_normalizer/normalize_japanese_addresses_schmoozer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'schmooze'
+
+module JapaneseAddressParser
+  module AddressNormalizer
+    class NormalizeJapaneseAddressesSchmoozer < ::Schmooze::Base
+      JS_PACKAGE_PATH = ::File.expand_path('../../../js', __dir__)
+      public_constant :JS_PACKAGE_PATH
+
+      dependencies normalize_japanese_addresses: '@geolonia/normalize-japanese-addresses'
+      method :normalize, 'normalize_japanese_addresses.normalize'
+
+      def self.call(full_address)
+        new(::JapaneseAddressParser::AddressNormalizer::NormalizeJapaneseAddressesSchmoozer::JS_PACKAGE_PATH).normalize(full_address)
+      end
+    end
+  end
+end

data/lib/japanese_address_parser/address_normalizer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'address_normalizer/normalize_japanese_addresses_schmoozer'
+require_relative 'exceptions'
+
+module JapaneseAddressParser
+  module AddressNormalizer
+    def call(full_address)
+      # https://github.com/geolonia/normalize-japanese-addresses を使って住所を正規化する。
+      ::JapaneseAddressParser::AddressNormalizer::NormalizeJapaneseAddressesSchmoozer.call(full_address)
+
+    # Schmoozeが稀に例外を吐くことがある。
+    # ライブラリを利用するときに扱いやすくするために例外のクラスを固定しておく。
+    rescue ::StandardError
+      raise(::JapaneseAddressParser::NormalizeError)
+    end
+
+    module_function :call
+  end
+end

data/lib/japanese_address_parser/exceptions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JapaneseAddressParser
+  class NormalizeError < StandardError; end
+end

data/lib/japanese_address_parser/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module JapaneseAddressParser
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
   public_constant :VERSION
 end

data/lib/japanese_address_parser.rb

@@ -1,22 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'japanese_address_parser/address_normalizer'
 require_relative 'japanese_address_parser/address_parser'
 require_relative 'japanese_address_parser/version'
-require_relative 'japanese_address_parser/normalize_japanese_addresses_schmoozer'
 
 module JapaneseAddressParser
-  JS_PACKAGE_PATH = ::File.expand_path('../js', __dir__)
-  public_constant :JS_PACKAGE_PATH
-
   module_function
 
   def call(full_address)
-    # https://github.com/geolonia/normalize-japanese-addresses を使って住所を正規化する。
-    normalize_japanese_addresses = ::JapaneseAddressParser::NormalizeJapaneseAddressesSchmoozer.new(::JapaneseAddressParser::JS_PACKAGE_PATH)
-    result = normalize_japanese_addresses.normalize(full_address)
+    normalized = ::JapaneseAddressParser::AddressNormalizer.call(full_address)
 
     # このライブラリで探索するのは町域まで。
     # それ以降のデータを使って探索するとデータと名前が一致しないことがあるので、町域までのデータを使う。
-    ::JapaneseAddressParser::AddressParser.call("#{result['pref']}#{result['city']}#{result['town']}")
+    ::JapaneseAddressParser::AddressParser.call("#{normalized['pref']}#{normalized['city']}#{normalized['town']}")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japanese_address_parser
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Yamaguchi Takuya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schmooze
@@ -252,6 +252,8 @@ files:
 - js/package-lock.json
 - js/package.json
 - lib/japanese_address_parser.rb
+- lib/japanese_address_parser/address_normalizer.rb
+- lib/japanese_address_parser/address_normalizer/normalize_japanese_addresses_schmoozer.rb
 - lib/japanese_address_parser/address_parser.rb
 - lib/japanese_address_parser/csv_parser.rb
 - lib/japanese_address_parser/data/01-01101.csv
@@ -2196,11 +2198,11 @@ files:
 - lib/japanese_address_parser/data/47-47382.csv
 - lib/japanese_address_parser/data/47.csv
 - lib/japanese_address_parser/data/prefectures.csv
+- lib/japanese_address_parser/exceptions.rb
 - lib/japanese_address_parser/models/address.rb
 - lib/japanese_address_parser/models/city.rb
 - lib/japanese_address_parser/models/prefecture.rb
 - lib/japanese_address_parser/models/town.rb
-- lib/japanese_address_parser/normalize_japanese_addresses_schmoozer.rb
 - lib/japanese_address_parser/version.rb
 - sig/japanese_address_parser.rbs
 homepage: https://github.com/yamat47/japanese_address_parser

data/lib/japanese_address_parser/normalize_japanese_addresses_schmoozer.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'schmooze'
-
-module JapaneseAddressParser
-  class NormalizeJapaneseAddressesSchmoozer < ::Schmooze::Base
-    dependencies normalize_japanese_addresses: '@geolonia/normalize-japanese-addresses'
-    method :normalize, 'normalize_japanese_addresses.normalize'
-  end
-end