workroom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 709e14f9e8836400b840ad9772320ad6ddc9f2fbb163c800a0ba932b5d26ebe1
+  data.tar.gz: 6334a7e2daa13faaf34e3d7931bfe1082ec752b456f88531b255d429515c99da
+SHA512:
+  metadata.gz: 07ec6e20dfc896dec2a75cd11fe402b31c9dad2619ca323ac5b191ef23aa8cef681c742d41254356e62edef460aa5377c1e37d20c461d1e9f14caf15dec14658
+  data.tar.gz: 8915fa7afb229916379e8c0343550734b25300f87d6a64d3b495b4509afe1112e976e3138720920c1881dbac02366aee68dee7bed4e8f26d6c27ed95d6d49e40

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Joel Moss
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Workroom
+
+Create and manage local development workrooms using [JJ](https://martinvonz.github.io/jj/) workspaces or git worktrees.
+
+A workroom is an isolated copy of your project created as a sibling directory, allowing you to work on multiple branches or features simultaneously without stashing or switching contexts.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'workroom'
+```
+
+Then run `bundle install`.
+
+Or install directly:
+
+```bash
+gem install workroom
+```
+
+## Requirements
+
+- Ruby >= 3.1
+- [JJ (Jujutsu)](https://martinvonz.github.io/jj/) or Git
+
+## Usage
+
+### Create a workroom
+
+```bash
+workroom create my-feature
+```
+
+This creates a new workroom at `../my-feature` relative to your project root. Workroom automatically detects whether you're using JJ or Git and uses the appropriate mechanism (JJ workspace or git worktree).
+
+### Delete a workroom
+
+```bash
+workroom delete my-feature
+```
+
+Removes the workspace/worktree and cleans up the directory. You'll be prompted for confirmation before deletion.
+
+### Options
+
+- `-v`, `--verbose` - Print detailed output
+- `-p`, `--pretend` - Run through the command without making changes (dry run)
+
+### Naming rules
+
+Workroom names must be alphanumeric (dashes and underscores allowed) and must not start or end with a dash or underscore.
+
+## Setup and teardown scripts
+
+Workroom supports user-defined scripts that run automatically during create and delete operations.
+
+### Setup script
+
+Place an executable script at `scripts/workroom_setup` in your project. It will run inside the new workroom directory after creation.
+
+### Teardown script
+
+Place an executable script at `scripts/workroom_teardown` in your project. It will run after a workroom is deleted.
+
+## Rails integration
+
+Workroom includes a Rails Engine for auto-discovery by host Rails apps. Simply add the gem to your Rails app's Gemfile and it will be loaded automatically.
+
+## License
+
+[MIT](MIT-LICENSE)

data/bin/workroom

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.require
+
+Workroom::Commands.start

data/lib/workroom/commands.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'thor'
+
+module Workroom
+  class Commands < Thor
+    include Thor::Actions
+
+    IGNORED_JJ_WORKSPACE_NAMES = ['', 'default'].freeze
+
+    attr_reader :name
+
+    class_option :verbose, type: :boolean, aliases: '-v', group: :runtime,
+                           desc: 'Print detailed and verbose output'
+    add_runtime_options!
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'create NAME', 'Create a new workroom'
+    long_desc <<-DESC, wrap: false
+      Create a new workroom with the given NAME at the same level as your main project directory,
+      using JJ workspaces if available, otherwise falling back to git worktrees.
+    DESC
+    def create(name)
+      @name = name
+      check_not_in_workroom!
+      validate_name!
+
+      if !options[:pretend]
+        if workroom_exists?
+          exception = jj? ? JJWorkspaceExistsError : GitWorktreeExistsError
+          raise_error exception, "#{vcs_label} '#{name}' already exists!"
+        end
+
+        if workroom_path.exist?
+          raise_error DirExistsError, "Workroom directory '#{workroom_path}' already exists!"
+        end
+      end
+
+      create_workroom
+      run_setup_script
+
+      say
+      say "Workroom '#{name}' created successfully at #{workroom_path}.", :green
+
+      return if !@setup_result
+
+      say 'Setup script output:', :blue
+      say @setup_result
+    end
+
+    desc 'delete NAME', 'Delete an existing workroom'
+    def delete(name)
+      @name = name
+      check_not_in_workroom!
+      validate_name!
+
+      if !options[:pretend]
+        if !workroom_exists?
+          exception = jj? ? JJWorkspaceExistsError : GitWorktreeExistsError
+          raise_error exception, "#{vcs_label} '#{name}' does not exist!"
+        end
+
+        if !yes?("Are you sure you want to delete workroom '#{name}'?")
+          say_error "Aborting. Workroom '#{name}' was not deleted.", :yellow
+          return
+        end
+      end
+
+      delete_workroom
+      cleanup_directory if jj?
+      run_teardown_script
+
+      say
+      say "Workroom '#{name}' deleted successfully.", :green
+
+      if !jj?
+        say
+        say "Note: Git branch '#{name}' was not deleted."
+        say "      Delete manually with `git branch -D #{name}` if needed."
+      end
+
+      return if !@teardown_result
+
+      say
+      say 'Teardown script output:', :blue
+      say @teardown_result
+    end
+
+    private
+
+      def run_setup_script
+        return if !setup_script.exist?
+
+        inside workroom_path do
+          run_user_script :setup, setup_script_to_run.to_s
+        end
+      end
+
+      def setup_script
+        @setup_script ||= workroom_path.join('scripts', 'workroom_setup')
+      end
+
+      def setup_script_to_run
+        setup_script
+      end
+
+      def run_teardown_script
+        return if !teardown_script.exist?
+
+        run_user_script :teardown, teardown_script_to_run.to_s
+      end
+
+      def teardown_script
+        @teardown_script ||= Pathname.pwd.join('scripts', 'workroom_teardown')
+      end
+
+      def teardown_script_to_run
+        teardown_script
+      end
+
+      def run_user_script(type, command)
+        return if behavior != :invoke
+
+        destination = relative_to_original_destination_root(destination_root, false)
+
+        say_status type, "Running #{command} from #{destination.inspect}"
+
+        return if options[:pretend]
+
+        result, status = Open3.capture2e(command)
+
+        instance_variable_set :"@#{type}_result", result
+
+        return if status.success?
+
+        exception_class = Object.const_get("::Workroom::#{type.to_s.capitalize}Error")
+
+        raise_error exception_class, "#{command} returned a non-zero exit code.\n#{result}"
+      end
+
+      def raise_error(exception_class, message)
+        message = shell.set_color message, :red if !testing?
+        raise exception_class, message
+      end
+
+      def workroom_path
+        @workroom_path ||= Pathname.pwd.join("../#{name}")
+      end
+
+      def jj?
+        vcs == :jj
+      end
+
+      def vcs
+        @vcs ||= if Dir.exist?('.jj')
+                   say_status :repo, 'Detected Jujutsu'
+                   :jj
+                 elsif Dir.exist?('.git')
+                   say_status :repo, 'Detected Git'
+                   :git
+                 else
+                   say_status :repo, 'No supported VCS detected', :red
+                   raise_error UnsupportedVCSError, <<~_
+                     No supported VCS detected. Workroom requires either Jujutsu or Git to manage workspaces.
+                   _
+                 end
+      end
+
+      def vcs_label
+        jj? ? 'JJ workspace' : 'Git worktree'
+      end
+
+      def workroom_exists?
+        jj? ? jj_workspace_exists? : git_worktree_exists?
+      end
+
+      def jj_workspace_exists?
+        jj_workspaces.include?(name)
+      end
+
+      def git_worktree_exists?
+        git_worktrees.any? { |path| File.basename(path) == name }
+      end
+
+      def jj_workspaces
+        @jj_workspaces ||= begin
+          out = raw_jj_workspace_list.lines
+          out.map { |line| line.split(':').first.strip }.reject do |name|
+            IGNORED_JJ_WORKSPACE_NAMES.include?(name)
+          end.compact
+        end
+      end
+
+      def raw_jj_workspace_list
+        run 'jj workspace list --color never', capture: true
+      end
+
+      def git_worktrees
+        @git_worktrees ||= begin
+          arr = []
+          directory = ''
+          raw_git_worktree_list.split("\n").each do |w|
+            s = w.split
+            directory = s[1] if s[0] == 'worktree'
+            arr << directory if s[0] == 'HEAD' && Dir.pwd != directory
+          end
+          arr
+        end
+      end
+
+      def raw_git_worktree_list
+        run 'git worktree list --porcelain', capture: true
+      end
+
+      def validate_name!
+        return if /\A[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?\z/.match?(name)
+
+        say_status :create, name, :red
+        raise_error InvalidNameError, <<~_
+          Workroom name must be alphanumeric (dashes and underscores allowed), and must not start or end with a dash or underscore.
+        _
+      end
+
+      # Ensure the command is not being run from within an existing workroom by checking for the
+      # presence of the a `.Workroom`.
+      def check_not_in_workroom!
+        return if !Pathname.pwd.join('.Workroom').exist?
+
+        say_status :create, name, :red
+        raise_error InWorkroomError, <<~_
+          Looks like you are already in a workroom. Run this command from the root of your main development directory, not from within an existing workroom.
+        _
+      end
+
+      def create_workroom
+        if testing?
+          FileUtils.copy('./', workroom_path)
+          return
+        end
+
+        if jj?
+          run "jj workspace add #{workroom_path}"
+        else
+          run "git worktree add -b #{name} #{workroom_path}"
+        end
+      end
+
+      def delete_workroom
+        if testing?
+          FileUtils.rm_rf(workroom_path)
+          return
+        end
+
+        if jj?
+          run "jj workspace forget #{name}"
+        else
+          run "git worktree remove #{workroom_path} --force"
+        end
+      end
+
+      def cleanup_directory
+        return if !workroom_path.exist?
+
+        remove_dir(workroom_path, verbose:)
+      end
+
+      def run(command, config = {})
+        if !config[:force] && testing?
+          raise TestError, "Command execution blocked during testing: `#{command}`"
+        end
+
+        config[:verbose] = verbose
+        config[:capture] = !verbose if !config.key?(:capture)
+
+        super
+      end
+
+      def say_status(...)
+        super if verbose
+      end
+
+      def verbose
+        options[:verbose]
+      end
+
+      def testing?
+        ENV['WORKROOM_TEST'] == '1'
+      end
+  end
+end

data/lib/workroom/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Workroom
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/workroom/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Workroom
+  VERSION = '0.1.0'
+end

data/lib/workroom.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+require 'thor'
+
+module Workroom
+  class Error < Thor::Error; end
+  class TestError < Thor::Error; end
+  class InvalidNameError < Error; end
+  class InWorkroomError < Error; end
+  class DirExistsError < Error; end
+  class UnsupportedVCSError < Error; end
+  class JJWorkspaceExistsError < Error; end
+  class GitWorktreeExistsError < Error; end
+  class SetupError < Error; end
+  class TeardownError < Error; end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: workroom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Create and manage local development workrooms using JJ workspaces or
+  git worktrees
+email:
+- joel@developwithstyle.com
+executables:
+- workroom
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- bin/workroom
+- lib/workroom.rb
+- lib/workroom/commands.rb
+- lib/workroom/engine.rb
+- lib/workroom/version.rb
+homepage: https://github.com/joelmoss/workroom
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Manage development workrooms
+test_files: []