rails-worktree 0.2.0 → 0.3.1

data/lib/worktree/installer.rb

@@ -1,12 +1,45 @@
+require "fileutils"
+require "open3"
+
 module RailsWorktree
+  # Installs the launcher and the repository integration files:
+  # .gitignore entry, .worktree.yml, .worktreeinclude (Claude Code), the
+  # AGENTS.md / CLAUDE.md block and the herdr plugin under .worktree/herdr.
   class Installer
-    def self.install(root, replace: false)
-      Launcher.install(root, replace: replace)
-      ignore_worktrees(root)
+    AGENTS_START = "<!-- rails-worktree:start -->".freeze
+    AGENTS_FINISH = "<!-- rails-worktree:end -->".freeze
+    INCLUDE_START = "# rails-worktree:start".freeze
+    INCLUDE_FINISH = "# rails-worktree:end".freeze
+    HERDR_DIR = ".worktree/herdr".freeze
+
+    def self.install(root, replace: false, quiet: true)
+      new(root, replace: replace, quiet: quiet).install
     end
 
     def self.ignore_worktrees(root)
-      path = File.join(root, ".gitignore")
+      new(root).ignore_worktrees
+    end
+
+    def initialize(root, replace: false, quiet: true)
+      @root = File.expand_path(root)
+      @replace = replace
+      @quiet = quiet
+      @changes = []
+    end
+
+    def install
+      Launcher.install(@root, replace: @replace)
+      ignore_worktrees
+      write_config
+      write_worktreeinclude
+      write_agents_block
+      write_herdr_plugin
+      report
+      @changes
+    end
+
+    def ignore_worktrees
+      path = File.join(@root, ".gitignore")
       content = File.exist?(path) ? File.read(path) : ""
       return if content.lines.any? { |line| %w[ .worktrees .worktrees/ /.worktrees /.worktrees/ ].include?(line.strip) }
 
@@ -14,6 +47,120 @@ module RailsWorktree
         file.puts unless content.empty? || content.end_with?("\n")
         file.puts "/.worktrees/"
       end
+      @changes << ".gitignore"
+    end
+
+    private
+
+    def config
+      @config ||= Config.load(@root)
+    end
+
+    def write_config
+      path = File.join(@root, Config::FILE)
+      return if File.exist?(path)
+
+      File.write(path, Config::TEMPLATE)
+      @changes << Config::FILE
+    end
+
+    def write_worktreeinclude
+      body = ["# Gitignored files Claude Code copies into every worktree it creates.",
+        "# Generated from the copy list in #{Config::FILE}; rerun bin/worktree install to update."] + config.copy_patterns
+      @changes << ".worktreeinclude" if ManagedBlock.write(File.join(@root, ".worktreeinclude"), body.join("\n"), start: INCLUDE_START, finish: INCLUDE_FINISH)
+    end
+
+    def write_agents_block
+      body = <<~MARKDOWN
+        ## Worktrees
+
+        A fresh checkout (git worktree, herdr, Claude Code or Codex) has no gitignored
+        configuration. Run `bin/worktree init` in it before starting the app or the specs.
+        It copies the files listed in `#{Config::FILE}` from the main checkout and is safe to repeat.
+
+        - `bin/worktree init --level minimal`: configuration files only, shares the main development database.
+        - `bin/worktree init --level test`: minimal plus an isolated test setup.
+        - `bin/worktree init --level full`: minimal plus own development and test databases.
+        - `bin/worktree create <name> <base>`: create a worktree under `.worktrees/` and provision it.
+      MARKDOWN
+      agents_files.each do |path|
+        @changes << File.basename(path) if ManagedBlock.write(path, body, start: AGENTS_START, finish: AGENTS_FINISH)
+      end
+    end
+
+    # AGENTS.md and CLAUDE.md when they exist; a symlink to the other file counts once.
+    # Without either file, AGENTS.md is created.
+    def agents_files
+      candidates = %w[AGENTS.md CLAUDE.md].map { |name| File.join(@root, name) }.select { |path| File.exist?(path) }
+      return [File.join(@root, "AGENTS.md")] if candidates.empty?
+
+      candidates.uniq { |path| File.realpath(path) }
+    end
+
+    def write_herdr_plugin
+      directory = File.join(@root, HERDR_DIR)
+      FileUtils.mkdir_p(directory)
+      manifest = File.join(directory, "herdr-plugin.toml")
+      script = File.join(directory, "provision")
+      app = File.basename(main_checkout).gsub(/[^A-Za-z0-9_.-]/, "-")
+      manifest_body = <<~TOML
+        # herdr plugin generated by rails-worktree. Link it once per machine:
+        #   herdr plugin link #{HERDR_DIR}
+        # It provisions every worktree herdr creates for this repository.
+        id = "rails-worktree.#{app}"
+        name = "rails-worktree (#{app})"
+        version = "#{VERSION}"
+        min_herdr_version = "0.8.0"
+        description = "Provision new herdr worktrees with bin/worktree init"
+        platforms = ["linux", "macos"]
+
+        [[events]]
+        on = "worktree.created"
+        command = ["./provision"]
+      TOML
+      script_body = <<~'SH'
+        #!/bin/sh
+        # Runs bin/worktree init in the worktree that herdr just created.
+        # Skips checkouts of other repositories (no bin/worktree launcher).
+        set -eu
+        # herdr wraps the payload: {"event": "worktree_created", "data": {"worktree": {"path": ...}}}.
+        path=$(ruby -rjson -e 'event = JSON.parse(ENV.fetch("HERDR_PLUGIN_EVENT_JSON", "{}")); event = event["data"] || event; puts(event.dig("worktree", "path") || event["path"] || "")')
+        [ -n "$path" ] || { echo "rails-worktree: no worktree path in the event; skipped" >&2; exit 0; }
+        [ -x "$path/bin/worktree" ] || exit 0
+        here=$(CDPATH= cd -- "$(dirname -- "$0")/../.." && pwd -P)
+        main_of() { git -C "$1" worktree list --porcelain | head -n 1 | sed 's/^worktree //'; }
+        [ "$(main_of "$path")" = "$(main_of "$here")" ] || exit 0
+        cd "$path"
+        # herdr inherits the PATH of the shell that started it, which can put another Ruby first.
+        # mise exec selects the Ruby that the checkout's version file asks for.
+        if command -v mise >/dev/null 2>&1; then
+          exec mise exec -- bin/worktree init --level "${RAILS_WORKTREE_HERDR_LEVEL:-minimal}"
+        fi
+        exec bin/worktree init --level "${RAILS_WORKTREE_HERDR_LEVEL:-minimal}"
+      SH
+      write_if_changed(manifest, manifest_body)
+      write_if_changed(script, script_body, mode: 0755)
+    end
+
+    # The main checkout's directory, so a worktree installs the same plugin id as the main checkout.
+    def main_checkout
+      output, _error, status = Open3.capture3(Context::GIT_ENVIRONMENT, "git", "-C", @root, "worktree", "list", "--porcelain")
+      first = status.success? && output.lines.grep(/^worktree /).first
+      first ? first.delete_prefix("worktree ").strip : @root
+    end
+
+    def write_if_changed(path, body, mode: nil)
+      return if File.file?(path) && File.read(path) == body && (mode.nil? || File.executable?(path))
+
+      File.write(path, body)
+      File.chmod(mode, path) if mode
+      @changes << path.delete_prefix(@root + File::SEPARATOR)
+    end
+
+    def report
+      return if @quiet || @changes.empty?
+
+      @changes.each { |change| puts "  wrote #{change}" }
     end
   end
 end

data/lib/worktree/managed_block.rb

@@ -0,0 +1,32 @@
+module RailsWorktree
+  # Writes a marked block into a text file. Repeated writes replace the block in
+  # place and leave the rest of the file untouched.
+  class ManagedBlock
+    def self.write(path, body, start:, finish:)
+      new(path, start: start, finish: finish).write(body)
+    end
+
+    def initialize(path, start:, finish:)
+      @path = path
+      @start = start
+      @finish = finish
+    end
+
+    def write(body)
+      block = "#{@start}\n#{body.chomp}\n#{@finish}\n"
+      content = File.file?(@path) ? File.read(@path) : ""
+      updated =
+        if content.include?(@start) && content.include?(@finish)
+          content.sub(/#{Regexp.escape(@start)}\n.*?#{Regexp.escape(@finish)}\n?/m) { block }
+        elsif content.empty?
+          block
+        else
+          content + (content.end_with?("\n") ? "\n" : "\n\n") + block
+        end
+      return false if updated == content
+
+      File.write(@path, updated)
+      true
+    end
+  end
+end

data/lib/worktree/push_hook.rb

@@ -1,6 +1,5 @@
 require "fileutils"
 require "open3"
-require "rbconfig"
 
 module RailsWorktree
   class PushHook
@@ -10,13 +9,14 @@ module RailsWorktree
       output, error, status = Open3.capture3(Context::GIT_ENVIRONMENT, "git", "-C", root, "rev-parse", "--git-path", "hooks/pre-push")
       raise Error, "Cannot locate pre-push hook: #{error}" unless status.success?
       path = File.expand_path(output.strip, root)
+      return warn_tracked(path) if tracked?(File.dirname(path))
       return if File.file?(path) && File.read(path).include?(MARKER)
       previous = "#{path}.before-rails-worktree"
       raise Error, "Hook backup already exists: #{previous}; restore it before installing the worktree hook." if File.exist?(previous)
       FileUtils.mkdir_p(File.dirname(path))
       FileUtils.mv(path, previous) if File.exist?(path)
       File.write(path, <<~RUBY)
-        #!#{RbConfig.ruby}
+        #!/usr/bin/env ruby
         #{MARKER}
         require "open3"
         require "tempfile"
@@ -44,5 +44,18 @@ module RailsWorktree
       RUBY
       File.chmod(0755, path)
     end
+
+    def self.tracked?(directory)
+      return false unless File.directory?(directory)
+      inside, _, status = Open3.capture3(Context::GIT_ENVIRONMENT, "git", "-C", directory, "rev-parse", "--is-inside-work-tree")
+      return false unless status.success? && inside.strip == "true"
+      output, _, status = Open3.capture3(Context::GIT_ENVIRONMENT, "git", "-C", directory, "ls-files", "--", ".")
+      status.success? && !output.empty?
+    end
+
+    def self.warn_tracked(path)
+      warn "Skipped the pre-push hook: #{path} is in a directory that Git tracks. " \
+        "Run `bin/worktree verify --push` from that hook instead and pass it the hook's standard input."
+    end
   end
 end

data/lib/worktree/railtie.rb

@@ -8,11 +8,9 @@ module RailsWorktree
       load "worktree/tasks.rb"
     end
 
-    initializer "worktree.install_binstub" do
-      # Install binstub automatically when Rails loads in development
-      if Rails.env.development?
-        Installer.install(Rails.root.to_s)
-      end
+    initializer "worktree.install" do
+      # Install the launcher and repository integration files when Rails loads in development.
+      Installer.install(Rails.root.to_s) if Rails.env.development?
     end
   end
 end

data/lib/worktree/tasks.rb

@@ -1,10 +1,11 @@
 namespace :worktree do
-  desc "Install bin/worktree and ignore local .worktrees"
+  desc "Install bin/worktree, .worktree.yml, .worktreeinclude, the AGENTS.md block and the herdr plugin"
   task :install do
-    RailsWorktree::Installer.install(Dir.pwd, replace: ENV["FORCE"] == "1")
+    RailsWorktree::Installer.install(Dir.pwd, replace: ENV["FORCE"] == "1", quiet: false)
 
-    puts "✓ bin/worktree is installed and .worktrees is ignored"
-    puts "Usage: bin/worktree <name> <base-branch>"
+    puts "✓ rails-worktree is installed"
+    puts "Usage: bin/worktree create <name> <base>"
+    puts "Link the herdr plugin once with: herdr plugin link #{RailsWorktree::Installer::HERDR_DIR}"
   end
 
   desc "Uninstall worktree binstub from bin/worktree"

data/lib/worktree/version.rb

@@ -1,3 +1,3 @@
 module RailsWorktree
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-worktree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Martin Ulleberg
@@ -22,13 +22,18 @@ files:
 - exe/worktree
 - lib/rails-worktree.rb
 - lib/worktree/cli.rb
+- lib/worktree/clone_database.rb
 - lib/worktree/commands/close.rb
 - lib/worktree/commands/create.rb
 - lib/worktree/commands/exec.rb
 - lib/worktree/commands/init.rb
+- lib/worktree/config.rb
 - lib/worktree/context.rb
+- lib/worktree/copy_sqlite.rb
+- lib/worktree/database_probe.rb
 - lib/worktree/installer.rb
 - lib/worktree/launcher.rb
+- lib/worktree/managed_block.rb
 - lib/worktree/push_hook.rb
 - lib/worktree/railtie.rb
 - lib/worktree/tasks.rb
@@ -46,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="