Configuration for tmp folder (#136)

Author: m-darbinyan

.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /test/dummy_app/tmp/
+/test/dummy_app/custom/
 /test/dummy_app/db/**/*.rb
 .ruby-version
 .ruby-gemset

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:

lib/actual_db_schema.rb

@@ -59,7 +59,7 @@ def self.migrated_folders
   end
 
   def self.default_migrated_folder
-    Rails.root.join("tmp", "migrated")
+    config[:migrated_folder] || Rails.root.join("tmp", "migrated")
   end
 
   def self.migrations_paths

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 @@ def initialize
       @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)

lib/actual_db_schema/migration.rb

@@ -101,7 +101,8 @@ def sort_migrations_desc(migrations)
     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)

lib/actual_db_schema/schema_diff.rb

@@ -63,17 +63,25 @@ def migration_changes
     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)

lib/generators/actual_db_schema/templates/actual_db_schema.rb

@@ -21,7 +21,11 @@
   # 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

lib/tasks/actual_db_schema.rake

@@ -55,7 +55,7 @@ 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|
+  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"
 

test/rake_task_test.rb

@@ -122,6 +122,37 @@ def down
         assert_empty utils.migrated_files
       end
     end
+
+    describe "with custom migrated folder" do
+      before do
+        ActualDbSchema.configure { |config| config.migrated_folder = Rails.root.join("custom", "migrated") }
+      end
+
+      after do
+        utils.remove_app_dir("custom/migrated")
+        ActualDbSchema.configure { |config| config.migrated_folder = nil }
+      end
+
+      it "creates the custom migrated folder" do
+        refute File.exist?(utils.app_file("custom/migrated"))
+        utils.run_migrations
+        assert File.exist?(utils.app_file("custom/migrated"))
+      end
+
+      it "keeps migrated migrations in the custom migrated folder" do
+        utils.run_migrations
+        assert_equal %w[20130906111511_first.rb 20130906111512_second.rb], utils.migrated_files
+      end
+
+      it "rolls back the migrations in the reversed order" do
+        utils.prepare_phantom_migrations
+        assert_empty TestingState.down
+        utils.run_migrations
+        assert_equal %i[second first], TestingState.down
+        assert_match(/\[ActualDbSchema\] Rolling back phantom migration/, TestingState.output)
+        assert_empty utils.migrated_files
+      end
+    end
   end
 
   describe "db:rollback_branches:manual" do

test/support/test_utils.rb

@@ -207,7 +207,8 @@ def delete_migrations_files_for(path)
   end
 
   def migrated_files_call(prefix_name = nil)
-    path = MIGRATED_PATHS.fetch(prefix_name&.to_sym, migrated_paths.first)
+    migrated_path = ActualDbSchema.config[:migrated_folder].presence || migrated_paths.first
+    path = MIGRATED_PATHS.fetch(prefix_name&.to_sym, migrated_path.to_s)
     Dir.glob(app_file("#{path}/*.rb")).map { |f| File.basename(f) }.sort
   end