exwiw 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4b63b89a56ddce55ea6dc835bde4052b9140cff4b24da6cb9c05d5cac7d0f59
-  data.tar.gz: a567c52917014798129638281c90d66f9f7102db624f8b601dd9e025d4351677
+  metadata.gz: 9ad123bcfe1cadde34a031d1db34fb4592892b88765d3b979c2fb827b53578f7
+  data.tar.gz: 59b2263b51e51f95e9f8d79cbc214dc0f385202e7ca120d108f3f64e18832a52
 SHA512:
-  metadata.gz: 0d782a227fb06e75ac28d35a636f28ccb224dd1c1eb1aad7015863bd8365082be6f51c948f3e7beafbca12d10ac1162af9170e1e064f07a7ca7b64e1433a71d4
-  data.tar.gz: 994f8795368c96bc9f773526da33cf8f3d024eac6fcb0665e028f3fc8bd2f67fc5424d4e2e3ada7e91d7a3eb4e2906bd2464d18c4da01d134ba051426e49b9e0
+  metadata.gz: f79b7338d57d93eebbfba42d81ff6a3f3c232dbb9163118e42d4f67b73844c50234910d3add9eafe72ff4f854d5497191ac7cb37a4ec1da1647dfb1987c118be
+  data.tar.gz: 22c97b02f4cb68badb0bc3e404996af4a48f46f0c32f0366cf0845a6e683b5d4a6a1af3ed499dae425d9adafe131f5c86eca933d5f51eac3d3d4458e508f36a8

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [0.2.7] - 2026-05-30
+
+### Added
+
+- `schema:generate` no longer crashes on models with a composite primary key (`primary_key` returns an Array). Such tables are emitted with `skip: true`, tagged `type: "unsupported_composite_primary_key"`, and annotated with a `comment` listing the key columns. `columns` / `belongs_tos` are retained so the entry can be wired up once composite-key support lands; for now `skip: true` excludes it from extraction. `skip: true` tables no longer require `primary_key` at load time.
+
+### Notes
+
+- `schema:generate` multi-database support: each database keeps its own Rails migration history, so a per-database `schema_migrations` / `ar_internal_metadata` entry is emitted for every database that has one. Known limitation: the rails-managed table *name* is resolved from the global `ActiveRecord::Base.schema_migrations_table_name` / `internal_metadata_table_name` accessors, so a per-database override of those names is not detected and the table will be missing from that database's generated configs.
+
+## [0.2.6] - 2026-05-29
+
+### Added
+
+- `schema:generate` now supports Rails multiple-database setups (`connects_to`). Models are bucketed by their database (`connection_db_config.name`, e.g. `primary` / `analytics`) and each database's config files are written into its own subdirectory under `OUTPUT_DIR_PATH` (`exwiw/primary/`, `exwiw/analytics/`, ...). Rails-managed tables (`schema_migrations` / `ar_internal_metadata`) are emitted under whichever database actually owns them. Single-database apps are unaffected and still write flat into the output directory. This replaces the previous behavior of raising `MultipleDatabasesNotSupportedError`.
+
 ## [0.2.5] - 2026-05-29
 
 ### Added

data/README.md

@@ -128,6 +128,26 @@ By default, the schema files will be saved in the `exwiw` directory. You can spe
 OUTPUT_DIR_PATH=custom_directory bundle exec rake exwiw:schema:generate
 ```
 
+#### Multiple databases
+
+If the application uses Rails' multiple-database support (`connects_to`), `schema:generate` buckets models by the database they connect to and writes each database's config files into its own subdirectory of the output directory, named after the database config name (`primary`, `analytics`, ...):
+
+```
+exwiw/
+  primary/
+    shops.json
+    users.json
+    schema_migrations.json
+  analytics/
+    analytics_events.json
+```
+
+Each database keeps its own Rails migration history, so a `schema_migrations` (and `ar_internal_metadata`) entry is emitted under every database that contains one — the example above shows `primary/schema_migrations.json` and would also produce `analytics/schema_migrations.json` when the analytics database has its own migration table. Single-database applications are unaffected and continue to write files flat into the output directory.
+
+**Limitations**
+
+- The rails-managed table *names* are resolved from the global `ActiveRecord::Base.schema_migrations_table_name` / `internal_metadata_table_name` accessors, which are shared across all connections. A per-database override of these names is not detected, so such a table will be missing from that database's generated configs.
+
 ### Configuration
 
 This is an example of the one table schema:
@@ -250,7 +270,24 @@ Constraints:
 
 - Defining `primary_key`, `columns`, or `belongs_tos` on a rails-managed entry is rejected with `ArgumentError` on load.
 - A rails-managed table cannot be used as `--target-table`.
-- Multi-database setups are not yet supported — the table name is read from the global `ActiveRecord::Base` accessor.
+- In multi-database setups, the rails-managed entry is emitted under whichever database's connection actually contains the table (see [Multiple databases](#multiple-databases)). The table name itself is still derived from the global `ActiveRecord::Base.schema_migrations_table_name` / `internal_metadata_table_name` (prefix/suffix) accessors.
+
+### Composite primary keys (unsupported)
+
+exwiw does not yet support tables with a composite primary key. When `exwiw:schema:generate` encounters a model whose `primary_key` is an array, it still emits a config entry so the table is not silently dropped, but marks it `skip: true`, tags it `type: "unsupported_composite_primary_key"`, and records the key columns in a `comment`:
+
+```json
+{
+  "name": "composite_pk_records",
+  "type": "unsupported_composite_primary_key",
+  "skip": true,
+  "comment": "exwiw does not support composite primary keys (organization_id, location_id); data extraction is skipped.",
+  "belongs_tos": [],
+  "columns": [{ "name": "organization_id" }, { "name": "location_id" }, { "name": "name" }]
+}
+```
+
+Unlike rails-managed entries, `columns` and `belongs_tos` are retained so the entry is ready to wire up once composite-key support lands. The `type` is purely a marker — `skip: true` is what actually excludes the table from extraction, so removing `skip` (and supplying a workable `primary_key`) lets you opt the table back in manually.
 
 ### Bulk insert chunk size
 

data/lib/exwiw/schema_generator.rb

@@ -5,8 +5,6 @@ require "json"
 
 module Exwiw
   class SchemaGenerator
-    class MultipleDatabasesNotSupportedError < StandardError; end
-
     def self.from_rails_application(output_dir:)
       Rails.application.eager_load!
       new(models: ActiveRecord::Base.descendants, output_dir: output_dir)
@@ -18,33 +16,53 @@ module Exwiw
     end
 
     def generate!
-      tables = build_tables
-      write_files(tables)
-      tables
+      groups = build_table_groups
+      write_groups(groups)
+      groups
     end
 
-    def build_tables
+    # Returns a Hash keyed by the database name.
+    #
+    # - Single-database setup: the only key is `nil`, signalling that the table
+    #   configs should be written flat into `output_dir` (backwards compatible).
+    # - Multi-database setup (Rails `connects_to`): one key per database
+    #   (`connection_db_config.name`, e.g. "primary" / "analytics"), each
+    #   mapping to that database's table configs. They are written into
+    #   `output_dir/<db_name>/`.
+    def build_table_groups
       models = concrete_models
-      validate_single_database!(models)
+      grouped = models.group_by { |model| database_name_for(model) }
 
-      tables_from_models = models.group_by(&:table_name).map do |table_name, model_group|
-        representative = model_group.first
-        TableConfig.from_symbol_keys(
-          name: table_name,
-          primary_key: representative.primary_key,
-          belongs_tos: aggregate_belongs_tos(model_group),
-          columns: representative.column_names.map { |name| { name: name } },
-        )
+      if grouped.size <= 1
+        conn = models.empty? ? ActiveRecord::Base.connection : models.first.connection
+        return { nil => build_tables_for(models, conn) }
       end
 
-      tables_from_models + build_rails_managed_tables
+      grouped.each_with_object({}) do |(db_name, group_models), result|
+        conn = group_models.first.connection
+        result[db_name] = build_tables_for(group_models, conn)
+      end
+    end
+
+    # Backwards-compatible flat list of all table configs. Only meaningful for
+    # a single-database setup; for multi-database setups prefer
+    # `#build_table_groups` so the database association is preserved.
+    def build_tables
+      build_table_groups.values.flatten
+    end
+
+    def write_groups(groups)
+      groups.each do |db_name, tables|
+        dir = db_name.nil? ? @output_dir : File.join(@output_dir, db_name)
+        write_files(dir, tables)
+      end
     end
 
-    def write_files(tables)
-      FileUtils.mkdir_p(@output_dir)
+    def write_files(dir, tables)
+      FileUtils.mkdir_p(dir)
 
       tables.each do |table|
-        path = File.join(@output_dir, "#{table.name}.json")
+        path = File.join(dir, "#{table.name}.json")
         config_to_write =
           if File.exist?(path)
             TableConfig.from(JSON.parse(File.read(path))).merge(table)
@@ -55,20 +73,50 @@ module Exwiw
       end
     end
 
+    private def build_tables_for(models, conn)
+      tables_from_models = models.group_by(&:table_name).map do |table_name, model_group|
+        representative = model_group.first
+        primary_key = representative.primary_key
+
+        # 複合主キー (`representative.primary_key` が Array) のテーブルは現状未対応。
+        # primary_key を省略し、type で非対応である旨を明示したうえで skip:true を
+        # 付与して出力する。type を付けておくことで将来対応する際の目印になる。
+        # 利用者が必要に応じて手動で skip を外して設定し直せるよう、設定ファイル
+        # 自体は生成しておく。
+        if primary_key.is_a?(Array)
+          TableConfig.from_symbol_keys(
+            name: table_name,
+            type: TableConfig::UNSUPPORTED_COMPOSITE_PRIMARY_KEY,
+            skip: true,
+            comment: "exwiw does not support composite primary keys " \
+                     "(#{primary_key.join(', ')}); data extraction is skipped.",
+            belongs_tos: aggregate_belongs_tos(model_group),
+            columns: representative.column_names.map { |name| { name: name } },
+          )
+        else
+          TableConfig.from_symbol_keys(
+            name: table_name,
+            primary_key: primary_key,
+            belongs_tos: aggregate_belongs_tos(model_group),
+            columns: representative.column_names.map { |name| { name: name } },
+          )
+        end
+      end
+
+      tables_from_models + build_rails_managed_tables(conn)
+    end
+
     private def concrete_models
       @models.reject(&:abstract_class?).select(&:table_exists?)
     end
 
-    # NOTE: multi-database setup には未対応。`ActiveRecord::Base.schema_migrations_table_name`
-    # と `internal_metadata_table_name` はクラスレベルのグローバル設定を返すため、
-    # connection 毎にテーブル名が違うケース (`connects_to` で別 DB を扱う場合や
-    # `ActiveRecord::Base` 以外で `connection.schema_migration.table_name` を上書きしている場合)
-    # を拾えない。現状は `validate_single_database!` で multi-DB を弾いているので
-    # ここに到達するのは単一 DB 構成のみという前提で動いている。
-    # multi-DB 対応する際は、対象の connection に紐づく schema_migration から
-    # テーブル名を取り、connection 毎にエントリを生成する必要がある。
-    private def build_rails_managed_tables
-      conn = ActiveRecord::Base.connection
+    # rails-managed テーブル (`schema_migrations` / `ar_internal_metadata`) は
+    # モデルクラスを持たないため `ActiveRecord::Base.descendants` からは拾えない。
+    # multi-DB 構成では各 connection が独立した migration 履歴テーブルを持つので、
+    # 対象 connection を受け取り、その connection 上に該当テーブルが存在する場合のみ
+    # エントリを生成する。テーブル名そのものは prefix/suffix を含むグローバル設定
+    # (`ActiveRecord::Base.schema_migrations_table_name` 等) から得る。
+    private def build_rails_managed_tables(conn)
       result = []
 
       schema_migrations_name = ActiveRecord::Base.schema_migrations_table_name
@@ -108,22 +156,13 @@ module Exwiw
       end
     end
 
-    # `connection_specification_name` is a quasi-private API but has been stable
-    # across Rails 6.1 - 8.x. With Rails multi-DB (`connects_to`), every
-    # descendant of the same abstract base shares one spec name regardless of
-    # role/shard, so distinct values across concrete models indicate genuinely
-    # separate databases.
-    private def validate_single_database!(models)
-      return if models.empty?
-
-      specs = models.map(&:connection_specification_name).uniq
-      return if specs.size <= 1
-
-      raise MultipleDatabasesNotSupportedError, <<~MSG
-        exwiw does not yet support Rails multiple-database setup.
-        Detected connection specifications: #{specs.inspect}
-        Track progress at https://github.com/riseshia/exwiw/issues
-      MSG
+    # Identifies which database a model belongs to. With Rails multi-DB
+    # (`connects_to` backed by `database.yml`), `connection_db_config.name`
+    # returns the configuration name ("primary", "analytics", ...) which is
+    # stable across roles/shards and makes a natural per-database directory
+    # name. Single-database apps all share one name, collapsing into one group.
+    private def database_name_for(model)
+      model.connection_db_config.name
     end
   end
 end

data/lib/exwiw/table_config.rb

@@ -11,6 +11,11 @@ module Exwiw
       RAILS_MANAGED_INTERNAL_METADATA,
     ].freeze
 
+    # exwiw が現状サポートしていない複合主キーのテーブルを表す type。
+    # schema:generate が skip:true と併せて付与する。将来サポートする際の
+    # 目印になるよう、rails-managed とは異なり columns/belongs_tos は保持する。
+    UNSUPPORTED_COMPOSITE_PRIMARY_KEY = "unsupported_composite_primary_key"
+
     attribute :name, String
     attribute :primary_key, optional(String), skip_serializing_if_nil: true
     attribute :type, optional(String), skip_serializing_if_nil: true
@@ -138,7 +143,9 @@ module Exwiw
                 "Table '#{name}' has type=#{type}; columns must not be defined."
         end
       else
-        if primary_key.nil?
+        # skip:true のテーブルはデータ抽出を行わないため primary_key を要求しない。
+        # (例: exwiw 非対応の複合主キーテーブル)
+        if primary_key.nil? && !skip
           raise ArgumentError, "Table '#{name}' requires primary_key."
         end
       end

data/lib/exwiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exwiw
-  VERSION = "0.2.5"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exwiw
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Shia