rails-worktrees 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf1debd660652a5429a2d5485e944006685268b423866a96e15af71f9cb3471
-  data.tar.gz: 14f6a3f5efaa6b829026b3d4d085c9b55d09236cb7b610bafa8f8834a534fb5b
+  metadata.gz: 19ad567125176f17f962138eaf218f8e8c91a7a6585b61db0bddfa4c259f7d17
+  data.tar.gz: 7c29590624ed404c362deb38866f134ba9516bbd3e6f83f3b04cfb00792caeb4
 SHA512:
-  metadata.gz: e16d066bfb55c97b959e92b4c25d1b2ac08404a728cadf077852a937a1a4c00ea17ca0c08dcfecc571654f836ba0aeccc6f81b08b6a96f7a4443093681d3b25d
-  data.tar.gz: f7fdc3e954463fed68f62934d153fbe4b086fb86f4be97c8f8e172b54c0bcc4d402587b99c2b171cc024f7ef53be14e950da311399e49ef0a491d696ac15dc64
+  metadata.gz: f35103be9855cc4e262f12b4dbff0ff935cb65b67d3ae6d2ca619eb1d47bdfcf8829be5b03f2d8ff3cc587509098045d32ccea539fa48395a02c6180ca69546b
+  data.tar.gz: ef54f096ea64e518519b59f9f74af756bec7601ee492c0d1aec98736c485e62998cc6ec9149b251fa903f4acdb39f5e8cc36e4ed66aa650357df76090c3fd67b

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.2.0"}
+{".":"0.2.2"}

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.2](https://github.com/asjer/rails-worktrees/compare/v0.2.1...v0.2.2) (2026-03-30)
+
+
+### Bug Fixes
+
+* **yolo:** skip generating `Procfile.dev.worktree.example` in --yolo mode ([b2320be](https://github.com/asjer/rails-worktrees/commit/b2320be92c84bfdcbb4f781fb34fc079df09f0b1))
+
+## [0.2.1](https://github.com/asjer/rails-worktrees/compare/v0.2.0...v0.2.1) (2026-03-30)
+
+
+### Bug Fixes
+
+* **puma:** add missing `DEV_PORT` support to config/puma.rb ([3fd71a0](https://github.com/asjer/rails-worktrees/commit/3fd71a04d79732bed4cf626951abe06ddbc01153))
+
 ## [0.2.0](https://github.com/asjer/rails-worktrees/compare/v0.1.1...v0.2.0) (2026-03-30)
 
 

data/README.md

@@ -13,7 +13,7 @@
 ```bash
 bundle add rails-worktrees
 bin/rails generate worktrees:install
-# or, to apply the common Procfile.dev + mise follow-ups automatically:
+# or, to apply the common Procfile.dev + Puma + mise follow-ups automatically:
 bin/rails generate worktrees:install --yolo
 ```
 
@@ -21,12 +21,14 @@ The installer adds:
 
 - `bin/wt` — a thin wrapper that executes the gem-owned CLI
 - `config/initializers/rails_worktrees.rb` — optional configuration
-- `Procfile.dev.worktree.example` — a copy-paste helper for `${DEV_PORT:-3000}` in `Procfile.dev`
+- `Procfile.dev.worktree.example` — a copy-paste helper for `${DEV_PORT:-3000}` in `Procfile.dev` on regular installs
 - a safe update to `config/database.yml` for common development/test database names
 
 With `--yolo`, the installer also:
 
+- skips `Procfile.dev.worktree.example`
 - replaces the existing `web:` entry in `Procfile.dev` with the DEV_PORT-aware command when `Procfile.dev` already exists
+- updates `config/puma.rb` to use `port ENV['DEV_PORT'] || ENV.fetch('PORT', 3000)` when it still uses a supported default `PORT` binding
 - updates `mise.toml` or `.mise.toml` to load `.env` from `[env]` when either file already exists
 
 ## Usage
@@ -122,17 +124,21 @@ When `bin/wt` creates a worktree it writes a worktree-local `.env` with:
 
 Existing `.env` values are never overwritten.
 
-By default, the installer does **not** edit your `Procfile.dev` or `mise` config. It generates `Procfile.dev.worktree.example` with a ready-to-copy line:
+By default, the installer does **not** edit your `Procfile.dev`, `config/puma.rb`, or `mise` config. It generates `Procfile.dev.worktree.example` with a ready-to-copy line:
 
 ```text
 web: env RUBY_DEBUG_OPEN=true bin/rails server -b 0.0.0.0 -p ${DEV_PORT:-3000}
 ```
 
-If you run `bin/rails generate worktrees:install --yolo`, the installer applies the two common follow-ups for you when the files already exist:
+If you run `bin/rails generate worktrees:install --yolo`, the installer applies the three common follow-ups for you when the files already exist:
 
+- skip generating `Procfile.dev.worktree.example`
 - replace the existing `web:` entry in `Procfile.dev`
+- update `config/puma.rb` to `port ENV['DEV_PORT'] || ENV.fetch('PORT', 3000)` when it still uses a supported default `PORT` binding
 - add `_.file = ".env"` to the `[env]` section of `mise.toml` or `.mise.toml`
 
+On a regular install, the follow-up message also suggests the same `config/puma.rb` edit when Puma still uses the default `PORT` binding.
+
 Use a project-local env loader like `mise` with `_.file = ".env"` to keep values scoped per-worktree.
 
 ## Development
@@ -154,7 +160,7 @@ This smoke test:
 - creates a temporary Rails app from a compatible Rails version
 - installs `rails-worktrees` from the current checkout path
 - runs `bin/rails generate worktrees:install --yolo`
-- verifies `bin/wt`, the generated initializer, the Procfile example, yolo updates to `Procfile.dev` and `mise.toml`, `config/database.yml` patching, and worktree `.env` bootstrapping
+- verifies `bin/wt`, the generated initializer, that `--yolo` skips the Procfile example, yolo updates to `Procfile.dev`, `config/puma.rb`, and `mise.toml`, `config/database.yml` patching, and worktree `.env` bootstrapping
 - creates a temporary bare `origin` and confirms `bin/wt smoke-branch` creates a real worktree
 
 By default, the script cleans up all temp directories after the run. Set `KEEP_SMOKE_TEST_ARTIFACTS=1` to keep them around for debugging, or set `RAILS_WORKTREES_SMOKE_RAILS_VERSION` to try a different compatible Rails version.

data/lib/generators/rails/worktrees/puma_follow_up.rb

@@ -0,0 +1,45 @@
+module Rails
+  module Worktrees
+    module Generators
+      # Detects config/puma.rb setups that should prefer the worktree-local DEV_PORT.
+      module PumaFollowUp
+        private
+
+        def puma_follow_up_notes_text
+          return '' unless suggest_puma_dev_port_update?
+
+          [
+            '',
+            '      Tip:',
+            '        Detected config/puma.rb. To bind Puma to the worktree-local DEV_PORT,',
+            '        consider changing the port line to:',
+            "          #{::Rails::Worktrees::PumaConfigUpdater::STANDARD_PORT_LINE}"
+          ].join("\n")
+        end
+
+        def suggest_puma_dev_port_update?
+          existing_puma_config_path && puma_update_result.status == :updated
+        end
+
+        def puma_update_result
+          return missing_puma_update_result unless existing_puma_config_path
+
+          ::Rails::Worktrees::PumaConfigUpdater.new(content: File.read(existing_puma_config_path)).call
+        end
+
+        def missing_puma_update_result
+          ::Rails::Worktrees::PumaConfigUpdater::Result.new(nil, false, :skip, [])
+        end
+
+        def puma_config_path
+          File.join(destination_root, 'config/puma.rb')
+        end
+
+        def existing_puma_config_path
+          path = puma_config_path
+          File.file?(path) ? path : nil
+        end
+      end
+    end
+  end
+end

data/lib/generators/worktrees/install/install_generator.rb

@@ -2,9 +2,11 @@ require 'open3'
 require 'rails/generators'
 
 require_relative '../../rails/worktrees/mise_follow_up'
+require_relative '../../rails/worktrees/puma_follow_up'
 require_relative '../../../rails/worktrees/database_config_updater'
 require_relative '../../../rails/worktrees/procfile_updater'
 require_relative '../../../rails/worktrees/mise_toml_updater'
+require_relative '../../../rails/worktrees/puma_config_updater'
 
 module Worktrees
   module Generators
@@ -12,6 +14,7 @@ module Worktrees
     # rubocop:disable Metrics/ClassLength
     class InstallGenerator < ::Rails::Generators::Base
       include ::Rails::Worktrees::Generators::MiseFollowUp
+      include ::Rails::Worktrees::Generators::PumaFollowUp
 
       namespace 'worktrees:install'
       desc 'Installs bin/wt, a Rails::Worktrees initializer, and updates config/database.yml when safe.'
@@ -19,7 +22,7 @@ module Worktrees
       class_option :conductor, type: :boolean, default: false,
                                desc: 'Configure the installer for ~/Sites/conductor/workspaces'
       class_option :yolo, type: :boolean, default: false,
-                          desc: 'Apply common Procfile.dev and mise .env follow-up edits when safe'
+                          desc: 'Apply common Procfile.dev, config/puma.rb, and mise .env follow-up edits when safe'
 
       FOLLOW_UP_TEMPLATE = <<~TEXT.freeze
           ============================================
@@ -48,6 +51,8 @@ module Worktrees
       end
 
       def create_procfile_worktree_example
+        return if options[:yolo]
+
         template('Procfile.dev.worktree.example.tt', 'Procfile.dev.worktree.example')
       end
 
@@ -55,6 +60,7 @@ module Worktrees
         return unless options[:yolo]
 
         update_procfile
+        update_puma_config
         update_mise_toml
       end
 
@@ -92,6 +98,10 @@ module Worktrees
         File.join(destination_root, 'Procfile.dev')
       end
 
+      def puma_config_path
+        File.join(destination_root, 'config/puma.rb')
+      end
+
       def mise_toml_paths
         [
           File.join(destination_root, 'mise.toml'),
@@ -113,12 +123,16 @@ module Worktrees
         "\n#{format(FOLLOW_UP_TEMPLATE, installed: installed_items_text, notes: follow_up_notes_text)}"
       end
 
+      def follow_up_notes_text
+        [super, puma_follow_up_notes_text].join
+      end
+
       def installed_items_text
         items = [
           '      • bin/wt',
-          '      • config/initializers/rails_worktrees.rb',
-          '      • Procfile.dev.worktree.example'
+          '      • config/initializers/rails_worktrees.rb'
         ]
+        items << '      • Procfile.dev.worktree.example' unless options[:yolo]
         items << database_follow_up_line if database_follow_up_line
         items.join("\n")
       end
@@ -152,6 +166,18 @@ module Worktrees
         announce_updater_result('Procfile.dev', result)
       end
 
+      def update_puma_config
+        unless File.exist?(puma_config_path)
+          say_status(:skip, 'config/puma.rb not found', :yellow)
+          say('Skipped config/puma.rb yolo update because the file does not exist yet.')
+          return
+        end
+
+        result = ::Rails::Worktrees::PumaConfigUpdater.new(content: File.read(puma_config_path)).call
+        File.write(puma_config_path, result.content) if result.changed?
+        announce_updater_result('config/puma.rb', result)
+      end
+
       def update_mise_toml
         path = first_mise_toml_path
         return announce_missing_mise_toml unless path

data/lib/rails/worktrees/puma_config_updater.rb

@@ -0,0 +1,91 @@
+module Rails
+  module Worktrees
+    # Safely updates config/puma.rb to bind Puma to the worktree-local DEV_PORT.
+    class PumaConfigUpdater
+      Result = Struct.new(:content, :changed, :status, :messages) do
+        def changed?
+          changed
+        end
+      end
+
+      STANDARD_PORT_LINE = "port ENV['DEV_PORT'] || ENV.fetch('PORT', 3000)".freeze
+      CURRENT_PORT_PATTERN = /\A\s*port\s+ENV\.fetch\(["']PORT["'],\s*3000\)\s*(?:#.*)?\z/
+      LEGACY_PORT_PATTERN = /\A\s*port\s+ENV\.fetch\(["']PORT["']\)\s*\{\s*3000\s*\}\s*(?:#.*)?\z/
+      PORT_LINE_PATTERN = /\A\s*port\s+/
+      DEV_PORT_ACCESS_PATTERN = /ENV\[(["'])DEV_PORT\1\]/
+      DEV_PORT_FETCH_PATTERN = /ENV\.fetch\((["'])DEV_PORT\1(?:\s*,|\s*\))/
+
+      def initialize(content:)
+        @content = content
+      end
+
+      def call
+        lines = @content.lines(chomp: true)
+        return identical_result(@content) if dev_port_configured?(lines)
+
+        port_line_indexes = supported_port_line_indexes(lines)
+        return skip_result if port_line_indexes.empty?
+
+        updated_content = rebuild_content(
+          replace_port_lines(lines, port_line_indexes),
+          trailing_newline: @content.end_with?("\n")
+        )
+
+        updated_result(updated_content)
+      end
+
+      private
+
+      def updated_result(content)
+        Result.new(content, true, :updated, ['Updated config/puma.rb to prefer DEV_PORT before PORT.'])
+      end
+
+      def identical_result(content)
+        Result.new(content, false, :identical, ['config/puma.rb already uses DEV_PORT-aware port binding.'])
+      end
+
+      def skip_result
+        Result.new(
+          @content,
+          false,
+          :skip,
+          ['No supported Puma port binding found in config/puma.rb; update it manually if needed.']
+        )
+      end
+
+      def dev_port_configured?(lines)
+        lines.any? do |line|
+          line.match?(PORT_LINE_PATTERN) &&
+            (line.match?(DEV_PORT_ACCESS_PATTERN) || line.match?(DEV_PORT_FETCH_PATTERN))
+        end
+      end
+
+      def supported_port_line_indexes(lines)
+        lines.each_index.select { |index| supported_port_line?(lines[index]) }
+      end
+
+      def supported_port_line?(line)
+        line.match?(CURRENT_PORT_PATTERN) || line.match?(LEGACY_PORT_PATTERN)
+      end
+
+      def replace_port_lines(lines, port_line_indexes)
+        lines.dup.tap do |updated_lines|
+          port_line_indexes.each do |index|
+            original_line = lines[index]
+            indent = original_line[/\A\s*/]
+            trailing_comment = original_line[/(\s*#.*)\z/, 1].to_s
+
+            updated_lines[index] = "#{indent}#{STANDARD_PORT_LINE}#{trailing_comment}"
+          end
+        end
+      end
+
+      def rebuild_content(lines, trailing_newline:)
+        content = lines.join("\n")
+        return content if content.empty? || !trailing_newline
+
+        "#{content}\n"
+      end
+    end
+  end
+end

data/lib/rails/worktrees/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Worktrees
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end

data/lib/rails/worktrees.rb

@@ -8,6 +8,7 @@ require_relative 'worktrees/cli'
 require_relative 'worktrees/database_config_updater'
 require_relative 'worktrees/procfile_updater'
 require_relative 'worktrees/mise_toml_updater'
+require_relative 'worktrees/puma_config_updater'
 
 module Rails
   # Rails-specific git worktree helpers and installer support.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-worktrees
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Asjer Querido
@@ -46,6 +46,7 @@ files:
 - exe/wt
 - lefthook.yml
 - lib/generators/rails/worktrees/mise_follow_up.rb
+- lib/generators/rails/worktrees/puma_follow_up.rb
 - lib/generators/rails/worktrees/templates/Procfile.dev.worktree.example.tt
 - lib/generators/rails/worktrees/templates/bin/wt
 - lib/generators/rails/worktrees/templates/rails_worktrees.rb.tt
@@ -64,6 +65,7 @@ files:
 - lib/rails/worktrees/mise_toml_updater.rb
 - lib/rails/worktrees/names/cities.txt
 - lib/rails/worktrees/procfile_updater.rb
+- lib/rails/worktrees/puma_config_updater.rb
 - lib/rails/worktrees/railtie.rb
 - lib/rails/worktrees/version.rb
 - mise.toml