seed-snapshot 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef5c34c4578ce762ac87e59b187d72c3688f90f51b075e553e11be7ec6b397a
-  data.tar.gz: 53bf8fc36fbf5b2db69f07889b8bd2bcab27282bc4b7b8730af5ad2a43c53640
+  metadata.gz: f8c4741381c5ac0fa4c2faedf03223b60d7a1b6eb484d6523c0a162ee96edf54
+  data.tar.gz: 5166c21119588ee4ad4d9a625aeaca78d9e7f6aea4be5dff087cec5b0f5a40f7
 SHA512:
-  metadata.gz: 57ec41c9b0c18d2834cd499743cd15de93e2e0c68ccb8ce0cb0b16adbf9ef2fbb0bdcc78f7d1571106de6eff5f05b148b36a74065faf1e57ec39a5ca116daa3d
-  data.tar.gz: 912325ee93075b5f0aad64c2656edab3b720fe6278cd68c566730b69b75af46695b318e97db9b65490f093bb34614d9fce239b03bddc598968f4b080f4b2dfd2
+  metadata.gz: 3e28c974fcc4b4ed0746c6bd8a3493486843af014274c1cd58340e57a9a45ddd1a6af4ba0cec1d954acd18adab085d9deb336895216c7e5a268876ece57b7de8
+  data.tar.gz: a2bb46155b7346cc90635aaee2c1e93e65580d92b159c1356c12666cd018148284f1830840b6920b6747dcf0196179f2ec4ae1583623b95ffefaeaaf923b0c0f

data/.github/workflows/main.yml

@@ -31,11 +31,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.1', '3.2', '3.3']
-        ar: ['7.0', '7.1', '7.2', '8.0']
-        exclude:
-          - ruby: '3.1'
-            ar: '8.0'
+        ruby: ['3.3', '3.4', '4.0']
+        ar: ['7.2', '8.0', '8.1']
 
     env:
       BUNDLE_GEMFILE: gemfiles/ar_${{ matrix.ar }}.gemfile

data/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+# v0.8.0 のようなタグを push すると rubygems.org に gem を公開する
+# 認証は RubyGems の Trusted Publishing（OIDC）を使うので API キーは不要
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      # タグと lib/seed_snapshot/version.rb のバージョンが一致しなければ中断する
+      - name: Check version
+        run: |
+          version=$(ruby -Ilib -e 'require "seed_snapshot/version"; print SeedSnapshot::VERSION')
+          if [ "v${version}" != "${GITHUB_REF_NAME}" ]; then
+            echo "::error::Tag ${GITHUB_REF_NAME} does not match SeedSnapshot::VERSION (${version})"
+            exit 1
+          fi
+
+      - name: Release gem
+        uses: rubygems/release-gem@v1

data/AGENTS.md

@@ -0,0 +1,55 @@
+# AGENTS.md
+
+This file provides guidance to AI coding agents (Claude Code, Codex, etc.) when working with code in this repository.
+
+## 概要
+
+`seed-snapshot` は ActiveRecord (>= 7.2) 向けの gem で、テスト用のシードデータを `mysqldump` / `mysql` CLI で高速にダンプ・リストアする。**MySQL (Mysql2 アダプタ) 専用**で、`Seed::Configuration` の初期化時に他アダプタだと例外を投げる。
+
+## コマンド
+
+```sh
+bin/setup                     # bundle install
+bundle exec rake              # 全テスト実行（default タスク = test）
+bundle exec ruby -Ilib -Itest test/cases/dump_test.rb              # 単一ファイル
+bundle exec ruby -Ilib -Itest test/cases/dump_test.rb -n test_dump # 単一テスト
+BUNDLE_GEMFILE=gemfiles/ar_8.0.gemfile bundle exec rake            # 特定の ActiveRecord バージョンで実行
+```
+
+**リリース**: `lib/seed_snapshot/version.rb` のバージョンを上げて master にマージした後、`git tag v<バージョン> && git push origin v<バージョン>` でタグを push すると、`.github/workflows/release.yml` が rubygems.org に公開する（RubyGems の Trusted Publishing を使用）。タグとバージョンが一致しないと失敗する。
+
+## テスト環境
+
+テストには実際の MySQL が必要（既定は `127.0.0.1:3306`、`root` / パスワード空）。
+
+```sh
+docker compose up -d --wait   # CI と同じ MySQL 8.0 を起動（compose.yaml）
+bundle exec rake
+docker compose down           # データは tmpfs なので停止すると消える
+```
+
+- **接続先の上書き**: `test/config.yml` は `DB_HOST` / `DB_PORT` / `DB_USERNAME` / `DB_PASSWORD` を参照する。`ARCONFIG` で `test/config.yml` 自体を差し替え可能。3306 が埋まっている場合は `DB_PORT=13306 docker compose up -d --wait` で起動し、テストも同じ `DB_PORT` で実行する。
+- **起動待ち**: コンテナは起動のたびに初期化が走り、接続可能になるまで数秒かかる。`test/cases/db_config.rb` の `wait_for_connection` が接続エラーの間だけ最大 30 秒リトライするので、`--wait` なしの `docker compose up -d` 直後に実行しても動く。
+- **MySQL クライアント**: gem 本体がホスト上で `mysqldump` / `mysql` を実行する。PATH 上に `mysqldump` が無い場合は `test/support/mysql_client.rb` が `test/bin` を PATH に足し、compose の mysql コンテナ内のクライアントを `docker compose exec` 経由で使う（`test/bin/mysqldump` は `test/bin/mysql` へのシンボリックリンク。`-h` / `-P` はコンテナ内の `127.0.0.1:3306` に上書きする）。CI ではランナー（`ubuntu-latest`）にプリインストールされたクライアントが使われる。
+- **DB・テーブルの作成**: 各テストが `require 'cases/helper'` → `test/cases/db_config.rb` の順に読み込み、テスト起動時に以下を行う。
+  1. `create_database_if_not_exists` が `activerecord_unittest` / `activerecord_unittest2` を作成（DB 名は `test/support/config.rb` の `expand_config` が接続名 `arunit` / `arunit2` に割り当てる。既存なら何もしない）
+  2. `ARTest.connect` で `arunit`（`activerecord_unittest`）に接続
+  3. `load_schema` が `test/schema/schema.rb` をロードし、`rents` / `books` / `users` を `force: true` で毎回作り直す
+
+  `activerecord_unittest2` は DB を作るだけで、テーブルは作られず現状のテストでも使われていない。
+
+CI（`.github/workflows/main.yml`）は Ruby 3.3〜4.0 × ActiveRecord 7.2〜8.1 のマトリクスを `gemfiles/ar_*.gemfile` で回す（MySQL 8.0）。サポートが終了した Ruby / Rails は基本的に外す方針（ただし Rails 7.2 は EOL 後も残している）。サポートする AR バージョンを増減する場合は gemfile・CI マトリクス・gemspec の `activerecord` 依存をまとめて更新する。
+
+## アーキテクチャ
+
+- `lib/seed-snapshot.rb` — 公開 API（`SeedSnapshot.dump(classes:, ignore_classes:, force:)`, `.restore`, `.exists?`, `.clean`, `.manifest`）。呼び出しごとに `Seed::Configuration` を新規生成する。
+- `Seed::Configuration` — 接続情報・パスを解決する。ダンプファイルは `Dir.pwd/tmp/dump/<schema_version>.sql`。`schema_version` は**マイグレーションバージョン一覧の SHA1** なので、マイグレーションが変わるとスナップショットは自動的に無効化（別ファイル扱い）される。`get_all_versions` は `MigrationContext#get_all_versions` を使う。
+- `Seed::Snapshot` — dump/restore/clean の本体。モデルクラスから `table_name` を取り出して `Seed::Mysql` に渡す。`ar_internal_metadata` と `schema_migrations` は常に除外（`--ignore-table` は `db.table` 形式が必要）。
+- `Seed::Mysql` — `system` でシェルコマンドを組み立てて実行。`mysqldump -t`（データのみ、スキーマなし）。クライアントバージョンが 8 系なら `--skip-column-statistics` を付ける。
+- `Seed::Manifest` — シードファイル群の SHA256 を `tmp/dump/seed_manifest.json` に保存し、`diff?` でシード入力の変更を検知するための補助。
+
+## 注意点
+
+- バージョン定義は `lib/seed_snapshot/version.rb`（gemspec が参照）。
+- README の Usage 例（`SeedSnapshot.restore(tables)` / `dump(tables)`）は現在のキーワード引数 API と一致していない。
+- テストは `Dir.pwd` 基準で `tmp/dump` を作るため、リポジトリルートから実行すること。

data/compose.yaml

@@ -0,0 +1,19 @@
+# 開発/テスト用 MySQL（CI の services と同じ構成）
+#   docker compose up -d --wait
+#   bundle exec rake
+services:
+  mysql:
+    image: mysql:8.0
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+      MYSQL_DATABASE: activerecord_unittest
+    ports:
+      - "${DB_PORT:-3306}:3306"
+    # テスト用なのでデータは永続化せずメモリ上に置く
+    tmpfs:
+      - /var/lib/mysql
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1"]
+      interval: 5s
+      timeout: 5s
+      retries: 20

data/gemfiles/{ar_7.0.gemfile → ar_8.1.gemfile}

@@ -6,4 +6,4 @@ gem 'pry'
 gem 'minitest'
 gem 'erubis'
 gem 'mysql2', '>= 0.4.4', '< 0.6.0'
-gem 'activerecord', '~> 7.0.0'
+gem 'activerecord', '~> 8.1.0'

data/lib/seed/configuration.rb

@@ -41,18 +41,8 @@ module Seed
     private
 
     def get_all_versions
-      if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new('7.1')
-        migration_paths = ::ActiveRecord::Migrator.migrations_paths
-        ::ActiveRecord::MigrationContext.new(migration_paths).get_all_versions
-      elsif ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new('6.0')
-        migration_paths = ::ActiveRecord::Migrator.migrations_paths
-        ::ActiveRecord::MigrationContext.new(migration_paths, ::ActiveRecord::SchemaMigration).get_all_versions
-      elsif ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new('5.2')
-        migration_paths = ::ActiveRecord::Migrator.migrations_paths
-        ::ActiveRecord::MigrationContext.new(migration_paths).get_all_versions
-      else
-        ::ActiveRecord::Migrator.get_all_versions
-      end
+      migration_paths = ::ActiveRecord::Migrator.migrations_paths
+      ::ActiveRecord::MigrationContext.new(migration_paths).get_all_versions
     end
   end
 end

data/lib/seed_snapshot/version.rb

@@ -1,3 +1,3 @@
 module SeedSnapshot
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/seed-snapshot.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  spec.add_runtime_dependency 'activerecord', '>= 7.0'
+  spec.add_runtime_dependency 'activerecord', '>= 7.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - yo_waka
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 description: Easy dump/restore tool for ActiveRecord.
 email:
 - y.wakahara@gmail.com
@@ -31,23 +31,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
+- AGENTS.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/ar_7.0.gemfile
-- gemfiles/ar_7.1.gemfile
+- compose.yaml
 - gemfiles/ar_7.2.gemfile
 - gemfiles/ar_8.0.gemfile
+- gemfiles/ar_8.1.gemfile
 - lib/seed-snapshot.rb
 - lib/seed/configuration.rb
 - lib/seed/manifest.rb
 - lib/seed/mysql.rb
 - lib/seed/snapshot.rb
-- lib/seed/version.rb
 - lib/seed_snapshot/version.rb
 - seed-snapshot.gemspec
 homepage: https://github.com/waka/seed-snapshot
@@ -68,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Easy dump/restore tool for ActiveRecord.
 test_files: []

data/gemfiles/ar_7.1.gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'bundler'
-gem 'rake'
-gem 'pry'
-gem 'minitest'
-gem 'erubis'
-gem 'mysql2', '>= 0.4.4', '< 0.6.0'
-gem 'activerecord', '~> 7.1.0'

data/lib/seed/version.rb

@@ -1,3 +0,0 @@
-module SeedSnapshot
-  VERSION = "0.1.0"
-end