feat: add Worktree#status

jcouball · jcouball · commit d7a3232e6863 · 2025-03-26T17:14:10.000-07:00
diff --git a/.github/workflows/continuous_integration.yml b/.github/workflows/continuous_integration.yml
@@ -13,6 +13,10 @@ env:
   # SimpleCov suggests setting the JRuby --debug flag to ensure that coverage
   # results from JRuby are complete.
   JRUBY_OPTS: --debug
+  GIT_AUTHOR_NAME: Git Author
+  GIT_AUTHOR_EMAIL: git_author@example.com
+  GIT_COMMITTER_NAME: Git Committer
+  GIT_COMMITTER_EMAIL: git_committer@example.com
 
 # Supported platforms / Ruby versions:
 #  - Ubuntu: MRI (3.1, 3.2, 3.3, 3.4), TruffleRuby (24), JRuby (9.4)
diff --git a/.github/workflows/experimental_ruby_builds.yml b/.github/workflows/experimental_ruby_builds.yml
@@ -22,6 +22,13 @@ jobs:
     runs-on: ${{ matrix.operating-system }}
     continue-on-error: true
 
+    env:
+      FAIL_ON_LOW_COVERAGE: ${{ matrix.fail_on_low_coverage }}
+      GIT_AUTHOR_NAME: Git Author
+      GIT_AUTHOR_EMAIL: git_author@example.com
+      GIT_COMMITTER_NAME: Git Committer
+      GIT_COMMITTER_EMAIL: git_committer@example.com
+
     strategy:
       fail-fast: false
       matrix:
diff --git a/lib/ruby_git.rb b/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/repository'
 require_relative 'ruby_git/status'
 require_relative 'ruby_git/version'
 require_relative 'ruby_git/worktree'
diff --git a/lib/ruby_git/command_line/runner.rb b/lib/ruby_git/command_line/runner.rb
@@ -166,7 +166,7 @@ def call(*args, **options_hash)
         options_hash[:raise_errors] = false
         options = RubyGit::CommandLine::Options.new(logger: logger, **options_hash)
         begin
-          result = ProcessExecuter.run_with_options([env, *build_git_cmd(args)], options)
+          result = run_with_chdir([env, *build_git_cmd(args)], options)
         rescue ProcessExecuter::ProcessIOError => e
           raise RubyGit::ProcessIOError.new(e.message), cause: e.exception.cause
         end
@@ -175,6 +175,39 @@ def call(*args, **options_hash)
 
       private
 
+      # Run command with options with special handling for the `chdir` option on JRuby
+      #
+      # JRuby does not support the `chdir` option in `Process.spawn`. Note that this
+      # workaround means that this library is not thread-safe when using JRuby.
+      #
+      # @param args [Array<String>] the command to run
+      # @param options [RubyGit::CommandLine::Options] the options to pass to `Process.spawn`
+      #
+      # @return [ProcessExecuter::Result] the result of the command
+      #
+      # @api private
+      #
+      def run_with_chdir(args, options)
+        return ProcessExecuter.run_with_options(args, options) unless jruby? && options.chdir != :not_set
+
+        # :nocov: Not executed in MRI Ruby
+        Dir.chdir(options.chdir) do
+          saved_chdir = options.chdir
+          options.merge!(chdir: :not_set)
+          ProcessExecuter.run_with_options(args, options).tap do
+            options.merge!(chdir: saved_chdir)
+          end
+        end
+        # :nocov:
+      end
+
+      # Returns true if running on JRuby
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def jruby? = RUBY_ENGINE == 'jruby'
+
       # Build the git command line from the available sources to send to `Process.spawn`
       # @return [Array<String>]
       # @api private
diff --git a/lib/ruby_git/repository.rb b/lib/ruby_git/repository.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RubyGit
+  # The repository is the database of all the objects, refs, and other data that
+  # make up the history of a project.
+  #
+  # @api public
+  #
+  class Repository
+    # @attribute [r] path
+    #
+    # The absolute path to the repository
+    #
+    # @example
+    #  repository = RubyGit::Repository.new('.git')
+    #  repository.path = '/absolute/path/.git'
+    #
+    # @return [String]
+    #
+    attr_reader :path
+
+    # Create a new Repository object with the given repository path
+    #
+    # @example
+    #   RubyGit::Repository.new('/path/to/repository') #=> #<RubyGit::Repository ...>
+    #
+    # @param [String] repository_path the path to the repository
+    #
+    def initialize(repository_path)
+      @path = File.expand_path(repository_path)
+    end
+  end
+end
diff --git a/lib/ruby_git/worktree.rb b/lib/ruby_git/worktree.rb
@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'open3'
-
 module RubyGit
   # The working tree is a directory tree consisting of the checked out files that
   # you are currently working on.
@@ -106,9 +104,64 @@ def self.clone(repository_url, to_path: '')
       new(to_path)
     end
 
+    # Show the working tree and index status
+    #
+    # @example worktree = Worktree.open(worktree_path) worktree.status #=>
+    #   #<RubyGit::Status::Report ...>
+    #
+    # @param untracked_files [:all, :normal, :no] Defines how untracked files will be
+    # handled
+    #
+    #   See [git-staus
+    #   --untracked-files](https://git-scm.com/docs/git-status#Documentation/git-status.txt---untracked-filesltmodegt).
+    #
+    # @param ignored [:traditional, :matching, :no] Defines how ignored files will be
+    # handled, :no to not include ignored files
+    #
+    #   See [git-staus
+    #   --ignored](https://git-scm.com/docs/git-status#Documentation/git-status.txt---ignoredltmodegt).
+    #
+    # @param ignore_submodules [:all, :dirty, :untracked, :none] Default is :all
+    #
+    #   See [git-staus
+    #   --ignore-submodules](https://git-scm.com/docs/git-status#Documentation/git-status.txt---ignore-submodulesltwhengt).
+    #
+    # @return [RubyGit::Status::Report] the status of the working tree
+    #
+    def status(untracked_files: :all, ignored: :no, ignore_submodules: :all)
+      command = %w[status --porcelain=v2 --branch --show-stash --ahead-behind --renames -z]
+      command << "--untracked-files=#{untracked_files}"
+      command << "--ignored=#{ignored}"
+      command << "--ignore-submodules=#{ignore_submodules}"
+      options = { out: StringIO.new, err: StringIO.new }
+      status_output = run(*command, **options).stdout
+      RubyGit::Status.parse(status_output)
+    end
+
+    # Return the repository associated with the worktree
+    #
+    # @example
+    #   worktree = Worktree.open(worktree_path)
+    #   worktree.repository #=> #<RubyGit::Repository ...>
+    #
+    # @return [RubyGit::Repository] the repository associated with the worktree
+    #
+    def repository
+      @repository ||= begin
+        command = %w[rev-parse --git-dir]
+        options = { chdir: path, chomp: true, out: StringIO.new, err: StringIO.new }
+        # rev-parse path might be relative to the worktree, thus the need to expand it
+        git_dir = File.expand_path(RubyGit::CommandLine.run(*command, **options).stdout, path)
+        Repository.new(git_dir)
+      end
+    end
+
     private
 
     # Create a Worktree object
+    #
+    # @param worktree_path [String] a path anywhere in the worktree
+    #
     # @api private
     #
     def initialize(worktree_path)
@@ -132,25 +185,19 @@ def root_path(worktree_path)
       RubyGit::CommandLine.run(*command, **options).stdout
     end
 
-    # def run(*command, **options)
-    #   RubyGit::CommandLine.run(*command, worktree_path: path, **options)
-    # end
-
-    # #
-    # # @param untracked_files [Symbol] Can be :all, :normal, :no
-    # # @param ignore_submodules [Symbol] Can be :all, :dirty, :untracked, :none
-    # # @param ignored [Symbol] Can be :traditional, :matching, :no
-    # # @param renames [Boolean] Whether to detect renames
-    # def status(untracked_files:)
-    #   # -z for null-terminated output
-    #   # --porcelain for machine-readable output
-    #   git status --porcelain=v2 --untracked-files --branch --show-stash --ahead-behind --renames -z
-    #   command = ['status', '--porcelain', '--branch', '-z']
-    #   command << '--untracked-files=all' if untracked_files == :all
-    #   command << '--untracked-files=no' if untracked_files == :no
-    #   options = { chdir: path, out: StringIO.new, err: StringIO.new }
-    #   result = RubyGit::CommandLine.run(*command, **options)
-    #   result.stdout
-    # end
+    # Run a Git command in this worktree
+    #
+    # Passes the repository path and worktree path to RubyGit::CommandLine.run
+    #
+    # @param command [Array<String>] the git command to run
+    # @param options [Hash] options to pass to RubyGit::CommandLine.run
+    #
+    # @return [RubyGit::CommandLineResult] the result of the git command
+    #
+    # @api private
+    #
+    def run(*command, **options)
+      RubyGit::CommandLine.run(*command, repository_path: repository.path, worktree_path: path, **options)
+    end
   end
 end
diff --git a/spec/lib/ruby_git/repository_spec.rb b/spec/lib/ruby_git/repository_spec.rb
@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyGit::Repository do
+  let(:repository) { RubyGit::Repository.new(repository_path) }
+
+  describe '#initialize' do
+    subject { repository }
+
+    context 'when given a repository path' do
+      let(:repository_path) { File.expand_path('/path/to/repository') }
+
+      it 'should set the path to the given repository path' do
+        expect(subject).to have_attributes(path: repository_path)
+      end
+    end
+  end
+end
diff --git a/spec/lib/ruby_git/worktree_clone_spec.rb b/spec/lib/ruby_git/worktree_clone_spec.rb
diff --git a/spec/lib/ruby_git/worktree_init_spec.rb b/spec/lib/ruby_git/worktree_init_spec.rb
diff --git a/spec/lib/ruby_git/worktree_initialize_spec.rb b/spec/lib/ruby_git/worktree_initialize_spec.rb
diff --git a/spec/lib/ruby_git/worktree_open_spec.rb b/spec/lib/ruby_git/worktree_open_spec.rb
diff --git a/spec/lib/ruby_git/worktree_spec.rb b/spec/lib/ruby_git/worktree_spec.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyGit::Worktree do
+  describe '#repository' do
+    let(:worktree) { RubyGit::Worktree.open(worktree_path) }
+    let(:worktree_path) { @worktree_path }
+
+    around do |example|
+      in_temp_dir do |worktree_path|
+        @worktree_path = worktree_path
+        run %w[git init --initial-branch=main]
+        example.run
+      end
+    end
+
+    subject { worktree.repository }
+
+    it { is_expected.to be_a(RubyGit::Repository) }
+    it { is_expected.to have_attributes(path: File.expand_path('./.git')) }
+  end
+end
diff --git a/spec/lib/ruby_git/worktree_status_spec.rb b/spec/lib/ruby_git/worktree_status_spec.rb
@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+# @param untracked_files [:all, :normal, :no] Defines how untracked files will be
+# handled
+#
+#   See [git-staus
+#   --untracked-files](https://git-scm.com/docs/git-status#Documentation/git-status.txt---untracked-filesltmodegt).
+#
+# @param ignored [:traditional, :matching, :no] Defines how ignored files will be
+# handled, :no to not include ignored files
+#
+#   See [git-staus
+#   --ignored](https://git-scm.com/docs/git-status#Documentation/git-status.txt---ignoredltmodegt).
+#
+# @param ignore_submodules [:all, :dirty, :untracked, :none] Default is :all
+#
+#   See [git-staus
+#   --ignore-submodules](https://git-scm.com/docs/git-status#Documentation/git-status.txt---ignore-submodulesltwhengt).
+#
+
+RSpec.describe RubyGit::Worktree do
+  let(:worktree) { described_class.open(worktree_path) }
+  let(:worktree_path) { '.' }
+
+  describe '.status' do
+    subject { worktree.status(untracked_files:, ignored:, ignore_submodules:) }
+    let(:untracked_files) { :all }
+    let(:ignored) { :no }
+    let(:ignore_submodules) { :all }
+
+    context 'for a working tree with no commits and no changes' do
+      around do |example|
+        in_temp_dir do
+          run %w[git init --initial-branch=main]
+          example.run
+        end
+      end
+
+      it 'should report no changes' do
+        expect(subject).to have_attributes(entries: [])
+      end
+
+      it 'should report the branch name "main" and OID nil' do
+        expect(subject.branch).to have_attributes(name: 'main', oid: nil)
+      end
+    end
+
+    context 'for a working tree with no changes' do
+      around do |example|
+        in_temp_dir do
+          run %w[git init --initial-branch=main]
+          run %w[git commit --allow-empty -m commit_1]
+          example.run
+        end
+      end
+
+      it 'should report no changes' do
+        expect(subject).to have_attributes(entries: [])
+      end
+
+      it 'should report the branch name "main" and OID SHA' do
+        expect(subject.branch).to have_attributes(name: 'main', oid: a_string_matching(/^\h+$/))
+      end
+    end
+
+    context 'a working tree with two changes' do
+      around do |example|
+        in_temp_dir do
+          run %w[git init --initial-branch=main]
+          File.write('file_1', 'content_1')
+          File.write('file_2', 'content_2')
+          run %w[git add file_1 file_2]
+          run %w[git commit -m commit_1]
+          File.write('file_1', 'content_1_changed')
+          File.write('file_2', 'content_2_changed')
+          example.run
+        end
+      end
+
+      it 'should report the two changes' do
+        expect(subject.entries.map(&:path)).to contain_exactly('file_1', 'file_2')
+      end
+    end
+
+    context 'when run from a directory outside the working tree' do
+      let(:worktree_path) { @worktree_path }
+
+      around do |example|
+        in_temp_dir do
+          in_dir 'working_tree' do
+            @worktree_path = Dir.pwd
+
+            run %w[git init --initial-branch=main]
+            File.write('file_1', 'content_1')
+            File.write('file_2', 'content_2')
+            run %w[git add file_1 file_2]
+            run %w[git commit -m commit_1]
+            File.write('file_1', 'content_1_changed')
+            File.write('file_2', 'content_2_changed')
+
+            Dir.chdir('..') do
+              example.run
+            end
+          end
+        end
+      end
+
+      it 'should be successfully report the changes within the working tree' do
+        expect(subject.entries.map(&:path)).to contain_exactly('file_1', 'file_2')
+      end
+    end
+  end
+end
