japanese_address_parser 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72363aa74cf45e200716ce789f6755ea43b23b556d913a76cd4479e88c44e571
-  data.tar.gz: 844e5565b51f6cb3d630b244d77c6197cbbc35e6f57015d807ef546173e03f59
+  metadata.gz: 0a042febb9a10f78adeadbd23f6e99a97c69817546479ecbd2dc1cd1fe6f5f50
+  data.tar.gz: ed7d82baf90223493a3cb0e33b21afb2a61779cd57718e18f63358ddc963d66f
 SHA512:
-  metadata.gz: 780a695538d70fdded3cc8a2be167241f006fa4719658cb7d556d52911be7a91addb6fdea8a7989fcccd945229fa3f8a4dc76007f982f9ba8a5c9a39c175e6e8
-  data.tar.gz: 98ba158b5ccce3fd5b49f6e1ca1eb0f9a3958dbaf0f0d1bb6bddd944208cea89f29195b5688ed43d2b687653e92e9caad3d60f0c0a8cad00e0cd3a0797d3d0ab
+  metadata.gz: fbfe12bdc50a1eaacba31ad237a6034a3d1db4961d2f50b061ab862961753d4a62dc9515cc0d96373d1f432599906a49617687b5ed3b1f89ebf032c6110a0709
+  data.tar.gz: 00f949e850de4bd327af851ed3ff4d046423a73473b2a847f5b316fc91cb0dccc4ae06ebd36c7567b75bef8f690a8e48a13ba1c0464ca1ab4b655e874ec558c3

data/CHANGELOG.md

@@ -17,6 +17,11 @@ Change Log の形式は [Keep a Changelog](http://keepachangelog.com/) に従い
 
 ### Security
 
+## [3.0.1] - 2022-09-25
+### Added
+
+- [#53](https://github.com/yamat47/japanese_address_parser/pull/53) Steepでの型検査の仕組みを導入した。([@yamat47](https://github.com/yamat47))
+
 ## [3.0.0] - 2022-09-25
 ### Added
 

data/Dockerfile

@@ -13,3 +13,5 @@ WORKDIR $APP_HOME
 COPY . $APP_HOME
 
 RUN bundle install
+
+CMD sh -c "/bin/sh"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    japanese_address_parser (3.0.0)
+    japanese_address_parser (3.0.1)
       schmooze
 
 GEM
@@ -17,15 +17,24 @@ GEM
     diff-lcs (1.5.0)
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
+    ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
+    language_server-protocol (3.17.0.1)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.6.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -59,6 +68,19 @@ GEM
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     schmooze (0.2.0)
+    steep (1.1.1)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    typeprof (0.21.3)
+      rbs (>= 1.8.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
@@ -78,6 +100,8 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
+  steep
+  typeprof
 
 BUNDLED WITH
    2.3.3

data/Steepfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+  ignore 'lib/japanese_address_parser/csv_parser.rb'
+
+  configure_code_diagnostics(::Steep::Diagnostic::Ruby.strict)
+end
+
+target :test do
+  signature 'sig'
+
+  check 'spec'
+
+  configure_code_diagnostics(::Steep::Diagnostic::Ruby.strict)
+end

data/docker-compose.yml

@@ -2,5 +2,6 @@ version: "3"
 services:
   gemsrc:
     build: .
+    tty: true
     volumes:
       - .:/gemsrc

data/japanese_address_parser.gemspec

@@ -38,5 +38,7 @@ require_relative 'lib/japanese_address_parser/version'
   spec.add_development_dependency('rubocop')
   spec.add_development_dependency('rubocop-rake')
   spec.add_development_dependency('rubocop-rspec')
+  spec.add_development_dependency('steep')
+  spec.add_development_dependency('typeprof')
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/japanese_address_parser/address_normalizer/normalize_japanese_addresses_schmoozer.rb

@@ -5,10 +5,12 @@ require 'schmooze'
 module JapaneseAddressParser
   module AddressNormalizer
     class NormalizeJapaneseAddressesSchmoozer < ::Schmooze::Base
-      JS_PACKAGE_PATH = ::File.expand_path('../../../js', __dir__)
+      current_dir = __dir__ || ''
+
+      JS_PACKAGE_PATH = ::File.expand_path('../../../js', current_dir)
       public_constant :JS_PACKAGE_PATH
 
-      JAPANESE_API_PATH = "file://#{::File.expand_path('../data/geolonia-japanese-addresses/api/ja', __dir__)}"
+      JAPANESE_API_PATH = "file://#{::File.expand_path('../data/geolonia-japanese-addresses/api/ja', current_dir)}"
       public_constant :JAPANESE_API_PATH
 
       dependencies normalize_japanese_addresses: '@geolonia/normalize-japanese-addresses'

data/lib/japanese_address_parser/version.rb

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

data/sig/japanese_address_parser.rbs

@@ -1,4 +1,81 @@
+# TypeProf 0.21.3
+
+# Classes
 module JapaneseAddressParser
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  def self.call: (String full_address) -> Models::Address?
+  def self.call!: (String full_address) -> Models::Address
+  def self._call: (String full_address) -> Models::Address
+
+  module AddressNormalizer
+    def self.call: (String full_address) -> String
+
+    class NormalizeJapaneseAddressesSchmoozer < Schmooze::Base
+      JS_PACKAGE_PATH: String
+      JAPANESE_API_PATH: String
+
+      def self.call: (String full_address) -> String
+    end
+  end
+
+  module Models
+    class Address
+      def initialize: (full_address: String, prefecture: String, city: String, town: String) -> void
+      def furigana: -> String
+      attr_reader full_address: String
+      attr_reader prefecture: String
+      attr_reader city: String
+      attr_reader town: String
+    end
+
+    class Town
+      def initialize: (name: String, name_kana: String, name_romaji: String, nickname: String, latitude: String, longitude: String) -> void
+      def attributes: -> {name: String, name_kana: String, name_romaji: String, nickname: String, latitude: String, longitude: String}
+      attr_reader name: String
+      attr_reader name_kana: String
+      attr_reader name_romaji: String
+      attr_reader nickname: String
+      attr_reader latitude: String
+      attr_reader longitude: String
+    end
+
+    class City
+      def initialize: (code: String, prefecture_code: String, name: String, name_kana: String, name_romaji: String) -> void
+      def formatted_code: -> String
+      def attributes: -> {code: String, prefecture_code: String, name: String, name_kana: String, name_romaji: String}
+      def prefecture: -> Models::Prefecture?
+      def towns: -> Array[Models::Town]
+      attr_reader code: String
+      attr_reader prefecture_code: String
+      attr_reader name: String
+      attr_reader name_kana: String
+      attr_reader name_romaji: String
+    end
+
+    class Prefecture
+      def self.all: -> Array[Models::Prefecture]
+      def initialize: (code: String, name: String, name_kana: String, name_romaji: String) -> void
+      def attributes: -> {code: String, name: String, name_kana: String, name_romaji: String}
+      def cities: -> Array[Models::City]
+      attr_reader code: String
+      attr_reader name: String
+      attr_reader name_kana: String
+      attr_reader name_romaji: String
+    end
+  end
+
+  module CsvParser
+    HEADER_MAP: Hash[String, Symbol]
+
+    def self.call: -> Hash[untyped, untyped]
+    def self._find_or_build_prefecture: (Array[untyped] prefectures, untyped row) -> Models::Prefecture
+    def self._find_or_build_city: (Array[untyped] cities, Models::Prefecture current_prefecture, untyped row) -> Models::City
+    def self._find_town: (Array[untyped] towns, untyped row) -> nil
+    def self._build_town: (untyped row) -> Models::Town
+    def self._write_csv: (Hash[untyped, untyped] prefectures) -> Hash[untyped, untyped]
+    def self._write_prefectures_csv: (Array[untyped] prefectures) -> Array[untyped]
+    def self._write_cities_csv: (bot prefecture, untyped cities) -> untyped
+    def self._write_towns_csv: (untyped prefecture, untyped city, untyped towns) -> untyped
+  end
 end

data/sig/schmooze_base.rbs

@@ -0,0 +1,25 @@
+module Schmooze
+  class Base
+    def self.dependencies: (untyped deps) -> untyped
+
+    def self.finalize: (untyped stdin, untyped stdout, untyped stderr, untyped process_thread) -> untyped
+
+    def self.method: (untyped name, untyped code) -> untyped
+
+    public
+
+    def pid: () -> untyped
+
+    private
+
+    def call_js_method: (untyped method, untyped args) -> untyped
+
+    def ensure_packages_are_initiated: (untyped stdin, untyped stdout, untyped stderr, untyped process_thread) -> untyped
+
+    def ensure_process_is_spawned: () -> untyped
+
+    def initialize: (untyped root, ?untyped env) -> void
+
+    def spawn_process: () -> untyped
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: japanese_address_parser
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Yamaguchi Takuya
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  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: typeprof
+  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: JapaneseAddressParser is a Ruby gem that parses Japanese address. To
   detect the address, it uses geolonia/japanese-addresses (https://github.com/geolonia/japanese-addresses)
   CSV data.
@@ -142,6 +170,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - docker-compose.yml
@@ -4103,6 +4132,7 @@ files:
 - lib/japanese_address_parser/models/town.rb
 - lib/japanese_address_parser/version.rb
 - sig/japanese_address_parser.rbs
+- sig/schmooze_base.rbs
 homepage: https://github.com/yamat47/japanese_address_parser
 licenses:
 - MIT