about summary refs log tree commit diff
path: root/lib/generators/post_deployment_migration
diff options
context:
space:
mode:
authorMatt Jankowski <matt@jankowski.online>2023-04-11 11:25:29 +0200
committerGitHub <noreply@github.com>2023-04-11 11:25:29 +0200
commita2a66300d99ed53d63a7f065ffbed53d2ce074e3 (patch)
tree0c0f0e44df9e50ded8ac4c8685e2f16e17f37fb8 /lib/generators/post_deployment_migration
parent3c7053a2db86450d48849ca6b2f7e9ab6ff071bb (diff)
Clean up the post deployment migration generator (#24233)
Diffstat (limited to 'lib/generators/post_deployment_migration')
-rw-r--r--lib/generators/post_deployment_migration/USAGE10
-rw-r--r--lib/generators/post_deployment_migration/post_deployment_migration_generator.rb17
-rw-r--r--lib/generators/post_deployment_migration/templates/migration.erb8
3 files changed, 35 insertions, 0 deletions
diff --git a/lib/generators/post_deployment_migration/USAGE b/lib/generators/post_deployment_migration/USAGE
new file mode 100644
index 000000000..57f3c6aa1
--- /dev/null
+++ b/lib/generators/post_deployment_migration/USAGE
@@ -0,0 +1,10 @@
+Description:
+    Generate a Rails migration in the db/post_migrate/ dir.
+
+    Interacts with the post_deployment_migrations initializer.
+
+Example:
+    bin/rails generate post_deployment_migration IsolateChanges
+
+    Creates a migration in db/post_migrate/<timestamp>_isolate_changes.rb
+    which will have `disable_ddl_transaction!` and a `change` method included.
diff --git a/lib/generators/post_deployment_migration/post_deployment_migration_generator.rb b/lib/generators/post_deployment_migration/post_deployment_migration_generator.rb
new file mode 100644
index 000000000..adb34a289
--- /dev/null
+++ b/lib/generators/post_deployment_migration/post_deployment_migration_generator.rb
@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+class PostDeploymentMigrationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  include Rails::Generators::Migration
+
+  def create_post_deployment_migration
+    migration_template 'migration.erb', "db/post_migrate/#{file_name}.rb"
+  end
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+end
diff --git a/lib/generators/post_deployment_migration/templates/migration.erb b/lib/generators/post_deployment_migration/templates/migration.erb
new file mode 100644
index 000000000..fd6a02a0f
--- /dev/null
+++ b/lib/generators/post_deployment_migration/templates/migration.erb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  disable_ddl_transaction!
+
+  def change
+  end
+end