japanese_address_parser 2.2.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713a2974b9ccf061e4c834969e879e37918ffc49c8b312a63daf42b91abc98a1
-  data.tar.gz: a3e41f696082da17e49b29ddec7a52228c8526fd8f74a9929f88aac9ba9b90a6
+  metadata.gz: 0a042febb9a10f78adeadbd23f6e99a97c69817546479ecbd2dc1cd1fe6f5f50
+  data.tar.gz: ed7d82baf90223493a3cb0e33b21afb2a61779cd57718e18f63358ddc963d66f
 SHA512:
-  metadata.gz: e77067fd81c5347bfbe5af1d87f2da12de8814024c08bc79cfbdcd0c0eae2282b5a55a4cb62d789024b5fe028e62b39432c16bf5ab85dd29a9d2b845677640b8
-  data.tar.gz: 3d92174c193a17f0eb7566d7bec1ea54cddb22dca403dcd1c8e365a3c34c164404ce09ce00ed4f3cb9ff3bbd9243363ded73eca87c7ea80128dc776c8d5fba29
+  metadata.gz: fbfe12bdc50a1eaacba31ad237a6034a3d1db4961d2f50b061ab862961753d4a62dc9515cc0d96373d1f432599906a49617687b5ed3b1f89ebf032c6110a0709
+  data.tar.gz: 00f949e850de4bd327af851ed3ff4d046423a73473b2a847f5b316fc91cb0dccc4ae06ebd36c7567b75bef8f690a8e48a13ba1c0464ca1ab4b655e874ec558c3

data/.rubocop.yml

@@ -6,6 +6,7 @@ require:
 
 AllCops:
   EnabledByDefault: true
+  TargetRubyVersion: 2.7
 
 Metrics/BlockLength:
   Exclude:
@@ -35,3 +36,6 @@ Style/StringHashKeys:
 # elseがない場合にはcase文ではなくif文を許容する。
 Style/MissingElse:
   EnforcedStyle: case
+
+Gemspec/DependencyVersion:
+  EnforcedStyle: forbidden

data/CHANGELOG.md

@@ -17,6 +17,20 @@ 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
+
+- [#49](https://github.com/yamat47/japanese_address_parser/pull/49) Dockerを使って開発環境の準備をできるようにした。([@yamat47](https://github.com/yamat47))
+
+### Security
+
+- [#51](https://github.com/yamat47/japanese_address_parser/pull/51) Ruby 2.6 のサポートを切った。([@yamat47](https://github.com/yamat47))
+
 ## [2.2.1] - 2022-07-16
 ### Changed
 

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:3.1.2-alpine
+
+ENV LANG=C.UTF-8 \
+    APP_HOME=/gemsrc
+
+# `japanese_address_parser.gemspec` needs git.
+RUN apk update && \
+    apk add --virtual build-dependencies --no-cache git nodejs make gcc musl-dev
+
+RUN mkdir $APP_HOME
+WORKDIR $APP_HOME
+
+COPY . $APP_HOME
+
+RUN bundle install
+
+CMD sh -c "/bin/sh"

data/Gemfile.lock

@@ -1,32 +1,41 @@
 PATH
   remote: .
   specs:
-    japanese_address_parser (2.2.1)
+    japanese_address_parser (3.0.1)
       schmooze
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.6)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    factory_bot (6.2.0)
+    factory_bot (6.2.1)
       activesupport (>= 5.0.0)
-    i18n (1.10.0)
+    ffi (1.15.5)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.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)
-    regexp_parser (2.2.1)
+    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)
       rspec-core (~> 3.11.0)
@@ -34,42 +43,56 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.9.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     schmooze (0.2.0)
-    tzinfo (2.0.4)
+    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.1.0)
-    zeitwerk (2.5.4)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
+  aarch64-linux-musl
   arm64-darwin-21
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
-  activesupport (< 7)
+  activesupport
   factory_bot
   japanese_address_parser!
   rake
@@ -77,6 +100,8 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
+  steep
+  typeprof
 
 BUNDLED WITH
    2.3.3

data/README.md

@@ -111,6 +111,14 @@ address.furigana #=> "トウキョウトミナトクシバコウエン 4"
 bin/setup
 ```
 
+開発環境の構築は Docker を使ってもできます。
+MacOS でしか試していないので、他プラットフォームで動かなかったら issue でご報告ください。
+
+```
+docker compose build
+docker compose run --rm gemsrc sh
+```
+
 自動テストやリンターを実行するには、このコマンドを実行してください：
 
 ```

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

@@ -0,0 +1,7 @@
+version: "3"
+services:
+  gemsrc:
+    build: .
+    tty: true
+    volumes:
+      - .:/gemsrc

data/japanese_address_parser.gemspec

@@ -12,7 +12,7 @@ require_relative 'lib/japanese_address_parser/version'
   spec.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.'
   spec.homepage = 'https://github.com/yamat47/japanese_address_parser'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/yamat47/japanese_address_parser'
@@ -31,12 +31,14 @@ require_relative 'lib/japanese_address_parser/version'
   spec.require_paths = ['lib']
 
   spec.add_dependency('schmooze')
-  spec.add_development_dependency('activesupport', '< 7')
+  spec.add_development_dependency('activesupport')
   spec.add_development_dependency('factory_bot')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec')
   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/models/prefecture.rb

@@ -12,12 +12,7 @@ module JapaneseAddressParser
       def self.all
         filepath = Pathname(__FILE__).dirname.join('../data/prefectures.csv')
         ::CSV.table(filepath, converters: nil).map do |prefecture|
-          new(
-            code: prefecture[:code],
-            name: prefecture[:name],
-            name_kana: prefecture[:name_kana],
-            name_romaji: prefecture[:name_romaji]
-          )
+          new(code: prefecture[:code], name: prefecture[:name], name_kana: prefecture[:name_kana], name_romaji: prefecture[:name_romaji])
         end
       end
 
@@ -35,13 +30,7 @@ module JapaneseAddressParser
       def cities
         filepath = Pathname(__FILE__).dirname.join("../data/#{code}.csv")
         ::CSV.table(filepath, converters: nil).map do |city|
-          ::JapaneseAddressParser::Models::City.new(
-            code: city[:code],
-            prefecture_code: city[:prefecture_code],
-            name: city[:name],
-            name_kana: city[:name_kana],
-            name_romaji: city[:name_romaji]
-          )
+          ::JapaneseAddressParser::Models::City.new(code: city[:code], prefecture_code: city[:prefecture_code], name: city[:name], name_kana: city[:name_kana], name_romaji: city[:name_romaji])
         end
       end
     end

data/lib/japanese_address_parser/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module JapaneseAddressParser
-  VERSION = '2.2.1'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japanese_address_parser
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.1
 platform: ruby
 authors:
 - Yamaguchi Takuya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-16 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schmooze
@@ -28,16 +28,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -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.
@@ -136,13 +164,16 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - japanese_address_parser.gemspec
 - js/.gitignore
 - js/node_modules/.package-lock.json
@@ -4101,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
@@ -4117,7 +4149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="