feat: implement RubyGit::Worktree#status

Author: jcouball

.rubocop.yml

@@ -1,6 +1,16 @@
 inherit_gem:
   main_branch_shared_rubocop_config: config/rubocop.yml
 
+Metrics/MethodLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+
+Metrics/AbcSize:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+
 AllCops:
   # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
   # or later.

bin/console

@@ -12,4 +12,6 @@ require 'ruby_git'
 # Pry.start
 
 require 'irb'
+require_relative '../spec/spec_helper'
+
 IRB.start(__FILE__)

lib/ruby_git.rb

@@ -3,6 +3,7 @@
 require_relative 'ruby_git/command_line'
 require_relative 'ruby_git/encoding_normalizer'
 require_relative 'ruby_git/errors'
+require_relative 'ruby_git/status'
 require_relative 'ruby_git/version'
 require_relative 'ruby_git/worktree'
 

lib/ruby_git/encoding_normalizer.rb

@@ -3,7 +3,7 @@
 require 'rchardet'
 
 module RubyGit
-  # Utility to normalize string encoding to the {#normalized_encoding}
+  # Utility to normalize string encoding
   # @api public
   module EncodingNormalizer
     # Detects the character encoding used to create a string or binary data

lib/ruby_git/status.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'status/branch'
+require_relative 'status/entry'
+require_relative 'status/ignored_entry'
+require_relative 'status/ordinary_entry'
+require_relative 'status/parser'
+require_relative 'status/renamed_entry'
+require_relative 'status/report'
+require_relative 'status/stash'
+require_relative 'status/submodule_status'
+require_relative 'status/unmerged_entry'
+require_relative 'status/untracked_entry'
+
+module RubyGit
+  # The working tree status
+  module Status
+    # Parse output of `git status` and return a structured report
+    #
+    # @example
+    #   output = `git status -u --porcelain=v2 --renames --branch --show-stash -z`
+    #   status = RubyGit::Status.parse(output)
+    #   status.branch.name #=> 'main'
+    #
+    # @param status_output [String] the raw output from git status command
+    # @return [RubyGit::Status::Report] a structured representation of git status
+    #
+    # @api public
+    def self.parse(status_output)
+      Parser.parse(status_output)
+    end
+  end
+end

lib/ruby_git/status/branch.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RubyGit
+  module Status
+    # Represents git branch information
+    #
+    # @api public
+    class Branch
+      # @attribute [rw] name
+      #
+      # The name of the current branch
+      #
+      # @example
+      #   branch.name #=> 'main'
+      #
+      # @return [String, nil] branch name or nil if detached HEAD
+      #
+      # @api public
+      attr_accessor :name
+
+      # @attribute [rw] oid
+      #
+      # The object ID (hash) of the current commit
+      #
+      # @example
+      #   branch.oid #=> 'abcdef1234567890'
+      #
+      # @return [String] commit hash
+      #
+      # @api public
+      attr_accessor :oid
+
+      # @attribute [rw] upstream
+      #
+      # The name of the upstream branch
+      #
+      # @example
+      #   branch.upstream #=> 'origin/main'
+      #
+      # @return [String, nil] upstream branch name or nil if no upstream
+      #
+      # @api public
+      attr_accessor :upstream
+
+      # @attribute [rw] ahead
+      #
+      # Number of commits ahead of upstream
+      #
+      # @example
+      #   branch.ahead #=> 2
+      #
+      # @return [Integer] number of commits ahead
+      #
+      # @api public
+      attr_accessor :ahead
+
+      # @attribute [rw] behind
+      #
+      # Number of commits behind upstream
+      #
+      # @example
+      #   branch.behind #=> 3
+      #
+      # @return [Integer] number of commits behind
+      #
+      # @api public
+      attr_accessor :behind
+
+      # Check if the branch has an upstream configured
+      #
+      # @example
+      #   branch.upstream? #=> true
+      #
+      # @return [Boolean] true if upstream is configured
+      #
+      def upstream?
+        !@upstream.nil?
+      end
+
+      # Check if HEAD is detached
+      #
+      # @example
+      #   branch.detached? #=> true
+      #
+      # @return [Boolean] true if HEAD is detached
+      #
+      def detached?
+        @name.nil?
+      end
+    end
+  end
+end

lib/ruby_git/status/entry.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RubyGit
+  module Status
+    # Base class for git status entries
+    #
+    # @api public
+    class Entry
+      # Status code mapping to symbols
+      STATUS_CODES = {
+        '.': :unmodified,
+        M: :modified,
+        T: :type_changed,
+        A: :added,
+        D: :deleted,
+        R: :renamed,
+        C: :copied,
+        U: :updated_but_unmerged,
+        '?': :untracked,
+        '!': :ignored
+      }.freeze
+
+      # Rename operation mapping to symbols
+      RENAME_OPERATIONS = {
+        'R' => :rename
+        # git status doesn't actually try to detect copies
+        # 'C' => :copy
+      }.freeze
+
+      # @attribute [r] path
+      #
+      # The path of the file
+      #
+      # @example
+      #   entry.path #=> 'lib/example.rb'
+      #
+      # @return [String] file path
+      #
+      attr_reader :path
+
+      # Initialize a new entry
+      #
+      # @example
+      #   Entry.new('lib/example.rb')
+      #
+      # @param path [String] file path
+      #
+      def initialize(path)
+        @path = path
+      end
+
+      # Convert a status code to a symbol
+      #
+      # @example
+      #   Entry.status_to_symbol('M') #=> :modified
+      #
+      # @param code [String] status code
+      # @return [Symbol] status as symbol
+      #
+      def self.status_to_symbol(code)
+        STATUS_CODES[code.to_sym] || :unknown
+      end
+
+      # Convert a rename operation to a symbol
+      #
+      # @example
+      #   Entry.rename_operation_to_symbol('R') #=> :rename
+      #
+      # @param code [String] the operation code
+      # @return [Symbol] operation as symbol
+      #
+      def self.rename_operation_to_symbol(code)
+        RENAME_OPERATIONS[code] || :unknown
+      end
+
+      # Get the staging status
+      #
+      # @example
+      #   entry.staging_status #=> :modified
+      #
+      # @return [Symbol, nil] staging status symbol or nil if not applicable
+      #
+      def index_status = nil
+
+      # Get the worktree status
+      #
+      # @example
+      #   entry.worktree_status #=> :unchanged
+      #
+      # @return [Symbol, nil] worktree status symbol or nil if not applicable
+      #
+      def worktree_status = nil
+    end
+  end
+end

lib/ruby_git/status/ignored_entry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'entry'
+
+module RubyGit
+  module Status
+    # Represents an ignored file in git status
+    #
+    # @api public
+    class IgnoredEntry < Entry
+      # Parse a git status line to create an ignored entry
+      #
+      # @example
+      #   IgnoredEntry.parse('!! lib/example.rb') #=> #<RubyGit::Status::IgnoredEntry:0x00000001046bd488 ...>
+      #
+      # @param line [String] line from git status
+      # @return [RubyGit::Status::IgnoredEntry] parsed entry
+      #
+      def self.parse(line)
+        tokens = line.split(' ', 2)
+        new(path: tokens[1])
+      end
+
+      # Initialize with the path
+      #
+      # @example
+      #   IgnoredEntry.new(path: 'lib/example.rb')
+      #
+      # @param path [String] file path
+      #
+      def initialize(path:)
+        super(path)
+      end
+    end
+  end
+end