actual_db_schema 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a49295fefc3c066ebb4ba22ea2304a25013963ce7daf614d97032ec249d2769a
-  data.tar.gz: bb870c91a0896aaf35d304869f2f6af2d9dc190e8d8694ff9a56b56d8c693bc0
+  metadata.gz: a731a134ac425aed56e92b8c715812d17c9c1b3d519580281f7284dd05ae8d4a
+  data.tar.gz: e262bafa9ebc123fc702baa883fae55ac30a030d778ef9123f1f88cddb6b9192
 SHA512:
-  metadata.gz: ecffe8659acb2add81d97c36418ae6b7f5bb65c053f44856e4da3da9a4c91911e0016bb3fa8c5fbbd463816c45c1fdef63a5ae58fa2b2b4fdb864a47c1946f3a
-  data.tar.gz: cb823af551359b10b97dd3e0d3f51966c076f95ee8b16fcc9d2b1d335348301e17185a8df2e83b62c0a8887caea841b9d8b9df37446de5a36912038a4d518441
+  metadata.gz: 03aecc678b4de3e808367715de4c7d193ebab7fb036fbba31b0d0da771637b165bc348ad08bce50dd6a5472701065e8888b9aecbed042a282627fa792260ba39
+  data.tar.gz: 81fa7c7b457be66ab587fa1062a61236fb5e578060b6565a2d26f1eaebd6817bdad09e6ec2b15ffbd8a5d489d84b42463fd02689bc8257a0e308f2cd6987e0ce

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.7.6] - 2024-07-22
+- Added UI
+- Added environment variable `ACTUAL_DB_SCHEMA_UI_ENABLED` to enable/disable the UI in specific environments
+- Added configuration option `ActualDbSchema.config[:ui_enabled]` to enable/disable the UI in specific environments
+
 ## [0.7.5] - 2024-06-20
 - Added db:rollback_migrations:manual task to manually rolls back phantom migrations one by one
 

data/Gemfile.lock

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

data/README.md

@@ -62,6 +62,35 @@ The gem offers the following rake tasks that can be manually run according to yo
 - `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.
 
+## Accessing the UI
+
+The UI for managing migrations is enabled automatically. To access the UI, simply navigate to the following URL in your web browser:
+```
+http://localhost:3000/rails/phantom_migrations
+```
+This page displays a list of phantom migrations for each database connection and provides options to view details and rollback them.
+
+## UI options
+
+By default, the UI is enabled in the development environment. If you prefer to enable the UI for another environment, you can do so in two ways:
+
+### 1. Using Environment Variable
+
+Set the environment variable `ACTUAL_DB_SCHEMA_UI_ENABLED` to `true`:
+
+```sh
+export ACTUAL_DB_SCHEMA_UI_ENABLED=true
+```
+
+### 2. Using Initializer
+Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
+
+```ruby
+ActualDbSchema.config[:ui_enabled] = true
+```
+
+> With this option, the UI can be disabled for all environments or be enabled in specific ones.
+
 ## 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:

data/app/assets/javascripts/application.js

@@ -0,0 +1,39 @@
+document.addEventListener('DOMContentLoaded', function () {
+  const migrationActions = document.querySelectorAll('.migration-action');
+
+  migrationActions.forEach(button => {
+    button.addEventListener('click', function (event) {
+      const originalText = button.value;
+      button.value = 'Loading...';
+      disableButtons();
+
+      fetch(event.target.form.action, { method: 'POST'})
+      .then(response => {
+        if (response.ok) {
+          window.location.reload();
+        } else {
+          throw new Error('Network response was not ok.');
+        }
+      })
+      .catch(error => {
+        console.error('There has been a problem with your fetch operation:', error);
+        enableButtons();
+        button.value = originalText;
+      });
+
+      event.preventDefault();
+    });
+  });
+
+  function disableButtons() {
+    migrationActions.forEach(button => {
+      button.disabled = true;
+    });
+  }
+
+  function enableButtons() {
+    migrationActions.forEach(button => {
+      button.disabled = false;
+    });
+  }
+});

data/app/assets/stylesheets/styles.css

@@ -0,0 +1,114 @@
+body {
+  margin: 8px;
+  background-color: #fff;
+  color: #333;
+}
+
+body, p, td {
+  font-family: helvetica, verdana, arial, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+h2 {
+  padding-left: 10px;
+}
+
+table {
+  margin: 0;
+  border-collapse: collapse;
+
+  thead tr {
+    border-bottom: 2px solid #ddd;
+  }
+
+  tbody {
+    .migration-row.phantom {
+      background-color: #fff3f3;
+    }
+    
+    .migration-row.normal {
+      background-color: #ffffff;
+    }
+    
+    .migration-row:nth-child(odd).phantom {
+      background-color: #ffe6e6;
+    }
+    
+    .migration-row:nth-child(odd).normal {
+      background-color: #f9f9f9;
+    }
+  }
+
+  td {
+    padding: 14px 30px;
+  }
+}
+
+.top-buttons {
+  margin: 8px;
+  display: flex;
+  align-items: center;
+
+  .top-button {
+    background-color: #ddd;
+  }
+}
+
+.button, .top-button {
+  font-weight: bold;
+  color: #000;
+  border: none;
+  padding: 5px 10px;
+  text-align: center;
+  text-decoration: none;
+  display: inline-block;
+  margin: 0 2px;
+  cursor: pointer;
+  border-radius: 4px;
+  transition: background-color 0.3s;
+  background: none;
+}
+
+.button:hover, .top-button:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+.button:disabled, .button:hover:disabled {
+  background-color: transparent;
+  color: #666;
+  cursor: not-allowed;
+}
+
+.button-container {
+  display: flex;
+}
+
+pre {
+  background-color: #f7f7f7;
+  padding: 10px;
+  border: 1px solid #ddd;
+}
+
+.truncate-text {
+  max-width: 200px;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.flash {
+  padding: 10px;
+  margin-bottom: 10px;
+  border-radius: 5px;
+}
+
+.flash.notice {
+  background-color: #d4edda;
+  color: #155724;
+}
+
+.flash.alert {
+  background-color: #f8d7da;
+  color: #721c24;
+}

data/app/controllers/actual_db_schema/migrations_controller.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Controller to display the list of migrations for each database connection.
+  class MigrationsController < ActionController::Base
+    protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
+
+    def index; end
+
+    def show
+      render file: "#{Rails.root}/public/404.html", layout: false, status: :not_found unless migration
+    end
+
+    def rollback
+      handle_rollback(params[:id], params[:database])
+      redirect_to migrations_path
+    end
+
+    def migrate
+      handle_migrate(params[:id], params[:database])
+      redirect_to migrations_path
+    end
+
+    private
+
+    def handle_rollback(id, database)
+      ActualDbSchema::Migration.instance.rollback(id, database)
+      flash[:notice] = "Migration #{id} was successfully rolled back."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    def handle_migrate(id, database)
+      ActualDbSchema::Migration.instance.migrate(id, database)
+      flash[:notice] = "Migration #{id} was successfully migrated."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    helper_method def migrations
+      @migrations ||= ActualDbSchema::Migration.instance.all
+    end
+
+    helper_method def migration
+      @migration ||= ActualDbSchema::Migration.instance.find(params[:id], params[:database])
+    end
+  end
+end

data/app/controllers/actual_db_schema/phantom_migrations_controller.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Controller to display the list of phantom migrations for each database connection.
+  class PhantomMigrationsController < ActionController::Base
+    protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
+
+    def index; end
+
+    def show
+      render file: "#{Rails.root}/public/404.html", layout: false, status: :not_found unless phantom_migration
+    end
+
+    def rollback
+      handle_rollback(params[:id], params[:database])
+      redirect_to phantom_migrations_path
+    end
+
+    def rollback_all
+      handle_rollback_all
+      redirect_to phantom_migrations_path
+    end
+
+    private
+
+    def handle_rollback(id, database)
+      ActualDbSchema::Migration.instance.rollback(id, database)
+      flash[:notice] = "Migration #{id} was successfully rolled back."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    def handle_rollback_all
+      ActualDbSchema::Migration.instance.rollback_all
+      flash[:notice] = "Migrations was successfully rolled back."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    helper_method def phantom_migrations
+      @phantom_migrations ||= ActualDbSchema::Migration.instance.all_phantom
+    end
+
+    helper_method def phantom_migration
+      @phantom_migration ||= ActualDbSchema::Migration.instance.find(params[:id], params[:database])
+    end
+  end
+end

data/app/views/actual_db_schema/migrations/index.html.erb

@@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Migrations</title>
+    <%= stylesheet_link_tag 'styles', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Migrations</h2>
+      <p>
+        <span style="background-color: #ffe6e6; padding: 0 5px;">Red rows</span> represent phantom migrations.
+      </p>
+      <div class="top-buttons">
+        <%= link_to 'Phantom Migrations', phantom_migrations_path, class: "top-button" %>
+      </div>
+      <% if migrations.present? %>
+        <table>
+          <thead>
+            <tr>
+              <th>Status</th>
+              <th>Migration ID</th>
+              <th>Name</th>
+              <th>Branch</th>
+              <th>Database</th>
+              <th>Actions</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% migrations.each do |migration| %>
+              <tr class="migration-row <%= migration[:phantom] ? 'phantom' : 'normal' %>">
+                <td><%= migration[:status] %></td>
+                <td><%= migration[:version] %></td>
+                <td>
+                  <div class="truncate-text" title="<%= migration[:name] %>">
+                    <%= migration[:name] %>
+                  </div>
+                </td>
+                <td><%= migration[:branch] %></td>
+                <td><%= migration[:database] %></td>
+                <td>
+                  <div class='button-container'>
+                    <%= link_to '👁 Show',
+                                migration_path(id: migration[:version], database: migration[:database]),
+                                class: 'button' %>
+                    <%= button_to '⎌ Rollback',
+                                  rollback_migration_path(id: migration[:version], database: migration[:database]),
+                                  method: :post,
+                                  class: 'button migration-action',
+                                  style: ('display: none;' if migration[:status] == "down") %>
+                    <%= button_to '⬆ Migrate',
+                                  migrate_migration_path(id: migration[:version], database: migration[:database]),
+                                  method: :post,
+                                  class: 'button migration-action',
+                                  style: ('display: none;' if migration[:status] == "up" || migration[:phantom]) %>
+                  </div>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% else %>
+        <p>No migrations found.</p>
+      <% end %>
+    </div>
+  </body>
+</html>

data/app/views/actual_db_schema/migrations/show.html.erb

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Migration Details</title>
+    <%= stylesheet_link_tag 'styles', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Migration <%= migration[:name] %> Details</h2>
+      <table>
+        <tbody>
+          <tr>
+            <th>Status</th>
+            <td><%= migration[:status] %></td>
+          </tr>
+          <tr>
+            <th>Migration ID</th>
+            <td><%= migration[:version] %></td>
+          </tr>
+          <tr>
+            <th>Branch</th>
+            <td><%= migration[:branch] %></td>
+          </tr>
+          <tr>
+            <th>Database</th>
+            <td><%= migration[:database] %></td>
+          </tr>
+          <tr>
+            <th>Path</th>
+            <td><%= migration[:filename] %></td>
+          </tr>
+        </tbody>
+      </table>
+
+      <h3>Migration Code</h3>
+      <div>
+        <pre><%= File.read(migration[:filename]) %></pre>
+      </div>
+      <div class='button-container'>
+        <%= link_to '← Back', migrations_path, class: 'button' %>
+        <%= button_to '⎌ Rollback',
+                      rollback_migration_path(id: migration[:version], database: migration[:database]),
+                      method: :post,
+                      class: 'button migration-action',
+                      style: ('display: none;' if migration[:status] == "down") %>
+        <%= button_to '⬆ Migrate',
+                      migrate_migration_path(id: migration[:version], database: migration[:database]),
+                      method: :post,
+                      class: 'button migration-action',
+                      style: ('display: none;' if migration[:status] == "up" || migration[:phantom]) %>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/actual_db_schema/phantom_migrations/index.html.erb

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Phantom Migrations</title>
+    <%= stylesheet_link_tag 'styles', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Phantom Migrations</h2>
+      <div class="top-buttons">
+        <%= link_to 'All Migrations', migrations_path, class: "top-button" %>
+        <% if phantom_migrations.present? %>
+          <%= button_to '⎌ Rollback all',
+                        rollback_all_phantom_migrations_path,
+                        method: :post,
+                        class: 'button migration-action' %>
+        <% end %>
+      </div>
+      <% if phantom_migrations.present? %>
+        <table>
+          <thead>
+            <tr>
+              <th>Status</th>
+              <th>Migration ID</th>
+              <th>Name</th>
+              <th>Branch</th>
+              <th>Database</th>
+              <th>Actions</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% phantom_migrations.each do |migration| %>
+              <tr class="migration-row phantom">
+                <td><%= migration[:status] %></td>
+                <td><%= migration[:version] %></td>
+                <td>
+                  <div class="truncate-text" title="<%= migration[:name] %>">
+                    <%= migration[:name] %>
+                  </div>
+                </td>
+                <td><%= migration[:branch] %></td>
+                <td><%= migration[:database] %></td>
+                <td>
+                  <div class='button-container'>
+                    <%= link_to '👁 Show',
+                                phantom_migration_path(id: migration[:version], database: migration[:database]),
+                                class: 'button' %>
+                    <%= button_to '⎌ Rollback',
+                                  rollback_phantom_migration_path(id: migration[:version], database: migration[:database]),
+                                  method: :post,
+                                  class: 'button migration-action' %>
+                  </div>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% else %>
+        <p>No phantom migrations found.</p>
+      <% end %>
+    </div>
+  </body>
+</html>

data/app/views/actual_db_schema/phantom_migrations/show.html.erb

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Phantom Migration Details</title>
+    <%= stylesheet_link_tag 'styles', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Phantom Migration <%= phantom_migration[:name] %> Details</h2>
+      <table>
+        <tbody>
+          <tr>
+            <th>Status</th>
+            <td><%= phantom_migration[:status] %></td>
+          </tr>
+          <tr>
+            <th>Migration ID</th>
+            <td><%= phantom_migration[:version] %></td>
+          </tr>
+          <tr>
+            <th>Branch</th>
+            <td><%= phantom_migration[:branch] %></td>
+          </tr>
+          <tr>
+            <th>Database</th>
+            <td><%= phantom_migration[:database] %></td>
+          </tr>
+          <tr>
+            <th>Path</th>
+            <td><%= phantom_migration[:filename] %></td>
+          </tr>
+        </tbody>
+      </table>
+
+      <h3>Migration Code</h3>
+      <div>
+        <pre><%= File.read(phantom_migration[:filename]) %></pre>
+      </div>
+      <div class='button-container'>
+        <%= link_to '← Back', phantom_migrations_path, class: 'button' %>
+        <%= button_to '⎌ Rollback',
+                      rollback_phantom_migration_path(id: params[:id], database: params[:database]),
+                      method: :post,
+                      class: 'button migration-action' %>
+      </div>
+    </div>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+ActualDbSchema::Engine.routes.draw do
+  resources :migrations, only: %i[index show] do
+    member do
+      post :rollback
+      post :migrate
+    end
+  end
+  resources :phantom_migrations, only: %i[index show] do
+    member do
+      post :rollback
+    end
+    collection do
+      post :rollback_all
+    end
+  end
+end

data/lib/actual_db_schema/commands/base.rb

@@ -4,6 +4,12 @@ module ActualDbSchema
   module Commands
     # Base class for all commands
     class Base
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+      end
+
       def call
         unless ActualDbSchema.config.fetch(:enabled, true)
           raise "ActualDbSchema is disabled. Set ActualDbSchema.config[:enabled] = true to enable it."
@@ -17,22 +23,6 @@ module ActualDbSchema
       def call_impl
         raise NotImplementedError
       end
-
-      def context
-        @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
 end

data/lib/actual_db_schema/commands/list.rb

@@ -12,27 +12,18 @@ module ActualDbSchema
       end
 
       def indexed_phantom_migrations
-        @indexed_phantom_migrations ||= context.migrations.index_by { |m| m.version.to_s }
+        @indexed_phantom_migrations ||= context.phantom_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."
-        database_path = db_config[:database]
-        puts "\ndatabase: #{database_path}\n\n"
+        puts "\ndatabase: #{ActualDbSchema.db_config[:database]}\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
@@ -66,14 +57,14 @@ module ActualDbSchema
         ].join("  ")
       end
 
-      def branch_for(version)
-        metadata.fetch(version, {})[:branch] || "unknown"
-      end
-
       def metadata
         @metadata ||= ActualDbSchema::Store.instance.read
       end
 
+      def branch_for(version)
+        metadata.fetch(version, {})[:branch] || "unknown"
+      end
+
       def longest_branch_name
         @longest_branch_name ||=
           metadata.values.map { |v| v[:branch] }.compact.max_by(&:length) || "unknown"

data/lib/actual_db_schema/commands/rollback.rb

@@ -4,9 +4,9 @@ module ActualDbSchema
   module Commands
     # Rolls back all phantom migrations
     class Rollback < Base
-      def initialize(manual_mode: false)
+      def initialize(context, manual_mode: false)
         @manual_mode = manual_mode || manual_mode_default?
-        super()
+        super(context)
       end
 
       private

data/lib/actual_db_schema/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # It isolates the namespace to avoid conflicts with the main application.
+  class Engine < ::Rails::Engine
+    isolate_namespace ActualDbSchema
+
+    initializer "actual_db_schema.initialize" do |app|
+      if ActualDbSchema.config[:ui_enabled]
+        app.routes.append do
+          mount ActualDbSchema::Engine => "/rails"
+        end
+
+        app.config.assets.precompile += %w[styles.css application.js]
+      end
+    end
+  end
+end

data/lib/actual_db_schema/migration.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # The Migration class is responsible for managing and retrieving migration information
+  class Migration
+    include Singleton
+
+    Migration = Struct.new(:status, :version, :name, :branch, :database, :filename, :phantom, keyword_init: true)
+
+    def all_phantom
+      migrations = []
+
+      MigrationContext.instance.each do |context|
+        indexed_migrations = context.phantom_migrations.index_by { |m| m.version.to_s }
+
+        context.migrations_status.each do |status, version|
+          migration = indexed_migrations[version]
+          migrations << build_migration_struct(status, migration) if should_include?(status, migration)
+        end
+      end
+
+      sort_migrations_desc(migrations)
+    end
+
+    def all
+      migrations = []
+
+      MigrationContext.instance.each do |context|
+        indexed_migrations = context.migrations.index_by { |m| m.version.to_s }
+
+        context.migrations_status.each do |status, version|
+          migration = indexed_migrations[version]
+          migrations << build_migration_struct(status, migration) if should_include?(status, migration)
+        end
+      end
+
+      sort_migrations_desc(migrations)
+    end
+
+    def find(version, database)
+      MigrationContext.instance.each do |context|
+        next unless ActualDbSchema.db_config[:database] == database
+
+        migration = find_migration_in_context(context, version)
+        return migration if migration
+      end
+      nil
+    end
+
+    def rollback(version, database)
+      MigrationContext.instance.each do |context|
+        next unless ActualDbSchema.db_config[:database] == database
+
+        if context.migrations.detect { |m| m.version.to_s == version }
+          context.run(:down, version.to_i)
+          break
+        end
+      end
+    end
+
+    def rollback_all
+      MigrationContext.instance.each(&:rollback_branches)
+    end
+
+    def migrate(version, database)
+      MigrationContext.instance.each do |context|
+        next unless ActualDbSchema.db_config[:database] == database
+
+        if context.migrations.detect { |m| m.version.to_s == version }
+          context.run(:up, version.to_i)
+          break
+        end
+      end
+    end
+
+    private
+
+    def build_migration_struct(status, migration)
+      Migration.new(
+        status: status,
+        version: migration.version.to_s,
+        name: migration.name,
+        branch: branch_for(migration.version),
+        database: ActualDbSchema.db_config[:database],
+        filename: migration.filename,
+        phantom: phantom?(migration)
+      )
+    end
+
+    def sort_migrations_desc(migrations)
+      migrations.sort_by { |migration| migration[:version].to_i }.reverse if migrations.any?
+    end
+
+    def phantom?(migration)
+      migration.filename.include?("/tmp/migrated")
+    end
+
+    def should_include?(status, migration)
+      migration && (status == "up" || !phantom?(migration))
+    end
+
+    def find_migration_in_context(context, version)
+      migration = context.migrations.detect { |m| m.version.to_s == version }
+      return unless migration
+
+      status = context.migrations_status.detect { |_s, v| v.to_s == version }&.first || "unknown"
+      build_migration_struct(status, migration)
+    end
+
+    def branch_for(version)
+      metadata.fetch(version.to_s, {})[:branch] || "unknown"
+    end
+
+    def metadata
+      @metadata ||= {}
+      @metadata[ActualDbSchema.db_config[:database]] ||= ActualDbSchema::Store.instance.read
+    end
+  end
+end

data/lib/actual_db_schema/migration_context.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # The class manages connections to each database and provides the appropriate migration context for each connection.
+  class MigrationContext
+    include Singleton
+
+    def each
+      configs.each do |db_config|
+        establish_connection(db_config)
+        yield context
+      end
+    end
+
+    private
+
+    def establish_connection(db_config)
+      config = db_config.respond_to?(:config) ? db_config.config : db_config
+      ActiveRecord::Base.establish_connection(config)
+    end
+
+    def configs
+      ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
+    end
+
+    def context
+      ar_version = Gem::Version.new(ActiveRecord::VERSION::STRING)
+      context = 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
+      context.extend(ActualDbSchema::Patches::MigrationContext)
+    end
+  end
+end

data/lib/actual_db_schema/patches/migration_context.rb

@@ -5,7 +5,7 @@ module ActualDbSchema
     # Add new command to roll back the phantom migrations
     module MigrationContext
       def rollback_branches(manual_mode: false)
-        migrations.reverse_each do |migration|
+        phantom_migrations.reverse_each do |migration|
           next unless status_up?(migration)
 
           show_info_for(migration) if manual_mode
@@ -15,6 +15,16 @@ module ActualDbSchema
         end
       end
 
+      def phantom_migrations
+        paths = Array(migrations_paths)
+        current_branch_files = Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+        current_branch_file_names = current_branch_files.map { |f| ActualDbSchema.migration_filename(f) }
+
+        migrations.reject do |migration|
+          current_branch_file_names.include?(ActualDbSchema.migration_filename(migration.filename))
+        end
+      end
+
       private
 
       def down_migrator_for(migration)
@@ -31,9 +41,13 @@ module ActualDbSchema
         paths = Array(migrations_paths)
         current_branch_files = Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
         other_branches_files = Dir["#{ActualDbSchema.migrated_folder}/**/[0-9]*_*.rb"]
+        current_branch_versions = current_branch_files.map { |file| file.match(/(\d+)_/)[1] }
+        filtered_other_branches_files = other_branches_files.reject do |file|
+          version = file.match(/(\d+)_/)[1]
+          current_branch_versions.include?(version)
+        end
 
-        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) }
+        current_branch_files + filtered_other_branches_files
       end
 
       def status_up?(migration)
@@ -52,7 +66,7 @@ module ActualDbSchema
         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 "Database: #{ActualDbSchema.db_config[:database]}"
         puts "Version: #{migration.version}\n\n"
         puts File.read(migration.filename)
       end
@@ -69,14 +83,6 @@ module ActualDbSchema
         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

data/lib/actual_db_schema/version.rb

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

data/lib/actual_db_schema.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require "actual_db_schema/engine"
 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/migration"
+require_relative "actual_db_schema/migration_context"
 require_relative "actual_db_schema/patches/migration_proxy"
 require_relative "actual_db_schema/patches/migrator"
 require_relative "actual_db_schema/patches/migration_context"
@@ -17,8 +20,6 @@ require_relative "actual_db_schema/commands/list"
 module ActualDbSchema
   raise NotImplementedError, "ActualDbSchema is only supported in Rails" unless defined?(Rails)
 
-  require "railtie"
-
   class << self
     attr_accessor :config, :failed
   end
@@ -26,7 +27,8 @@ module ActualDbSchema
   self.failed = []
   self.config = {
     enabled: Rails.env.development?,
-    auto_rollback_disabled: ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?
+    auto_rollback_disabled: ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?,
+    ui_enabled: Rails.env.development? || ENV["ACTUAL_DB_SCHEMA_UI_ENABLED"].present?
   }
 
   def self.migrated_folder
@@ -58,17 +60,16 @@ module ActualDbSchema
     end
   end
 
-  def self.migration_filename(fullpath)
-    fullpath.split("/").last
+  def self.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 self.for_each_db_connection
-    configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
-    configs.each do |db_config|
-      config = db_config.respond_to?(:config) ? db_config.config : db_config
-      ActiveRecord::Base.establish_connection(config)
-      yield
-    end
+  def self.migration_filename(fullpath)
+    fullpath.split("/").last
   end
 end
 

data/lib/tasks/db.rake

@@ -4,8 +4,8 @@ namespace :db do
   desc "Rollback migrations that were run inside not a merged branch."
   task rollback_branches: :load_config do
     ActualDbSchema.failed = []
-    ActualDbSchema.for_each_db_connection do
-      ActualDbSchema::Commands::Rollback.new.call
+    ActualDbSchema::MigrationContext.instance.each do |context|
+      ActualDbSchema::Commands::Rollback.new(context).call
     end
   end
 
@@ -13,16 +13,16 @@ namespace :db 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
+      ActualDbSchema::MigrationContext.instance.each do |context|
+        ActualDbSchema::Commands::Rollback.new(context, 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
-      ActualDbSchema::Commands::List.new.call
+    ActualDbSchema::MigrationContext.instance.each do |context|
+      ActualDbSchema::Commands::List.new(context).call
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,6 +127,15 @@ files:
 - README.md
 - Rakefile
 - actual_db_schema.gemspec
+- app/assets/javascripts/application.js
+- app/assets/stylesheets/styles.css
+- app/controllers/actual_db_schema/migrations_controller.rb
+- app/controllers/actual_db_schema/phantom_migrations_controller.rb
+- app/views/actual_db_schema/migrations/index.html.erb
+- app/views/actual_db_schema/migrations/show.html.erb
+- app/views/actual_db_schema/phantom_migrations/index.html.erb
+- app/views/actual_db_schema/phantom_migrations/show.html.erb
+- config/routes.rb
 - gemfiles/rails.6.0.gemfile
 - gemfiles/rails.6.1.gemfile
 - gemfiles/rails.7.0.gemfile
@@ -136,13 +145,15 @@ files:
 - 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/engine.rb
 - lib/actual_db_schema/git.rb
+- lib/actual_db_schema/migration.rb
+- lib/actual_db_schema/migration_context.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
 - sig/actual_db_schema.rbs
 homepage: https://blog.widefix.com/actual-db-schema/

data/lib/railtie.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "rails"
-
-module ActualDbSchema
-  # Load the task into Rails app
-  class Railtie < Rails::Railtie
-    railtie_name :actual_db_schema
-
-    rake_tasks do
-      path = File.expand_path(__dir__)
-      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
-    end
-  end
-end