rails-worktrees 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698795e04a67284039d3beba2286f3a9aa156a5856832a345f22ffa57b6177e3
-  data.tar.gz: 0a57ef25c66c3226798498476abf8caf033c6a2989ae170b30a161fde66fddcf
+  metadata.gz: de8cd30214f81e827aee0e2fabba426a1c0cfca6f172d03fb36fad408fc8bfe7
+  data.tar.gz: 604eb3468c743e91b3b5ad19f9943fa94d9fe891b45732de491ddc8219c4b943
 SHA512:
-  metadata.gz: 06c8ae396186a19c08e45445e031a28198d48f7ea5125c02e63b2df39977f5399f75421e7f1897071d14b00d042051616ed4e447b83b570852d54756d8689377
-  data.tar.gz: 800a19ef60af420e03280b8a30c02c9012c4ded0d3eaecc421ed5e42e072b8024a0cbc93e7ba7aaf7d806dc972deacacbb0c5edfe45da40b2ab05659b1ccc5c5
+  metadata.gz: 8f33f141355afb0dbc9ee06cdaab2e2f242c7d49b7ac72b6c2aa21202aabc8fb709cf79aa88a0b43f2357240b19b88dab37cc284f3fd4f712cc2b6c1057b743b
+  data.tar.gz: c9bc8caa8f38b496e2d7dd4bc0693251ec18606863b349cf949398e2cc131c448277869e04ac873e80f8b3dfff3f1fc59604e7ba2207fff21a97c255376524f3

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.5.1"}
+{".":"0.6.0"}

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/asjer/rails-worktrees/compare/v0.5.1...v0.6.0) (2026-04-03)
+
+
+### Features
+
+* **post-create:** bootstrap new worktrees after creation ([b429105](https://github.com/asjer/rails-worktrees/commit/b42910507d21c1d048d45cfdc4d7311a1ec8a96b))
+
 ## [0.5.1](https://github.com/asjer/rails-worktrees/compare/v0.5.0...v0.5.1) (2026-04-02)
 
 

data/lib/generators/rails/worktrees/templates/rails_worktrees.rb.tt

@@ -16,4 +16,15 @@ Rails.application.config.x.rails_worktrees.tap do |config|
   #   'rails-worktrees',
   #   'used-names.tsv'
   # )
+
+  # Post-create setup steps (run automatically after a new worktree is created)
+  # config.post_create_command = nil    # nil = built-in steps; false = skip all; 'script/worktree-setup' = custom command
+  # config.run_bundle_install = true
+  # config.run_yarn_install = true      # auto-skipped when yarn.lock is absent
+  # config.run_db_prepare = true
+  # config.run_test_db_prepare = true
+  # config.run_test_assets_precompile = true
+  # config.link_credential_keys = true  # link development.key from a sibling worktree (opt-out)
+  # config.link_test_credential_key = false
+  # config.link_production_credential_key = false
 end

data/lib/rails/worktrees/command/post_create_support.rb

@@ -0,0 +1,33 @@
+module Rails
+  module Worktrees
+    class Command
+      # Delegates post-create setup steps to PostCreateRunner.
+      module PostCreateSupport
+        private
+
+        def run_post_create_steps(context)
+          post_create_runner_for(context).call(dry_run: false)
+        end
+
+        def preview_post_create_steps(context)
+          post_create_runner_for(context).call(dry_run: true)
+        end
+
+        def post_create_runner_for(context)
+          PostCreateRunner.new(
+            target_dir: context[:target_dir],
+            peer_roots: peer_roots_excluding(context[:target_dir]),
+            configuration: @configuration,
+            io: { stdout: @stdout, stderr: @stderr }
+          )
+        end
+
+        def peer_roots_excluding(target_dir)
+          worktree_entries
+            .map { |entry| entry[:path] }
+            .reject { |path| path == target_dir }
+        end
+      end
+    end
+  end
+end

data/lib/rails/worktrees/command.rb

@@ -3,6 +3,7 @@ require_relative 'command/environment_support'
 require_relative 'command/git_operations'
 require_relative 'command/name_picking'
 require_relative 'command/output'
+require_relative 'command/post_create_support'
 require_relative 'command/workspace_paths'
 
 module Rails
@@ -18,6 +19,7 @@ module Rails
       include EnvironmentSupport
       include NamePicking
       include Output
+      include PostCreateSupport
       include WorkspacePaths
 
       def initialize(argv:, io:, env:, cwd:, configuration:)
@@ -284,7 +286,20 @@ module Rails
       def finish(context)
         settle_retired_name(context[:worktree_name], context[:project_name], dry_run: dry_run?)
         bootstrap_result = bootstrap_worktree_environment(context)
-        return complete_dry_run(context, env_values: bootstrap_result&.values) if dry_run?
+
+        return complete_dry_run_after_setup(context, bootstrap_result) if dry_run?
+
+        complete_created_worktree(context, bootstrap_result)
+      end
+
+      def complete_dry_run_after_setup(context, bootstrap_result)
+        preview_post_create_steps(context)
+        complete_dry_run(context, env_values: bootstrap_result&.values)
+      end
+
+      def complete_created_worktree(context, bootstrap_result)
+        result = run_post_create_steps(context)
+        return result unless result.zero?
 
         success('Worktree ready')
         print_context_summary(context, env_values: bootstrap_result&.values)

data/lib/rails/worktrees/configuration.rb

@@ -10,6 +10,15 @@ module Rails
         name_sources_path
         used_names_file
         worktree_database_suffix_max_length
+        post_create_command
+        run_bundle_install
+        run_yarn_install
+        run_db_prepare
+        run_test_db_prepare
+        run_test_assets_precompile
+        link_credential_keys
+        link_test_credential_key
+        link_production_credential_key
       ].freeze
 
       DEFAULT_BOOTSTRAP_ENV = true
@@ -25,9 +34,20 @@ module Rails
 
       attr_accessor :bootstrap_env, :branch_prefix, :dev_port_range, :legacy_used_names_files,
                     :name_sources_path, :used_names_file, :workspace_root,
-                    :worktree_database_suffix_max_length
+                    :worktree_database_suffix_max_length,
+                    :post_create_command,
+                    :run_bundle_install, :run_yarn_install,
+                    :run_db_prepare, :run_test_db_prepare, :run_test_assets_precompile,
+                    :link_credential_keys, :link_test_credential_key, :link_production_credential_key
 
       def initialize
+        assign_core_defaults
+        assign_post_create_defaults
+      end
+
+      private
+
+      def assign_core_defaults
         @bootstrap_env = DEFAULT_BOOTSTRAP_ENV
         @workspace_root = nil
         @branch_prefix = DEFAULT_BRANCH_PREFIX
@@ -38,7 +58,17 @@ module Rails
         @legacy_used_names_files = default_legacy_used_names_files
       end
 
-      private
+      def assign_post_create_defaults
+        @post_create_command = nil
+        @run_bundle_install = true
+        @run_yarn_install = true
+        @run_db_prepare = true
+        @run_test_db_prepare = true
+        @run_test_assets_precompile = true
+        @link_credential_keys = true
+        @link_test_credential_key = false
+        @link_production_credential_key = false
+      end
 
       def default_legacy_used_names_files
         state_home = ENV.fetch('XDG_STATE_HOME', File.join(Dir.home, '.local/state'))

data/lib/rails/worktrees/credential_key_linker.rb

@@ -0,0 +1,93 @@
+require 'fileutils'
+
+module Rails
+  module Worktrees
+    # Links credential key files from a sibling worktree into the new worktree.
+    class CredentialKeyLinker
+      Result = Struct.new(:messages)
+
+      CREDENTIALS_DIR = 'config/credentials'.freeze
+
+      KEY_TYPES = [
+        { name: 'development', config_attr: :link_credential_keys },
+        { name: 'test',        config_attr: :link_test_credential_key },
+        { name: 'production',  config_attr: :link_production_credential_key }
+      ].freeze
+
+      def initialize(target_dir:, peer_roots:, configuration:)
+        @target_dir = target_dir
+        @peer_roots = peer_roots
+        @configuration = configuration
+      end
+
+      def call(dry_run: false)
+        messages = []
+
+        KEY_TYPES.each do |key_type|
+          next unless @configuration.public_send(key_type[:config_attr])
+
+          message = process_key(key_type[:name], dry_run: dry_run)
+          messages << message if message
+        end
+
+        Result.new(messages)
+      end
+
+      private
+
+      def process_key(key_name, dry_run:)
+        destination = destination_path_for(key_name)
+        existing_message = existing_destination_message(destination, key_name)
+        return existing_message if existing_message
+
+        replace_existing_symlink = File.symlink?(destination)
+        return "#{key_name}.key already exists; leaving as-is" if File.exist?(destination)
+
+        source = find_source(key_name)
+        return "Could not find source for #{key_name}.key" unless source
+
+        link_key(destination, key_name, source, dry_run: dry_run, replace_existing_symlink: replace_existing_symlink)
+      end
+
+      def find_source(key_name)
+        @peer_roots.each do |peer_root|
+          candidate = File.join(peer_root, CREDENTIALS_DIR, "#{key_name}.key")
+          next if File.expand_path(peer_root) == File.expand_path(@target_dir)
+
+          return candidate if File.file?(candidate)
+        end
+
+        nil
+      end
+
+      def destination_path_for(key_name)
+        File.join(@target_dir, CREDENTIALS_DIR, "#{key_name}.key")
+      end
+
+      def existing_destination_message(destination, key_name)
+        return unless File.symlink?(destination) && File.exist?(destination)
+
+        "#{key_name}.key already linked"
+      end
+
+      def link_key(destination, key_name, source, dry_run:, replace_existing_symlink: false)
+        return dry_run_link_message(key_name, source, replace_existing_symlink) if dry_run
+
+        FileUtils.mkdir_p(File.dirname(destination))
+        FileUtils.rm_f(destination) if replace_existing_symlink
+        File.symlink(source, destination)
+        linked_key_message(key_name, source, replace_existing_symlink)
+      end
+
+      def dry_run_link_message(key_name, source, replace_existing_symlink)
+        verb = replace_existing_symlink ? 'Would relink' : 'Would link'
+        "#{verb} #{key_name}.key → #{source}"
+      end
+
+      def linked_key_message(key_name, source, replace_existing_symlink)
+        verb = replace_existing_symlink ? 'Relinked' : 'Linked'
+        "#{verb} #{key_name}.key → #{source}"
+      end
+    end
+  end
+end

data/lib/rails/worktrees/post_create_runner.rb

@@ -0,0 +1,201 @@
+require 'open3'
+
+module Rails
+  module Worktrees
+    # Runs post-create setup steps in a newly created worktree.
+    # Steps run in order: credential linking, bundle install, yarn install,
+    # db:prepare (development), db:prepare (test), assets:precompile (test).
+    # rubocop:disable Metrics/ClassLength
+    class PostCreateRunner
+      STEPS = [
+        { id: :bundle, argv: %w[bundle install],
+          header: '📦 Installing gems...' },
+        { id: :yarn, argv: %w[yarn install],
+          header: '🧶 Installing JS dependencies...' },
+        { id: :db_prepare, argv: %w[bin/rails db:prepare],
+          header: '🗄️  Preparing development database...', env: { 'RAILS_ENV' => 'development' } },
+        { id: :test_db_prepare, argv: %w[bin/rails db:prepare],
+          header: '🗄️  Preparing test database...', env: { 'RAILS_ENV' => 'test' } },
+        { id: :test_assets_precompile, argv: %w[bin/rails assets:precompile],
+          header: '🎨 Precompiling test assets...', env: { 'RAILS_ENV' => 'test' } }
+      ].freeze
+
+      STEP_CONFIG = {
+        bundle: :run_bundle_install,
+        yarn: :run_yarn_install,
+        db_prepare: :run_db_prepare,
+        test_db_prepare: :run_test_db_prepare,
+        test_assets_precompile: :run_test_assets_precompile
+      }.freeze
+
+      def initialize(target_dir:, peer_roots:, configuration:, io:)
+        @target_dir    = target_dir
+        @peer_roots    = peer_roots
+        @configuration = configuration
+        @stdout        = io.fetch(:stdout)
+        @stderr        = io.fetch(:stderr)
+      end
+
+      def call(dry_run: false)
+        return 0 if @configuration.post_create_command == false
+
+        return run_custom_command(dry_run: dry_run) if custom_command?
+
+        run_built_in_steps(dry_run: dry_run)
+      end
+
+      private
+
+      def custom_command?
+        @configuration.post_create_command.is_a?(String) && !@configuration.post_create_command.empty?
+      end
+
+      def run_custom_command(dry_run:)
+        command = @configuration.post_create_command
+
+        if dry_run
+          info("Would run: #{command}")
+          return 0
+        end
+
+        info("Running: #{command}")
+        stream_shell_command(command)
+      end
+
+      def run_built_in_steps(dry_run:)
+        result = run_credential_linking(dry_run: dry_run)
+        return result unless result.zero?
+
+        STEPS.each do |step|
+          config_attr = STEP_CONFIG[step[:id]]
+          next unless @configuration.public_send(config_attr)
+          next if step[:id] == :yarn && !yarn_lock_present?
+
+          result = run_step(step, dry_run: dry_run)
+          return result unless result.zero?
+        end
+
+        0
+      end
+
+      def run_credential_linking(dry_run:)
+        # Missing peer key files are intentionally best-effort and should not abort
+        # worktree setup; the linker reports those cases in its messages while real
+        # filesystem errors still raise out of `credential_key_linker.call`.
+        return 0 unless credential_linking_enabled?
+
+        info('🔑 Linking credential keys...')
+
+        result = credential_key_linker.call(dry_run: dry_run)
+        print_credential_linking_messages(result)
+
+        0
+      end
+
+      def run_step(step, dry_run:)
+        if dry_run
+          info("Would run: #{display_command(step)}")
+          return 0
+        end
+
+        info(step[:header])
+        stream_step_command(step)
+      end
+
+      def stream_shell_command(command)
+        exit_status = capture_shell_command_exit_status(command)
+        report_failed_command(command, exit_status) unless exit_status.zero?
+        exit_status
+      end
+
+      def stream_step_command(step)
+        command = display_command(step)
+        exit_status = capture_step_command_exit_status(step)
+        report_failed_command(command, exit_status) unless exit_status.zero?
+        exit_status
+      end
+
+      def capture_shell_command_exit_status(command)
+        exit_status = nil
+
+        Open3.popen2e(base_env, command, chdir: @target_dir) do |_stdin, output, wait_thread|
+          output.each_line { |line| @stdout.print(line) }
+          exit_status = wait_thread.value.exitstatus
+        end
+
+        exit_status
+      rescue StandardError => e
+        report_failed_command_start(command, e)
+        1
+      end
+
+      def capture_step_command_exit_status(step)
+        exit_status = nil
+
+        Open3.popen2e(*step_command(step), chdir: @target_dir) do |_stdin, output, wait_thread|
+          output.each_line { |line| @stdout.print(line) }
+          exit_status = wait_thread.value.exitstatus
+        end
+
+        exit_status
+      rescue StandardError => e
+        report_failed_command_start(display_command(step), e)
+        1
+      end
+
+      def base_env
+        # Pass through only the essentials so subprocess tools work correctly.
+        ENV.to_h.slice('PATH', 'HOME', 'LANG', 'TERM', 'SHELL',
+                       'BUNDLE_GEMFILE', 'BUNDLE_PATH', 'GEM_HOME', 'GEM_PATH',
+                       'RUBY_VERSION', 'RAILS_ENV', 'NODE_ENV',
+                       'XDG_STATE_HOME', 'XDG_DATA_HOME', 'XDG_CONFIG_HOME',
+                       'DEV_PORT', 'WORKTREE_DATABASE_SUFFIX')
+      end
+
+      def yarn_lock_present?
+        File.exist?(File.join(@target_dir, 'yarn.lock'))
+      end
+
+      def display_command(step)
+        env_prefix = step.fetch(:env, {}).map { |key, value| "#{key}=#{value}" }.join(' ')
+        command = step.fetch(:argv).join(' ')
+        [env_prefix, command].reject(&:empty?).join(' ')
+      end
+
+      def step_command(step)
+        [base_env.merge(step.fetch(:env, {})), *step.fetch(:argv)]
+      end
+
+      def info(message)
+        @stdout.puts("→ #{message}")
+      end
+
+      def report_failed_command(command, exit_status)
+        @stderr.puts("❌ Command failed (exit #{exit_status}): #{command}")
+      end
+
+      def report_failed_command_start(command, error)
+        @stderr.puts("❌ Command failed to start: #{command} (#{error.message})")
+      end
+
+      def credential_linking_enabled?
+        @configuration.link_credential_keys ||
+          @configuration.link_test_credential_key ||
+          @configuration.link_production_credential_key
+      end
+
+      def credential_key_linker
+        CredentialKeyLinker.new(
+          target_dir: @target_dir,
+          peer_roots: @peer_roots,
+          configuration: @configuration
+        )
+      end
+
+      def print_credential_linking_messages(result)
+        result.messages.each { |message| info("   #{message}") }
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/rails/worktrees/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Worktrees
-    VERSION = '0.5.1'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/rails/worktrees.rb

@@ -4,6 +4,8 @@ require_relative 'worktrees/version'
 require_relative 'worktrees/configuration'
 require_relative 'worktrees/application_configuration'
 require_relative 'worktrees/env_bootstrapper'
+require_relative 'worktrees/credential_key_linker'
+require_relative 'worktrees/post_create_runner'
 require_relative 'worktrees/command'
 require_relative 'worktrees/cli'
 require_relative 'worktrees/browser_command'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-worktrees
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Asjer Querido
@@ -63,13 +63,16 @@ files:
 - lib/rails/worktrees/command/git_operations.rb
 - lib/rails/worktrees/command/name_picking.rb
 - lib/rails/worktrees/command/output.rb
+- lib/rails/worktrees/command/post_create_support.rb
 - lib/rails/worktrees/command/workspace_paths.rb
 - lib/rails/worktrees/configuration.rb
+- lib/rails/worktrees/credential_key_linker.rb
 - lib/rails/worktrees/database_config_updater.rb
 - lib/rails/worktrees/env_bootstrapper.rb
 - lib/rails/worktrees/initializer_updater.rb
 - lib/rails/worktrees/mise_toml_updater.rb
 - lib/rails/worktrees/names/cities.txt
+- 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