actual_db_schema 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4b87fc03cd39a068d303e4e3844a66eb4bd8ced5c7e934c804c0049a3ff141f
-  data.tar.gz: ab30dd516f5c492b2de6e8a41f6d22adcbdc49623a2329ff1948a8114c754823
+  metadata.gz: d78699aee32920e20a6dd084512949d9cc88e7878531de087295d43833463193
+  data.tar.gz: 1e55c7f7b15e0a2fbace58cc80c32deb2061bbe6cd8d8da69f8f35682e9d5b75
 SHA512:
-  metadata.gz: dfa64d7885732bc7e736dcff0c3a66ab5c30d05e80695a729ef8c48c9d478cee8ada3d3dd4566ff0824f884cfd0d244c367915d55971a79ee4a5b60fc53a9e67
-  data.tar.gz: 72a54dd856b12990db02432c63d2aa992e77596ea3af0a4b6e3f83bf31be0a6069edd60222940773adf53f5a3fb286031fa512c7146bacf60fd3fc5424d56036
+  metadata.gz: df1251d4d45888438f9e5ab3585eafa2f2eec2ace597ec0b6985479dc835a67460990e5b6e67534bfeceb779f088b64c65fcff0c9a7b7e16007a90c365f7d93e
+  data.tar.gz: 94a00404bb421f3b3a1124c456358003da71762a652cca2d6e89763bdbc872ddf3f86c2c68ca9b5cc26e12a514869f9c11aba972dfb705f816dc3d43200e63a1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.8.3] - 2025-03-03
+
+- View Schema with Migration Annotations in the UI
+- Clean Up Broken Migrations
+- Filter Migrations in the UI
+- Customize Your Migrated Folder Location
+
 ## [0.8.2] - 2025-02-06
 
 - Show migration name in the schema.rb diff that caused the change

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.8.2)
+    actual_db_schema (0.8.3)
       activerecord
       activesupport
       ast

data/README.md

@@ -72,6 +72,25 @@ 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.
 
+## Migrated Folder Configuration
+
+By default, `actual_db_schema` stores all run migrations in the `tmp/migrated` folder. However, if you want to change this location, you can configure it in two ways:
+
+### 1. Using Environment Variable
+
+Set the environment variable `ACTUAL_DB_SCHEMA_MIGRATED_FOLDER` to your desired folder path:
+
+```sh
+export ACTUAL_DB_SCHEMA_MIGRATED_FOLDER="custom/migrated"
+```
+
+### 2. Using Initializer
+Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
+
+```ruby
+config.migrated_folder = Rails.root.join("custom", "migrated")
+```
+
 ## 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:
@@ -228,6 +247,49 @@ remove_index :users, :email
 rename_column :users, :username, :handle
 ```
 
+## Delete Broken Migrations
+
+A migration is considered broken if it has been migrated in the database but the corresponding migration file is missing. This functionality allows you to safely delete these broken versions from the database to keep it clean.
+
+You can delete broken migrations using either of the following methods:
+
+### 1. Using the UI
+
+Navigate to the following URL in your web browser:
+```
+http://localhost:3000/rails/broken_versions
+```
+
+This page lists all broken versions and provides an option to delete them.
+
+### 2. Using a Rake Task
+
+To delete all broken migrations, run:
+```sh
+rake actual_db_schema:delete_broken_versions
+```
+
+To delete specific migrations, pass the migration version(s) and optionally a database:
+```sh
+rake actual_db_schema:delete_broken_versions[<version>, <version>]
+```
+
+- `<version>` – The migration version(s) to delete (space-separated if multiple).
+- `<database>` (optional) – Specify a database if using multiple databases.
+
+#### Examples:
+
+```sh
+# Delete all broken migrations
+rake actual_db_schema:delete_broken_versions
+
+# Delete specific migrations
+rake actual_db_schema:delete_broken_versions["20250224103352 20250224103358"]
+
+# Delete specific migrations from a specific database
+rake actual_db_schema:delete_broken_versions["20250224103352 20250224103358", "primary"]
+```
+
 ## 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.
@@ -241,7 +303,8 @@ To release a new version do the following in the order:
 - `bundle install` to update `Gemfile.lock`;
 - 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);
-- [announce the new release on GitHub](https://github.com/widefix/actual_db_schema/releases).
+- [announce the new release on GitHub](https://github.com/widefix/actual_db_schema/releases);
+- close the milestone on GitHub.
 
 ### Running Tests with Specific Rails Versions
 

data/app/controllers/actual_db_schema/broken_versions_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Controller for managing broken migration versions.
+  class BrokenVersionsController < ActionController::Base
+    protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
+
+    def index; end
+
+    def delete
+      handle_delete(params[:id], params[:database])
+      redirect_to broken_versions_path
+    end
+
+    def delete_all
+      handle_delete_all
+      redirect_to broken_versions_path
+    end
+
+    private
+
+    def handle_delete(id, database)
+      ActualDbSchema::Migration.instance.delete(id, database)
+      flash[:notice] = "Migration #{id} was successfully deleted."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    def handle_delete_all
+      ActualDbSchema::Migration.instance.delete_all
+      flash[:notice] = "All broken versions were successfully deleted."
+    rescue StandardError => e
+      flash[:alert] = e.message
+    end
+
+    helper_method def broken_versions
+      @broken_versions ||= ActualDbSchema::Migration.instance.broken_versions
+    end
+  end
+end

data/app/controllers/actual_db_schema/migrations_controller.rb

@@ -40,6 +40,20 @@ module ActualDbSchema
 
     helper_method def migrations
       @migrations ||= ActualDbSchema::Migration.instance.all
+      query = params[:query].to_s.strip.downcase
+
+      return @migrations if query.blank?
+
+      @migrations.select do |migration|
+        file_name_matches = migration[:filename].include?(query)
+        content_matches = begin
+          File.read(migration[:filename]).downcase.include?(query)
+        rescue StandardError
+          false
+        end
+
+        file_name_matches || content_matches
+      end
     end
 
     helper_method def migration

data/app/controllers/actual_db_schema/schema_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Controller to display the database schema diff.
+  class SchemaController < ActionController::Base
+    protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
+
+    def index; end
+
+    private
+
+    helper_method def schema_diff_html
+      schema_diff = ActualDbSchema::SchemaDiffHtml.new("./db/schema.rb", "db/migrate")
+      schema_diff.render_html(params[:table])
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Broken Versions</title>
+    <%= render partial: 'actual_db_schema/shared/js' %>
+    <%= render partial: 'actual_db_schema/shared/style' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Broken Versions</h2>
+      <p>
+        These are versions that were migrated in the database, but the corresponding migration file is missing.  
+        You can safely delete them from the database to clean up.
+      </p>
+      <div class="top-buttons">
+        <%= link_to 'All Migrations', migrations_path, class: "top-button" %>
+        <% if broken_versions.present? %>
+          <%= button_to '✖ Delete all',
+                        delete_all_broken_versions_path,
+                        method: :post,
+                        data: { confirm: 'These migrations do not have corresponding migration files. Proceeding will remove these entries from the `schema_migrations` table. Are you sure you want to continue?' },
+                        class: 'button migration-action' %>
+        <% end %>
+      </div>
+      <% if broken_versions.present? %>
+        <table>
+          <thead>
+            <tr>
+              <th>Status</th>
+              <th>Migration ID</th>
+              <th>Branch</th>
+              <th>Database</th>
+              <th>Actions</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% broken_versions.each do |version| %>
+              <tr class="migration-row phantom">
+                <td><%= version[:status] %></td>
+                <td><%= version[:version] %></td>
+                <td><%= version[:branch] %></td>
+                <td><%= version[:database] %></td>
+                <td>
+                  <div class='button-container'>
+                    <%= button_to '✖ Delete',
+                                  delete_broken_version_path(id: version[:version], database: version[:database]),
+                                  method: :post,
+                                  data: { confirm: 'This migration does not have a corresponding migration file. Proceeding will remove its entry from the `schema_migrations` table. Are you sure you want to continue?' },
+                                  class: 'button migration-action' %>
+                  </div>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% else %>
+        <p>No broken versions found.</p>
+      <% end %>
+    </div>
+  </body>
+</html>

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

@@ -14,57 +14,69 @@
       <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>
+      <div class="container">
+        <div class="top-controls">
+          <div class="top-buttons">
+            <%= link_to 'Phantom Migrations', phantom_migrations_path, class: "top-button" %>
+            <%= link_to 'Broken Versions', broken_versions_path, class: "top-button" %>
+            <%= link_to 'View Schema', schema_path, class: "top-button" %>
+          </div>
+          <div class="top-search">
+            <%= form_tag migrations_path, method: :get, class: "search-form" do %>
+              <span class="search-icon">🔍</span>
+              <%= text_field_tag :query, params[:query], placeholder: "Search migrations by name or content", class: "search-input" %>
             <% end %>
-          </tbody>
-        </table>
-      <% else %>
-        <p>No migrations found.</p>
-      <% end %>
+          </div>
+        </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>
     </div>
   </body>
 </html>

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

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Database Schema</title>
+    <%= render partial: 'actual_db_schema/shared/js' %>
+    <%= render partial: 'actual_db_schema/shared/style' %>
+  </head>
+  <body>
+    <div>
+      <% flash.each do |key, message| %>
+        <div class="flash <%= key %>"><%= message %></div>
+      <% end %>
+      <h2>Database Schema</h2>
+      <div class="top-controls">
+        <div class="top-buttons">
+          <%= link_to 'All Migrations', migrations_path, class: "top-button" %>
+        </div>
+        <div class="top-search">
+          <%= form_tag schema_path, method: :get, class: "search-form" do %>
+            <span class="search-icon">🔍</span>
+            <%= text_field_tag :table, params[:table], placeholder: "Filter by table name", class: "search-input" %>
+          <% end %>
+        </div>
+      </div>
+
+      <div class="schema-diff">
+        <pre><%= raw schema_diff_html %></pre>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/actual_db_schema/shared/_js.html

@@ -4,6 +4,12 @@
 
     migrationActions.forEach(button => {
       button.addEventListener('click', function(event) {
+        const confirmMessage = button.dataset.confirm;
+          if (confirmMessage && !confirm(confirmMessage)) {
+            event.preventDefault();
+            return;
+        }
+
         const originalText = button.value;
         button.value = 'Loading...';
         disableButtons();

data/app/views/actual_db_schema/shared/_style.html

@@ -15,6 +15,10 @@
     padding-left: 10px;
   }
 
+  p {
+    padding-left: 10px;
+  }
+
   table {
     margin: 0;
     border-collapse: collapse;
@@ -65,6 +69,7 @@
     text-decoration: none;
     display: inline-block;
     margin: 0 2px;
+    margin-right: 8px;
     cursor: pointer;
     border-radius: 4px;
     transition: background-color 0.3s;
@@ -113,4 +118,44 @@
     background-color: #f8d7da;
     color: #721c24;
   }
+
+  .container {
+    display: inline-block;
+    max-width: 100%;
+  }
+
+  .top-controls {
+    display: flex;
+    justify-content: space-between; 
+    align-items: center;
+    width: 100%;
+  }
+
+  .top-search {
+    display: flex;
+    align-items: center;
+    justify-content: flex-end;
+  }
+
+  .search-form {
+    display: flex;
+    align-items: center;
+  }
+
+  .search-form .search-icon {
+    margin-right: 5px;
+    font-size: 16px;
+  }
+
+  .search-form .search-input {
+    padding: 5px;
+    border: 1px solid #ccc;
+    border-radius: 4px;
+    font-size: 13px;
+    width: 250px;
+  }
+
+  .schema-diff {
+    margin-left: 8px;
+  }
 </style>

data/config/routes.rb

@@ -15,4 +15,14 @@ ActualDbSchema::Engine.routes.draw do
       post :rollback_all
     end
   end
+  resources :broken_versions, only: %i[index] do
+    member do
+      post :delete
+    end
+    collection do
+      post :delete_all
+    end
+  end
+
+  get "schema", to: "schema#index", as: :schema
 end

data/lib/actual_db_schema/configuration.rb

@@ -4,7 +4,7 @@ module ActualDbSchema
   # Manages the configuration settings for the gem.
   class Configuration
     attr_accessor :enabled, :auto_rollback_disabled, :ui_enabled, :git_hooks_enabled, :multi_tenant_schemas,
-                  :console_migrations_enabled
+                  :console_migrations_enabled, :migrated_folder
 
     def initialize
       @enabled = Rails.env.development?
@@ -13,6 +13,7 @@ module ActualDbSchema
       @git_hooks_enabled = ENV["ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED"].present?
       @multi_tenant_schemas = nil
       @console_migrations_enabled = ENV["ACTUAL_DB_SCHEMA_CONSOLE_MIGRATIONS_ENABLED"].present?
+      @migrated_folder = ENV["ACTUAL_DB_SCHEMA_MIGRATED_FOLDER"].present?
     end
 
     def [](key)

data/lib/actual_db_schema/migration.rb

@@ -73,6 +73,43 @@ module ActualDbSchema
       end
     end
 
+    def broken_versions
+      broken = []
+      MigrationContext.instance.each do |context|
+        context.migrations_status.each do |status, version, name|
+          next unless name == "********** NO FILE **********"
+
+          broken << Migration.new(
+            status: status,
+            version: version.to_s,
+            name: name,
+            branch: branch_for(version),
+            database: ActualDbSchema.db_config[:database]
+          )
+        end
+      end
+
+      broken
+    end
+
+    def delete(version, database)
+      validate_broken_migration(version, database)
+
+      MigrationContext.instance.each do
+        next if database && ActualDbSchema.db_config[:database] != database
+        next if ActiveRecord::Base.connection.select_values("SELECT version FROM schema_migrations").exclude?(version)
+
+        ActiveRecord::Base.connection.execute("DELETE FROM schema_migrations WHERE version = '#{version}'")
+        break
+      end
+    end
+
+    def delete_all
+      broken_versions.each do |version|
+        delete(version.version, version.database)
+      end
+    end
+
     private
 
     def build_migration_struct(status, migration)
@@ -92,7 +129,8 @@ module ActualDbSchema
     end
 
     def phantom?(migration)
-      migration.filename.include?("/tmp/migrated")
+      migrated_folder = ActualDbSchema.config[:migrated_folder].presence || "/tmp/migrated"
+      migration.filename.include?(migrated_folder.to_s)
     end
 
     def should_include?(status, migration)
@@ -115,5 +153,15 @@ module ActualDbSchema
       @metadata ||= {}
       @metadata[ActualDbSchema.db_config[:database]] ||= ActualDbSchema::Store.instance.read
     end
+
+    def validate_broken_migration(version, database)
+      if database
+        unless broken_versions.any? { |v| v.version == version && v.database == database }
+          raise StandardError, "Migration is not broken for database #{database}."
+        end
+      else
+        raise StandardError, "Migration is not broken." unless broken_versions.any? { |v| v.version == version }
+      end
+    end
   end
 end

data/lib/actual_db_schema/schema_diff.rb

@@ -63,17 +63,25 @@ module ActualDbSchema
     end
 
     def migrated_folders
+      dirs = find_migrated_folders
+
+      if (configured_migrated_folder = ActualDbSchema.config[:migrated_folder].presence)
+        relative_migrated_folder = configured_migrated_folder.to_s.sub(%r{\A#{Regexp.escape(Rails.root.to_s)}/?}, "")
+        dirs << relative_migrated_folder unless dirs.include?(relative_migrated_folder)
+      end
+
+      dirs.map { |dir| dir.sub(%r{\A\./}, "") }.uniq
+    end
+
+    def find_migrated_folders
       path_parts = Pathname.new(@migrations_path).each_filename.to_a
       db_index = path_parts.index("db")
-
       return [] unless db_index
 
       base_path = db_index.zero? ? "." : File.join(*path_parts[0...db_index])
-      dirs = Dir[File.join(base_path, "tmp", "migrated*")].select do |path|
+      Dir[File.join(base_path, "tmp", "migrated*")].select do |path|
         File.directory?(path) && File.basename(path).match?(/^migrated(_[a-zA-Z0-9_-]+)?$/)
       end
-
-      dirs.map { |dir| dir.sub(%r{\A\./}, "") }
     end
 
     def generate_diff(old_content, new_content)

data/lib/actual_db_schema/schema_diff_html.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Generates an HTML representation of the schema diff,
+  # annotated with the migrations responsible for each change.
+  class SchemaDiffHtml < SchemaDiff
+    def render_html(table_filter)
+      return unless old_schema_content && !old_schema_content.strip.empty?
+
+      @full_diff_html ||= generate_diff_html
+      filter = table_filter.to_s.strip.downcase
+
+      filter.empty? ? @full_diff_html : extract_table_section(@full_diff_html, filter)
+    end
+
+    private
+
+    def generate_diff_html
+      diff_output = generate_full_diff(old_schema_content, new_schema_content)
+      return "<pre>#{ERB::Util.html_escape(new_schema_content)}</pre>" if diff_output.strip.empty?
+
+      process_diff_output_for_html(diff_output)
+    end
+
+    def generate_full_diff(old_content, new_content)
+      Tempfile.create("old_schema") do |old_file|
+        Tempfile.create("new_schema") do |new_file|
+          old_file.write(old_content)
+          new_file.write(new_content)
+          old_file.rewind
+          new_file.rewind
+
+          `diff -u -U 9999999 #{old_file.path} #{new_file.path}`
+        end
+      end
+    end
+
+    def process_diff_output_for_html(diff_str)
+      current_table = nil
+      result_lines = []
+      @tables = {}
+      table_start = nil
+      block_depth = 1
+
+      diff_str.lines.each do |line|
+        next if line.start_with?("---") || line.start_with?("+++") || line.match(/^@@/)
+
+        current_table, table_start, block_depth =
+          process_table(line, current_table, table_start, result_lines.size, block_depth)
+        result_lines << (%w[+ -].include?(line[0]) ? handle_diff_line_html(line, current_table) : line)
+      end
+
+      result_lines.join
+    end
+
+    def process_table(line, current_table, table_start, table_end, block_depth)
+      if (ct = line.match(/create_table\s+["']([^"']+)["']/))
+        return [ct[1], table_end, block_depth]
+      end
+
+      return [current_table, table_start, block_depth] unless current_table
+
+      block_depth += line.scan(/\bdo\b/).size unless line.match(/create_table\s+["']([^"']+)["']/)
+      block_depth -= line.scan(/\bend\b/).size
+
+      if block_depth.zero?
+        @tables[current_table] = { start: table_start, end: table_end }
+        current_table = nil
+        block_depth = 1
+      end
+
+      [current_table, table_start, block_depth]
+    end
+
+    def handle_diff_line_html(line, current_table)
+      sign = line[0]
+      line_content = line[1..]
+      color = SIGN_COLORS[sign]
+
+      action, name = detect_action_and_name(line_content, sign, current_table)
+      annotation = action ? find_migrations(action, current_table, name) : []
+      annotation.any? ? annotate_line(line, annotation, color) : colorize_html(line, color)
+    end
+
+    def annotate_line(line, migration_file_paths, color)
+      links_html = migration_file_paths.map { |path| link_to_migration(path) }.join(", ")
+      "#{colorize_html(line.chomp, color)}#{colorize_html(" // #{links_html} //", :gray)}\n"
+    end
+
+    def colorize_html(text, color)
+      safe = ERB::Util.html_escape(text)
+
+      case color
+      when :green
+        %(<span style="color: green">#{safe}</span>)
+      when :red
+        %(<span style="color: red">#{safe}</span>)
+      when :gray
+        %(<span style="color: gray">#{text}</span>)
+      end
+    end
+
+    def link_to_migration(migration_file_path)
+      migration = migrations.detect { |m| m.filename == migration_file_path }
+      return ERB::Util.html_escape(migration_file_path) unless migration
+
+      url = "migrations/#{migration.version}?database=#{migration.database}"
+      "<a href=\"#{url}\">#{ERB::Util.html_escape(migration_file_path)}</a>"
+    end
+
+    def migrations
+      @migrations ||= ActualDbSchema::Migration.instance.all
+    end
+
+    def extract_table_section(full_diff_html, table_name)
+      return unless @tables[table_name]
+
+      range = @tables[table_name]
+      full_diff_html.lines[range[:start]..range[:end]].join
+    end
+  end
+end

data/lib/actual_db_schema/version.rb

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

data/lib/actual_db_schema.rb

@@ -19,6 +19,7 @@ require_relative "actual_db_schema/git_hooks"
 require_relative "actual_db_schema/multi_tenant"
 require_relative "actual_db_schema/railtie"
 require_relative "actual_db_schema/schema_diff"
+require_relative "actual_db_schema/schema_diff_html"
 require_relative "actual_db_schema/schema_parser"
 
 require_relative "actual_db_schema/commands/base"
@@ -58,7 +59,7 @@ module ActualDbSchema
   end
 
   def self.default_migrated_folder
-    Rails.root.join("tmp", "migrated")
+    config[:migrated_folder] || Rails.root.join("tmp", "migrated")
   end
 
   def self.migrations_paths

data/lib/generators/actual_db_schema/templates/actual_db_schema.rb

@@ -21,7 +21,11 @@ ActualDbSchema.configure do |config|
   # If your application leverages multiple schemas for multi-tenancy, define the active schemas.
   # config.multi_tenant_schemas = -> { ["public", "tenant1", "tenant2"] }
 
-  # Enable console migrations
+  # Enable console migrations.
   # config.console_migrations_enabled = true
   config.console_migrations_enabled = ENV["ACTUAL_DB_SCHEMA_CONSOLE_MIGRATIONS_ENABLED"].present?
+
+  # Define the migrated folder location.
+  # config.migrated_folder = Rails.root.join("custom", "migrated")
+  config.migrated_folder = Rails.root.join("tmp", "migrated")
 end

data/lib/tasks/actual_db_schema.rake

@@ -55,11 +55,35 @@ namespace :actual_db_schema do # rubocop:disable Metrics/BlockLength
   end
 
   desc "Show the schema.rb diff annotated with the migrations that made the changes"
-  task :diff_schema_with_migrations, [:schema_path, :migrations_path] do |_, args|
-    schema_path = args[:schema_path] || "db/schema.rb"
+  task :diff_schema_with_migrations, %i[schema_path migrations_path] => :environment do |_, args|
+    schema_path = args[:schema_path] || "./db/schema.rb"
     migrations_path = args[:migrations_path] || "db/migrate"
 
     schema_diff = ActualDbSchema::SchemaDiff.new(schema_path, migrations_path)
     puts schema_diff.render
   end
+
+  desc "Delete broken migration versions from the database"
+  task :delete_broken_versions, %i[versions database] => :environment do |_, args|
+    extend ActualDbSchema::OutputFormatter
+
+    if args[:versions]
+      versions = args[:versions].split(" ").map(&:strip)
+      versions.each do |version|
+        ActualDbSchema::Migration.instance.delete(version, args[:database])
+        puts colorize("[ActualDbSchema] Migration #{version} was successfully deleted.", :green)
+      rescue StandardError => e
+        puts colorize("[ActualDbSchema] Error deleting version #{version}: #{e.message}", :red)
+      end
+    elsif ActualDbSchema::Migration.instance.broken_versions.empty?
+      puts colorize("[ActualDbSchema] No broken versions found.", :gray)
+    else
+      begin
+        ActualDbSchema::Migration.instance.delete_all
+        puts colorize("[ActualDbSchema] All broken versions were successfully deleted.", :green)
+      rescue StandardError => e
+        puts colorize("[ActualDbSchema] Error deleting all broken versions: #{e.message}", :red)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -155,12 +155,16 @@ files:
 - README.md
 - Rakefile
 - actual_db_schema.gemspec
+- app/controllers/actual_db_schema/broken_versions_controller.rb
 - app/controllers/actual_db_schema/migrations_controller.rb
 - app/controllers/actual_db_schema/phantom_migrations_controller.rb
+- app/controllers/actual_db_schema/schema_controller.rb
+- app/views/actual_db_schema/broken_versions/index.html.erb
 - 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
+- app/views/actual_db_schema/schema/index.html.erb
 - app/views/actual_db_schema/shared/_js.html
 - app/views/actual_db_schema/shared/_style.html
 - config/routes.rb
@@ -192,6 +196,7 @@ files:
 - lib/actual_db_schema/patches/migrator.rb
 - lib/actual_db_schema/railtie.rb
 - lib/actual_db_schema/schema_diff.rb
+- lib/actual_db_schema/schema_diff_html.rb
 - lib/actual_db_schema/schema_parser.rb
 - lib/actual_db_schema/store.rb
 - lib/actual_db_schema/version.rb