migsupo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6bd6bc4627dd5769bb11ae7f872a7234a09eccf52b4ed9661e162d7049dc87a
-  data.tar.gz: 796a9c73842e770248796ce1f35a5def6e006fe9c44b31485fd9ca21f98ac31f
+  metadata.gz: 46769b47cf0ccd1fddb7f3391c43cdec1cbe20df56cb3d18efdafc22c9427c09
+  data.tar.gz: a8edc433d3472182ddcfd5be264704c6d21ad58d70e491934c3f92cbf53cd3ed
 SHA512:
-  metadata.gz: 88c10374ed224574113524e17ea4856f8671f04022a669899136691c87387580f57f49d91458887261a962d143d033875a633b8e829ccff4fdaa9e8e338ed9a5
-  data.tar.gz: 14719373ed30592817a1b0e9107dd613fb3936c1c47a977fd0e38d8067bcf0ef982b2bae5df1cac74308a7bcecfa480559fa069b988ea3d32f378f7d641d3250
+  metadata.gz: 03a340761dfb39ff21b8d80d98f1901b2e553c6b57b8178e0927fdb78db6f0247034c98d2e159379b754700d8ecd7e46ac45d24966794344a920dd93d1a49aae
+  data.tar.gz: cbeba7b4ec1da9528edec1ef4efd7c52d25101d3e6f8f071f4bddde68d23a30a059740b902a99475b620cea0f39aa12aa17a67bdc752fd6813045c6262b6b9cf

data/README.md

@@ -126,6 +126,10 @@ rails db:generate_migration:check
 
 Adopt a hand-made database change as the truth. See [coherent](#coherent--when-the-db-was-changed-by-hand).
 
+### `rails db:squash` / `rails db:squash:apply`
+
+Collapse the whole migration history into a single `Init` migration. See [squash](#squash--collapse-the-history-into-one-init-migration).
+
 ## `coherent` — when the DB was changed by hand
 
 Sometimes someone edits the database directly — an emergency `ALTER TABLE` in production, say — and that state is the one you want to keep. The normal flow cannot express this: the Schemafile is behind, and running a migration to catch up would touch columns that are already correct.
@@ -180,6 +184,51 @@ Nothing special. `db/migrate/*.rb` is a normal migration, so staging and product
 - Only what migsupo models is tracked: tables, columns, indexes. Foreign keys, extensions and check constraints are neither diffed nor written to the Schemafile.
 - Primary key options (`id: :uuid`, `primary_key: "uid"`) are not read back from the database, so the regenerated Schemafile drops them. Diffs are unaffected — table options are not compared — but re-add them by hand if you ever recreate the table from the Schemafile.
 
+## `squash` — collapse the history into one Init migration
+
+When `db/migrate` has grown long, `squash` replaces every migration file with a single `<timestamp>_init.rb` that creates the whole schema as declared in the Schemafile, and then rewrites `schema_migrations` to hold only that version. No DDL is executed.
+
+```
+db/migrate/*.rb (N files)
+  ├─ db:squash        → db/migrate/<ts>_init.rb   (all other files deleted)
+  └─ db:squash:apply  → schema_migrations = [<ts>]   ← tables untouched
+                        db/schema.rb re-dumped
+```
+
+### 1. Generate
+
+```bash
+rails db:squash
+rails db:squash DRY_RUN=true   # print the Init migration, change nothing
+```
+
+It aborts unless both hold:
+
+- every migration file has been applied (pending ones may carry data migrations the Schemafile cannot express)
+- the DB matches the Schemafile (the Init migration must reproduce this exact DB)
+
+### 2. Review, then rewrite history
+
+```bash
+rails db:squash:apply VERSION=20261103120000
+```
+
+`VERSION` can be omitted when `db/migrate` holds exactly one file (right after `db:squash`); that one is used.
+
+### On other environments
+
+Unlike `coherent`, this is **not** picked up by plain `rails db:migrate` — the Init migration would try to create tables that already exist. On every existing environment:
+
+1. Deploy the pre-squash code and run `rails db:migrate` so the DB matches the Schemafile.
+2. Deploy the squashed code and run `rails db:squash:apply VERSION=<ts>` **before** `rails db:migrate`.
+
+New environments just run `rails db:migrate` (or `db:schema:load`).
+
+### Caveats
+
+- Data migrations and raw SQL in the old files are gone. Keep them elsewhere if you still need them.
+- Only what migsupo models is emitted: tables, columns, indexes. Foreign keys, extensions and check constraints are not in the Init migration.
+
 ## Environment Variables
 
 | Variable | Default | Description |

data/lib/migsupo/squash.rb

@@ -0,0 +1,44 @@
+require_relative "parser/schemafile_parser"
+require_relative "generator/migration_builder"
+require_relative "differ/operations/create_table"
+require_relative "coherent"
+
+module Migsupo
+  # Collapses the whole migration history into a single Init migration built
+  # from the Schemafile, then rewrites schema_migrations to match - no DDL.
+  module Squash
+    module_function
+
+    # Built from the Schemafile, not the DB: the DB loader drops primary key
+    # options (id: :uuid etc.), the Schemafile keeps them.
+    def build(schemafile_path: nil, rails_version: nil)
+      schemafile_path ||= Migsupo.configuration.schemafile_path
+      schema = Parser::SchemafileParser.parse(schemafile_path)
+      ops    = schema.tables.values.map { |table| Differ::Operations::CreateTable.new(table) }
+
+      Generator::MigrationBuilder.new(rails_version: rails_version).build(ops, class_name: "Init")
+    end
+
+    # Deletes every migration file and writes <timestamp>_init.rb. Returns its path.
+    def write(content, migrations_dir: nil)
+      migrations_dir ||= Migsupo.configuration.migrations_dir
+      Dir.glob(File.join(migrations_dir, "*.rb")).each { |path| File.delete(path) }
+
+      path = File.join(migrations_dir, "#{Time.now.strftime('%Y%m%d%H%M%S')}_init.rb")
+      File.write(path, content)
+      path
+    end
+
+    # Replaces all history with the single version. Atomic so a failure
+    # cannot leave schema_migrations empty.
+    def rewrite_history(version)
+      connection = Coherent.connection
+      table = connection.quote_table_name("schema_migrations")
+
+      connection.transaction do
+        connection.execute("DELETE FROM #{table}")
+        connection.execute("INSERT INTO #{table} (version) VALUES (#{connection.quote(version.to_s)})")
+      end
+    end
+  end
+end

data/lib/migsupo/tasks/migsupo.rake

@@ -133,3 +133,81 @@ namespace :db do
     end
   end
 end
+
+namespace :db do
+  desc "Collapse every migration into a single Init migration built from the Schemafile"
+  task squash: :environment do
+    schemafile_path = ENV.fetch("SCHEMAFILE", Migsupo.configuration.schemafile_path)
+    output_dir      = ENV.fetch("OUTPUT_DIR", Migsupo.configuration.migrations_dir)
+    dry_run         = ENV["DRY_RUN"] == "true"
+
+    # Pending files may hold data migrations that the Schemafile cannot express.
+    pending = Migsupo::Coherent.pending(output_dir)
+    unless pending.empty?
+      puts "Run the pending migrations before squashing:"
+      pending.each { |version, name| puts "  #{version}  #{name}" }
+      exit 1
+    end
+
+    # Init replaces the history only if it reproduces this exact DB.
+    diff = Migsupo.calculate_diff(schemafile_path: schemafile_path, loader: :active_record)
+    unless diff.empty?
+      puts "The database and the Schemafile do not match. Bring them in sync before squashing:"
+      puts diff.to_s
+      exit 1
+    end
+
+    content = Migsupo::Squash.build(schemafile_path: schemafile_path, rails_version: Migsupo.detect_rails_version)
+    if dry_run
+      puts content
+      next
+    end
+
+    removed = Migsupo::Coherent.migration_files(output_dir).size
+    path    = Migsupo::Squash.write(content, migrations_dir: output_dir)
+    version = File.basename(path)[/\A\d+/]
+
+    puts "Removed #{removed} migration file(s) and generated:"
+    puts "  #{path}"
+    puts
+    puts "Review it, then replace the history on every environment (no DDL is executed):"
+    puts "  rails db:squash:apply VERSION=#{version}"
+  end
+
+  namespace :squash do
+    desc "Replace schema_migrations with the single Init version (VERSION=ts)"
+    task apply: :environment do
+      schemafile_path = ENV.fetch("SCHEMAFILE", Migsupo.configuration.schemafile_path)
+      output_dir      = ENV.fetch("OUTPUT_DIR", Migsupo.configuration.migrations_dir)
+      version         = ENV["VERSION"].to_s.strip
+
+      if version.empty?
+        files = Migsupo::Coherent.migration_files(output_dir)
+        unless files.size == 1
+          puts "VERSION is required when #{output_dir} does not hold exactly one migration (found #{files.size})."
+          exit 1
+        end
+        version = files.first.first
+        puts "Using #{files.first.last}"
+      end
+
+      unless Migsupo::Coherent.migration_files(output_dir).to_h[version]
+        puts "No migration found in #{output_dir} for: #{version}"
+        exit 1
+      end
+
+      diff = Migsupo.calculate_diff(schemafile_path: schemafile_path, loader: :active_record)
+      unless diff.empty?
+        puts "The database and the Schemafile do not match. Run rails db:migrate on the pre-squash code first:"
+        puts diff.to_s
+        exit 1
+      end
+
+      Migsupo::Squash.rewrite_history(version)
+      puts "schema_migrations now holds only: #{version}"
+
+      Rake::Task["db:schema:dump"].invoke
+      puts "Updated db/schema.rb."
+    end
+  end
+end

data/lib/migsupo/version.rb

@@ -1,3 +1,3 @@
 module Migsupo
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/migsupo.rb

@@ -10,6 +10,7 @@ require_relative "migsupo/loader/schema_rb_loader"
 require_relative "migsupo/differ/diff_calculator"
 require_relative "migsupo/generator/migration_generator"
 require_relative "migsupo/coherent"
+require_relative "migsupo/squash"
 
 module Migsupo
   class << self
@@ -39,6 +40,14 @@ module Migsupo
                                    .generate(diff, output_dir: output_dir, dry_run: dry_run)
     end
 
+    def detect_rails_version
+      return configuration.migration_version if configuration.migration_version
+      return nil unless defined?(Rails)
+
+      major_minor = Rails::VERSION::STRING.split(".").first(2).join(".")
+      major_minor
+    end
+
     private
 
     def build_loader(loader)
@@ -62,14 +71,6 @@ module Migsupo
         "db/schema.rb"
       end
     end
-
-    def detect_rails_version
-      return configuration.migration_version if configuration.migration_version
-      return nil unless defined?(Rails)
-
-      major_minor = Rails::VERSION::STRING.split(".").first(2).join(".")
-      major_minor
-    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migsupo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - masak1yu
@@ -129,6 +129,7 @@ files:
 - lib/migsupo/schema/index_definition.rb
 - lib/migsupo/schema/schema_definition.rb
 - lib/migsupo/schema/table_definition.rb
+- lib/migsupo/squash.rb
 - lib/migsupo/tasks/migsupo.rake
 - lib/migsupo/version.rb
 - migsupo.gemspec