actual_db_schema 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43a6d3a4c89ea984fe7b4cbc6160a9f459951bac207d2592b609ae0a7606fd76
-  data.tar.gz: ac2dcb733bb87bdf8dcf5daa250eb386e0ac15f99297d0feb53815e308fb3915
+  metadata.gz: 9197558d7b71582d339535933b2186c9ce3db7d0c4dd492759db5a226931ddf8
+  data.tar.gz: ccd05c4164478a54130c6bee32a234abbb2f193292438b8d35b6d7edd313802c
 SHA512:
-  metadata.gz: 1bd9b3d3ed5145aacc2d0a481742dc3a45e707257dc3290de245ca4e6ce8db26aaad75619bb0212273aedc6dc30c833e0e604d84c5a1711ea0d1bf8d0cef0dc2
-  data.tar.gz: bbc183547eeb23566c326405519120af7e4e1aea2525ade5c7f8711985d90b6d3d142322bcc19b955a1605f58074420c28657646a16be8c667d47aeae2531ebc
+  metadata.gz: b12528875d4b7d5b12739b1a37877d979bccc6d66f7a0006454ae260b1215eb69bb5baa2aae332e68bc4f1fa29859e4b00a427591cf78acf2aebc57264889a46
+  data.tar.gz: ae2baeaae67451740cc6773abbc79e4d0896baf96b99e7c2baebe027c1b7b05bbbbb75da5717be47c43d240835810a1681408e79c3d44449f7f44c3d4e8830a6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.8.1] - 2025-01-15
+
+- Support for multiple database schemas, ensuring compatibility with multi-tenant applications using the apartment gem or similar solutions
+- DSL for configuring the gem, simplifying setup and customization
+- Rake task added to initialize the gem
+- Improved the post-checkout git hook to run only when switching branches, reducing unnecessary executions during file checkouts
+- Fixed the changelog link in the gemspec, ensuring Rubygems points to the correct file and the link works
+
 ## [0.8.0] - 2024-12-30
 - Enhanced Console Visibility: Automatically rolled-back phantom migrations now provide clearer and more visible logs in the console
 - Git Hooks for Branch Management: Introduced hooks that automatically rollback phantom migrations after checking out a branch. Additionally, the schema migration rake task can now be executed automatically upon branch checkout

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.8.0)
+    actual_db_schema (0.8.1)
       activerecord
       activesupport
       csv
@@ -222,6 +222,7 @@ GEM
     zeitwerk (2.6.12)
 
 PLATFORMS
+  arm64-darwin-22
   arm64-darwin-23
   x86_64-darwin-20
   x86_64-darwin-22

data/README.md

@@ -50,6 +50,16 @@ And then execute:
 
 If you cannot commit changes to the repo or Gemfile, consider the local Gemfile installation described in [this post](https://blog.widefix.com/personal-gemfile-for-development/).
 
+Next, generate your ActualDbSchema initializer file by running:
+
+```sh
+rake actual_db_schema:install
+```
+
+This will create a `config/initializers/actual_db_schema.rb` file with all the available configuration options so you can adjust them as needed. It will also prompt you to install the post-checkout Git hook for automatic phantom migration rollback when switching branches.
+
+For more details on the available configuration options, see the sections below.
+
 ## Usage
 
 Just run `rails db:migrate` inside the current branch. It will roll back all phantom migrations for all configured databases in your `database.yml.`
@@ -86,7 +96,7 @@ export ACTUAL_DB_SCHEMA_UI_ENABLED=true
 Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
 
 ```ruby
-ActualDbSchema.config[:ui_enabled] = true
+config.ui_enabled = true
 ```
 
 > With this option, the UI can be disabled for all environments or be enabled in specific ones.
@@ -107,7 +117,7 @@ export ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED=true
 Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
 
 ```ruby
-ActualDbSchema.config[:auto_rollback_disabled] = true
+config.auto_rollback_disabled = true
 ```
 
 ## Automatic Phantom Migration Rollback On Branch Switch
@@ -126,7 +136,7 @@ export ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED=true
 Add the following line to your initializer file (`config/initializers/actual_db_schema.rb`):
 
 ```ruby
-ActualDbSchema.config[:git_hooks_enabled] = true
+config.git_hooks_enabled = true
 ```
 
 ### Installing the Post-Checkout Hook
@@ -144,6 +154,20 @@ This task will prompt you to choose one of the three options:
 
 Based on your selection, a post-checkout hook will be installed or updated in your `.git/hooks` folder.
 
+## Multi-Tenancy Support
+
+If your application leverages multiple schemas for multi-tenancy — such as those implemented by the [apartment](https://github.com/influitive/apartment) gem or similar solutions — you can configure ActualDbSchema to handle migrations across all schemas. To do so, add the following configuration to your initializer file (`config/initializers/actual_db_schema.rb`):
+
+```ruby
+config.multi_tenant_schemas = -> { # list of all active schemas }
+```
+
+### Example:
+
+```ruby
+config.multi_tenant_schemas = -> { ["public", "tenant1", "tenant2"] }
+```
+
 ## 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.
@@ -182,6 +206,24 @@ To run tests with a specific version of Rails using Appraisal:
   bundle exec appraisal rails.6.0 rake test TEST=test/rake_task_test.rb TESTOPTS="--name=/db::db:rollback_branches#test_0003_keeps/"
   ```
 
+By default, `rake test` runs tests using `SQLite3`. To explicitly run tests with `SQLite3`, `PostgreSQL`, or `MySQL`, you can use the following tasks:
+- Run tests with `SQLite3`:
+  ```sh
+  bundle exec rake test:sqlite3
+  ```
+- Run tests with `PostgreSQL` (requires Docker):
+  ```sh
+  bundle exec rake test:postgresql
+  ```
+- Run tests with `MySQL` (requires Docker):
+  ```sh
+  bundle exec rake test:mysql2
+  ```
+- Run tests for all supported adapters:
+  ```sh
+  bundle exec rake test:all
+  ```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/widefix/actual_db_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/widefix/actual_db_schema/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -3,6 +3,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+load "lib/tasks/test.rake"
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/actual_db_schema.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/widefix/actual_db_schema"
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/widefix/actual_db_schema/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -47,10 +47,10 @@ Gem::Specification.new do |spec|
   spec.post_install_message = <<~MSG
     Thank you for installing ActualDbSchema!
 
-    To enable automatic rollback of phantom migrations when switching branches, follow these steps:
-    1. Set `export ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED=true` in your environment, OR
-       add `ActualDbSchema.config[:git_hooks_enabled] = true` to your initializer.
-    2. Run `rake actual_db_schema:install_git_hooks` to install the post-checkout Git hook.
+    Next steps:
+    1. Run `rake actual_db_schema:install` to generate the initializer file and install
+       the post-checkout Git hook for automatic phantom migration rollback when switching branches.
+    2. Or, if you prefer environment variables, skip this step.
 
     For more information, see the README.
 

data/docker/mysql-init/create_secondary_db.sql

@@ -0,0 +1 @@
+CREATE DATABASE actual_db_schema_test_secondary;

data/docker/postgres-init/create_secondary_db.sql

@@ -0,0 +1 @@
+CREATE DATABASE actual_db_schema_test_secondary;

data/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.8'
+
+services:
+  postgres:
+    image: postgres:14
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: actual_db_schema_test
+    ports:
+      - "5432:5432"
+    volumes:
+      - ./docker/postgres-init:/docker-entrypoint-initdb.d
+
+  mysql:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: actual_db_schema_test
+    ports:
+      - "3306:3306"
+    volumes:
+    - ./docker/mysql-init:/docker-entrypoint-initdb.d

data/gemfiles/rails.6.0.gemfile

@@ -7,6 +7,8 @@ source "https://rubygems.org"
 gem "activerecord", "~> 6.0.0"
 gem "activesupport", "~> 6.0.0"
 gem "minitest", "~> 5.0"
+gem "mysql2", "~> 0.5.2"
+gem "pg", "~> 1.5"
 gem "rake"
 gem "rubocop", "~> 1.21"
 gem "sqlite3", "~> 1.4.0"

data/gemfiles/rails.6.1.gemfile

@@ -7,6 +7,8 @@ source "https://rubygems.org"
 gem "activerecord", "~> 6.1.0"
 gem "activesupport", "~> 6.1.0"
 gem "minitest", "~> 5.0"
+gem "mysql2", "~> 0.5.2"
+gem "pg", "~> 1.5"
 gem "rake"
 gem "rubocop", "~> 1.21"
 gem "sqlite3", "~> 1.4.0"

data/gemfiles/rails.7.0.gemfile

@@ -7,6 +7,8 @@ source "https://rubygems.org"
 gem "activerecord", "~> 7.0.0"
 gem "activesupport", "~> 7.0.0"
 gem "minitest", "~> 5.0"
+gem "mysql2", "~> 0.5.2"
+gem "pg", "~> 1.5"
 gem "rake"
 gem "rubocop", "~> 1.21"
 gem "sqlite3", "~> 1.4.0"

data/gemfiles/rails.7.1.gemfile

@@ -7,6 +7,8 @@ source "https://rubygems.org"
 gem "activerecord", "~> 7.1.0"
 gem "activesupport", "~> 7.1.0"
 gem "minitest", "~> 5.0"
+gem "mysql2", "~> 0.5.2"
+gem "pg", "~> 1.5"
 gem "rake"
 gem "rubocop", "~> 1.21"
 gem "sqlite3", "~> 1.4.0"

data/gemfiles/rails.edge.gemfile

@@ -7,6 +7,8 @@ source "https://rubygems.org"
 gem "activerecord", ">= 7.2.0.beta"
 gem "activesupport", ">= 7.2.0.beta"
 gem "minitest", "~> 5.0"
+gem "mysql2", "~> 0.5.2"
+gem "pg", "~> 1.5"
 gem "rake"
 gem "rubocop", "~> 1.21"
 gem "rails", ">= 7.2.0.beta"

data/lib/actual_db_schema/commands/rollback.rb

@@ -17,7 +17,7 @@ module ActualDbSchema
       def call_impl
         rolled_back = context.rollback_branches(manual_mode: @manual_mode)
 
-        return unless rolled_back
+        return unless rolled_back || ActualDbSchema.failed.any?
 
         ActualDbSchema.failed.empty? ? print_success : print_error
       end
@@ -43,11 +43,10 @@ module ActualDbSchema
 
       def failed_migrations_list
         ActualDbSchema.failed.map.with_index(1) do |failed, index|
-          <<~MIGRATION
-            #{colorize("Migration ##{index}:", :yellow)}
-              File: #{failed.short_filename}
-              Branch: #{failed.branch}
-          MIGRATION
+          migration_details = colorize("Migration ##{index}:\n", :yellow)
+          migration_details += "  File: #{failed.short_filename}\n"
+          migration_details += "  Schema: #{failed.schema}\n" if failed.schema
+          migration_details + "  Branch: #{failed.branch}\n"
         end.join("\n")
       end
 

data/lib/actual_db_schema/configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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
+
+    def initialize
+      @enabled = Rails.env.development?
+      @auto_rollback_disabled = ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?
+      @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
+    end
+
+    def [](key)
+      public_send(key)
+    end
+
+    def []=(key, value)
+      public_send("#{key}=", value)
+    end
+
+    def fetch(key, default = nil)
+      if respond_to?(key)
+        public_send(key)
+      else
+        default
+      end
+    end
+  end
+end

data/lib/actual_db_schema/failed_migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActualDbSchema
-  FailedMigration = Struct.new(:migration, :exception, :branch, keyword_init: true) do
+  FailedMigration = Struct.new(:migration, :exception, :branch, :schema, keyword_init: true) do
     def filename
       migration.filename
     end

data/lib/actual_db_schema/git_hooks.rb

@@ -15,6 +15,11 @@ module ActualDbSchema
       # ActualDbSchema post-checkout hook (ROLLBACK)
       # Runs db:rollback_branches on branch checkout.
 
+      # Check if this is a file checkout or creating a new branch
+      if [ "$3" == "0" ] || [ "$1" == "$2" ]; then
+        exit 0
+      fi
+
       if [ -f ./bin/rails ]; then
         if [ -n "$ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED" ]; then
           GIT_HOOKS_ENABLED="$ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED"
@@ -34,6 +39,11 @@ module ActualDbSchema
       # ActualDbSchema post-checkout hook (MIGRATE)
       # Runs db:migrate on branch checkout.
 
+      # Check if this is a file checkout or creating a new branch
+      if [ "$3" == "0" ] || [ "$1" == "$2" ]; then
+        exit 0
+      fi
+
       if [ -f ./bin/rails ]; then
         if [ -n "$ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED" ]; then
           GIT_HOOKS_ENABLED="$ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED"

data/lib/actual_db_schema/multi_tenant.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Handles multi-tenancy support by switching schemas for supported databases
+  module MultiTenant
+    include ActualDbSchema::OutputFormatter
+
+    class << self
+      def with_schema(schema_name)
+        context = switch_schema(schema_name)
+        yield
+      ensure
+        restore_context(context)
+      end
+
+      private
+
+      def adapter_name
+        ActiveRecord::Base.connection.adapter_name
+      end
+
+      def switch_schema(schema_name)
+        case adapter_name
+        when /postgresql/i
+          switch_postgresql_schema(schema_name)
+        when /mysql/i
+          switch_mysql_schema(schema_name)
+        else
+          message = "[ActualDbSchema] Multi-tenancy not supported for adapter: #{adapter_name}. " \
+            "Proceeding without schema switching."
+          puts colorize(message, :gray)
+        end
+      end
+
+      def switch_postgresql_schema(schema_name)
+        old_search_path = ActiveRecord::Base.connection.schema_search_path
+        ActiveRecord::Base.connection.schema_search_path = schema_name
+        { type: :postgresql, old_context: old_search_path }
+      end
+
+      def switch_mysql_schema(schema_name)
+        old_db = ActiveRecord::Base.connection.current_database
+        ActiveRecord::Base.connection.execute("USE #{ActiveRecord::Base.connection.quote_table_name(schema_name)}")
+        { type: :mysql, old_context: old_db }
+      end
+
+      def restore_context(context)
+        return unless context
+
+        case context[:type]
+        when :postgresql
+          ActiveRecord::Base.connection.schema_search_path = context[:old_context] if context[:old_context]
+        when :mysql
+          return unless context[:old_context]
+
+          ActiveRecord::Base.connection.execute(
+            "USE #{ActiveRecord::Base.connection.quote_table_name(context[:old_context])}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/actual_db_schema/patches/migration_context.rb

@@ -3,23 +3,21 @@
 module ActualDbSchema
   module Patches
     # Add new command to roll back the phantom migrations
-    module MigrationContext
+    module MigrationContext # rubocop:disable Metrics/ModuleLength
       include ActualDbSchema::OutputFormatter
 
       def rollback_branches(manual_mode: false)
-        rolled_back = false
+        schemas = multi_tenant_schemas&.call || []
+        schema_count = schemas.any? ? schemas.size : 1
 
-        phantom_migrations.reverse_each do |migration|
-          next unless status_up?(migration)
+        rolled_back_migrations = if schemas.any?
+                                   rollback_multi_tenant(schemas, manual_mode: manual_mode)
+                                 else
+                                   rollback_branches_for_schema(manual_mode: manual_mode)
+                                 end
 
-          rolled_back = true
-          show_info_for(migration) if manual_mode
-          migrate(migration) if !manual_mode || user_wants_rollback?
-        rescue StandardError => e
-          handle_rollback_error(migration, e)
-        end
-
-        rolled_back
+        delete_migrations(rolled_back_migrations, schema_count)
+        rolled_back_migrations.any?
       end
 
       def phantom_migrations
@@ -34,6 +32,32 @@ module ActualDbSchema
 
       private
 
+      def rollback_branches_for_schema(manual_mode: false, schema_name: nil, rolled_back_migrations: [])
+        phantom_migrations.reverse_each do |migration|
+          next unless status_up?(migration)
+
+          show_info_for(migration, schema_name) if manual_mode
+          migrate(migration, rolled_back_migrations, schema_name) if !manual_mode || user_wants_rollback?
+        rescue StandardError => e
+          handle_rollback_error(migration, e, schema_name)
+        end
+
+        rolled_back_migrations
+      end
+
+      def rollback_multi_tenant(schemas, manual_mode: false)
+        all_rolled_back_migrations = []
+
+        schemas.each do |schema_name|
+          ActualDbSchema::MultiTenant.with_schema(schema_name) do
+            rollback_branches_for_schema(manual_mode: manual_mode, schema_name: schema_name,
+                                         rolled_back_migrations: all_rolled_back_migrations)
+          end
+        end
+
+        all_rolled_back_migrations
+      end
+
       def down_migrator_for(migration)
         if ActiveRecord::Migration.current_version < 6
           ActiveRecord::Migrator.new(:down, [migration], migration.version)
@@ -69,26 +93,29 @@ module ActualDbSchema
         answer[0] == "y"
       end
 
-      def show_info_for(migration)
+      def show_info_for(migration, schema_name = nil)
         puts colorize("\n[ActualDbSchema] A phantom migration was found and is about to be rolled back.", :gray)
         puts "Please make a decision from the options below to proceed.\n\n"
+        puts "Schema: #{schema_name}" if schema_name
         puts "Branch: #{branch_for(migration.version.to_s)}"
         puts "Database: #{ActualDbSchema.db_config[:database]}"
         puts "Version: #{migration.version}\n\n"
         puts File.read(migration.filename)
       end
 
-      def migrate(migration)
+      def migrate(migration, rolled_back_migrations, schema_name = nil)
         migration.name = extract_class_name(migration.filename)
 
-        message = "[ActualDbSchema] Rolling back phantom migration #{migration.version} #{migration.name} " \
-            "(from branch: #{branch_for(migration.version.to_s)})"
+        message = "[ActualDbSchema]"
+        message += " #{schema_name}:" if schema_name
+        message += " Rolling back phantom migration #{migration.version} #{migration.name} " \
+                   "(from branch: #{branch_for(migration.version.to_s)})"
         puts colorize(message, :gray)
 
         migrator = down_migrator_for(migration)
         migrator.extend(ActualDbSchema::Patches::Migrator)
         migrator.migrate
-        File.delete(migration.filename)
+        rolled_back_migrations << migration
       end
 
       def extract_class_name(filename)
@@ -104,20 +131,45 @@ module ActualDbSchema
         @metadata ||= ActualDbSchema::Store.instance.read
       end
 
-      def handle_rollback_error(migration, exception)
+      def handle_rollback_error(migration, exception, schema_name = nil)
         error_message = <<~ERROR
           Error encountered during rollback:
 
-          #{exception.message.gsub(/^An error has occurred, all later migrations canceled:\s*/, "").strip}
+          #{cleaned_exception_message(exception.message)}
         ERROR
 
         puts colorize(error_message, :red)
         ActualDbSchema.failed << FailedMigration.new(
           migration: migration,
           exception: exception,
-          branch: branch_for(migration.version.to_s)
+          branch: branch_for(migration.version.to_s),
+          schema: schema_name
         )
       end
+
+      def cleaned_exception_message(message)
+        patterns_to_remove = [
+          /^An error has occurred, all later migrations canceled:\s*/,
+          /^An error has occurred, this and all later migrations canceled:\s*/
+        ]
+
+        patterns_to_remove.reduce(message.strip) { |msg, pattern| msg.gsub(pattern, "").strip }
+      end
+
+      def delete_migrations(migrations, schema_count)
+        migration_counts = migrations.each_with_object(Hash.new(0)) do |migration, hash|
+          hash[migration.filename] += 1
+        end
+
+        migrations.uniq.each do |migration|
+          count = migration_counts[migration.filename]
+          File.delete(migration.filename) if count == schema_count && File.exist?(migration.filename)
+        end
+      end
+
+      def multi_tenant_schemas
+        ActualDbSchema.config[:multi_tenant_schemas]
+      end
     end
   end
 end

data/lib/actual_db_schema/version.rb

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

data/lib/actual_db_schema.rb

@@ -4,6 +4,7 @@ require "actual_db_schema/engine"
 require "active_record/migration"
 require "csv"
 require_relative "actual_db_schema/git"
+require_relative "actual_db_schema/configuration"
 require_relative "actual_db_schema/store"
 require_relative "actual_db_schema/version"
 require_relative "actual_db_schema/migration"
@@ -14,6 +15,7 @@ require_relative "actual_db_schema/patches/migration_proxy"
 require_relative "actual_db_schema/patches/migrator"
 require_relative "actual_db_schema/patches/migration_context"
 require_relative "actual_db_schema/git_hooks"
+require_relative "actual_db_schema/multi_tenant"
 
 require_relative "actual_db_schema/commands/base"
 require_relative "actual_db_schema/commands/rollback"
@@ -28,12 +30,11 @@ module ActualDbSchema
   end
 
   self.failed = []
-  self.config = {
-    enabled: Rails.env.development?,
-    auto_rollback_disabled: ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?,
-    ui_enabled: Rails.env.development? || ENV["ACTUAL_DB_SCHEMA_UI_ENABLED"].present?,
-    git_hooks_enabled: ENV["ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED"].present?
-  }
+  self.config = Configuration.new
+
+  def self.configure
+    yield(config)
+  end
 
   def self.migrated_folder
     migrated_folders.first

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# ActualDbSchema initializer
+# Adjust the configuration as needed.
+
+ActualDbSchema.configure do |config|
+  # Enable the gem.
+  config.enabled = Rails.env.development?
+
+  # Disable automatic rollback of phantom migrations.
+  # config.auto_rollback_disabled = true
+  config.auto_rollback_disabled = ENV["ACTUAL_DB_SCHEMA_AUTO_ROLLBACK_DISABLED"].present?
+
+  # Enable the UI for managing migrations.
+  config.ui_enabled = Rails.env.development? || ENV["ACTUAL_DB_SCHEMA_UI_ENABLED"].present?
+
+  # Enable automatic phantom migration rollback on branch switch,
+  # config.git_hooks_enabled = true
+  config.git_hooks_enabled = ENV["ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED"].present?
+
+  # If your application leverages multiple schemas for multi-tenancy, define the active schemas.
+  # config.multi_tenant_schemas = -> { ["public", "tenant1", "tenant2"] }
+end

data/lib/tasks/actual_db_schema.rake

@@ -1,6 +1,34 @@
 # frozen_string_literal: true
 
-namespace :actual_db_schema do
+namespace :actual_db_schema do # rubocop:disable Metrics/BlockLength
+  desc "Install ActualDbSchema initializer and post-checkout git hook."
+  task :install do
+    extend ActualDbSchema::OutputFormatter
+
+    initializer_path = Rails.root.join("config", "initializers", "actual_db_schema.rb")
+    initializer_content = File.read(
+      File.expand_path("../../lib/generators/actual_db_schema/templates/actual_db_schema.rb", __dir__)
+    )
+
+    if File.exist?(initializer_path)
+      puts colorize("[ActualDbSchema] An initializer already exists at #{initializer_path}.", :gray)
+      puts "Overwrite the existing file at #{initializer_path}? [y,n] "
+      answer = $stdin.gets.chomp.downcase
+
+      if answer.start_with?("y")
+        File.write(initializer_path, initializer_content)
+        puts colorize("[ActualDbSchema] Initializer updated successfully at #{initializer_path}", :green)
+      else
+        puts colorize("[ActualDbSchema] Skipped overwriting the initializer.", :yellow)
+      end
+    else
+      File.write(initializer_path, initializer_content)
+      puts colorize("[ActualDbSchema] Initializer created successfully at #{initializer_path}", :green)
+    end
+
+    Rake::Task["actual_db_schema:install_git_hooks"].invoke
+  end
+
   desc "Install ActualDbSchema post-checkout git hook that rolls back phantom migrations when switching branches."
   task :install_git_hooks do
     extend ActualDbSchema::OutputFormatter

data/lib/tasks/test.rake

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+namespace :test do # rubocop:disable Metrics/BlockLength
+  desc "Run tests with SQLite3"
+  task :sqlite3 do
+    ENV["DB_ADAPTER"] = "sqlite3"
+    Rake::Task["test"].invoke
+    Rake::Task["test"].reenable
+  end
+
+  desc "Run tests with PostgreSQL"
+  task :postgresql do
+    sh "docker-compose up -d postgres"
+    wait_for_postgres
+
+    begin
+      ENV["DB_ADAPTER"] = "postgresql"
+      Rake::Task["test"].invoke
+      Rake::Task["test"].reenable
+    ensure
+      sh "docker-compose down"
+    end
+  end
+
+  desc "Run tests with MySQL"
+  task :mysql2 do
+    sh "docker-compose up -d mysql"
+    wait_for_mysql
+
+    begin
+      ENV["DB_ADAPTER"] = "mysql2"
+      Rake::Task["test"].invoke
+      Rake::Task["test"].reenable
+    ensure
+      sh "docker-compose down"
+    end
+  end
+
+  desc "Run tests with all adapters (SQLite3, PostgreSQL, MySQL)"
+  task all: %i[sqlite3 postgresql mysql2]
+
+  def wait_for_postgres
+    retries = 10
+    begin
+      sh "docker-compose exec -T postgres pg_isready -U postgres"
+    rescue StandardError
+      retries -= 1
+
+      raise "PostgreSQL is not ready after several attempts." if retries < 1
+
+      sleep 2
+      retry
+    end
+  end
+
+  def wait_for_mysql
+    retries = 10
+    begin
+      sh "docker-compose exec -T mysql mysqladmin ping -h 127.0.0.1 --silent"
+    rescue StandardError
+      retries -= 1
+
+      raise "MySQL is not ready after several attempts." if retries < 1
+
+      sleep 2
+      retry
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -136,6 +136,9 @@ files:
 - app/views/actual_db_schema/shared/_js.html
 - app/views/actual_db_schema/shared/_style.html
 - config/routes.rb
+- docker-compose.yml
+- docker/mysql-init/create_secondary_db.sql
+- docker/postgres-init/create_secondary_db.sql
 - gemfiles/rails.6.0.gemfile
 - gemfiles/rails.6.1.gemfile
 - gemfiles/rails.7.0.gemfile
@@ -145,20 +148,24 @@ 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/configuration.rb
 - lib/actual_db_schema/engine.rb
 - lib/actual_db_schema/failed_migration.rb
 - lib/actual_db_schema/git.rb
 - lib/actual_db_schema/git_hooks.rb
 - lib/actual_db_schema/migration.rb
 - lib/actual_db_schema/migration_context.rb
+- lib/actual_db_schema/multi_tenant.rb
 - lib/actual_db_schema/output_formatter.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/generators/actual_db_schema/templates/actual_db_schema.rb
 - lib/tasks/actual_db_schema.rake
 - lib/tasks/db.rake
+- lib/tasks/test.rake
 - sig/actual_db_schema.rbs
 homepage: https://blog.widefix.com/actual-db-schema/
 licenses:
@@ -166,14 +173,14 @@ licenses:
 metadata:
   homepage_uri: https://blog.widefix.com/actual-db-schema/
   source_code_uri: https://github.com/widefix/actual_db_schema
-  changelog_uri: https://blog.widefix.com/actual-db-schema//blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/widefix/actual_db_schema/blob/main/CHANGELOG.md
 post_install_message: |+
   Thank you for installing ActualDbSchema!
 
-  To enable automatic rollback of phantom migrations when switching branches, follow these steps:
-  1. Set `export ACTUAL_DB_SCHEMA_GIT_HOOKS_ENABLED=true` in your environment, OR
-     add `ActualDbSchema.config[:git_hooks_enabled] = true` to your initializer.
-  2. Run `rake actual_db_schema:install_git_hooks` to install the post-checkout Git hook.
+  Next steps:
+  1. Run `rake actual_db_schema:install` to generate the initializer file and install
+     the post-checkout Git hook for automatic phantom migration rollback when switching branches.
+  2. Or, if you prefer environment variables, skip this step.
 
   For more information, see the README.