Add worktree listing

ofir-petrushka · ofir-petrushka · commit e0fb3f6679ad · 2020-07-31T21:15:33.000+10:00
Signed-off-by: Ofir Petrushka &lt;hatkyinc@gmail.com&gt;
diff --git a/lib/git.rb b/lib/git.rb
@@ -21,6 +21,8 @@
 require 'git/stashes'
 require 'git/version'
 require 'git/working_directory'
+require 'git/worktree'
+require 'git/worktrees'
 
 lib = Git::Lib.new(nil, nil)
 unless lib.meets_required_version?
diff --git a/lib/git/base/factory.rb b/lib/git/base/factory.rb
@@ -15,6 +15,12 @@ def branches
         Git::Branches.new(self)
       end
       
+      # returns a Git::worktrees object of all the Git::Worktrees
+      # objects for this repo
+      def worktrees
+        Git::Worktrees.new(self)
+      end
+
       def commit_tree(tree = nil, opts = {})
         Git::Object::Commit.new(self, self.lib.commit_tree(tree, opts))
       end
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -308,6 +308,26 @@ def branches_all
       arr
     end
 
+    def worktrees_all
+      arr = []
+      directory = ''
+      # Output example for `worktree list --porcelain`:
+      # worktree /code/public/ruby-git
+      # HEAD 4bef5abbba073c77b4d0ccc1ffcd0ed7d48be5d4
+      # branch refs/heads/master
+      # 
+      # worktree /tmp/worktree-1
+      # HEAD b8c63206f8d10f57892060375a86ae911fad356e
+      # detached
+      #
+      command_lines('worktree',['list', '--porcelain']).each do |w|
+        s = w.split("\s")
+        directory = s[1] if s[0] == 'worktree'
+        arr << [directory, s[1]] if s[0] == 'HEAD'
+      end
+      arr
+    end
+
     def list_files(ref_dir)
       dir = File.join(@git_dir, 'refs', ref_dir)
       files = []
diff --git a/lib/git/worktree.rb b/lib/git/worktree.rb
@@ -0,0 +1,29 @@
+require 'git/path'
+
+module Git
+
+  class Worktree < Path
+    
+    attr_accessor :full, :dir, :gcommit
+    
+    def initialize(base, dir, gcommit)
+      @full = dir + ' ' + gcommit
+      @base = base
+      @dir = dir
+      @gcommit = gcommit
+    end
+
+    def gcommit
+      @gcommit ||= @base.gcommit(@full)
+      @gcommit
+    end
+
+    def to_a
+      [@full]
+    end
+    
+    def to_s
+      @full
+    end
+  end
+end
diff --git a/lib/git/worktrees.rb b/lib/git/worktrees.rb
@@ -0,0 +1,44 @@
+module Git
+  # object that holds all the available worktrees
+  class Worktrees
+
+    include Enumerable
+    
+    def initialize(base)
+      @worktrees = {}
+      
+      @base = base
+      
+      # Array contains [dir, git_hash]
+      @base.lib.worktrees_all.each do |w|
+        @worktrees[w[0]] = Git::Worktree.new(@base, w[0], w[1])
+      end
+    end
+
+    # array like methods
+
+    def size
+      @worktrees.size
+    end    
+    
+    def each(&block)
+      @worktrees.values.each(&block)
+    end
+
+    def [](worktree_name)
+      @worktrees.values.inject(@worktrees) do |worktrees, worktree|
+        worktrees[worktree.full] ||= worktree
+        worktrees
+      end[worktree_name.to_s]
+    end
+    
+    def to_s
+      out = ''
+      @worktrees.each do |k, b|
+        out << b.to_s << "\n"
+      end
+      out
+    end
+  end
+end
+  
diff --git a/tests/files/working/dot_git/index b/tests/files/working/dot_git/index
diff --git a/tests/files/working/dot_git/logs/refs/heads/aaa b/tests/files/working/dot_git/logs/refs/heads/aaa
@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 5e53019b3238362144c2766f02a2c00d91fcc023 Scott Chacon <schacon@gmail.com> 1596189348 +1000	branch: Created from HEAD
diff --git a/tests/files/working/dot_git/refs/heads/aaa b/tests/files/working/dot_git/refs/heads/aaa
@@ -0,0 +1 @@
+5e53019b3238362144c2766f02a2c00d91fcc023
diff --git a/tests/files/working/dot_git/worktrees/aaa/HEAD b/tests/files/working/dot_git/worktrees/aaa/HEAD
@@ -0,0 +1 @@
+935badc874edd62a8629aaf103418092c73f0a56
diff --git a/tests/files/working/dot_git/worktrees/aaa/ORIG_HEAD b/tests/files/working/dot_git/worktrees/aaa/ORIG_HEAD
@@ -0,0 +1 @@
+5e53019b3238362144c2766f02a2c00d91fcc023
diff --git a/tests/files/working/dot_git/worktrees/aaa/commondir b/tests/files/working/dot_git/worktrees/aaa/commondir
@@ -0,0 +1 @@
+../..
diff --git a/tests/files/working/dot_git/worktrees/aaa/gitdir b/tests/files/working/dot_git/worktrees/aaa/gitdir
@@ -0,0 +1 @@
+/tmp/aaa/.git
diff --git a/tests/files/working/dot_git/worktrees/aaa/index b/tests/files/working/dot_git/worktrees/aaa/index
diff --git a/tests/files/working/dot_git/worktrees/aaa/logs/HEAD b/tests/files/working/dot_git/worktrees/aaa/logs/HEAD
@@ -0,0 +1,2 @@
+5e53019b3238362144c2766f02a2c00d91fcc023 5e53019b3238362144c2766f02a2c00d91fcc023 Scott Chacon <schacon@gmail.com> 1596189348 +1000	reset: moving to HEAD
+5e53019b3238362144c2766f02a2c00d91fcc023 935badc874edd62a8629aaf103418092c73f0a56 Scott Chacon <schacon@gmail.com> 1596189368 +1000	checkout: moving from aaa to 935badc874edd62a8629aaf103418092c73f0a56
diff --git a/tests/units/test_logger.rb b/tests/units/test_logger.rb
@@ -20,7 +20,7 @@ def test_logger
     
     logc = File.read(log.path)
     assert(/INFO -- : git '--git-dir=[^']+' '--work-tree=[^']+' '-c' 'color.ui=false' branch '-a'/.match(logc))
-    assert(/DEBUG -- :   diff_over_patches/.match(logc))
+    assert(/DEBUG -- :   aaa\n  diff_over_patches/.match(logc))
 
     log = Tempfile.new('logfile')
     log.close
@@ -32,7 +32,7 @@ def test_logger
     
     logc = File.read(log.path)
     assert(/INFO -- : git '--git-dir=[^']+' '--work-tree=[^']+' '-c' 'color.ui=false' branch '-a'/.match(logc))
-    assert(!/DEBUG -- :   diff_over_patches/.match(logc))
+    assert(!/DEBUG -- :   aaa\n  diff_over_patches/.match(logc))
   end
   
 end
diff --git a/tests/units/test_worktree.rb b/tests/units/test_worktree.rb
@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../test_helper'
+
+SAMPLE_LAST_COMMIT = '5e53019b3238362144c2766f02a2c00d91fcc023'
+
+class TestWorktree < Test::Unit::TestCase
+  def setup
+    set_file_paths
+    @git = Git.open(@wdir)
+    
+    @commit = @git.object('1cc8667014381')
+    @tree = @git.object('1cc8667014381^{tree}')
+    @blob = @git.object('v2.5:example.txt')
+    
+    @worktrees = @git.worktrees
+  end
+  
+  def test_worktrees_all
+    assert(@git.worktrees.is_a?(Git::Worktrees))
+    assert(@git.worktrees.first.is_a?(Git::Worktree))
+    assert_equal(@git.worktrees.size, 2)
+  end
+  
+  def test_worktrees_single
+    worktree = @git.worktrees.first
+    assert_equal(worktree.dir, @git.dir.to_s)
+    assert_equal(worktree.gcommit, SAMPLE_LAST_COMMIT)
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+0000000000000000000000000000000000000000 5e53019b3238362144c2766f02a2c00d91fcc023 Scott Chacon <schacon@gmail.com> 1596189348 +1000 branch: Created from HEAD`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+5e53019b3238362144c2766f02a2c00d91fcc023`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+935badc874edd62a8629aaf103418092c73f0a56`