jp_address_complement 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17438b03576a1b31a50ee4ed00413a2da5ccd8e2187c3ccb1b4f60f5f9a8c0df
-  data.tar.gz: 1efaf00afc7166bdb9b6bfcdde8128ea9e7d9682d5500c1096d9d8eb7e166ed9
+  metadata.gz: 65c654356d4cf02a324ae3bd6a91302b9b01f124c40764b243be16b5250c4e8b
+  data.tar.gz: 5edc22e95c71f0348a460edc70b800f892060399ee4a8cdba8a03d7469e50c77
 SHA512:
-  metadata.gz: dc70f4d677374348176ae4a724aee2fba171fc101cde7c2c091a2c8d32d594a6ac51d7575c16fedf5ae9e7babda75f1fd575e7072f2062beb7105c45798e5ef0
-  data.tar.gz: dab79d95277591fec2a31775b9b436397900ed7cd889f9db5016008286efcdfb68021d91771573f26e858fbde6abf36b691b6ed7e566cbe14ab14d5a65f7b449
+  metadata.gz: 3aede94e81398e1b13a22753aa39c104f65644adc78a34d9e624bfbf5be689265163f9e781bc20ec68282ae8a39dec3b6a643f5b07bece90f3625c5597bc9074
+  data.tar.gz: 818c73343376926aa0ce127b37a9a4b524ce49a7d4db030ed4dcd0c1d1d5c6b7e11cd1d3a5906ade66377525db08bcb4b7d34d85a34298c31eab518a7c37688d

data/CHANGELOG.md

@@ -1,25 +1,15 @@
 ## [Unreleased]
 
-### Changed
-
-- **CSV インポート（003: 消えたレコード削除）**
-  - `JpAddressComplement::Importers::CsvImporter#import` の戻り値を **Integer から `ImportResult`（Data.define :upserted, :deleted）に変更**（破壊的変更）
-  - フルインポート時に、今回のCSVに存在しない住所レコードをストアから削除するようにした
-  - 空CSV（有効行0件）の場合はインポートを拒否し、`JpAddressComplement::ImportError` を発生させる
-  - Rake タスク `jp_address_complement:import` の完了メッセージを「インポート完了: upsert N 件, 削除 M 件」形式に変更
+## [0.2.0] - 2026-03-02
 
-### Added
-
-- **都道府県コード変換・住所逆引き（004）**
-  - `JpAddressComplement.prefecture_name_from_code(code)` — 都道府県コード（2桁）から正式名称を返す（該当なしは nil）
-  - `JpAddressComplement.prefecture_code_from_name(name)` — 都道府県の正式名称から2桁コードを返す（該当なしは nil）
-  - `JpAddressComplement.search_postal_codes_by_address(pref:, city:, town: nil)` — 都道府県・市区町村・町域から郵便番号候補を逆引き（該当なし・入力不十分時は []）
+### Changed
 
-- RBS type annotations and Steep type checking (see [specs/002-rbs-type-annotations](../specs/002-rbs-type-annotations/))
-  - Public API and internal methods annotated with rbs-inline
-  - `sig/` and `sig/manual/` for type definitions; `AddressRecord` hand-defined in `sig/manual/address_record.rbs`
-  - Rake tasks: `rake rbs:generate` (generate RBS from annotations), `rake steep` (type check)
-  - CI runs `bundle exec rake steep`; type errors fail the build
+- **Active Record をオプショナルに変更**
+  - gemspec: `activerecord` / `railties` を runtime 依存から削除し、development 依存に移動
+  - デフォルトリポジトリ・`base_record_class`: Gemfile のみで未 require の場合に備え、require を試してから利用するよう変更（`defined?` 判定を廃止）
+  - Railtie: 同様に `require 'rails'` を試してから読み込むよう変更
+  - `default_repository`: LoadError 時に利用者向けメッセージで `JpAddressComplement::Error` を発生
+  - README: 必要環境・インストール手順に利用者側の対応を追記
 
 ## [0.1.0] - 2026-02-22
 

data/README.md

@@ -26,8 +26,7 @@
 ## 必要環境
 
 - Ruby 3.2 以上
-- Rails 7.1 以上
-- ActiveRecord 利用を前提としています
+- **デフォルトの DB 利用（ActiveRecord）を使う場合のみ**: Rails 7.0 以上および `activerecord` gem（Rails アプリでは通常含まれる）。使わない場合は不要です。
 
 ## インストール
 
@@ -39,13 +38,24 @@
 gem 'jp_address_complement'
 ```
 
+**デフォルトの ActiveRecord リポジトリを使う場合（DB に郵便番号テーブルを置く場合）**  
+本 gem は `activerecord` を必須依存にしていません。Rails アプリでは `gem 'rails'` に含まれるため追加不要です。Rails を使わずに ActiveRecord だけ使う場合は、利用者側で `Gemfile` に `activerecord` を追加してください。
+
+```ruby
+gem 'jp_address_complement'
+gem 'activerecord', '>= 7.0'   # デフォルトリポジトリを使う場合のみ
+```
+
+**CSV リポジトリや自前リポジトリだけ使う場合**  
+`JpAddressComplement.configure { |c| c.repository = ... }` でリポジトリを設定すれば、`activerecord` は不要です。gem の追加だけで利用できます。
+
 Bundler を使わない場合:
 
 ```bash
 gem install jp_address_complement
 ```
 
-### 2. テーブルの作成
+### 2. テーブルの作成（デフォルトの ActiveRecord リポジトリを使う場合）
 
 郵便番号データを格納するマイグレーションを生成し、マイグレートします。
 
@@ -54,7 +64,7 @@ rails g jp_address_complement:install
 rails db:migrate
 ```
 
-### 3. 住所データのインポート
+### 3. 住所データのインポート（デフォルトの ActiveRecord リポジトリを使う場合）
 
 日本郵便の KEN_ALL 形式 CSV（UTF-8 版 `utf_ken_all.csv`）をインポートする必要があります。
 

data/examples/rails/jp_address_complement_demo/Gemfile.lock

@@ -2,9 +2,7 @@ PATH
   remote: ../../..
   specs:
     jp_address_complement (0.1.0)
-      activerecord (>= 7.0)
       csv (>= 3.0)
-      railties (>= 7.0)
       rubyzip (>= 2.3)
 
 GEM

data/lib/jp_address_complement/railtie.rb

@@ -14,6 +14,8 @@ module JpAddressComplement
     end
 
     initializer 'jp_address_complement.setup_repository' do # steep:ignore
+      next unless defined?(ActiveRecord)
+
       require_relative 'repositories/active_record_postal_code_repository'
       require_relative 'models/postal_code'
       JpAddressComplement.configuration.repository ||=

data/lib/jp_address_complement/version.rb

@@ -2,5 +2,5 @@
 # rbs_inline: enabled
 
 module JpAddressComplement
-  VERSION = '0.1.0' #: String
+  VERSION = '0.2.0' #: String
 end

data/lib/jp_address_complement.rb

@@ -9,8 +9,13 @@ require_relative 'jp_address_complement/repositories/postal_code_repository'
 require_relative 'jp_address_complement/searcher'
 require_relative 'jp_address_complement/prefecture'
 
-# Rails 環境でのみ Railtie をロード
-require_relative 'jp_address_complement/railtie' if defined?(Rails)
+# Rails が利用可能な場合のみ Railtie をロード（Gemfile に指定されていても require 前だと defined?(Rails) が false になり得るため、require を試す）
+begin
+  require 'rails'
+  require_relative 'jp_address_complement/railtie'
+rescue LoadError
+  # Rails が利用できない場合は Railtie をスキップ
+end
 
 module JpAddressComplement
   class Error < StandardError; end
@@ -31,10 +36,19 @@ module JpAddressComplement
       @configuration ||= Configuration.new
     end
 
-    # PostalCode モデルの継承元。未設定時は ActiveRecord::Base。configuration.postal_code_model_base に委譲する。
+    # PostalCode モデルの継承元。未設定時は ActiveRecord::Base（activerecord gem が利用可能な場合）。
+    # Gemfile に指定されていても require 前だと defined? が false になり得るため、未ロード時は require を試す。
     # @rbs () -> Class
     def base_record_class
-      configuration.postal_code_model_base || ActiveRecord::Base
+      base = configuration.postal_code_model_base
+      return base if base
+
+      require 'active_record'
+      ActiveRecord::Base
+    rescue LoadError => e
+      raise Error,
+            'ActiveRecord is not available. Add gem "activerecord" to your Gemfile, or set ' \
+            "JpAddressComplement.configuration.postal_code_model_base. (#{e.message})"
     end
 
     # @rbs (Class) -> void
@@ -124,6 +138,10 @@ module JpAddressComplement
       require_relative 'jp_address_complement/repositories/active_record_postal_code_repository'
       require_relative 'jp_address_complement/models/postal_code'
       Repositories::ActiveRecordPostalCodeRepository.new
+    rescue LoadError => e
+      raise Error,
+            'ActiveRecord is not loaded. Add gem "activerecord" to your Gemfile to use the default repository, ' \
+            "or set JpAddressComplement.configuration.repository to your own implementation. (#{e.message})"
     end
   end
 end

data/sig/generated/jp_address_complement.rbs

@@ -17,7 +17,8 @@ module JpAddressComplement
   # @return [Configuration]
   def self.configuration: () -> Configuration
 
-  # PostalCode モデルの継承元。未設定時は ActiveRecord::Base。configuration.postal_code_model_base に委譲する。
+  # PostalCode モデルの継承元。未設定時は ActiveRecord::Base（activerecord gem が利用可能な場合）。
+  # Gemfile に指定されていても require 前だと defined? が false になり得るため、未ロード時は require を試す。
   # @rbs () -> Class
   def self.base_record_class: () -> Class
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jp_address_complement
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - naokirin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-03-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
+        version: '7.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement