actual_db_schema 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bae784cf88c546a852fea372e8bcbf1356008bc36c9e63c6ff0e18fb1c06bd6
-  data.tar.gz: 0fc13227fd92ecb46f7d10f16d900477115a2ca960c701a2080d19690f1631d3
+  metadata.gz: a49295fefc3c066ebb4ba22ea2304a25013963ce7daf614d97032ec249d2769a
+  data.tar.gz: bb870c91a0896aaf35d304869f2f6af2d9dc190e8d8694ff9a56b56d8c693bc0
 SHA512:
-  metadata.gz: 226db7dc680bb706a73048c1fec3e52685a1e36ac5d5e2cef82511080234e1cc6b789cb5266ea101669462205823ec565da9b059cc7d4b0752fc4f600f0cfbe2
-  data.tar.gz: 47c936d8bb2cddf627dbb04ab8d3993e71a960363d4472c9ef9fa4b2102b89789fea7257333b6b91e38ffe1a288c52b5e72ef619377c97276684a0f46dd04ee1
+  metadata.gz: ecffe8659acb2add81d97c36418ae6b7f5bb65c053f44856e4da3da9a4c91911e0016bb3fa8c5fbbd463816c45c1fdef63a5ae58fa2b2b4fdb864a47c1946f3a
+  data.tar.gz: cb823af551359b10b97dd3e0d3f51966c076f95ee8b16fcc9d2b1d335348301e17185a8df2e83b62c0a8887caea841b9d8b9df37446de5a36912038a4d518441

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.7.5] - 2024-06-20
+- Added db:rollback_migrations:manual task to manually rolls back phantom migrations one by one
+
 ## [0.7.4] - 2024-06-06
 - Rails 7.2 support added
 - Rails 6.0 support added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.7.4)
+    actual_db_schema (0.7.5)
       activerecord (>= 6.0.0)
       activesupport (>= 6.0.0)
       csv

data/README.md

@@ -59,8 +59,28 @@ Just run `rails db:migrate` inside the current branch. It will roll back all pha
 
 The gem offers the following rake tasks that can be manually run according to your preferences:
 - `rails db:rollback_branches` - run it to manually rolls back phantom migrations.
+- `rails db:rollback_branches:manual` - run it to manually rolls back phantom migrations one by one.
 - `rails db:phantom_migrations` - displays a list of phantom migrations.
 
+## Disabling Automatic Rollback
+
+By default, the automatic rollback of migrations is enabled. If you prefer to perform manual rollbacks, you can disable the automatic rollback in two ways:
+
+### 1. Using Environment Variable
+
+Set the environment variable `ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED` to `true`:
+
+```sh
+export ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED=true
+```
+
+### 2. Using Initializer
+Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
+
+```ruby
+ActualDbSchema.config[:auto_rollback_disabled] = true
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -88,12 +108,15 @@ To run tests with a specific version of Rails using Appraisal:
 - Run all tests with Rails 6.0:
   ```sh
   bundle exec appraisal rails.6.0 rake test
+  ```
 - Run tests for a specific file:
   ```sh
   bundle exec appraisal rails.6.0 rake test TEST=test/rake_task_test.rb
+  ```
 - Run a specific test:
   ```sh
   bundle exec appraisal rails.6.0 rake test TEST=test/rake_task_test.rb TESTOPTS="--name=/db::db:rollback_branches#test_0003_keeps/"
+  ```
 
 ## Contributing
 

data/lib/actual_db_schema/commands/rollback.rb

@@ -4,10 +4,15 @@ module ActualDbSchema
   module Commands
     # Rolls back all phantom migrations
     class Rollback < Base
+      def initialize(manual_mode: false)
+        @manual_mode = manual_mode || manual_mode_default?
+        super()
+      end
+
       private
 
       def call_impl
-        context.rollback_branches
+        context.rollback_branches(manual_mode: @manual_mode)
 
         return if ActualDbSchema.failed.empty?
 
@@ -17,6 +22,10 @@ module ActualDbSchema
         puts ActualDbSchema.failed.map { |migration| "- #{migration.filename}" }.join("\n")
         puts ""
       end
+
+      def manual_mode_default?
+        ActualDbSchema.config[:auto_rollback_disabled]
+      end
     end
   end
 end

data/lib/actual_db_schema/patches/migration_context.rb

@@ -4,15 +4,14 @@ module ActualDbSchema
   module Patches
     # Add new command to roll back the phantom migrations
     module MigrationContext
-      def rollback_branches
+      def rollback_branches(manual_mode: false)
         migrations.reverse_each do |migration|
-          migrator = down_migrator_for(migration)
-          migrator.extend(ActualDbSchema::Patches::Migrator)
-          migrator.migrate
-        rescue StandardError => e
-          raise unless e.message.include?("ActiveRecord::IrreversibleMigration")
+          next unless status_up?(migration)
 
-          ActualDbSchema.failed << migration
+          show_info_for(migration) if manual_mode
+          migrate(migration) if !manual_mode || user_wants_rollback?
+        rescue StandardError => e
+          handle_migration_error(e, migration)
         end
       end
 
@@ -36,6 +35,55 @@ module ActualDbSchema
         current_branch_file_names = current_branch_files.map { |f| ActualDbSchema.migration_filename(f) }
         other_branches_files.reject { |f| ActualDbSchema.migration_filename(f).in?(current_branch_file_names) }
       end
+
+      def status_up?(migration)
+        migrations_status.any? do |status, version|
+          status == "up" && version.to_s == migration.version.to_s
+        end
+      end
+
+      def user_wants_rollback?
+        print "\nRollback this migration? [y,n] "
+        answer = $stdin.gets.chomp.downcase
+        answer[0] == "y"
+      end
+
+      def show_info_for(migration)
+        puts "\n[ActualDbSchema] A phantom migration was found and is about to be rolled back."
+        puts "Please make a decision from the options below to proceed.\n\n"
+        puts "Branch: #{branch_for(migration.version.to_s)}"
+        puts "Database: #{db_config[:database]}"
+        puts "Version: #{migration.version}\n\n"
+        puts File.read(migration.filename)
+      end
+
+      def handle_migration_error(error, migration)
+        raise unless error.message.include?("ActiveRecord::IrreversibleMigration")
+
+        ActualDbSchema.failed << migration
+      end
+
+      def migrate(migration)
+        migrator = down_migrator_for(migration)
+        migrator.extend(ActualDbSchema::Patches::Migrator)
+        migrator.migrate
+      end
+
+      def db_config
+        @db_config ||= if ActiveRecord::Base.respond_to?(:connection_db_config)
+                         ActiveRecord::Base.connection_db_config.configuration_hash
+                       else
+                         ActiveRecord::Base.connection_config
+                       end
+      end
+
+      def branch_for(version)
+        metadata.fetch(version, {})[:branch] || "unknown"
+      end
+
+      def metadata
+        @metadata ||= ActualDbSchema::Store.instance.read
+      end
     end
   end
 end

data/lib/actual_db_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActualDbSchema
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

data/lib/actual_db_schema.rb

@@ -25,7 +25,8 @@ module ActualDbSchema
 
   self.failed = []
   self.config = {
-    enabled: Rails.env.development?
+    enabled: Rails.env.development?,
+    auto_rollback_disabled: ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?
   }
 
   def self.migrated_folder

data/lib/tasks/db.rake

@@ -9,6 +9,16 @@ namespace :db do
     end
   end
 
+  namespace :rollback_branches do
+    desc "Manually rollback phantom migrations one by one"
+    task manual: :load_config do
+      ActualDbSchema.failed = []
+      ActualDbSchema.for_each_db_connection do
+        ActualDbSchema::Commands::Rollback.new(manual_mode: true).call
+      end
+    end
+  end
+
   desc "List all phantom migrations - non-relevant migrations that were run inside not a merged branch."
   task phantom_migrations: :load_config do
     ActualDbSchema.for_each_db_connection do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord