exwiw 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff943aae77c0ed0f79dc80c2e68527badcae7c6b330e89aec6a019adf0dd1e5
-  data.tar.gz: 8a146a76aea7ab0bd3aeabb27ccf789f575f86e1d965b64b2432c250addb003b
+  metadata.gz: 21a9432692220a23b0109497b0ffcb3f1c7f0fc360248c3590f730a4a98452ec
+  data.tar.gz: bf0847f90a24c8da3cf078f1c18e5d22f9827b705bc13945ddfc28f8e42460f1
 SHA512:
-  metadata.gz: 6dbd0212c4ca02aba3839f17bfe7fc45283f17cb7264d903527fbafda04a4cc9b5c756762a1422fae549b143a60ec825669581311ada63972c2288bdb744e47c
-  data.tar.gz: 6364942e8ee51055eb2ed2bffc16995b1a19c64b977790fa8ff4222742f034ae6d4b0b7410f779f70655bb2d6d3ea33af7321853727a2c9300adcdcbd45fc763
+  metadata.gz: c59e201f1180e2fb6191506647b78a82c43d7d124117c0d87e2cdcbfd8fa68ff30653accc9a22d82434d7e680496eed41d91c7b150b8b884b3b545b344b91d72
+  data.tar.gz: 600e4a3b8d134d43182b81017b8b4ad9a352824a76a351300ca3fc22ee4942ceccf6f8404eb6e04e2a2320a79849ddc6b3cacf0c3510c7b8acca0c06820eaa22

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [0.2.8] - 2026-05-31
+
+### Added
+
+- `schema:generate` now supports polymorphic `belongs_to` associations. Each polymorphic relation (`belongs_to :reviewable, polymorphic: true`) is expanded into one `belongs_to` entry per concrete target table — discovered from the other models' `has_many` / `has_one ..., as:` declarations — carrying `foreign_type` (the type column, e.g. `reviewable_type`) and `type_value` (the stored type, e.g. `"Product"`). Targets are ordered by table name so the generated output is stable across Ruby versions. At dump time, a polymorphic `belongs_to` on the path to the dump target is constrained by both the foreign key and the type column — in both the `SELECT` and the `delete-*.sql` bulk-delete subquery — so only rows of the matching type are extracted. ([#43](https://github.com/heyinc/exwiw/pull/43))
+
+## [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

data/README.md

@@ -142,7 +142,11 @@ exwiw/
     analytics_events.json
 ```
 
-Rails-managed tables (`schema_migrations` / `ar_internal_metadata`) are emitted under whichever database actually contains them. Single-database applications are unaffected and continue to write files flat into the output directory.
+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
 
@@ -237,6 +241,47 @@ Constraints:
 - Specifying a skipped table as `--target-table` raises `ArgumentError`.
 - `skip: true` is preserved by `exwiw:schema:generate` regenerations (the receiver value wins over the auto-generated config).
 
+### Polymorphic `belongs_to`
+
+A Rails polymorphic association (`belongs_to :reviewable, polymorphic: true`) does not point at a single table — the target row is selected at runtime by a type column. exwiw models this as **one `belongs_to` entry per concrete target table**, each carrying two extra fields:
+
+- `foreign_type` — the type column on *this* table (e.g. `reviewable_type`).
+- `type_value` — the value stored in that column for this target (e.g. `"Product"`), i.e. the target model's `polymorphic_name`.
+
+```json
+{
+  "name": "reviews",
+  "primary_key": "id",
+  "belongs_tos": [
+    {
+      "table_name": "products",
+      "foreign_key": "reviewable_id",
+      "foreign_type": "reviewable_type",
+      "type_value": "Product"
+    },
+    {
+      "table_name": "shops",
+      "foreign_key": "reviewable_id",
+      "foreign_type": "reviewable_type",
+      "type_value": "Shop"
+    }
+  ],
+  "columns": [{ "name": "id" }, { "name": "reviewable_type" }, { "name": "reviewable_id" }]
+}
+```
+
+`exwiw:schema:generate` expands a polymorphic `belongs_to` automatically: it finds every model that registers the association as a target via `has_many` / `has_one ..., as: :reviewable` and emits one entry per target table (ordered by table name so the output is stable across Ruby versions). A plain (non-polymorphic) `belongs_to` simply omits `foreign_type` / `type_value`.
+
+At dump time, when a polymorphic `belongs_to` lies on the path to the dump target, exwiw constrains **both** the foreign key and the type column, so only rows of the matching type are extracted. For example, dumping `products` pulls only reviews whose `reviewable_type = 'Product'`:
+
+```sql
+SELECT reviews.* FROM reviews
+WHERE reviews.reviewable_id IN (/* products subquery */)
+  AND reviews.reviewable_type = 'Product'
+```
+
+The same type filter is applied on the join path — and in the matching `delete-*.sql` bulk-delete subquery — when the polymorphic table is an intermediate hop rather than the directly-dumped table.
+
 ### Rails-managed tables (special `type` values)
 
 Some tables are owned by Rails itself rather than the application — they have no ActiveRecord model and Rails reserves the right to evolve their column shape between versions (e.g. `schema_migrations`, `ar_internal_metadata`). exwiw treats them as a distinct category via the `type` field on a table config:
@@ -268,6 +313,23 @@ Constraints:
 - A rails-managed table cannot be used as `--target-table`.
 - 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
 
 `bulk_insert_chunk_size` splits the generated `INSERT` statement into multiple statements, each containing at most the specified number of rows. This is useful when the number of records per table is large enough to hit limits like MySQL's `max_allowed_packet`.

data/lib/exwiw/adapter/mysql2_adapter.rb

@@ -136,7 +136,18 @@ module Exwiw
 
         foreign_key = first_join.foreign_key
         subquery_sql = compile_ast(subquery_ast)
-        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql});"
+        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql})"
+
+        # first_join.base_where_clauses は外側の削除対象テーブル
+        # (from_table_name) 上の条件 (polymorphic 型カラム等)。subquery には
+        # 含まれないため、外側の WHERE に追加する。これにより、別の
+        # polymorphic 型に属する行まで削除してしまうのを防ぐ。
+        first_join.base_where_clauses.each do |where|
+          next unless where.is_a?(Exwiw::QueryAst::WhereClause)
+
+          sql += " AND #{compile_where_condition(where, select_query_ast.from_table_name)}"
+        end
+        sql += ";"
 
         sql
       end
@@ -159,6 +170,13 @@ module Exwiw
             compiled_where_condition = compile_where_condition(where, join.join_table_name)
             sql += " AND #{compiled_where_condition}"
           end
+
+          # base_where_clauses は結合元テーブル (base_table_name) に対して
+          # コンパイルする。polymorphic な結合元テーブルの型カラム絞り込み等。
+          join.base_where_clauses.each do |where|
+            compiled_where_condition = compile_where_condition(where, join.base_table_name)
+            sql += " AND #{compiled_where_condition}"
+          end
         end
 
         if query_ast.where_clauses.any?

data/lib/exwiw/adapter/postgresql_adapter.rb

@@ -178,7 +178,18 @@ module Exwiw
 
         foreign_key = first_join.foreign_key
         subquery_sql = compile_ast(subquery_ast)
-        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql});"
+        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql})"
+
+        # first_join.base_where_clauses は外側の削除対象テーブル
+        # (from_table_name) 上の条件 (polymorphic 型カラム等)。subquery には
+        # 含まれないため、外側の WHERE に追加する。これにより、別の
+        # polymorphic 型に属する行まで削除してしまうのを防ぐ。
+        first_join.base_where_clauses.each do |where|
+          next unless where.is_a?(Exwiw::QueryAst::WhereClause)
+
+          sql += " AND #{compile_where_condition(where, select_query_ast.from_table_name)}"
+        end
+        sql += ";"
 
         sql
       end
@@ -201,6 +212,13 @@ module Exwiw
             compiled_where_condition = compile_where_condition(where, join.join_table_name)
             sql += " AND #{compiled_where_condition}"
           end
+
+          # base_where_clauses は結合元テーブル (base_table_name) に対して
+          # コンパイルする。polymorphic な結合元テーブルの型カラム絞り込み等。
+          join.base_where_clauses.each do |where|
+            compiled_where_condition = compile_where_condition(where, join.base_table_name)
+            sql += " AND #{compiled_where_condition}"
+          end
         end
 
         if query_ast.where_clauses.any?

data/lib/exwiw/adapter/sqlite3_adapter.rb

@@ -123,7 +123,18 @@ module Exwiw
 
         foreign_key = first_join.foreign_key
         subquery_sql = compile_ast(subquery_ast)
-        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql});"
+        sql += "\nWHERE #{select_query_ast.from_table_name}.#{foreign_key} IN (#{subquery_sql})"
+
+        # first_join.base_where_clauses は外側の削除対象テーブル
+        # (from_table_name) 上の条件 (polymorphic 型カラム等)。subquery には
+        # 含まれないため、外側の WHERE に追加する。これにより、別の
+        # polymorphic 型に属する行まで削除してしまうのを防ぐ。
+        first_join.base_where_clauses.each do |where|
+          next unless where.is_a?(Exwiw::QueryAst::WhereClause)
+
+          sql += " AND #{compile_where_condition(where, select_query_ast.from_table_name)}"
+        end
+        sql += ";"
 
         sql
       end
@@ -146,6 +157,13 @@ module Exwiw
             compiled_where_condition = compile_where_condition(where, join.join_table_name)
             sql += " AND #{compiled_where_condition}"
           end
+
+          # base_where_clauses は結合元テーブル (base_table_name) に対して
+          # コンパイルする。polymorphic な結合元テーブルの型カラム絞り込み等。
+          join.base_where_clauses.each do |where|
+            compiled_where_condition = compile_where_condition(where, join.base_table_name)
+            sql += " AND #{compiled_where_condition}"
+          end
         end
 
         if query_ast.where_clauses.any?

data/lib/exwiw/belongs_to.rb

@@ -6,9 +6,22 @@ module Exwiw
 
     attribute :foreign_key, String
     attribute :table_name, String
+    # polymorphic 関連の場合のみ設定される。`foreign_type` は型を格納するカラム名
+    # (例: `reviewable_type`)、`type_value` はそのカラムに入る値 (例: `"Product"`)。
+    # 非 polymorphic の belongs_to では両方とも nil。
+    attribute :foreign_type, optional(String), skip_serializing_if_nil: true
+    attribute :type_value, optional(String), skip_serializing_if_nil: true
 
     def self.from_symbol_keys(hash)
       from(hash.transform_keys(&:to_s))
     end
+
+    def polymorphic?
+      !foreign_type.nil?
+    end
+
+    def to_hash
+      super.compact
+    end
   end
 end

data/lib/exwiw/query_ast.rb

@@ -3,14 +3,20 @@
 module Exwiw
   module QueryAst
     class JoinClause
-      attr_reader :base_table_name, :foreign_key, :join_table_name, :primary_key, :where_clauses
+      # `where_clauses` はこの join の join_table_name (= 結合先テーブル) に対して
+      # コンパイルされる。一方 `base_where_clauses` は base_table_name (= 結合元
+      # テーブル) に対してコンパイルされる。後者は、結合元テーブルが結合先へ
+      # polymorphic belongs_to していて型カラム (foreign_type) が結合元テーブル
+      # 側に存在するケースのために使う。
+      attr_reader :base_table_name, :foreign_key, :join_table_name, :primary_key, :where_clauses, :base_where_clauses
 
-      def initialize(base_table_name:, foreign_key:, join_table_name:, primary_key:, where_clauses: [])
+      def initialize(base_table_name:, foreign_key:, join_table_name:, primary_key:, where_clauses: [], base_where_clauses: [])
         @base_table_name = base_table_name
         @foreign_key = foreign_key
         @join_table_name = join_table_name
         @primary_key = primary_key
         @where_clauses = where_clauses
+        @base_where_clauses = base_where_clauses
       end
 
       def to_h
@@ -23,6 +29,9 @@ module Exwiw
         if where_clauses.size.positive?
           hash[:where_clauses] = where_clauses.map { |wc| wc.is_a?(String) ? wc : wc.to_h }
         end
+        if base_where_clauses.size.positive?
+          hash[:base_where_clauses] = base_where_clauses.map { |wc| wc.is_a?(String) ? wc : wc.to_h }
+        end
         hash
       end
     end

data/lib/exwiw/query_ast_builder.rb

@@ -54,8 +54,23 @@ module Exwiw
           foreign_key: relation.foreign_key,
           join_table_name: to_table.name,
           primary_key: to_table.primary_key,
-          where_clauses: []
+          where_clauses: [],
+          base_where_clauses: []
         )
+
+        # この hop 自体が polymorphic belongs_to の場合 (例: comments が
+        # commentable として posts へ polymorphic belongs_to)、型カラム
+        # (foreign_type) は結合元テーブル (from_table = base_table_name) 側に
+        # 存在する。外部キーだけでは reviewable_id=1 のような値が別モデルの
+        # 行と衝突しうるため、base_where_clauses に型条件を追加して結合元
+        # テーブルを絞り込む。
+        if relation.polymorphic?
+          join_clause.base_where_clauses.push QueryAst::WhereClause.new(
+            column_name: relation.foreign_type,
+            operator: :eq,
+            value: [relation.type_value]
+          )
+        end
         relation_to_dump_target = to_table.belongs_to(dump_target.table_name)
         if relation_to_dump_target
           join_clause.where_clauses.push QueryAst::WhereClause.new(
@@ -63,6 +78,18 @@ module Exwiw
             operator: :eq,
             value: dump_target.ids
           )
+
+          # 中間テーブルが dump target へ polymorphic belongs_to している場合は、
+          # 型カラム (foreign_type) も join 条件に追加する。型カラムは to_table
+          # (= join_table_name) 上に存在するため、JoinClause の where_clauses が
+          # join_table_name に対してコンパイルされる仕組みにそのまま乗せられる。
+          if relation_to_dump_target.polymorphic?
+            join_clause.where_clauses.push QueryAst::WhereClause.new(
+              column_name: relation_to_dump_target.foreign_type,
+              operator: :eq,
+              value: [relation_to_dump_target.type_value]
+            )
+          end
         end
 
         # Add filter from intermediate table to join clause
@@ -98,6 +125,17 @@ module Exwiw
         value: dump_target.ids
       )
 
+      # polymorphic belongs_to の場合は外部キーだけでは型を区別できないため
+      # (例: reviewable_id=1 が Product なのか別モデルなのか判別できない)、
+      # 型カラム (foreign_type) を type_value で絞り込む条件を追加する。
+      if belongs_to.polymorphic?
+        clauses.push Exwiw::QueryAst::WhereClause.new(
+          column_name: belongs_to.foreign_type,
+          operator: :eq,
+          value: [belongs_to.type_value]
+        )
+      end
+
       if table.filter
         clauses.push table.filter
       end

data/lib/exwiw/schema_generator.rb

@@ -76,12 +76,31 @@ module Exwiw
     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
-        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 } },
-        )
+        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)
@@ -126,15 +145,44 @@ module Exwiw
     end
 
     private def aggregate_belongs_tos(models)
-      pairs = models
-        .flat_map { |m| m.reflect_on_all_associations(:belongs_to) }
-        .reject(&:polymorphic?) # XXX: Support polymorphic
-        .map { |assoc| [assoc.table_name, assoc.foreign_key] }
-        .uniq
-
-      pairs.map do |table_name, foreign_key|
-        { table_name: table_name, foreign_key: foreign_key }
-      end
+      belongs_to_assocs = models.flat_map { |m| m.reflect_on_all_associations(:belongs_to) }
+
+      non_polymorphic = belongs_to_assocs
+        .reject(&:polymorphic?)
+        .map { |assoc| { table_name: assoc.table_name, foreign_key: assoc.foreign_key } }
+
+      # polymorphic な belongs_to (`belongs_to :reviewable, polymorphic: true`) は
+      # 単一の対象テーブルを持たない。対象になりうるテーブルは、他モデルで
+      # `has_many/has_one ..., as: <association_name>` と宣言されている側から逆引き
+      # する。各候補テーブルごとに、型カラム (`foreign_type`) と格納される型の値
+      # (`type_value`) を添えた belongs_to を 1 件ずつ展開する。
+      polymorphic = belongs_to_assocs
+        .select(&:polymorphic?)
+        .flat_map do |assoc|
+          polymorphic_target_models(assoc.name).map do |target_model|
+            {
+              table_name: target_model.table_name,
+              foreign_key: assoc.foreign_key,
+              foreign_type: assoc.foreign_type,
+              type_value: target_model.polymorphic_name,
+            }
+          end
+        end
+
+      (non_polymorphic + polymorphic).uniq
+    end
+
+    # polymorphic 関連 `association_name` の対象となりうる具象モデルを、全モデルの
+    # `has_many` / `has_one` の `as:` オプションから逆引きして列挙する。
+    # `concrete_models` の並びは `ActiveRecord::Base.descendants` の順に依存し、
+    # Ruby バージョンによって変わりうるため、生成される belongs_to の並びが安定する
+    # よう `table_name` でソートして決定的に返す。
+    private def polymorphic_target_models(association_name)
+      concrete_models.select do |model|
+        (model.reflect_on_all_associations(:has_many) +
+         model.reflect_on_all_associations(:has_one))
+          .any? { |reflection| reflection.options[:as] == association_name }
+      end.sort_by(&:table_name)
     end
 
     # Identifies which database a model belongs to. With Rails multi-DB

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.6"
+  VERSION = "0.2.8"
 end

metadata

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