Add UI

README.md

@@ -62,6 +62,14 @@ 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/migrations
+```
+This page will display a list of phantom migrations for each database connection and provide options to view details and rollback 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:

app/assets/stylesheets/actual_db_schema/styles.css

@@ -0,0 +1,68 @@
+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 {
+    tr {
+      border-bottom: 1px solid #ddd;
+    }
+
+    tr:nth-child(odd) {
+      background: #f2f2f2;
+    }
+  }
+
+  td {
+    padding: 14px 30px;
+  }
+}
+
+.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 {
+  color: #fff;
+  background-color: #000;
+}
+
+.button-container {
+  display: flex;
+}
+
+pre {
+  background-color: #f7f7f7;
+  padding: 10px;
+  border: 1px solid #ddd;
+}

app/controllers/actual_db_schema/migrations_controller.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Controller to display the list of phantom migrations for each database connection.
+  class MigrationsController < ActionController::Base
+    before_action :load_migrations, only: %i[index]
+
+    def index; end
+
+    def show
+      @migration = load_migration(params[:id], params[:database])
+    end
+
+    def rollback
+      version = params[:id]
+      database = params[:database]
+
+      rollback_migration(version, database)
+
+      redirect_to migrations_path, notice: "Migration #{version} has been rolled back."
+    end
+
+    private
+
+    def load_migrations
+      @migrations = []
+
+      ActualDbSchema.for_each_db_connection do
+        context = prepare_context
+        indexed_phantom_migrations = context.migrations.index_by { |m| m.version.to_s }
+
+        context.migrations_status.each do |status, version|
+          migration = indexed_phantom_migrations[version]
+          next unless migration
+
+          @migrations << build_migration_struct(status, migration)
+        end
+      end
+    end
+
+    def load_migration(version, database)
+      ActualDbSchema.for_each_db_connection do
+        next unless ActualDbSchema.db_config[:database] == database
+
+        context = prepare_context
+        migration = find_migration_in_context(context, version)
+        return migration if migration
+      end
+      nil
+    end
+
+    def rollback_migration(version, database)
+      ActualDbSchema.for_each_db_connection do
+        next unless ActualDbSchema.db_config[:database] == database
+
+        context = prepare_context
+        if context.migrations.detect { |m| m.version.to_s == version }
+          context.run(:down, version.to_i)
+          break
+        end
+      end
+    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 prepare_context
+      context = ActualDbSchema.fetch_migration_context
+      context.extend(ActualDbSchema::Patches::MigrationContext)
+      context
+    end
+
+    def build_migration_struct(status, migration)
+      ActualDbSchema::MigrationStruct.new(
+        status,
+        migration.version.to_s,
+        migration.name,
+        branch_for(migration.version),
+        ActualDbSchema.db_config[:database],
+        migration.filename
+      )
+    end
+
+    def branch_for(version)
+      metadata.fetch(version.to_s, {})[:branch] || "unknown"
+    end
+
+    def metadata
+      ActualDbSchema::Store.instance.read
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Phantom Migrations</title>
+    <%= stylesheet_link_tag 'actual_db_schema/styles', media: 'all' %>
+  </head>
+  <body>
+    <div>
+      <h2>Phantom Migrations</h2>
+      <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>
+              <td><%= migration[:status] %></td>
+              <td><%= migration[:version] %></td>
+              <td><%= migration[:name] %></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' %>
+                </div>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Migration Details</title>
+    <%= stylesheet_link_tag 'actual_db_schema/styles', media: 'all' %>
+  </head>
+  <body>
+    <div>
+      <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' %>
+      </div>
+    </div>
+  </body>
+</html>

config/routes.rb

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

lib/actual_db_schema.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "actual_db_schema/engine"
 require "active_record/migration"
 require "csv"
 require_relative "actual_db_schema/git"
@@ -29,6 +30,8 @@ class << self
     auto_rollback_disabled: ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?
   }
 
+  MigrationStruct = Struct.new(:status, :version, :name, :branch, :database, :filename)
+
   def self.migrated_folder
     migrated_folders.first
   end
@@ -58,6 +61,23 @@ def self.migrations_paths
     end
   end
 
+  def self.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
+
+  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.migration_filename(fullpath)
     fullpath.split("/").last
   end

lib/actual_db_schema/commands/base.rb

@@ -19,20 +19,10 @@ def call_impl
       end
 
       def context
-        @context ||= fetch_migration_context.tap do |c|
+        @context ||= ActualDbSchema.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

lib/actual_db_schema/commands/list.rb

@@ -19,20 +19,11 @@ 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

lib/actual_db_schema/engine.rb

@@ -0,0 +1,20 @@
+# 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.append_routes", after: :add_routing_paths do |app|
+      if Rails.env.development? || Rails.env.test?
+        app.routes.append do
+          mount ActualDbSchema::Engine => "/rails"
+        end
+      end
+    end
+
+    initializer "actual_db_schema.assets.precompile" do |app|
+      app.config.assets.precompile += %w[actual_db_schema/styles.css] if Rails.env.development?
+    end
+  end
+end