actual_db_schema 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9197558d7b71582d339535933b2186c9ce3db7d0c4dd492759db5a226931ddf8
-  data.tar.gz: ccd05c4164478a54130c6bee32a234abbb2f193292438b8d35b6d7edd313802c
+  metadata.gz: d78699aee32920e20a6dd084512949d9cc88e7878531de087295d43833463193
+  data.tar.gz: 1e55c7f7b15e0a2fbace58cc80c32deb2061bbe6cd8d8da69f8f35682e9d5b75
 SHA512:
-  metadata.gz: b12528875d4b7d5b12739b1a37877d979bccc6d66f7a0006454ae260b1215eb69bb5baa2aae332e68bc4f1fa29859e4b00a427591cf78acf2aebc57264889a46
-  data.tar.gz: ae2baeaae67451740cc6773abbc79e4d0896baf96b99e7c2baebe027c1b7b05bbbbb75da5717be47c43d240835810a1681408e79c3d44449f7f44c3d4e8830a6
+  metadata.gz: df1251d4d45888438f9e5ab3585eafa2f2eec2ace597ec0b6985479dc835a67460990e5b6e67534bfeceb779f088b64c65fcff0c9a7b7e16007a90c365f7d93e
+  data.tar.gz: 94a00404bb421f3b3a1124c456358003da71762a652cca2d6e89763bdbc872ddf3f86c2c68ca9b5cc26e12a514869f9c11aba972dfb705f816dc3d43200e63a1

data/.rubocop.yml

@@ -22,9 +22,12 @@ Metrics/BlockLength:
     - actual_db_schema.gemspec
 
 Metrics/MethodLength:
+  Max: 15
   Exclude:
     -  test/**/*
 
 Metrics/ClassLength:
-  Exclude:
-    -  test/**/*
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [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
+- Easy way to run DDL migration methods in Rails console
+
 ## [0.8.1] - 2025-01-15
 
 - Support for multiple database schemas, ensuring compatibility with multi-tenant applications using the apartment gem or similar solutions

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.8.1)
+    actual_db_schema (0.8.3)
       activerecord
       activesupport
+      ast
       csv
+      parser
 
 GEM
   remote: https://rubygems.org/

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:
@@ -168,6 +187,109 @@ config.multi_tenant_schemas = -> { # list of all active schemas }
 config.multi_tenant_schemas = -> { ["public", "tenant1", "tenant2"] }
 ```
 
+## Schema Diff with Migration Annotations
+
+If `schema.rb` generates a diff, it can be helpful to find out which migrations caused the changes. This helps you decide whether to resolve the diff on your own or discuss it with your teammates to determine the next steps. The `diff_schema_with_migrations` Rake task generates a diff of the `schema.rb` file, annotated with the migrations responsible for each change. This makes it easier to trace which migration introduced a specific schema modification, enabling faster and more informed decision-making regarding how to handle the diff.
+
+By default, the task uses `db/schema.rb` and `db/migrate` as the schema and migrations paths. You can also provide custom paths as arguments.
+
+### Usage
+
+Run the task with default paths:
+```sh
+rake actual_db_schema:diff_schema_with_migrations
+```
+
+Run the task with custom paths:
+```sh
+rake actual_db_schema:diff_schema_with_migrations[path/to/custom_schema.rb, path/to/custom_migrations]
+```
+
+## Console Migrations
+
+Sometimes, it's necessary to modify the database without creating migration files. This can be useful for fixing a corrupted schema, conducting experiments (such as adding and removing indexes), or quickly adjusting the schema in development. This gem allows you to run the same commands used in migrations directly in the Rails console.
+
+By default, Console Migrations is disabled. You can enable it in two ways:
+
+### 1. Using Environment Variable
+
+Set the environment variable `ACTUAL_DB_SCHEMA_CONSOLE_MIGRATIONS_ENABLED` to `true`:
+
+```sh
+export ACTUAL_DB_SCHEMA_CONSOLE_MIGRATIONS_ENABLED=true
+```
+
+### 2. Using Initializer
+
+Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
+
+```ruby
+config.console_migrations_enabled = true
+```
+
+### Usage
+
+Once enabled, you can run migration commands directly in the Rails console:
+
+```ruby
+# Create a new table
+create_table :posts do |t|
+  t.string :title
+end
+
+# Add a column
+add_column :users, :age, :integer
+
+# Remove an index
+remove_index :users, :email
+
+# Rename a column
+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.
@@ -181,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/actual_db_schema.gemspec

@@ -37,7 +37,9 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_runtime_dependency "activerecord"
   spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "ast"
   spec.add_runtime_dependency "csv"
+  spec.add_runtime_dependency "parser"
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "debug"

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

@@ -3,7 +3,8 @@
 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
+    attr_accessor :enabled, :auto_rollback_disabled, :ui_enabled, :git_hooks_enabled, :multi_tenant_schemas,
+                  :console_migrations_enabled, :migrated_folder
 
     def initialize
       @enabled = Rails.env.development?
@@ -11,6 +12,8 @@ module ActualDbSchema
       @ui_enabled = Rails.env.development? || ENV["ACTUAL_DB_SCHEMA_UI_ENABLED"].present?
       @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/console_migrations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Provides methods for executing schema modification commands directly in the Rails console.
+  module ConsoleMigrations
+    extend self
+
+    SCHEMA_METHODS = %i[
+      create_table
+      create_join_table
+      drop_table
+      change_table
+      add_column
+      remove_column
+      change_column
+      change_column_null
+      change_column_default
+      rename_column
+      add_index
+      remove_index
+      rename_index
+      add_timestamps
+      remove_timestamps
+      reversible
+      add_reference
+      remove_reference
+      add_foreign_key
+      remove_foreign_key
+    ].freeze
+
+    SCHEMA_METHODS.each do |method_name|
+      define_method(method_name) do |*args, **kwargs, &block|
+        if kwargs.any?
+          migration_instance.public_send(method_name, *args, **kwargs, &block)
+        else
+          migration_instance.public_send(method_name, *args, &block)
+        end
+      end
+    end
+
+    private
+
+    def migration_instance
+      @migration_instance ||= Class.new(ActiveRecord::Migration[ActiveRecord::Migration.current_version]) {}.new
+    end
+  end
+end