sxn 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9758f35bc9f122c019b15dd8a46f712cda58eb86495c6e5bb8c63791b10525e
-  data.tar.gz: 628449e55edf8b33ade3f83cdfab4369234bd22e26e5625cc3890b3c46a74702
+  metadata.gz: 6c2adba72c82bfd3b3b92c29bf497cc0c486b16261edc38c103135a7391525a4
+  data.tar.gz: fa079e0580d51496bf4d5f4af242b291847854a1d6dd6f17918730b463bb2c9d
 SHA512:
-  metadata.gz: 7970fbb77d1b7b21da3b93d566bb54a42219c787ca081b2319ec6c3dcf7b31dee35761339da42322ac2acf393232fa458325e3573dfebec546caa2e14f9da0eb
-  data.tar.gz: bd4f880ea4b2aa55b1a0de1d87d6e6bcc41a787218d29c104c644c87d07d2c43048b77217ba6ceae3f3df66a2da63c531a6b7f6cc96781d1454f0a2622232d1a
+  metadata.gz: d8a67b4261fb520b7b64c3c039dcabd5f47f1ae6ca377d1fa4d0a6d0dd9ac2574a83cc0024923273a754527c9e0cba96c75e0923918d1fd997ba62f8f1dd6ae7
+  data.tar.gz: 79218840d95ce17d7a62d40e2f4cfca09498973b784677175ec1cbf67a9ed801074fad18a716dba2a16f89c7499a030b53e3c9c5fbf1b5f412b7cbd0530cd628

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.3] - 2025-09-16
+
+### Added
+- Smart branch defaults: worktrees now use session name as default branch
+- Remote branch tracking with `remote:` prefix syntax (e.g., `sxn worktree add project remote:origin/feature`)
+- Automatic orphaned worktree recovery and cleanup
+- Enhanced error messages with actionable suggestions
+
+### Changed
+- Improved worktree creation logic to handle existing/orphaned states
+- Better error handling for remote branch operations
+- Updated CLI documentation with new branch options
+
+### Fixed
+- Orphaned worktree cleanup now works for both existing and missing directories
+- Worktree creation properly handles branch conflicts
+- Test suite compatibility with new worktree features
+
 ## [0.2.1] - 2025-01-20
 
 ### Fixed
@@ -53,5 +71,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial placeholder release
 - Basic gem structure
 
+[0.2.3]: https://github.com/idl3/sxn/compare/v0.2.1...v0.2.3
+[0.2.1]: https://github.com/idl3/sxn/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/idl3/sxn/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/idl3/sxn/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sxn (0.2.2)
+    sxn (0.2.3)
       async (~> 2.0)
       bcrypt (~> 3.1)
       dry-configurable (~> 1.0)

data/README.md

@@ -1,10 +1,10 @@
-# Sxn
+# sxn
 
 [![CI](https://github.com/idl3/sxn/actions/workflows/ci.yml/badge.svg)](https://github.com/idl3/sxn/actions/workflows/ci.yml)
 [![Ruby Version](https://img.shields.io/badge/ruby-3.2%2B-red)](https://www.ruby-lang.org)
 [![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE.txt)
 
-Sxn is a powerful session management tool for multi-repository development. It helps developers manage complex development environments with multiple git repositories, providing isolated workspaces, automatic project setup, and intelligent session management.
+sxn is a powerful session management tool for multi-repository development. It helps developers manage complex development environments with multiple git repositories, providing isolated workspaces, automatic project setup, and intelligent session management.
 
 ## Features
 
@@ -38,7 +38,7 @@ gem install sxn
 
 ## Quick Start
 
-### Initialize Sxn in your workspace
+### Initialize sxn in your workspace
 
 ```bash
 sxn init
@@ -135,7 +135,7 @@ sxn rules apply my-app
 
 ## Configuration
 
-Sxn stores its configuration in `.sxn/config.yml` in your workspace:
+sxn stores its configuration in `.sxn/config.yml` in your workspace:
 
 ```yaml
 sessions_folder: .sxn-sessions
@@ -168,7 +168,7 @@ rules:
 
 ## Templates
 
-Sxn includes templates for common project types:
+sxn includes templates for common project types:
 
 - **Rails**: CLAUDE.md, database.yml, session-info.md
 - **JavaScript**: README.md, session-info.md
@@ -178,19 +178,87 @@ Templates use Liquid syntax and have access to session, project, and environment
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+### Setup
 
-### Running Tests
+After cloning the repository, run:
+
+```bash
+bundle install
+./script/setup-hooks  # Set up git hooks for automated checks
+```
+
+### Testing and Code Quality
+
+**Important**: All code must pass tests and linting before being pushed to the repository.
+
+#### Running Tests
 
 ```bash
 # Run all tests
 bundle exec rspec
 
+# Run tests in parallel (faster)
+bundle exec rake parallel:spec
+
+# Run with coverage report
+bundle exec rake parallel:spec_with_coverage
+```
+
+#### Code Style
+
+```bash
+# Check code style
+bundle exec rubocop
+
+# Auto-fix code style issues
+bundle exec rubocop -a
+```
+
+#### Git Hooks
+
+The project includes a pre-push hook that automatically runs RuboCop and RSpec before allowing pushes. To set it up:
+
+```bash
+./script/setup-hooks
+```
+
+To bypass hooks in emergency situations (not recommended):
+```bash
+git push --no-verify
+```
+
+### Development Workflow
+
+1. Make your changes
+2. Run `bundle exec rubocop -a` to fix any style issues
+3. Run `bundle exec rspec` to ensure tests pass
+4. Commit your changes
+5. Push (pre-push hooks will run automatically)
+
+### Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Ensure tests pass and code style is correct
+5. Commit your changes with meaningful commit messages
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+### Additional Testing Options
+
+```bash
+# Run all tests in parallel (recommended for speed)
+bundle exec parallel_rspec spec/
+
+# Run all tests sequentially
+bundle exec rspec
+
 # Run only unit tests
 bundle exec rspec spec/unit
 
 # Run with coverage
-ENABLE_SIMPLECOV=true bundle exec rspec
+ENABLE_SIMPLECOV=true bundle exec parallel_rspec spec/
 ```
 
 ### Type Checking

data/lib/sxn/commands/worktrees.rb

@@ -19,7 +19,25 @@ module Sxn
         @worktree_manager = Sxn::Core::WorktreeManager.new(@config_manager, @session_manager)
       end
 
-      desc "add PROJECT [BRANCH]", "Add worktree to current session"
+      desc "add PROJECT [BRANCH]", "Add worktree to current session (defaults branch to session name)"
+      long_desc <<-DESC
+        Add a worktree for a project to the current session.
+
+        Branch options:
+        - No branch specified: Uses the session name as the branch name
+        - Branch name: Creates or checks out the specified branch
+        - remote:<branch>: Fetches and tracks the remote branch
+
+        Examples:
+        - sxn worktree add atlas-core
+          Creates worktree with branch name matching current session
+
+        - sxn worktree add atlas-core feature-branch
+          Creates worktree with specified branch name
+
+        - sxn worktree add atlas-core remote:origin/main
+          Fetches and tracks the remote branch
+      DESC
       option :session, type: :string, aliases: "-s", desc: "Target session (defaults to current)"
       option :apply_rules, type: :boolean, default: true, desc: "Apply project rules after creation"
       option :interactive, type: :boolean, aliases: "-i", desc: "Interactive mode"
@@ -33,10 +51,11 @@ module Sxn
           return if project_name.nil?
         end
 
-        # Interactive branch selection if not provided
+        # Interactive branch selection if not provided and interactive mode
+        # Note: If branch is nil, WorktreeManager will use session name as default
         if options[:interactive] && branch.nil?
-          project = @project_manager.get_project(project_name)
-          branch = @prompt.branch_name("Enter branch name:", default: project[:default_branch])
+          session_name = options[:session] || @config_manager.current_session
+          branch = @prompt.branch_name("Enter branch name:", default: session_name)
         end
 
         session_name = options[:session] || @config_manager.current_session

data/lib/sxn/core/config_manager.rb

@@ -3,6 +3,7 @@
 require "fileutils"
 require "yaml"
 require "pathname"
+require "ostruct"
 
 module Sxn
   module Core
@@ -40,7 +41,10 @@ module Sxn
         raise Sxn::ConfigurationError, "Project not initialized. Run 'sxn init' first." unless initialized?
 
         discovery = Sxn::Config::ConfigDiscovery.new(@base_path)
-        discovery.discover_config
+        config_hash = discovery.discover_config
+
+        # Convert nested hashes to OpenStruct recursively
+        config_to_struct(config_hash)
       end
 
       def update_current_session(session_name)
@@ -194,6 +198,14 @@ module Sxn
 
       private
 
+      def config_to_struct(obj)
+        return obj unless obj.is_a?(Hash)
+
+        OpenStruct.new(
+          obj.transform_values { |v| config_to_struct(v) }
+        )
+      end
+
       def sessions_folder_relative_path
         return ".sxn" unless @sessions_folder
 

data/lib/sxn/core/worktree_manager.rb

@@ -25,8 +25,30 @@ module Sxn
         project = @project_manager.get_project(project_name)
         raise Sxn::ProjectNotFoundError, "Project '#{project_name}' not found" unless project
 
-        # Use default branch if not specified
-        branch ||= project[:default_branch] || "master"
+        # Determine branch name
+        # If no branch specified, use session name as the branch name
+        # If branch starts with "remote:", handle remote branch tracking
+        if branch.nil?
+          branch = session_name
+        elsif branch.start_with?("remote:")
+          remote_branch = branch.sub("remote:", "")
+          # Fetch the remote branch first
+          begin
+            fetch_remote_branch(project[:path], remote_branch)
+            branch = remote_branch
+          rescue StandardError => e
+            raise Sxn::WorktreeCreationError, "Failed to fetch remote branch: #{e.message}"
+          end
+        end
+
+        if ENV["SXN_DEBUG"]
+          puts "[DEBUG] Adding worktree:"
+          puts "  Project: #{project_name}"
+          puts "  Project path: #{project[:path]}"
+          puts "  Session: #{session_name}"
+          puts "  Session path: #{session[:path]}"
+          puts "  Branch: #{branch}"
+        end
 
         # Check if worktree already exists in this session
         existing_worktrees = @session_manager.get_session_worktrees(session_name)
@@ -38,7 +60,12 @@ module Sxn
         # Create worktree path
         worktree_path = File.join(session[:path], project_name)
 
+        puts "  Worktree path: #{worktree_path}" if ENV["SXN_DEBUG"]
+
         begin
+          # Handle orphaned worktree if it exists
+          handle_orphaned_worktree(project[:path], worktree_path)
+
           # Create the worktree
           create_git_worktree(project[:path], worktree_path, branch)
 
@@ -169,6 +196,47 @@ module Sxn
 
       private
 
+      def handle_orphaned_worktree(project_path, worktree_path)
+        Dir.chdir(project_path) do
+          # Try to prune worktrees first
+          system("git worktree prune", out: File::NULL, err: File::NULL)
+
+          # Check if this worktree is registered (whether it exists or not)
+          output = `git worktree list --porcelain 2>/dev/null`
+          if output.include?(worktree_path)
+            # Force remove the orphaned/existing worktree
+            system("git worktree remove --force #{Shellwords.escape(worktree_path)}", out: File::NULL, err: File::NULL)
+          end
+        end
+
+        # Remove the directory if it still exists
+        FileUtils.rm_rf(worktree_path)
+      end
+
+      def fetch_remote_branch(project_path, branch_name)
+        Dir.chdir(project_path) do
+          # First, fetch all remotes to ensure we have the latest branches
+          raise "Failed to fetch remote branches" unless system("git fetch --all", out: File::NULL, err: File::NULL)
+
+          # Check if the branch exists on any remote
+          remotes = `git remote`.lines.map(&:strip)
+          branch_found = false
+
+          remotes.each do |remote|
+            next unless system("git show-ref --verify --quiet refs/remotes/#{remote}/#{Shellwords.escape(branch_name)}",
+                               out: File::NULL, err: File::NULL)
+
+            branch_found = true
+            # Set up tracking for the remote branch
+            system("git branch --track #{Shellwords.escape(branch_name)} #{remote}/#{Shellwords.escape(branch_name)}",
+                   out: File::NULL, err: File::NULL)
+            break
+          end
+
+          raise "Remote branch '#{branch_name}' not found on any remote" unless branch_found
+        end
+      end
+
       def create_git_worktree(project_path, worktree_path, branch)
         Dir.chdir(project_path) do
           # Check if branch exists
@@ -183,8 +251,39 @@ module Sxn
                   ["git", "worktree", "add", "-b", branch, worktree_path]
                 end
 
-          success = system(*cmd, out: File::NULL, err: File::NULL)
-          raise "Git worktree command failed" unless success
+          # Capture stderr for better error messages
+          require "open3"
+          stdout, stderr, status = Open3.capture3(*cmd)
+
+          unless status.success?
+            error_msg = stderr.empty? ? stdout : stderr
+            error_msg = "Git worktree command failed" if error_msg.strip.empty?
+
+            # Add more context to common errors
+            if error_msg.include?("already exists")
+              error_msg += "\nTry removing the existing worktree first with: sxn worktree remove #{File.basename(worktree_path)}"
+            elsif error_msg.include?("is already checked out")
+              error_msg += "\nThis branch is already checked out in another worktree"
+            elsif error_msg.include?("not a git repository")
+              error_msg = "Project '#{File.basename(project_path)}' is not a git repository"
+            elsif error_msg.include?("fatal: invalid reference")
+              # This typically means the branch doesn't exist and we're trying to create from a non-existent base
+              error_msg += "\nMake sure the repository has at least one commit or specify an existing branch"
+            elsif error_msg.include?("fatal:")
+              # Extract just the fatal error message for cleaner output
+              error_msg = error_msg.lines.grep(/fatal:/).first&.strip || error_msg
+            end
+
+            if ENV["SXN_DEBUG"]
+              puts "[DEBUG] Git worktree command failed:"
+              puts "  Command: #{cmd.join(" ")}"
+              puts "  Directory: #{project_path}"
+              puts "  STDOUT: #{stdout}"
+              puts "  STDERR: #{stderr}"
+            end
+
+            raise error_msg
+          end
         end
       end
 

data/lib/sxn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sxn
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/script/setup-hooks

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+#
+# Setup git hooks for sxn development
+#
+
+set -e
+
+echo "🔧 Setting up git hooks for sxn development..."
+
+# Create hooks directory if it doesn't exist
+mkdir -p .git/hooks
+
+# Create pre-push hook
+cat > .git/hooks/pre-push << 'EOF'
+#!/bin/sh
+#
+# Pre-push hook for sxn project
+# Runs RuboCop and RSpec before allowing push
+#
+
+echo "🔍 Running pre-push checks..."
+
+# Run RuboCop
+echo "📝 Checking code style with RuboCop..."
+bundle exec rubocop
+if [ $? -ne 0 ]; then
+    echo "❌ RuboCop failed! Please fix linting issues before pushing."
+    echo "   Run: bundle exec rubocop -a"
+    exit 1
+fi
+
+# Run RSpec tests
+echo "🧪 Running tests with RSpec..."
+bundle exec rspec --format progress
+if [ $? -ne 0 ]; then
+    echo "❌ Tests failed! Please fix failing tests before pushing."
+    exit 1
+fi
+
+echo "✅ All checks passed! Proceeding with push..."
+exit 0
+EOF
+
+chmod +x .git/hooks/pre-push
+
+echo "✅ Git hooks installed successfully!"
+echo ""
+echo "The following hooks have been set up:"
+echo "  • pre-push: Runs RuboCop and RSpec before pushing"
+echo ""
+echo "To bypass hooks in emergency (not recommended):"
+echo "  git push --no-verify"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sxn
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ernest Sim
@@ -558,6 +558,7 @@ files:
 - lib/sxn/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
+- script/setup-hooks
 - scripts/test.sh
 - sig/external/liquid.rbs
 - sig/external/thor.rbs