actual_db_schema 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc3d368f25e1d191f7a3e3b57215208ecc72cd6c7b40662e4898279b585d0d0e
-  data.tar.gz: a907caa6bad53ff65c4e257a85871350d3ab1aa6f8cce07710436d8a99f9b52c
+  metadata.gz: 957b11aa8112a41c4cc875a2c34510e651c9f41b94ab76c86b765f3f89501a27
+  data.tar.gz: b1d2c2a81647bb18b6a1b3bce71691ff3cac4cd809585a4830bc332a3b135df5
 SHA512:
-  metadata.gz: c5d79fe8513b58084f31a85274c130f4cd6983c271e64b042697ff7e38b5c3be0c4b3af71f5e7f47be09d167a12ca5c1844cdcde9f4e4063b2ac015bb84163cb
-  data.tar.gz: f9914a080827f0e906745cd7b1ff703d594a315e308059b3f614aeeea03d0aa571dc76a827186cdd0f073324bb9536c718891b06f4497f55ec5a48c7447f24de
+  metadata.gz: 9fc19c47a665af2efc5bc1e5e1d37cf8335f11d5f7c3e248e67cfb5d044d69fd626890b31e539f8f0e0fc3f63bdd36ecd3ce624383c42a1320bed9632a037242
+  data.tar.gz: d1af7d177e1dfbd9f7e69e502e5e55d7b73906c0d63b6a3c125ff4af311994feb3b1c5a97ba9eca321a7a8e2aa791016ee3e8de7baffda598f6eb5dcabb10ade

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.7.0] - 2024-01-18
+
+- db:phantom_migrations displays the branch in which the phantion migration was run
+
+## [0.6.0] - 2024-01-03
+
+- Added db:phantom_migrations task to display phantom migrations
+- Updated README
+
 ## [0.5.0] - 2023-11-06
 
 - Rails 7.1 support added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.5.0)
+    actual_db_schema (0.7.0)
       activerecord (>= 6.0.0)
       activesupport (>= 6.0.0)
 

data/README.md

@@ -2,7 +2,37 @@
 
 # ActualDbSchema
 
-Keep Rails DB schema consistent while switching between branches with no additional actions.
+Does switching between branches in your Rails app mess up the DB schema?
+
+Keep the DB schema actual across branches in your Rails project. Just install `actual_db_schema` gem and run `db:migrate` in branches as usual. It automatically rolls back the *phantom migrations* (non-relevant to the current branch). No additional steps are needed.
+
+## Why ActualDbSchema
+
+Still not clear why it's needed? To grasp the purpose of this gem and the issue it addresses, review the problem definition outlined below.
+
+### The problem definition
+
+Imagine you're working on **branch A**. You add a not-null column to a database table with a migration. You run the migration. Then you switch to **branch B**. The code in **branch B** isn't aware of this newly added field. When it tries to write data to the table, it fails with an error `null value provided for non-null field`. Why? The existing code is writing a null value into the column with a not-null constraint.
+
+Here's an example of this error:
+
+    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).
+
+Furthermore, the `db:migrate` task on **branch B** generates an irrelevant diff on the `schema.rb` file, reflecting the new column added in **branch A**.
+
+To fix this, you need to switch back to **branch A**, find the migration that added the problematic field, and roll it back. We'll call it a *phantom migration*. It's a pain, especially if you have a lot of branches in your project because you have to remember which branch the *phantom migration* is in and then manually roll it back.
+
+With `actual_db_schema` gem you don't need to care about that anymore. It saves you time by handling all this dirty work behind the scenes automatically.
+
+### How it solves the issue
+
+This gem stores all run migrations with their code in the `tmp/migrations` folder. Whenever you perform a schema dump, it rolls back the *phantom migrations*.
+
+The *phantom migrations* list is the difference between the migrations you've executed (in the `tmp/migrations` folder) and the current ones (in the `db/migrate` folder).
+
+Therefore, all you do is run rails `db:migrate` in your current branch. `actual_db_schema` will ensure the DB schema is up-to-date. You'll never have an inaccurate `schema.rb` file again.
 
 ## Installation
 
@@ -20,34 +50,20 @@ And then execute:
 
 ## Usage
 
-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.
-As the result, the code is failing with an error "null value provided for non-null field".
-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.
-
-Some example of this error:
-
-     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.
+Just run `rails db:migrate` inside the current branch.
 
-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 irreversible migrations should be solved manually. At the moment, the gem ignores them. You will see warnings in the terminal for each irreversible migrations.
 
-> **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.
+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:phantom_migrations` - displays a list of phantom migrations.
 
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which 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).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update the CHANGELOG, make the commit, push, and then run `bundle exec rake release`, which 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).
 
 ## Contributing
 

data/lib/actual_db_schema/commands/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  module Commands
+    # Base class for all commands
+    class Base
+      def call
+        unless ActualDbSchema.config.fetch(:enabled, true)
+          raise "ActualDbSchema is disabled. Set ActualDbSchema.config[:enabled] = true to enable it."
+        end
+
+        if ActiveRecord::Migration.current_version >= 6
+          ActiveRecord::Tasks::DatabaseTasks.raise_for_multi_db(command: "db:rollback_branches")
+        end
+
+        call_impl
+      end
+
+      private
+
+      def call_impl
+        raise NotImplementedError
+      end
+
+      def context
+        @context ||=
+          ActiveRecord::Base.connection.migration_context.tap do |c|
+            c.extend(ActualDbSchema::Patches::MigrationContext)
+          end
+      end
+    end
+  end
+end

data/lib/actual_db_schema/commands/list.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  module Commands
+    # Shows the list of phantom migrations
+    class List < Base
+      private
+
+      def call_impl
+        preambule
+        table
+      end
+
+      def indexed_phantom_migrations
+        @indexed_phantom_migrations ||= context.migrations.index_by { |m| m.version.to_s }
+      end
+
+      def preambule
+        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"
+        puts header.join("  ")
+        puts "-" * separator_width
+      end
+
+      def separator_width
+        header.map(&:length).sum + (header.size - 1) * 2
+      end
+
+      def header
+        @header ||=
+          [
+            "Status".center(8),
+            "Migration ID".ljust(14),
+            "Branch".ljust(branch_column_width),
+            "Migration File".ljust(16)
+          ]
+      end
+
+      def table
+        context.migrations_status.each do |status, version|
+          line = line_for(status, version)
+          puts line if line
+        end
+      end
+
+      def line_for(status, version)
+        migration = indexed_phantom_migrations[version]
+        return unless migration
+
+        [
+          status.center(8),
+          version.to_s.ljust(14),
+          branch_for(version).ljust(branch_column_width),
+          migration.filename.gsub("#{Rails.root}/", "")
+        ].join("  ")
+      end
+
+      def branch_for(version)
+        metadata.fetch(version, {})[:branch] || "unknown"
+      end
+
+      def metadata
+        @metadata ||= ActualDbSchema::Store.instance.read
+      end
+
+      def longest_branch_name
+        @longest_branch_name ||=
+          metadata.values.map { |v| v[:branch] }.compact.max_by(&:length) || "unknown"
+      end
+
+      def branch_column_width
+        longest_branch_name.length
+      end
+    end
+  end
+end

data/lib/actual_db_schema/commands/rollback.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  module Commands
+    # Rolls back all phantom migrations
+    class Rollback < Base
+      private
+
+      def call_impl
+        context.rollback_branches
+
+        return if ActualDbSchema.failed.empty?
+
+        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
+    end
+  end
+end

data/lib/actual_db_schema/git.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Git helper
+  class Git
+    def self.current_branch
+      `git rev-parse --abbrev-ref HEAD`.strip
+    rescue Errno::ENOENT
+      "unknown"
+    end
+  end
+end

data/lib/actual_db_schema/patches/migration_proxy.rb

@@ -6,7 +6,7 @@ module ActualDbSchema
     module MigrationProxy
       def migrate(direction)
         super(direction)
-        FileUtils.copy(filename, ActualDbSchema.migrated_folder.join(basename)) if direction == :up
+        ActualDbSchema::Store.instance.write(filename) if direction == :up
       end
     end
   end

data/lib/actual_db_schema/store.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Stores the migrated files into the tmp folder
+  class Store
+    include Singleton
+
+    Item = Struct.new(:version, :timestamp, :branch)
+
+    def write(filename)
+      basename = File.basename(filename)
+      FileUtils.copy(filename, folder.join(basename))
+      record_metadata(filename)
+    end
+
+    def read
+      return {} unless File.exist?(store_file)
+
+      CSV.read(store_file).map { |line| Item.new(*line) }.index_by(&:version)
+    end
+
+    private
+
+    def record_metadata(filename)
+      version = File.basename(filename).scan(/(\d+)_.*\.rb/).first.first
+      CSV.open(store_file, "a") do |csv|
+        csv << [
+          version,
+          Time.current.iso8601,
+          Git.current_branch
+        ]
+      end
+    end
+
+    def folder
+      ActualDbSchema.migrated_folder
+    end
+
+    def store_file
+      folder.join("metadata.csv")
+    end
+  end
+end

data/lib/actual_db_schema/version.rb

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

data/lib/actual_db_schema.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
 require "active_record/migration"
+require "csv"
+require_relative "actual_db_schema/git"
+require_relative "actual_db_schema/store"
 require_relative "actual_db_schema/version"
 require_relative "actual_db_schema/patches/migration_proxy"
 require_relative "actual_db_schema/patches/migrator"
 require_relative "actual_db_schema/patches/migration_context"
 
+require_relative "actual_db_schema/commands/base"
+require_relative "actual_db_schema/commands/rollback"
+require_relative "actual_db_schema/commands/list"
+
 # The main module definition
 module ActualDbSchema
   raise NotImplementedError, "ActualDbSchema is only supported in Rails" unless defined?(Rails)

data/lib/tasks/db.rake

@@ -3,24 +3,12 @@
 namespace :db do
   desc "Rollback migrations that were run inside not a merged branch."
   task rollback_branches: :load_config do
-    unless ActualDbSchema.config.fetch(:enabled, true)
-      raise "ActualDbSchema is disabled. Set ActualDbSchema.config[:enabled] = true to enable it."
-    end
-
-    if ActiveRecord::Migration.current_version >= 6
-      ActiveRecord::Tasks::DatabaseTasks.raise_for_multi_db(command: "db:rollback_branches")
-    end
+    ActualDbSchema::Commands::Rollback.new.call
+  end
 
-    context = ActiveRecord::Base.connection.migration_context
-    context.extend(ActualDbSchema::Patches::MigrationContext)
-    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
+  desc "List all phantom migrations - non-relevant migrations that were run inside not a merged branch."
+  task phantom_migrations: :load_config do
+    ActualDbSchema::Commands::List.new.call
   end
 
   task _dump: :rollback_branches

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -119,9 +119,14 @@ files:
 - gemfiles/rails.7.0.gemfile
 - gemfiles/rails.7.1.gemfile
 - lib/actual_db_schema.rb
+- lib/actual_db_schema/commands/base.rb
+- lib/actual_db_schema/commands/list.rb
+- lib/actual_db_schema/commands/rollback.rb
+- lib/actual_db_schema/git.rb
 - lib/actual_db_schema/patches/migration_context.rb
 - lib/actual_db_schema/patches/migration_proxy.rb
 - lib/actual_db_schema/patches/migrator.rb
+- lib/actual_db_schema/store.rb
 - lib/actual_db_schema/version.rb
 - lib/railtie.rb
 - lib/tasks/db.rake