ls-tree optional recursion into subtrees

bilbof · jcouball · commit 737c4bb16074 · 2024-08-23T17:18:36.000-07:00
diff --git a/README.md b/README.md
@@ -236,6 +236,9 @@ g.index.writable?
 g.repo
 g.dir
 
+# ls-tree with recursion into subtrees (list files)
+g.ls_tree("head", recursive: true)
+
 # log - returns a Git::Log object, which is an Enumerator of Git::Commit objects
 # default configuration returns a max of 30 commits
 g.log
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -642,8 +642,8 @@ def revparse(objectish)
       self.lib.revparse(objectish)
     end
 
-    def ls_tree(objectish)
-      self.lib.ls_tree(objectish)
+    def ls_tree(objectish, opts = {})
+      self.lib.ls_tree(objectish, opts)
     end
 
     def cat_file(objectish)
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -374,10 +374,15 @@ def object_contents(sha, &block)
       end
     end
 
-    def ls_tree(sha)
+    def ls_tree(sha, opts = {})
       data = { 'blob' => {}, 'tree' => {}, 'commit' => {} }
 
-      command_lines('ls-tree', sha).each do |line|
+      ls_tree_opts = []
+      ls_tree_opts << '-r' if opts[:recursive]
+      # path must be last arg
+      ls_tree_opts << opts[:path] if opts[:path]
+
+      command_lines('ls-tree', sha, *ls_tree_opts).each do |line|
         (info, filenm) = line.split("\t")
         (mode, type, sha) = info.split
         data[type][filenm] = {:mode => mode, :sha => sha}
diff --git a/tests/units/test_ls_tree.rb b/tests/units/test_ls_tree.rb
@@ -13,11 +13,26 @@ def test_ls_tree_with_submodules
       repo.add('README.md')
       repo.commit('Add README.md')
 
+      Dir.mkdir("repo/subdir")
+      File.write('repo/subdir/file.md', 'Content in subdir')
+      repo.add('subdir/file.md')
+      repo.commit('Add subdir/file.md')
+
+      # ls_tree
+      default_tree = assert_nothing_raised { repo.ls_tree('HEAD') }
+      assert_equal(default_tree.dig("blob").keys.sort, ["README.md"])
+      assert_equal(default_tree.dig("tree").keys.sort, ["subdir"])
+      # ls_tree with recursion into sub-trees
+      recursive_tree = assert_nothing_raised { repo.ls_tree('HEAD', recursive: true) }
+      assert_equal(recursive_tree.dig("blob").keys.sort, ["README.md", "subdir/file.md"])
+      assert_equal(recursive_tree.dig("tree").keys.sort, [])
+
       Dir.chdir('repo') do
         assert_child_process_success { `git -c protocol.file.allow=always submodule add ../submodule submodule 2>&1` }
         assert_child_process_success { `git commit -am "Add submodule" 2>&1` }
       end
 
+
       expected_submodule_sha = submodule.object('HEAD').sha
 
       # Make sure the ls_tree command can handle submodules (which show up as a commit object in the tree)
