actual_db_schema 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85ea0679fbf525eeab14a9b9db7d3bfb49cf514b554427db12d1e784e8c55d9
-  data.tar.gz: 87e02334c37e8d10cae7c05f2aa5df474157100074458d0b41d90b6583ac839c
+  metadata.gz: ba9797cc49da84c28977ef23e93bb8f76a34176614fa12deb3f2e7787dcb880e
+  data.tar.gz: 502f59630d933d643df14de7e50c72c84b4fe00bf8ff0034bb01c604e8d2c343
 SHA512:
-  metadata.gz: '083c8a127fc6350f67904dbc7e4295dacd7e924620e2aa9ce7e515fa4b5a300454c9fa8e4f50905f6f626a66b83f24dc10fb10753ff94d048ec986bbea8f73a4'
-  data.tar.gz: b125355516facc2111e9b48effc33d9eb2946e57c2e75ab2966477357769bf199ff3dd20c3fc1c6765d5a25bccba02aa7b27d3d57688a3781a326368f7b80dce
+  metadata.gz: d0e6ad5b607a3ff67243b5e2ec8d8fa6863068f0e63118de3a2dbda3922892e5c73e036c1c0da7693a7ab427fe923fe82b214adb8640352848c87545f1e8862d
+  data.tar.gz: 8a47aec7467625c6e68e8d35fd2f5035863d8556e7da9e6cce13931d27a06acae823e2beb186286cc62eab0c636e80af866ffcac0e1fab8c3667c89fc76b962c

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## [Unreleased]
+## [0.2.0] - 2022-10-19
+
+- Catch exceptions about irreversible migrations and show a warning
+- Namespace all patches into gem module
+- Fix typo in a module name with a patch
+- Use guard clause
 
 ## [0.1.0] - 2022-10-16
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.1.0)
+    actual_db_schema (0.2.0)
       activerecord
 
 GEM

data/README.md

@@ -1,6 +1,6 @@
 # ActualDbSchema
 
-Keep DB schema consistent while switching between branches with no additional actions.
+Keep Rails DB schema consistent while switching between branches with no additional actions.
 
 ## Installation
 
@@ -18,7 +18,7 @@ And then execute:
 
 ## Usage
 
-TL;TR: Just run `rails db:migrate` inside the current branch.
+TLTR; Just run `rails db:migrate` inside the current branch.
 
 In **branch A** I add a mandatory (not null) field into DB via migration and run it.
 Then I switch to another **branch B**. This branch's code is not aware of that field.
@@ -26,12 +26,20 @@ As the result, the code is failing with an error "null value provided for non-nu
 Moreover, a DB rake task generates a diff on `schema.rb` that's not relevant to this branch.
 I can switch to **branch A** and roll back the migration, but I need to remember that branch or waste time on it.
 
-This code changes the standard migration behavior to save all run migrations inside `tmp/migrations` folder.
-Every run of schema dump (that's a dependency of `db:migrate` task as well) rolls back the "unknown" migrations
-for the current branch looking into the `tmp/migrations` folder.
+Some example of this error:
 
-Using this gem you need to run `rails db:migrate` in the current branch and it will actualize the DB schema.
-You will never have wrongly generated `schema.rb`.
+     ActiveRecord::NotNullViolation:
+       PG::NotNullViolation: ERROR:  null value in column "log" of relation "check_results" violates not-null constraint
+       DETAIL:  Failing row contains (8, 46, success, 2022-10-16 21:47:21.07212, 2022-10-16 21:47:21.07212, null).
+
+This gem saves all run migrations inside `tmp/migrations` folder.
+Every run of schema dump (that's a dependency of `db:migrate` task as well) rolls back the "unknown" for the current branch migrations
+looking into the `tmp/migrations` folder.
+
+You just need to run `rails db:migrate` in the current branch to actualize the DB schema. With its hand, you will never have wrongly generated `schema.rb`.
+
+> **Warning**
+> This solution implies that all migrations are reversible. The cases with irreversible migrations should be solved manually. At the moment, these migrations are ignored by the gem and you will see a warning if some migrations can't roll back automatically.
 
 ## Development
 

data/actual_db_schema.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = <<~DESC
     Switching between branches with migrations and running them can make your DB inconsistent
     and not working in another branch if not roll the migration back.
-    Install this gem and forget about that issue by running the standard rake db:migrate."
+    Install this gem and forget about that issue by running the standard rake db:migrate.
   DESC
   spec.homepage = "https://github.com/widefix/actual_db_schema"
   spec.license = "MIT"

data/lib/actual_db_schema/version.rb

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

data/lib/tasks/db.rake

@@ -1,32 +1,35 @@
 # frozen_string_literal: true
 
-if Rails.env.development?
-  require "active_record/migration"
+return unless Rails.env.development?
 
-  def migrated_folder
-    Rails.root.join("tmp", "migrated").tap { |folder| FileUtils.mkdir_p(folder) }
-  end
+require "active_record/migration"
+
+def migrated_folder
+  Rails.root.join("tmp", "migrated").tap { |folder| FileUtils.mkdir_p(folder) }
+end
 
-  def migration_filename(fullpath)
-    fullpath.split("/").last
+def migration_filename(fullpath)
+  fullpath.split("/").last
+end
+
+# All patches are namespaced into this module
+module ActualDbSchema
+  class << self
+    attr_accessor :failed
   end
 
+  self.failed = []
+
   # Track migrated migrations inside the tmp folder
   module MigrationProxyPatch
     def migrate(direction)
-      if direction == :up
-        FileUtils.copy(filename, migrated_folder.join(basename))
-      else
-        FileUtils.rm(migrated_folder.join(basename))
-      end
       super(direction)
+      FileUtils.copy(filename, migrated_folder.join(basename)) if direction == :up
     end
   end
 
-  ActiveRecord::MigrationProxy.prepend(MigrationProxyPatch)
-
   # Run only one migration that's being rolled back
-  module MigratorPath
+  module MigratorPatch
     def runnable
       migration = migrations.first # there is only one migration, because we pass only one here
       ran?(migration) ? [migration] : []
@@ -38,8 +41,12 @@ if Rails.env.development?
     def rollback_branches
       migrations.each do |migration|
         migrator = ActiveRecord::Migrator.new(:down, [migration], schema_migration, migration.version)
-        migrator.extend(MigratorPath)
+        migrator.extend(ActualDbSchema::MigratorPatch)
         migrator.migrate
+      rescue StandardError => e
+        raise unless e.message.include?("ActiveRecord::IrreversibleMigration")
+
+        ActualDbSchema.failed << migration
       end
     end
 
@@ -54,17 +61,27 @@ if Rails.env.development?
       other_branches_files.reject { migration_filename(_1).in?(current_branch_file_names) }
     end
   end
+end
 
-  namespace :db do
-    desc "Rollback migrations that were run inside not a merged branch."
-    task rollback_branches: :load_config do
-      ActiveRecord::Tasks::DatabaseTasks.raise_for_multi_db(command: "db:rollback_branches")
+ActiveRecord::MigrationProxy.prepend(ActualDbSchema::MigrationProxyPatch)
 
-      context = ActiveRecord::Base.connection.migration_context
-      context.extend(MigrationContextPatch)
-      context.rollback_branches
-    end
+namespace :db do
+  desc "Rollback migrations that were run inside not a merged branch."
+  task rollback_branches: :load_config do
+    ActiveRecord::Tasks::DatabaseTasks.raise_for_multi_db(command: "db:rollback_branches")
 
-    task _dump: :rollback_branches
+    context = ActiveRecord::Base.connection.migration_context
+    context.extend(ActualDbSchema::MigrationContextPatch)
+    context.rollback_branches
+    if ActualDbSchema.failed.any?
+      puts ""
+      puts "[ActualDbSchema] Irreversible migrations were found from other branches. Roll them back or fix manually:"
+      puts ""
+      puts ActualDbSchema.failed.map { |migration| "- #{migration.filename}" }.join("\n")
+      puts ""
+    end
+    # raise ActualDbSchema.failed.inspect
   end
+
+  task _dump: :rollback_branches
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -27,7 +27,7 @@ dependencies:
 description: |
   Switching between branches with migrations and running them can make your DB inconsistent
   and not working in another branch if not roll the migration back.
-  Install this gem and forget about that issue by running the standard rake db:migrate."
+  Install this gem and forget about that issue by running the standard rake db:migrate.
 email:
 - ka8725@gmail.com
 executables: []