jp_address 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e8a270d6771b635d0de517833ad5b21c97558800c2ef459c2493cdc68f8ec9
-  data.tar.gz: 960f5bc5a54d66f929ab141cee756099b71a9f3a66f64a2ea757ce4e772ae84b
+  metadata.gz: 67701127b1fbec6ae9292647b6373acdeca9dcb51b78addeefaeed7544852531
+  data.tar.gz: d3fb7f7ee44c1976825cb22c0394414a9dec14aa220536e17bf57daa382a7575
 SHA512:
-  metadata.gz: c1ab63af145ca2654ea5383bf459eea3465678013a32589304c46daea4e9f69e99c03ab9bcd4f7db4a43dea9ebcaa00bc5b3c6ffc9fd0591bf5285fee1dae664
-  data.tar.gz: a87ecc0525afaa28ed2c75caaacdae8ff98191b3118d7d990b5066b1eb95c677e40f1addc0ce3fa47626fdaa6dd26ede79bbb2d3b5d4590f59a5f6da67483682
+  metadata.gz: 33814d00bd9491bce91816e44066be23025af90b8c68ff62a3924fe6ed1316d5f08339864642a3848f55a7cff23838712816ec5747edabe633e8ace33c91a8fa
+  data.tar.gz: becaad6991cc0cc30d8dc05f479488500b02707c3028c6b8841af2ed3e35a2042e01c5332a15ce20caa9962deb4231b629f9f83503f4e09a0bd0b9b7e1a36c74

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# CHANGELOG
+
+## 2.0.0
+
+最新の Ruby / Rails への対応と、郵便番号データの取り込みまわりのバグ修正。
+
+### 対応バージョン
+
+* Ruby 3.1 〜 3.4、Rails 7.1 / 8.0 / 8.1 に対応。
+  （Ruby 3.1 + Rails 7.1 〜 Ruby 3.4 + Rails 8.1 で実際にテスト済み）
+* Rails 6.x 以前のサポートを終了。
+* Ruby 3.4 で `csv` が bundled gem になったため、gemspec の依存に追加。
+  これがないと `require 'csv'` に失敗する。
+* `railties` / `activerecord` を runtime 依存として明示。
+* rubyzip 3.x に対応（`>= 2.3, < 4.0`）。
+
+### バグ修正
+
+* **町域名が複数行に分かれている郵便番号で町名が消えていた**。
+  ken_all.csv は町域名が長いと括弧の途中で改行して次の行に続くが、その
+  継続行を別の町名として扱っていたため、共通部分が見つからず町名が空に
+  なっていた。括弧が閉じるまでの行を読み飛ばすようにした。
+  例：9292225（石川県羽咋郡宝達志水町 米出）が `""` → `"米出"`。
+* **同じ郵便番号の行が全部同じ町名でも町名が空になっていた**。
+  `_find_shared_name_from` が「差分が見つからない＝共通部分なし」と
+  判定していたのを修正。短い方の地名がまるごと共通部分になる場合
+  （例：東中島／東中島本町）もその地名を返すようにした。
+* 日本郵便へのリクエストがリダイレクト・エラーレスポンスを一切見ていな
+  かったのを修正。リダイレクトは最大 5 回まで追い、200 以外は
+  `JpAddress::Zipcode::DownloadError` を投げる。
+* zip の中から CSV エントリだけを取り出すようにした（従来は全エントリを
+  同じパスに展開しようとしていた）。
+* 存在しない CSV パスを `load_master_data` に渡すと、無駄にダウンロード
+  してから `Errno::ENOENT` になっていたのを `ArgumentError` に。
+* `row[8]` が空の行で `NoMethodError` にならないようにした。
+* `FileUtils` を require していなかったのを修正。
+
+### 変更
+
+* `load_master_data` を全面的に書き直し。行ごとの生 SQL を `insert_all!`
+  でのバッチ投入に変え、統合処理も CSV 読み込み中にメモリ上で行うように
+  したので、大幅に速くなった（本番でのロードが数分 → 数十秒程度）。
+  これに伴い内部メソッド `_merge_same_zip_addresses` は削除。
+* API のレスポンスを `render plain:` から `render json:` に変更。
+  Content-Type が `text/plain` から `application/json` になる。
+* 郵便番号の全角数字（`５３３－００３３`）を受け付けるようにした。
+* `JpAddress::ApplicationRecord` を追加し、`Zipcode` の親クラスにした。
+* Sprockets 前提の app/assets・レイアウト・空の ApplicationHelper を削除。
+  JSON しか返さない engine には不要で、propshaft / importmap 環境では
+  むしろ壊れるため。
+* テストを VCR カセット（2.5MB のバイナリ）から WebMock のスタブに置き換え。
+  コントローラスペックはリクエストスペックに変更。
+* GitHub Actions で Ruby × Rails のマトリクステストを追加。
+
+## 1.0.2 以前
+
+省略。

data/README.md

@@ -1,10 +1,10 @@
-# Ruby on Rails 6 で 郵便番号住所検索 な gem
+# Ruby on Rails で 郵便番号住所検索 な gem
 
 ## JpAddressとは
-日本郵便の「[郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/oogaki-zip.html)」を用いて、あなたの Rails 6.1 サイトに「郵便番号からの住所検索機能」を組み込むための gem です。
+日本郵便の「[郵便番号データ](https://www.post.japanpost.jp/zipcode/download.html)」を用いて、あなたの Rails サイトに「郵便番号からの住所検索機能」を組み込むための gem です。
 以下の機能を提供します。
 
-* [[郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/oogaki/zip/ken_all.zip "ken_all.zip")]をダウンロードして自前ＤＢのテーブル（jp_address_zipcodes）にロードするクラスメソッド。（```JpAddress::Zipcode.load_master_data```）
+* [[郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip "ken_all.zip")]をダウンロードして自前ＤＢのテーブル（jp_address_zipcodes）にロードするクラスメソッド。（```JpAddress::Zipcode.load_master_data```）
 * 郵便番号を受け取り都道府県名と住所をJSONで返却するAPI。
 （```jp_address/zipcodes#search```）
 
@@ -14,8 +14,17 @@ APIはお使いのRailsアプリケーションにマウントして使います
 あと必要なのは、戻ってくるJSONを加工してHTML要素にセットするJavaScriptの記述だけです。<br>
 （本記事下部にサンプルコードを掲載しています。）
 
+### 対応バージョン
+
+| | 対応 |
+|---|---|
+| Ruby | 3.1 以降 |
+| Rails | 7.1 / 8.0 / 8.1 |
+
+Rails 6.x 以前をお使いの場合は 1.0.2 をご利用ください。
+
 ### インストール
-GemFileに追記
+Gemfileに追記
 ```ruby
 gem 'jp_address'
   ```
@@ -36,11 +45,15 @@ $ bundle exec rails runner -e development 'JpAddress::Zipcode.load_master_data'
 $ bundle exec rails runner -e production 'JpAddress::Zipcode.load_master_data'
 ```
 
-環境にもよりますが、５分ぐらいかかると思います。
-
 APP_ROOT/tmp/ を作業ディレクトリに使用しています。<br>
 最初にテーブルをトランケートしますので、毎回「全件insert」になります。<br>
 
+すでに手元に ken_all.csv がある場合は、パスを渡せばダウンロードを省略できます。<br>
+（文字コードは日本郵便の配布どおり CP932 のままで構いません。）
+```ruby
+JpAddress::Zipcode.load_master_data('tmp/ken_all.csv')
+```
+
 同じ郵便番号を持つレコードは統合されます。<br>
 <br>
 例：9896712<br>
@@ -78,6 +91,14 @@ http://localhost:3000/jp_address/zipcodes/search?zip=5330033
 {"id":84280,"zip":"5330033","prefecture":"大阪府","city":"大阪市東淀川区","town":"東中島"}
 ```
 
+該当する郵便番号がない場合は、各項目が null の JSON が返ります。
+```js script
+{"id":null,"zip":null,"prefecture":null,"city":null,"town":null}
+```
+
+半角ハイフン・空白・全角数字は自動的に取り除かれるので、`533-0033` や `５３３－００３３` を
+そのまま投げても構いません。
+
 ### APIを利用するサンプル JavaScript
 フォームに
 1. #zipcode （郵便番号を入力するテキストボックス）
@@ -85,8 +106,7 @@ http://localhost:3000/jp_address/zipcodes/search?zip=5330033
 3. #address （住所を表示するテキストボックス）
 
 の３要素があるとします。<br>
-#zipcodeに入れられた値を keyup イベントで拾ってAPIを叩き、都道府県プルダウンを選択し、住所をセットするサンプルです。<br>
-郵便番号の半角ハイフンは自動でカットされます。
+#zipcodeに入れられた値を input イベントで拾ってAPIを叩き、都道府県プルダウンを選択し、住所をセットするサンプルです。<br>
 
 都道府県プルダウンは、戻ってくるJSONの "prefecture" すなわち都道府県名で選択します。<br>
 ですので、お持ちの都道府県マスターの各レコードがどのようなＩＤを持っていても構いません。
@@ -148,108 +168,73 @@ http://localhost:3000/jp_address/zipcodes/search?zip=5330033
 </form>
 ```
 
-#### application.js など共通に読み込まれるファイルに配置するJavaScript
-※ JQuery の存在を前提にしています。<br>
-※ もともと CoffeeScript で書いてあったソースを decaffeinate したものですので冗長です（汗）。<br>
-本質的な処理はAddressSearch 関数が担っているだけで、他の関数は decaffeinate に必要なだけです。
+#### JavaScript
+jQuery などのライブラリは不要です。app/javascript 配下など、フォームのあるページで
+読み込まれる場所に置いてください。
+
 ```js script
-  function _classCallCheck(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-      throw new TypeError("Cannot call a class as a function");
-    }
+class AddressSearch {
+  constructor(zipSelector, prefectureSelector, addressSelector, endpoint = '/jp_address/zipcodes/search') {
+    this.zip        = document.querySelector(zipSelector);
+    this.prefecture = document.querySelector(prefectureSelector);
+    this.address    = document.querySelector(addressSelector);
+    this.endpoint   = endpoint;
+  }
+
+  start() {
+    this.zip.addEventListener('input', () => this.execute());
   }
 
-  function _defineProperties(target, props) {
-    for (var i = 0; i < props.length; i++) {
-      var descriptor = props[i];
-      descriptor.enumerable = descriptor.enumerable || false;
-      descriptor.configurable = true;
+  async execute() {
+    const zip = this.zip.value.replace(/[^0-9０-９]/g, '');
+    if (zip.length !== 7) return;
 
-      if ("value" in descriptor)
-        descriptor.writable = true;
-      Object.defineProperty(target, descriptor.key, descriptor);
+    const url = `${this.endpoint}?zip=${encodeURIComponent(zip)}`;
+    const res = await fetch(url, { headers: { Accept: 'application/json' } });
+    if (!res.ok) return;
+
+    const json = await res.json();
+    if (json.id === null) {
+      this.clear();
+    } else {
+      this.setPrefecture(json.prefecture);
+      this.address.value = `${json.city}${json.town}`;
     }
   }
 
-  function _createClass(Constructor, protoProps, staticProps) {
-    if (protoProps)
-      _defineProperties(Constructor.prototype, protoProps);
-    if (staticProps)
-      _defineProperties(Constructor, staticProps);
-    return Constructor;
+  clear() {
+    this.prefecture.selectedIndex = 0;
+    this.address.value = '';
   }
 
-  var AddressSearch = function() {
-    "use strict";
-    function AddressSearch(zip_elem_id, prefecture_elem_id, address_elem_id) {
-      _classCallCheck(this, AddressSearch);
-      this.zip                = $(zip_elem_id);
-      this.prefecture         = $(prefecture_elem_id);
-      this.address            = $(address_elem_id);
-      this.prefecture_elem_id = prefecture_elem_id;
+  setPrefecture(name) {
+    for (const option of this.prefecture.options) {
+      if (option.text === name) {
+        option.selected = true;
+        return;
+      }
     }
+  }
+}
 
-    _createClass(AddressSearch, [{
-      key: "_remove_hyphen",
-      value: function _remove_hyphen() {
-        return this.zip.val(this.zip.val().replace(/-/, ''));
-      }
-    }, {
-      key: "_clear_current_value",
-      value: function _clear_current_value() {
-        $(this.prefecture_elem_id + ' >option:eq(0)').prop('selected', true);
-        return this.address.val('');
-      }
-    }, {
-      key: "_set_prefecture",
-      value: function _set_prefecture(json) {
-        return $(this.prefecture_elem_id + ' > option').each(function() {
-          if ($(this).text() === json['prefecture']) {
-            return $(this).prop('selected', true);
-          }
-        });
-      }
-    }, {
-      key: "_set_address",
-      value: function _set_address(json) {
-        return this.address.val(json['city'] + json['town']);
-      }
-    }, {
-      key: "_call_api",
-      value: function _call_api() {
-        var _this = this;
-        return $.getJSON('/jp_address/zipcodes/search', {zip: this.zip.val()}, function(json) {
-          if (json['id'] === null) {
-            return _this._clear_current_value();
-          } else {
-            _this._set_prefecture(json);
-            return _this._set_address(json);
-          }
-        });
-      }
-    }, {
-      key: "execute",
-      value: function execute() {
-        this._remove_hyphen();
-        if (this.zip.val().length === 7) {
-          return this._call_api();
-        }
-      }
-    }]);
+// #zipcode, #prefecture_id, #address を各自の環境に合わせて書き換えてください。
+document.addEventListener('DOMContentLoaded', () => {
+  new AddressSearch('#zipcode', '#prefecture_id', '#address').start();
+});
+```
 
-    return AddressSearch;
-  }();
+### 開発
+
+```
+$ bundle install
+$ bundle exec rspec
 ```
 
-#### フォームのあるページに配置するJavaScript
-```js script
-  // #zipcode, #prefecture_id, #address を各自の環境に合わせて書き換えてください。
-  $(function() {
-    var address_search = new AddressSearch('#zipcode', '#prefecture_id', '#address');
-    $('#zipcode').keyup(function() {
-      address_search.execute();
-    });
-  });
+複数バージョンの Rails で試す場合は gemfiles/ 配下の Gemfile を使ってください。
+
+```
+$ BUNDLE_GEMFILE=gemfiles/rails_7_1.gemfile bundle install
+$ BUNDLE_GEMFILE=gemfiles/rails_7_1.gemfile bundle exec rspec
 ```
 
 ##### 作者

data/Rakefile

@@ -4,23 +4,22 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'JpAddress'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  require 'rdoc/task'
+
+  RDoc::Task.new(:rdoc) do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title    = 'JpAddress'
+    rdoc.options << '--line-numbers'
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue LoadError
+  # rdoc is optional; skip the task when it is not installed.
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
-
-load 'rails/tasks/statistics.rake'
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core'
@@ -29,5 +28,5 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/app/controllers/jp_address/application_controller.rb

@@ -1,4 +1,5 @@
 module JpAddress
   class ApplicationController < ActionController::Base
+    protect_from_forgery with: :null_session
   end
 end

data/app/controllers/jp_address/zipcodes_controller.rb

@@ -1,10 +1,15 @@
-require_dependency "jp_address/application_controller"
-
 module JpAddress
   class ZipcodesController < ApplicationController
     def search
-      @zipcode = Zipcode.find_by(:zip => params[:zip].to_s.gsub(/[^0-9]/, '')) || Zipcode.new
-      render plain: @zipcode.to_json
+      @zipcode = Zipcode.find_by(zip: _normalized_zip) || Zipcode.new
+      render json: @zipcode
+    end
+
+    private
+
+    # 全角数字・ハイフン・空白などを取り除いて半角数字だけにします。
+    def _normalized_zip
+      params[:zip].to_s.tr('０-９', '0-9').gsub(/[^0-9]/, '')
     end
   end
 end

data/app/models/jp_address/application_record.rb

@@ -0,0 +1,5 @@
+module JpAddress
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end