actual_db_schema 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca3780aca89ac715ade8441154b10a78b258514b3daa1d23db1ede9d37d63108
-  data.tar.gz: cb4ce56d44d5a5c61d20220ab2ead11830db440438e1dd433d0774cdf23aef97
+  metadata.gz: a49295fefc3c066ebb4ba22ea2304a25013963ce7daf614d97032ec249d2769a
+  data.tar.gz: bb870c91a0896aaf35d304869f2f6af2d9dc190e8d8694ff9a56b56d8c693bc0
 SHA512:
-  metadata.gz: bf59099adf9a660b934fc65c3573460c4034e59876f0770691019799601217b6eeee29b9f3eda43d1ea837380d6da2bb2930819b81dbc9eb334c6bc2f4e4777c
-  data.tar.gz: 8c9f16c0bf8f0571f163bcf07a73fe4b62dc4c031897d2d156e234aac3d4ca749a6380a41e983c5dec722d61909b0aaf09caf1f3b2303f885bc76385da6b1039
+  metadata.gz: ecffe8659acb2add81d97c36418ae6b7f5bb65c053f44856e4da3da9a4c91911e0016bb3fa8c5fbbd463816c45c1fdef63a5ae58fa2b2b4fdb864a47c1946f3a
+  data.tar.gz: cb823af551359b10b97dd3e0d3f51966c076f95ee8b16fcc9d2b1d335348301e17185a8df2e83b62c0a8887caea841b9d8b9df37446de5a36912038a4d518441

data/Appraisals

@@ -6,3 +6,9 @@
     gem "activesupport", "~> #{version}.0"
   end
 end
+
+appraise "rails.edge" do
+  gem "rails", ">= 7.2.0.beta"
+  gem "activerecord", ">= 7.2.0.beta"
+  gem "activesupport", ">= 7.2.0.beta"
+end

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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
+
 ## [0.7.3] - 2024-04-06
 - add multipe databases support
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.7.3)
+    actual_db_schema (0.7.5)
       activerecord (>= 6.0.0)
       activesupport (>= 6.0.0)
       csv
@@ -133,6 +133,8 @@ GEM
     net-smtp (0.4.0)
       net-protocol
     nio4r (2.5.9)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
     nokogiri (1.15.4-x86_64-linux)
@@ -204,6 +206,7 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    sqlite3 (1.6.8-arm64-darwin)
     sqlite3 (1.6.8-x86_64-darwin)
     sqlite3 (1.6.8-x86_64-linux)
     stringio (3.0.8)
@@ -219,6 +222,7 @@ GEM
     zeitwerk (2.6.12)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-darwin-22
   x86_64-linux

data/README.md

@@ -52,15 +52,35 @@ If you cannot commit changes to the repo or Gemfile, consider the local Gemfile
 
 ## Usage
 
-Just run `rails db:migrate` inside the current branch.
+Just run `rails db:migrate` inside the current branch. It will roll back all phantom migrations for all configured databases in your `database.yml.`
 
 > [!WARNING]
 > This solution implies that all migrations are reversible. The irreversible migrations should be solved manually. At the moment, the gem ignores them. You will see warnings in the terminal for each irreversible migrations.
 
 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.
@@ -75,6 +95,29 @@ To release a new version do the following in the order:
 - make the commit and push;
 - run `bundle exec rake release`. This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Running Tests with Specific Rails Versions
+
+The following versions can be specifically tested using Appraisal
+- 6.0
+- 6.1
+- 7.0
+- 7.1
+- edge
+
+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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/widefix/actual_db_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/widefix/actual_db_schema/blob/master/CODE_OF_CONDUCT.md).

data/gemfiles/rails.edge.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", ">= 7.2.0.beta"
+gem "activesupport", ">= 7.2.0.beta"
+gem "minitest", "~> 5.0"
+gem "rake"
+gem "rubocop", "~> 1.21"
+gem "rails", ">= 7.2.0.beta"
+gem "sqlite3"
+
+gemspec path: "../"

data/lib/actual_db_schema/commands/base.rb

@@ -19,10 +19,19 @@ module ActualDbSchema
       end
 
       def context
-        @context ||=
-          ActiveRecord::Base.connection.migration_context.tap do |c|
-            c.extend(ActualDbSchema::Patches::MigrationContext)
-          end
+        @context ||= fetch_migration_context.tap do |c|
+          c.extend(ActualDbSchema::Patches::MigrationContext)
+        end
+      end
+
+      def fetch_migration_context
+        ar_version = Gem::Version.new(ActiveRecord::VERSION::STRING)
+        if ar_version >= Gem::Version.new("7.2.0") ||
+           (ar_version >= Gem::Version.new("7.1.0") && ar_version.prerelease?)
+          ActiveRecord::Base.connection_pool.migration_context
+        else
+          ActiveRecord::Base.connection.migration_context
+        end
       end
     end
   end

data/lib/actual_db_schema/commands/list.rb

@@ -19,11 +19,20 @@ module ActualDbSchema
         puts "\nPhantom migrations\n\n"
         puts "Below is a list of irrelevant migrations executed in unmerged branches."
         puts "To bring your database schema up to date, the migrations marked as \"up\" should be rolled back."
-        puts "\ndatabase: #{ActiveRecord::Base.connection_db_config.database}\n\n"
+        database_path = db_config[:database]
+        puts "\ndatabase: #{database_path}\n\n"
         puts header.join("  ")
         puts "-" * separator_width
       end
 
+      def 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 separator_width
         header.map(&:length).sum + (header.size - 1) * 2
       end

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.3"
+  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
@@ -50,7 +51,11 @@ module ActualDbSchema
   end
 
   def self.migrations_paths
-    ActiveRecord::Base.connection_db_config.migrations_paths
+    if ActiveRecord::Base.respond_to?(:connection_db_config)
+      ActiveRecord::Base.connection_db_config.migrations_paths
+    else
+      ActiveRecord::Base.connection_config[:migrations_paths]
+    end
   end
 
   def self.migration_filename(fullpath)
@@ -60,7 +65,8 @@ module ActualDbSchema
   def self.for_each_db_connection
     configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
     configs.each do |db_config|
-      ActiveRecord::Base.establish_connection(db_config)
+      config = db_config.respond_to?(:config) ? db_config.config : db_config
+      ActiveRecord::Base.establish_connection(config)
       yield
     end
   end

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.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -131,6 +131,7 @@ files:
 - gemfiles/rails.6.1.gemfile
 - gemfiles/rails.7.0.gemfile
 - gemfiles/rails.7.1.gemfile
+- gemfiles/rails.edge.gemfile
 - lib/actual_db_schema.rb
 - lib/actual_db_schema/commands/base.rb
 - lib/actual_db_schema/commands/list.rb
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Keep your DB and schema.rb consistent in dev branches.