rails-worktree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8888a53c51f48da7d20802a75aa290fedafb9a4facb449276ac98f03a35a2ca
+  data.tar.gz: a6609cd5f4d380f0c62acb8a7bae58079e9c995c032ef04efb2b815386edc612
+SHA512:
+  metadata.gz: 28b6e35bbe05918a9ae07a794ce883e4c791e20f71d3fb1956b46a1b4c410ed7ee3f5c5382e914fcc2c90a5f78b25428b8a2a03a00a29c4b1191dce5df8d2706
+  data.tar.gz: d64ef8946b28c67a3f34e6602eed6903a8a2bb27492f576167453e2269ede2235e351ce985153495cb780e4469206da6a12d4274acf74a39b66fd81296e2d2e5

data/README.md

@@ -0,0 +1,174 @@
+# Rails Worktree
+
+A Ruby gem for managing git worktrees in Rails projects with isolated databases and configurations.
+
+## Features
+
+- Create git worktrees with automatic branch creation
+- Isolated database per worktree (separate database name)
+- Automatic configuration file copying (.env, database.yml, etc.)
+- Copy node_modules from main worktree
+- Easy cleanup with database dropping and directory removal
+- Works across any Rails project (no hardcoded paths)
+
+## Installation
+
+### In your Rails project Gemfile
+
+```ruby
+# Add to Gemfile (development group)
+group :development do
+  gem "rails-worktree"
+end
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+The gem will automatically install a binstub to `bin/worktree` when Rails loads in development mode.
+
+### Manual binstub installation
+
+If needed, you can manually install or reinstall the binstub:
+
+```bash
+bundle exec rake worktree:install
+```
+
+To uninstall:
+
+```bash
+bundle exec rake worktree:uninstall
+```
+
+### Global installation (optional)
+
+If you want to use `worktree` command globally:
+
+```bash
+gem install rails-worktree
+```
+
+## Usage
+
+### Create a new worktree
+
+```bash
+bin/worktree feature-branch
+# Creates worktree from current branch
+
+bin/worktree feature-branch main
+# Creates worktree from main branch
+```
+
+This will:
+1. Create a new git worktree in `../feature-branch`
+2. Create a new branch called `feature-branch`
+3. Copy configuration files from main worktree
+4. Set up a separate database (e.g., `myapp_feature-branch`)
+5. Copy node_modules
+6. Run migrations and seed the database
+
+### Close a worktree
+
+```bash
+# From main repository:
+bin/worktree --close feature-branch
+
+# From within the worktree:
+bin/worktree --close
+```
+
+This will:
+1. Drop the worktree's database
+2. Remove the worktree directory
+3. Delete the branch
+4. Clean up git worktree references
+
+### Manual initialization (advanced)
+
+If you need to manually initialize a worktree:
+
+```bash
+cd ../feature-branch
+worktree --init feature-branch
+```
+
+## How it works
+
+### Database isolation
+
+The gem automatically:
+- Detects your main database name from `config/database.yml`
+- Creates a new database with pattern: `{app_name}_{worktree_name}`
+- Updates the worktree's `.env` to set `DATABASE_NAME`
+- Modifies `database.yml` to use the `DATABASE_NAME` environment variable
+
+### Configuration files
+
+The following files are copied from the main worktree:
+- `.env`
+- `config/database.yml`
+- `Procfile.dev`
+- `config/credentials/development.key`
+
+### Node modules
+
+If `node_modules` exists in the main worktree, it will be copied to the new worktree.
+
+## Requirements
+
+- Ruby >= 2.6.0
+- Git with worktree support
+- Rails project with standard structure
+
+## Project structure
+
+This gem works with Rails projects that follow the standard structure:
+
+```
+your-project/
+├── config/
+│   ├── database.yml
+│   └── credentials/
+│       └── development.key
+├── .env
+├── Procfile.dev
+└── bin/
+    ├── rails
+    └── dev
+```
+
+## Development
+
+To work on the gem:
+
+```bash
+# Clone or create the gem
+cd worktree
+
+# Make changes to lib/worktree/**
+
+# Test locally
+gem build worktree.gemspec
+gem install ./worktree-0.1.0.gem
+
+# Test in a Rails project
+cd /path/to/rails/project
+worktree test-branch
+```
+
+## License
+
+MIT
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/exe/worktree

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "worktree"
+
+Worktree::CLI.run(ARGV)

data/lib/rails-worktree.rb

@@ -0,0 +1,12 @@
+require_relative "worktree/version"
+require_relative "worktree/cli"
+require_relative "worktree/commands/create"
+require_relative "worktree/commands/init"
+require_relative "worktree/commands/close"
+
+# Load Railtie only if Rails is available
+require_relative "worktree/railtie" if defined?(Rails::Railtie)
+
+module Worktree
+  class Error < StandardError; end
+end

data/lib/worktree/cli.rb

@@ -0,0 +1,59 @@
+module Worktree
+  class CLI
+    def self.run(args)
+      new(args).run
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      if @args.empty?
+        print_usage
+        exit 1
+      end
+
+      case @args[0]
+      when "--close", "close"
+        @args.shift
+        Commands::Close.new(@args).run
+      when "--init", "init"
+        @args.shift
+        Commands::Init.new(@args).run
+      when "--help", "-h", "help"
+        print_usage
+      else
+        # Default: create worktree
+        Commands::Create.new(@args).run
+      end
+    end
+
+    private
+
+    def print_usage
+      puts <<~USAGE
+        Usage: worktree <name> [base-branch]
+               worktree --close [worktree-name]
+               worktree --init <worktree-name>
+
+        Creates a new git worktree and initializes it with configuration
+
+        Commands:
+          <name>              Create a new worktree with the given name
+          --close [name]      Close and remove a worktree
+          --init <name>       Initialize a worktree (usually called automatically)
+          --help, -h          Show this help message
+
+        Arguments:
+          <name>              Name of the worktree (required)
+          [base-branch]       Branch to create worktree from (default: current branch)
+
+        Examples:
+          worktree feature-branch          # Create new worktree
+          worktree --close feature-branch  # Close worktree from main repo
+          worktree --close                 # Close worktree from within it
+      USAGE
+    end
+  end
+end

data/lib/worktree/commands/close.rb

@@ -0,0 +1,118 @@
+require "fileutils"
+
+module Worktree
+  module Commands
+    class Close
+      def initialize(args)
+        @worktree_name = args[0]
+        @main_worktree = get_main_worktree
+        @current_dir = Dir.pwd
+      end
+
+      def run
+        detect_worktree_name unless @worktree_name
+
+        @db_prefix = get_db_prefix
+        @database_name = "#{@db_prefix}_#{@worktree_name}"
+
+        detect_paths
+
+        puts "Closing worktree '#{@worktree_name}'..."
+        puts "Main worktree: #{@main_worktree}"
+        puts ""
+
+        drop_database
+        remove_worktree
+        prune_worktrees
+        delete_branch
+
+        puts ""
+        puts "✓ Worktree '#{@worktree_name}' closed successfully!"
+        puts "  Database #{@database_name} dropped"
+        puts "  Worktree removed from #{@worktree_path}"
+        puts "  Branch #{@worktree_name} deleted"
+      end
+
+      private
+
+      def get_main_worktree
+        output = `git worktree list --porcelain`
+        output.lines.grep(/^worktree /).first&.split(" ", 2)&.last&.strip
+      end
+
+      def detect_worktree_name
+        if @current_dir == @main_worktree
+          puts "Error: You must specify a worktree name when running from the main repository"
+          puts "Usage: worktree --close <worktree-name>"
+          puts "  or: cd to the worktree and run: worktree --close"
+          exit 1
+        else
+          @worktree_name = File.basename(@current_dir)
+          puts "Detected worktree name: #{@worktree_name}"
+        end
+      end
+
+      def get_db_prefix
+        database_yml = File.join(@main_worktree, "config/database.yml")
+        return nil unless File.exist?(database_yml)
+
+        content = File.read(database_yml)
+        match = content.match(/database:\s*(\w+)_development/)
+        match ? match[1] : nil
+      end
+
+      def detect_paths
+        if @current_dir == @main_worktree
+          @in_main_repo = true
+          @worktree_path = File.join(File.dirname(@main_worktree), @worktree_name)
+          @worktree_dir = @worktree_path
+        else
+          @in_main_repo = false
+          @worktree_path = @current_dir
+          @worktree_dir = "."
+        end
+      end
+
+      def drop_database
+        puts "Dropping database #{@database_name}..."
+
+        Dir.chdir(@worktree_dir) do
+          env_file = ".env"
+          if File.exist?(env_file) && File.read(env_file).match?(/^DATABASE_NAME=#{@database_name}/)
+            system("RAILS_ENV=development bin/rails db:drop 2>/dev/null") ||
+              puts("Warning: Could not drop database #{@database_name}")
+          else
+            puts "Warning: DATABASE_NAME not set to #{@database_name} in .env, skipping database drop"
+          end
+        end
+      end
+
+      def remove_worktree
+        puts "Removing worktree..."
+
+        # Change back to main repo if needed
+        Dir.chdir(@main_worktree) unless @in_main_repo
+
+        if system("git worktree remove #{@worktree_path} --force 2>/dev/null")
+          puts "Worktree removed successfully via git"
+        else
+          puts "Git worktree remove failed, deleting directory manually..."
+          if Dir.exist?(@worktree_path)
+            FileUtils.rm_rf(@worktree_path)
+            puts "Directory deleted: #{@worktree_path}"
+          end
+        end
+      end
+
+      def prune_worktrees
+        system("git worktree prune")
+      end
+
+      def delete_branch
+        puts "Deleting branch #{@worktree_name}..."
+        system("git branch -D #{@worktree_name} 2>/dev/null") ||
+          puts("Warning: Could not delete branch #{@worktree_name}")
+      end
+    end
+  end
+end

data/lib/worktree/commands/create.rb

@@ -0,0 +1,42 @@
+module Worktree
+  module Commands
+    class Create
+      def initialize(args)
+        @worktree_name = args[0]
+        @base_branch = args[1]
+      end
+
+      def run
+        unless @worktree_name
+          puts "Error: Worktree name is required"
+          exit 1
+        end
+
+        @base_branch ||= current_branch
+        worktree_path = "../#{@worktree_name}"
+
+        puts "Creating worktree '#{@worktree_name}' from branch '#{@base_branch}' at #{worktree_path}..."
+
+        unless system("git worktree add -b #{@worktree_name} #{worktree_path} #{@base_branch}")
+          puts "Failed to create worktree"
+          exit 1
+        end
+
+        puts ""
+        puts "✓ Worktree created at #{worktree_path}"
+        puts ""
+        puts "Initializing worktree..."
+
+        Dir.chdir(worktree_path) do
+          Init.new([@worktree_name]).run
+        end
+      end
+
+      private
+
+      def current_branch
+        `git branch --show-current`.strip
+      end
+    end
+  end
+end

data/lib/worktree/commands/init.rb

@@ -0,0 +1,130 @@
+require "fileutils"
+
+module Worktree
+  module Commands
+    class Init
+      def initialize(args)
+        @worktree_name = args[0]
+      end
+
+      def run
+        unless @worktree_name
+          puts "Error: Worktree name is required"
+          puts "Usage: worktree --init <worktree-name>"
+          exit 1
+        end
+
+        @main_worktree = get_main_worktree
+        @db_prefix = get_db_prefix
+        @database_name = "#{@db_prefix}_#{@worktree_name}"
+
+        puts "Initializing worktree '#{@worktree_name}'..."
+        puts "Main worktree: #{@main_worktree}"
+        puts "Database: #{@database_name}"
+
+        copy_config_files
+        set_database_name
+        update_database_yml
+        copy_node_modules
+        setup_database
+
+        puts ""
+        puts "✓ Worktree initialized successfully!"
+        puts "  Database: #{@database_name}"
+        puts "  Configuration files copied"
+        puts ""
+        puts "To start the development server: bin/dev"
+      end
+
+      private
+
+      def get_main_worktree
+        output = `git worktree list --porcelain`
+        output.lines.grep(/^worktree /).first&.split(" ", 2)&.last&.strip
+      end
+
+      def get_db_prefix
+        database_yml = File.join(@main_worktree, "config/database.yml")
+        return nil unless File.exist?(database_yml)
+
+        content = File.read(database_yml)
+        match = content.match(/database:\s*(\w+)_development/)
+        match ? match[1] : nil
+      end
+
+      def copy_config_files
+        puts "Copying configuration files..."
+
+        files_to_copy = [
+          ".env",
+          "config/database.yml",
+          "Procfile.dev",
+          "config/credentials/development.key"
+        ]
+
+        files_to_copy.each do |file|
+          source = File.join(@main_worktree, file)
+          if File.exist?(source)
+            FileUtils.mkdir_p(File.dirname(file)) unless File.directory?(File.dirname(file))
+            FileUtils.cp(source, file)
+          else
+            puts "Warning: #{file} not found, skipping"
+          end
+        end
+      end
+
+      def set_database_name
+        puts "Setting DATABASE_NAME=#{@database_name} in .env..."
+
+        env_file = ".env"
+        return unless File.exist?(env_file)
+
+        content = File.read(env_file)
+        if content.match?(/^DATABASE_NAME=/)
+          content.gsub!(/^DATABASE_NAME=.*$/, "DATABASE_NAME=#{@database_name}")
+        else
+          content += "\nDATABASE_NAME=#{@database_name}\n"
+        end
+
+        File.write(env_file, content)
+      end
+
+      def update_database_yml
+        puts "Updating database.yml to use DATABASE_NAME..."
+
+        database_yml = "config/database.yml"
+        return unless File.exist?(database_yml)
+
+        content = File.read(database_yml)
+        content.gsub!(
+          /database:\s*#{@db_prefix}_development/,
+          "database: <%= ENV.fetch(\"DATABASE_NAME\", \"#{@db_prefix}_development\") %>"
+        )
+
+        File.write(database_yml, content)
+      end
+
+      def copy_node_modules
+        source = File.join(@main_worktree, "node_modules")
+        dest = "node_modules"
+
+        if Dir.exist?(source) && !Dir.exist?(dest)
+          puts "Copying node_modules from main worktree..."
+          FileUtils.cp_r(source, dest)
+          puts "Note: node_modules copied."
+        end
+      end
+
+      def setup_database
+        puts "Creating database #{@database_name}..."
+        system("RAILS_ENV=development bin/rails db:create") || puts("Warning: Could not create database")
+
+        puts "Running migrations..."
+        system("RAILS_ENV=development bin/rails db:migrate") || puts("Warning: Could not run migrations")
+
+        puts "Seeding database..."
+        system("RAILS_ENV=development bin/rails db:seed") || puts("Warning: Could not seed database")
+      end
+    end
+  end
+end

data/lib/worktree/railtie.rb

@@ -0,0 +1,34 @@
+require "rails/railtie"
+
+module Worktree
+  class Railtie < Rails::Railtie
+    railtie_name :worktree
+
+    rake_tasks do
+      load "worktree/tasks.rb"
+    end
+
+    initializer "worktree.install_binstub" do
+      # Install binstub automatically when Rails loads in development
+      if Rails.env.development?
+        binstub_path = Rails.root.join("bin/worktree")
+
+        unless File.exist?(binstub_path)
+          Rails.logger.info "Installing worktree binstub to bin/worktree..."
+
+          File.write(binstub_path, <<~RUBY)
+            #!/usr/bin/env ruby
+
+            require "bundler/setup"
+            require "worktree"
+
+            Worktree::CLI.run(ARGV)
+          RUBY
+
+          FileUtils.chmod("+x", binstub_path)
+          Rails.logger.info "✓ Worktree binstub installed! Use: bin/worktree <name>"
+        end
+      end
+    end
+  end
+end

data/lib/worktree/tasks.rb

@@ -0,0 +1,37 @@
+namespace :worktree do
+  desc "Install worktree binstub to bin/worktree"
+  task :install do
+    binstub_path = File.join(Dir.pwd, "bin/worktree")
+
+    if File.exist?(binstub_path)
+      puts "Binstub already exists at bin/worktree"
+      exit 0
+    end
+
+    File.write(binstub_path, <<~RUBY)
+      #!/usr/bin/env ruby
+
+      require "bundler/setup"
+      require "worktree"
+
+      Worktree::CLI.run(ARGV)
+    RUBY
+
+    File.chmod(0755, binstub_path)
+
+    puts "✓ Worktree binstub installed to bin/worktree"
+    puts "Usage: bin/worktree <name>"
+  end
+
+  desc "Uninstall worktree binstub from bin/worktree"
+  task :uninstall do
+    binstub_path = File.join(Dir.pwd, "bin/worktree")
+
+    if File.exist?(binstub_path)
+      File.delete(binstub_path)
+      puts "✓ Worktree binstub removed from bin/worktree"
+    else
+      puts "Binstub not found at bin/worktree"
+    end
+  end
+end

data/lib/worktree/version.rb

@@ -0,0 +1,3 @@
+module Worktree
+  VERSION = "0.1.0"
+end

data/lib/worktree.rb

@@ -0,0 +1,12 @@
+require_relative "worktree/version"
+require_relative "worktree/cli"
+require_relative "worktree/commands/create"
+require_relative "worktree/commands/init"
+require_relative "worktree/commands/close"
+
+# Load Railtie only if Rails is available
+require_relative "worktree/railtie" if defined?(Rails::Railtie)
+
+module Worktree
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rails-worktree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Ulleberg
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Easily create, initialize, and close git worktrees with isolated databases
+  and configurations for Rails projects
+email:
+- martin@fasttravel.com
+executables:
+- worktree
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/worktree
+- lib/rails-worktree.rb
+- lib/worktree.rb
+- lib/worktree/cli.rb
+- lib/worktree/commands/close.rb
+- lib/worktree/commands/create.rb
+- lib/worktree/commands/init.rb
+- lib/worktree/railtie.rb
+- lib/worktree/tasks.rb
+- lib/worktree/version.rb
+homepage: https://github.com/FastTravelAS/rails-worktree
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FastTravelAS/rails-worktree
+  source_code_uri: https://github.com/FastTravelAS/rails-worktree
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Git worktree management for Rails projects
+test_files: []