rails-worktrees 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc7ddb67fbc5fde18c04ab164229207c6f54284dc4bb5c1fb955f40544706cbb
-  data.tar.gz: a4005286b6c1dbad990d94ca3999b1490f2532c981fa8e5a7fb9b5768e4f30d6
+  metadata.gz: 5c6da0f27411c99c20b5ab3496a4ac0672ba6a3833e429b33b53b5884d3a3c76
+  data.tar.gz: cb144472bad91868165d8a37de3ba12f0675255aabc2fa3df0d9e8d6c3d736ff
 SHA512:
-  metadata.gz: 8eef6c43ad39e5fc38c3dbdc10fc2618fc07f0ccd65c5c25bef94ae3991aeff143687ee45a37983846cc7ec8fc4c031d39b2b4cd6abcdd37d31243bb705a24a0
-  data.tar.gz: dfdeeb6c73a81e8c3c8147883b5ca752b79ff4a63e318db409792c6723c4fd84ae3f9effc93edc1d456f74fa22f326e954ac7239d044a27709436d1e462810b6
+  metadata.gz: 7d959fde216a23fa191dca31294ff776b0091e3f230db9191a87890e8736217c3182b773e2950b18cbc151c20f833b238b7f3a07e618a5a4aa997bad5191760e
+  data.tar.gz: 7abecada6524724a90bd993b3975ce8b20a05e5123c0a9e2f6a2e8bc3d5435d04590a2ba3df83561ec41004d03d83627d48659866290b78b5ce4ed3bebbabfb1

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.1.0"}
+{".":"0.1.1"}

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.1.1](https://github.com/asjer/rails-worktrees/compare/v0.1.0...v0.1.1) (2026-03-30)
+
+
+### Bug Fixes
+
+* **bin/wt:** remove unnecessary frozen_string_literal comment ([e3752c8](https://github.com/asjer/rails-worktrees/commit/e3752c86e4003b80e401253e3c07bd0107ba1514))
+* **ci:** update gem installation steps to prevent `Gemfile.lock` freeze ([e3c75e8](https://github.com/asjer/rails-worktrees/commit/e3c75e85528e575185adb417b6bd9efa995087f1))
+* **frozen-string-literal:** remove unnecessary frozen_string_literal comments ([a8583d2](https://github.com/asjer/rails-worktrees/commit/a8583d2bab1097a6c6a1906a3d6f6092d7b8d867))
+* **generator:** update generator command to use shorter namespace ([cef728e](https://github.com/asjer/rails-worktrees/commit/cef728e3642c36da054f0d53ab5d8a932b2511c4))
+* **installation:** show setup instructions on boot when generator hasn't run ([af31a3f](https://github.com/asjer/rails-worktrees/commit/af31a3f3849408cf7098e2a4e90a9246c89b0bbe))
+
 ## 0.1.0 (2026-03-30)
 
 

data/README.md

@@ -12,7 +12,7 @@
 
 ```bash
 bundle add rails-worktrees
-bin/rails generate rails:worktrees:install
+bin/rails generate worktrees:install
 ```
 
 The installer adds:
@@ -141,7 +141,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 rails:worktrees:install`
+- runs `bin/rails generate worktrees:install`
 - verifies `bin/wt`, the generated initializer, the Procfile example, `config/database.yml` patching, and worktree `.env` bootstrapping
 - creates a temporary bare `origin` and confirms `bin/wt smoke-branch` creates a real worktree
 

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/exe/wt

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
-
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     module Generators

data/lib/generators/rails/worktrees/templates/bin/wt

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
-
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup'

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 Rails::Worktrees.configure do |config|
 <% if options['conductor'] -%>
   config.workspace_root = <%= conductor_workspace_root %>

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

@@ -0,0 +1,134 @@
+require 'open3'
+require 'rails/generators'
+
+require_relative '../../rails/worktrees/mise_follow_up'
+require_relative '../../../rails/worktrees/database_config_updater'
+
+module Worktrees
+  module Generators
+    # Installs the wt wrapper, configuration, and safe database.yml updates.
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Worktrees::Generators::MiseFollowUp
+
+      namespace 'worktrees:install'
+      desc 'Installs bin/wt, a Rails::Worktrees initializer, and updates config/database.yml when safe.'
+      source_root File.expand_path('../../rails/worktrees/templates', __dir__)
+      class_option :conductor, type: :boolean, default: false,
+                               desc: 'Configure the installer for ~/Sites/conductor/workspaces'
+
+      FOLLOW_UP_TEMPLATE = <<~TEXT.freeze
+          ============================================
+            rails-worktrees installed successfully! 🚂
+
+            Installed:
+        %<installed>s
+
+            Get started:
+              $ bin/wt
+              $ bin/wt my-feature
+
+            Configure:
+              config/initializers/rails_worktrees.rb
+        %<notes>s
+          ============================================
+      TEXT
+
+      def create_bin_wrapper
+        template('bin/wt', 'bin/wt')
+        chmod('bin/wt', 0o755)
+      end
+
+      def create_initializer
+        template('rails_worktrees.rb.tt', 'config/initializers/rails_worktrees.rb')
+      end
+
+      def create_procfile_worktree_example
+        template('Procfile.dev.worktree.example.tt', 'Procfile.dev.worktree.example')
+      end
+
+      def update_database_configuration
+        unless File.exist?(database_config_path)
+          say_status(:skip, 'config/database.yml not found', :yellow)
+          @database_outcome = :not_found
+          return
+        end
+
+        result = database_update_result
+        @database_outcome = result.changed? ? :updated : :identical
+        announce_database_update(result)
+      end
+
+      def verify_installation
+        if git_repo?
+          say_status(:ok, 'git repository detected', :green)
+        else
+          say_status(:warning, 'run inside a git repository for bin/wt to work', :yellow)
+        end
+      end
+
+      def show_follow_up
+        say(follow_up_message)
+      end
+
+      private
+
+      def database_config_path
+        File.join(destination_root, 'config/database.yml')
+      end
+
+      def database_update_result
+        result = ::Rails::Worktrees::DatabaseConfigUpdater.new(
+          content: File.read(database_config_path)
+        ).call
+
+        File.write(database_config_path, result.content) if result.changed?
+
+        result
+      end
+
+      def follow_up_message
+        "\n#{format(FOLLOW_UP_TEMPLATE, installed: installed_items_text, notes: follow_up_notes_text)}"
+      end
+
+      def installed_items_text
+        items = [
+          '      • bin/wt',
+          '      • config/initializers/rails_worktrees.rb',
+          '      • Procfile.dev.worktree.example'
+        ]
+        items << database_follow_up_line if database_follow_up_line
+        items.join("\n")
+      end
+
+      def database_follow_up_line
+        case @database_outcome
+        when :updated
+          '      • config/database.yml (updated with WORKTREE_DATABASE_SUFFIX)'
+        when :not_found
+          '      • config/database.yml was not found — see README for manual setup'
+        end
+      end
+
+      def announce_database_update(result)
+        status = result.changed? ? :update : :identical
+        color = result.changed? ? :green : :blue
+
+        say_status(status, 'config/database.yml', color)
+        result.messages.each { |message| say(message) }
+      end
+
+      def git_repo?
+        _stdout_str, _stderr_str, status = Open3.capture3(
+          'git', 'rev-parse', '--is-inside-work-tree', chdir: destination_root
+        )
+        status.success?
+      rescue Errno::ENOENT
+        false
+      end
+
+      def conductor_workspace_root
+        "File.expand_path('~/Sites/conductor/workspaces')"
+      end
+    end
+  end
+end

data/lib/rails/worktrees/cli.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     # Shell entrypoint for the wt executable.

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     class Command

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'open3'
 
 module Rails

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     class Command

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     class Command

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     class Command

data/lib/rails/worktrees/command.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'fileutils'
 require_relative 'command/environment_support'
 require_relative 'command/git_operations'

data/lib/rails/worktrees/configuration.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     # Stores application-level settings for the wt command.
     class Configuration
       DEFAULT_BOOTSTRAP_ENV = true
-      DEFAULT_BRANCH_PREFIX = '🚂'
+      DEFAULT_BRANCH_PREFIX = '🚂'.freeze
       DEFAULT_DEV_PORT_RANGE = (3000..3999)
       DEFAULT_USED_NAMES_DIRECTORY = File.join(
         ENV.fetch('XDG_STATE_HOME', File.join(Dir.home, '.local/state')),

data/lib/rails/worktrees/database_config_updater.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
     # Safely patches common database.yml layouts for worktree suffixes.
@@ -10,7 +8,7 @@ module Rails
         end
       end
 
-      SUFFIX_TEMPLATE = "<%= ENV.fetch('WORKTREE_DATABASE_SUFFIX', '') %>"
+      SUFFIX_TEMPLATE = "<%= ENV.fetch('WORKTREE_DATABASE_SUFFIX', '') %>".freeze
       SUPPORTED_ENVIRONMENTS = %w[development test].freeze
       DATABASE_LINE_PATTERN = /\A(\s*database:\s*)(.+?)(\s*(?:#.*)?\n?)\z/
       SECTION_PATTERN = /\A([A-Za-z0-9_]+):(?:\s|$)/

data/lib/rails/worktrees/env_bootstrapper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'pathname'
 require 'zlib'
 
@@ -14,7 +12,7 @@ module Rails
         attr_accessor :values
       end
 
-      ENV_FILE_NAME = '.env'
+      ENV_FILE_NAME = '.env'.freeze
 
       def initialize(target_dir:, worktree_name:, configuration:)
         @target_dir = target_dir

data/lib/rails/worktrees/railtie.rb

@@ -1,8 +1,10 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
+    # Hooks install guidance into Rails boot when the generator has not run yet.
     class Railtie < ::Rails::Railtie
+      initializer 'rails_worktrees.installation_hint' do
+        Rails::Worktrees.warn_about_missing_installation
+      end
     end
   end
 end

data/lib/rails/worktrees/version.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module Rails
   module Worktrees
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'.freeze
   end
 end

data/lib/rails/worktrees.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
+require 'pathname'
 
 require_relative 'worktrees/version'
 require_relative 'worktrees/configuration'
@@ -12,6 +12,13 @@ module Rails
   module Worktrees
     class Error < StandardError; end
 
+    INSTALL_GENERATOR_COMMAND = 'bin/rails generate worktrees:install'.freeze
+    INSTALL_GENERATOR_NAMES = %w[worktrees:install].freeze
+    REQUIRED_INSTALLATION_PATHS = [
+      'bin/wt',
+      'config/initializers/rails_worktrees.rb'
+    ].freeze
+
     class << self
       def configuration
         @configuration ||= Configuration.new
@@ -25,6 +32,95 @@ module Rails
       def reset_configuration!
         @configuration = Configuration.new
       end
+
+      def installation_complete?(root = resolve_root)
+        return false unless root
+
+        required_installation_paths(root).all?(&:exist?)
+      end
+
+      def missing_installation_message(root: resolve_root)
+        return generic_missing_installation_message unless root
+
+        detailed_missing_installation_message(normalize_root(root))
+      end
+
+      def warn_about_missing_installation(root: resolve_root, stderr: $stderr, argv: ARGV)
+        return unless missing_installation_warning_needed?(root: root, argv: argv)
+
+        stderr.puts(missing_installation_message(root: root))
+      end
+
+      private
+
+      def missing_installation_warning_needed?(root:, argv:)
+        return false unless root
+        return false if installation_complete?(root)
+        return false if install_generator_invocation?(argv)
+
+        true
+      end
+
+      def install_generator_invocation?(argv)
+        normalized_args = Array(argv).map(&:to_s)
+        generator_commands = %w[generate g]
+
+        INSTALL_GENERATOR_NAMES.any? do |generator_name|
+          normalized_args.include?(generator_name) ||
+            normalized_args.each_cons(2).any? do |left, right|
+              generator_commands.include?(left) && right == generator_name
+            end
+        end
+      end
+
+      def required_installation_paths(root)
+        root_path = normalize_root(root)
+
+        REQUIRED_INSTALLATION_PATHS.map { |relative_path| root_path.join(relative_path) }
+      end
+
+      def generic_missing_installation_message
+        <<~MSG
+
+          rails-worktrees is in your bundle, but the app installer has not run yet.
+
+          Run:
+            $ #{INSTALL_GENERATOR_COMMAND}
+
+          Docs: https://github.com/asjer/rails-worktrees
+        MSG
+      end
+
+      def detailed_missing_installation_message(root_path)
+        <<~MSG
+
+          rails-worktrees is in your bundle, but the app installer has not run yet.
+
+          Run:
+            $ #{INSTALL_GENERATOR_COMMAND}
+
+          Missing expected files under #{root_path}:
+          #{missing_installation_items_text(root_path)}
+
+          Docs: https://github.com/asjer/rails-worktrees
+        MSG
+      end
+
+      def missing_installation_items_text(root)
+        required_installation_paths(root).reject(&:exist?).map do |path|
+          "  • #{path.relative_path_from(root)}"
+        end.join("\n")
+      end
+
+      def resolve_root
+        return unless defined?(Rails) && Rails.respond_to?(:root)
+
+        Rails.root
+      end
+
+      def normalize_root(root)
+        root.is_a?(Pathname) ? root : Pathname(root)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-worktrees
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Asjer Querido
@@ -45,11 +45,11 @@ files:
 - Rakefile
 - exe/wt
 - lefthook.yml
-- lib/generators/rails/worktrees/install_generator.rb
 - lib/generators/rails/worktrees/mise_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
+- lib/generators/worktrees/install/install_generator.rb
 - lib/rails/worktrees.rb
 - lib/rails/worktrees/cli.rb
 - lib/rails/worktrees/command.rb
@@ -77,7 +77,7 @@ metadata:
   rubygems_mfa_required: 'true'
 post_install_message: "\n============================================\n  Thank you
   for installing rails-worktrees! \U0001F389\n\n  Run the installer:\n    $ bin/rails
-  generate rails:worktrees:install\n\n  Docs: https://github.com/asjer/rails-worktrees\n============================================\n\n"
+  generate worktrees:install\n\n  Docs: https://github.com/asjer/rails-worktrees\n============================================\n\n"
 rdoc_options: []
 require_paths:
 - lib

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

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'rails/generators'
-require_relative 'mise_follow_up'
-require_relative '../../../rails/worktrees/database_config_updater'
-
-module Rails
-  module Worktrees
-    module Generators
-      # Installs the wt wrapper, configuration, and safe database.yml updates.
-      class InstallGenerator < ::Rails::Generators::Base
-        include MiseFollowUp
-
-        namespace 'rails:worktrees:install'
-        desc 'Installs bin/wt, a Rails::Worktrees initializer, and updates config/database.yml when safe.'
-        source_root File.expand_path('templates', __dir__)
-        class_option :conductor, type: :boolean, default: false,
-                                 desc: 'Configure the installer for ~/Sites/conductor/workspaces'
-
-        FOLLOW_UP_TEMPLATE = <<~TEXT
-            ============================================
-              rails-worktrees installed successfully! 🚂
-
-              Installed:
-          %<installed>s
-
-              Get started:
-                $ bin/wt
-                $ bin/wt my-feature
-
-              Configure:
-                config/initializers/rails_worktrees.rb
-          %<notes>s
-            ============================================
-        TEXT
-
-        def create_bin_wrapper
-          template('bin/wt', 'bin/wt')
-          chmod('bin/wt', 0o755)
-        end
-
-        def create_initializer
-          template('rails_worktrees.rb.tt', 'config/initializers/rails_worktrees.rb')
-        end
-
-        def create_procfile_worktree_example
-          template('Procfile.dev.worktree.example.tt', 'Procfile.dev.worktree.example')
-        end
-
-        def update_database_configuration
-          unless File.exist?(database_config_path)
-            say_status(:skip, 'config/database.yml not found', :yellow)
-            @database_outcome = :not_found
-            return
-          end
-
-          result = database_update_result
-          @database_outcome = result.changed? ? :updated : :identical
-          announce_database_update(result)
-        end
-
-        def verify_installation
-          if git_repo?
-            say_status(:ok, 'git repository detected', :green)
-          else
-            say_status(:warning, 'run inside a git repository for bin/wt to work', :yellow)
-          end
-        end
-
-        def show_follow_up
-          say(follow_up_message)
-        end
-
-        private
-
-        def database_config_path
-          File.join(destination_root, 'config/database.yml')
-        end
-
-        def database_update_result
-          result = ::Rails::Worktrees::DatabaseConfigUpdater.new(
-            content: File.read(database_config_path)
-          ).call
-
-          File.write(database_config_path, result.content) if result.changed?
-
-          result
-        end
-
-        def follow_up_message
-          "\n#{format(FOLLOW_UP_TEMPLATE, installed: installed_items_text, notes: follow_up_notes_text)}"
-        end
-
-        def installed_items_text
-          items = [
-            '      • bin/wt',
-            '      • config/initializers/rails_worktrees.rb',
-            '      • Procfile.dev.worktree.example'
-          ]
-          items << database_follow_up_line if database_follow_up_line
-          items.join("\n")
-        end
-
-        def database_follow_up_line
-          case @database_outcome
-          when :updated
-            '      • config/database.yml (updated with WORKTREE_DATABASE_SUFFIX)'
-          when :not_found
-            '      • config/database.yml was not found — see README for manual setup'
-          end
-        end
-
-        def announce_database_update(result)
-          status = result.changed? ? :update : :identical
-          color = result.changed? ? :green : :blue
-
-          say_status(status, 'config/database.yml', color)
-          result.messages.each { |message| say(message) }
-        end
-
-        def git_repo?
-          _stdout_str, _stderr_str, status = Open3.capture3(
-            'git', 'rev-parse', '--is-inside-work-tree', chdir: destination_root
-          )
-          status.success?
-        rescue Errno::ENOENT
-          false
-        end
-
-        def conductor_workspace_root
-          "File.expand_path('~/Sites/conductor/workspaces')"
-        end
-      end
-    end
-  end
-end