rails-worktrees 0.7.4 → 0.9.0

data/lib/rails/worktrees/teardown_runner.rb

@@ -0,0 +1,84 @@
+require 'open3'
+require 'tempfile'
+
+module Rails
+  module Worktrees
+    # Runs teardown in the target app, without borrowing the caller's suffix or bundle.
+    class TeardownRunner
+      RUNTIME_KEYS = %w[PATH HOME USER LOGNAME SHELL LANG LANGUAGE LC_ALL LC_CTYPE TMPDIR TMP TEMP
+                        GEM_HOME GEM_PATH LD_LIBRARY_PATH SSL_CERT_FILE SSL_CERT_DIR].freeze
+      RUBY_LOADER_KEYS = %w[RUBYOPT RUBYLIB].freeze
+      SUFFIX_KEY = 'WORKTREE_DATABASE_SUFFIX'.freeze
+      SCRIPT = File.expand_path('teardown_script.rb', __dir__).freeze
+
+      def initialize(target_dir:, env:, io:, use_current_env: false)
+        @target_dir = target_dir
+        @env = env.to_h
+        @stdout = io.fetch(:stdout)
+        @use_current_env = use_current_env
+      end
+
+      def call(dry_run: false)
+        env = runtime_env
+        validate_environment!(env)
+        Tempfile.create('rails-worktrees-teardown') do |plan|
+          run_teardown(env, plan.path, dry_run: dry_run)
+        end
+      rescue SystemCallError => e
+        raise Error, "Could not start teardown: #{e.message}"
+      end
+
+      private
+
+      def run_teardown(env, plan_path, dry_run:)
+        run(env.merge('RAILS_ENV' => 'test', 'RACK_ENV' => 'test'),
+            [rails_bin, 'runner', SCRIPT, '--export-test-configs', plan_path])
+        argv = [rails_bin, 'runner', SCRIPT, '--test-configs', plan_path]
+        argv << '--dry-run' if dry_run
+        run(env, argv)
+      end
+
+      def validate_environment!(env)
+        if env[SUFFIX_KEY].to_s.strip.empty?
+          raise Error, 'WORKTREE_DATABASE_SUFFIX must not be empty; refusing teardown.'
+        end
+        raise Error, "Expected #{@target_dir}/bin/rails for teardown." unless File.file?(rails_bin)
+      end
+
+      def run(env, argv)
+        Open3.popen2e(env, *argv, chdir: @target_dir, unsetenv_others: true) do |stdin, output, wait|
+          stdin.close
+          output.each_line { |line| @stdout.print(line) }
+          raise Error, 'Teardown failed; worktree and branch were kept.' unless wait.value.success?
+        end
+      end
+
+      def rails_bin = File.join(@target_dir, 'bin', 'rails')
+
+      def runtime_env
+        source = @use_current_env ? @env : @env.slice(*RUNTIME_KEYS)
+        env = source.reject { |key, _| key.start_with?('BUNDLE_', 'GIT_') || RUBY_LOADER_KEYS.include?(key) }
+        suffix = file_suffix
+        env[SUFFIX_KEY] = suffix unless suffix.nil?
+        env.merge('RAILS_ENV' => 'development', 'RACK_ENV' => 'development',
+                  'BUNDLE_GEMFILE' => File.join(@target_dir, 'Gemfile'))
+      end
+
+      def file_suffix
+        path = File.join(@target_dir, '.env')
+        return unless File.file?(path)
+
+        line = File.readlines(path, chomp: true).reverse.find do |entry|
+          entry.match?(/\A\s*(?:export\s+)?WORKTREE_DATABASE_SUFFIX\s*=/)
+        end
+        return unless line
+
+        value = line.split('=', 2).last.strip
+        match = value.match(/\A(?:'([^']*)'|"([^"]*)"|([^\s#'"$`]*))\s*(?:#.*)?\z/)
+        raise Error, 'Cannot safely read WORKTREE_DATABASE_SUFFIX from .env; use a literal value.' unless match
+
+        match.captures.compact.first
+      end
+    end
+  end
+end

data/lib/rails/worktrees/teardown_script.rb

@@ -0,0 +1,115 @@
+require 'json'
+
+# Executed by the target app's Rails runner, first in test, then in development.
+module Rails
+  module Worktrees
+    # Validates the complete Rails database plan before applying any destructive effects.
+    class DatabaseTeardown
+      class SafetyError < StandardError; end
+
+      def call(test_plan:, export: false, dry_run: false)
+        suffix = ENV.fetch('WORKTREE_DATABASE_SUFFIX', '')
+        raise SafetyError, 'WORKTREE_DATABASE_SUFFIX must not be empty; refusing teardown.' if suffix.strip.empty?
+
+        return export_test_configs(test_plan, suffix) if export
+
+        development = database_configs('development')
+        databases = development + test_configs(test_plan, suffix)
+        validate_databases!(databases, suffix)
+        check_protection!(development)
+        stop_overmind(dry_run: dry_run)
+        drop_databases(databases, dry_run: dry_run)
+      end
+
+      private
+
+      def database_configs(environment)
+        unless defined?(ActiveRecord::Base)
+          raise SafetyError, 'ActiveRecord is required to inspect development/test databases.'
+        end
+
+        configs = ActiveRecord::Base.configurations.configs_for(env_name: environment)
+        raise SafetyError, "No database configurations found for #{environment}; refusing teardown." if configs.empty?
+
+        configs
+      end
+
+      def export_test_configs(path, suffix)
+        configs = database_configs('test')
+        validate_databases!(configs, suffix)
+        check_protection!(configs)
+        File.write(path, JSON.generate('suffix' => suffix, 'configs' => config_hash(configs)))
+      end
+
+      def test_configs(path, suffix)
+        plan = JSON.parse(File.read(path))
+        if plan['suffix'] != suffix
+          raise SafetyError,
+                'Test environment changed WORKTREE_DATABASE_SUFFIX; refusing teardown.'
+        end
+
+        ActiveRecord::DatabaseConfigurations.new('test' => plan.fetch('configs')).configs_for(env_name: 'test')
+      end
+
+      def config_hash(configs)
+        configs.to_h { |config| [config.name, config.configuration_hash] }
+      end
+
+      def check_protection!(databases)
+        original = ActiveRecord::Base.configurations
+        existing = existing_databases(databases)
+        # Keep the resolved objects: rebuilding hashes would reapply environment URLs to explicit YAML URLs.
+        ActiveRecord::Base.configurations = existing
+        ENV.delete('DISABLE_DATABASE_ENVIRONMENT_CHECK')
+        existing.map(&:env_name).uniq.each do |environment|
+          ActiveRecord::Tasks::DatabaseTasks.check_protected_environments!(environment)
+        end
+      ensure
+        ActiveRecord::Base.configurations = original if original
+      end
+
+      def existing_databases(databases)
+        # SQLite opens would create absent files even in a dry-run. Absent files have no protected metadata.
+        databases.reject { |config| config.adapter == 'sqlite3' && !File.exist?(config.database) }
+      end
+
+      def validate_databases!(databases, suffix)
+        databases.each do |config|
+          # A suffix in a SQLite directory does not protect an unsuffixed database file.
+          next if File.basename(config.database.to_s).include?(suffix)
+
+          raise SafetyError,
+                "Database '#{config.database}' (#{config.env_name}/#{config.name}) does not contain " \
+                "WORKTREE_DATABASE_SUFFIX '#{suffix}'; refusing teardown."
+        end
+      end
+
+      def drop_databases(databases, dry_run:)
+        databases.each do |config|
+          puts "#{dry_run ? 'Would drop' : 'Dropping'} database '#{config.database}' " \
+               "(#{config.env_name}/#{config.name})"
+          ActiveRecord::Tasks::DatabaseTasks.drop(config) unless dry_run
+        end
+      end
+
+      def stop_overmind(dry_run:)
+        return unless File.exist?('.overmind.sock')
+
+        puts "#{dry_run ? 'Would stop' : 'Stopping'} Overmind at #{File.expand_path('.overmind.sock')}"
+        return if dry_run
+        return if system('overmind', 'quit', '--socket', '.overmind.sock')
+
+        raise SafetyError, 'Could not stop Overmind; databases were kept.'
+      end
+    end
+  end
+end
+
+begin
+  export = ARGV.first == '--export-test-configs'
+  Rails::Worktrees::DatabaseTeardown.new.call(test_plan: ARGV.fetch(1), export: export,
+                                              dry_run: ARGV.include?('--dry-run'))
+rescue StandardError => e
+  warn "Teardown failed: #{e.message}"
+  exit 1
+end

data/lib/rails/worktrees/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Worktrees
-    VERSION = '0.7.4'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/lib/rails/worktrees.rb

@@ -6,7 +6,9 @@ require_relative 'worktrees/application_configuration'
 require_relative 'worktrees/mise_environment'
 require_relative 'worktrees/env_bootstrapper'
 require_relative 'worktrees/credential_key_linker'
+require_relative 'worktrees/playwright_browser_check'
 require_relative 'worktrees/post_create_runner'
+require_relative 'worktrees/teardown_runner'
 require_relative 'worktrees/command'
 require_relative 'worktrees/cli'
 require_relative 'worktrees/browser_command'
@@ -15,6 +17,8 @@ require_relative 'worktrees/initializer_updater'
 require_relative 'worktrees/procfile_updater'
 require_relative 'worktrees/mise_toml_updater'
 require_relative 'worktrees/puma_config_updater'
+require_relative 'worktrees/pi_worktree_config_path'
+require_relative 'worktrees/pi_worktree_config_updater'
 require_relative 'worktrees/project_configuration_loader'
 require_relative 'worktrees/project_maintenance'
 

data/sig/rails/worktrees.rbs

@@ -8,6 +8,7 @@ module Rails
     class Configuration
       attr_accessor bootstrap_env: bool
       attr_accessor workspace_root: String?
+      attr_accessor worktrees_dir: String?
       attr_accessor branch_prefix: String
       attr_accessor dev_port_range: ::Range[Integer]
       attr_accessor name_sources_path: String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-worktrees
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Asjer Querido
@@ -61,6 +61,7 @@ files:
 - lib/rails/worktrees/command.rb
 - lib/rails/worktrees/command/environment_support.rb
 - lib/rails/worktrees/command/git_operations.rb
+- lib/rails/worktrees/command/in_repo_worktrees.rb
 - lib/rails/worktrees/command/name_picking.rb
 - lib/rails/worktrees/command/output.rb
 - lib/rails/worktrees/command/post_create_support.rb
@@ -73,12 +74,17 @@ files:
 - lib/rails/worktrees/mise_environment.rb
 - lib/rails/worktrees/mise_toml_updater.rb
 - lib/rails/worktrees/names/cities.txt
+- lib/rails/worktrees/pi_worktree_config_path.rb
+- lib/rails/worktrees/pi_worktree_config_updater.rb
+- lib/rails/worktrees/playwright_browser_check.rb
 - lib/rails/worktrees/post_create_runner.rb
 - lib/rails/worktrees/procfile_updater.rb
 - lib/rails/worktrees/project_configuration_loader.rb
 - lib/rails/worktrees/project_maintenance.rb
 - lib/rails/worktrees/puma_config_updater.rb
 - lib/rails/worktrees/railtie.rb
+- lib/rails/worktrees/teardown_runner.rb
+- lib/rails/worktrees/teardown_script.rb
 - lib/rails/worktrees/version.rb
 - mise.toml
 - release-please-config.json