Allow the use of an array of path_limiters and add extended_regexp option to grep (#624)

blanham · web-flow · commit 0f7c4a59b950 · 2023-02-23T16:25:00.000-08:00
* grep: multiple path_limiters and extended_regexp

Signed-off-by: Bryce Lanham &lt;blanham@gmail.com&gt;

* Document Base#grep parameters

Signed-off-by: James Couball &lt;jcouball@yahoo.com&gt;
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -209,6 +209,15 @@ def lib
     #     end
     #   end
     #
+    # @param string [String] the string to search for
+    # @param path_limiter [String, Array] a path or array of paths to limit the search to or nil for no limit
+    # @param opts [Hash] options to pass to the underlying `git grep` command
+    #
+    # @option opts [Boolean] :ignore_case (false) ignore case when matching
+    # @option opts [Boolean] :invert_match (false) select non-matching lines
+    # @option opts [Boolean] :extended_regexp (false) use extended regular expressions
+    # @option opts [String] :object (HEAD) the object to search from
+    #
     # @return [Hash<String, Array>] a hash of arrays
     #   ```Ruby
     #   {
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -413,10 +413,12 @@ def grep(string, opts = {})
       grep_opts = ['-n']
       grep_opts << '-i' if opts[:ignore_case]
       grep_opts << '-v' if opts[:invert_match]
+      grep_opts << '-E' if opts[:extended_regexp]
       grep_opts << '-e'
       grep_opts << string
       grep_opts << opts[:object] if opts[:object].is_a?(String)
-      grep_opts << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String
+      grep_opts.push('--', opts[:path_limiter]) if opts[:path_limiter].is_a?(String)
+      grep_opts.push('--', *opts[:path_limiter]) if opts[:path_limiter].is_a?(Array)
 
       hsh = {}
       command_lines('grep', *grep_opts).each do |line|
diff --git a/tests/units/test_lib.rb b/tests/units/test_lib.rb
@@ -291,6 +291,12 @@ def test_grep
     assert_equal("you can't search me!", match["gitsearch1:scott/newfile"].first[1])
     assert_equal(1, match.size)
 
+    match = @lib.grep('search', :object => 'gitsearch1', :path_limiter => ['scott/new*', 'scott/text.*'])
+    assert_equal("you can't search me!", match["gitsearch1:scott/newfile"].first[1])
+    assert_equal('to search one', match['gitsearch1:scott/text.txt'].assoc(6)[1])
+    assert_equal(2, match['gitsearch1:scott/text.txt'].size)
+    assert_equal(2, match.size)
+
     match = @lib.grep('SEARCH', :object => 'gitsearch1')
     assert_equal(0, match.size)
 
@@ -302,6 +308,11 @@ def test_grep
     assert_equal(6, match['gitsearch1:scott/text.txt'].size)
     assert_equal(2, match.size)
 
+    match = @lib.grep("you can't search me!|nothing!", :object => 'gitsearch1', :extended_regexp => true)
+    assert_equal("you can't search me!", match["gitsearch1:scott/newfile"].first[1])
+    assert_equal("nothing!", match["gitsearch1:scott/text.txt"].first[1])
+    assert_equal(2, match.size)
+
     match = @lib.grep('Grep', :object => 'grep_colon_numbers')
     assert_equal("Grep regex doesn't like this:4342: because it is bad", match['grep_colon_numbers:colon_numbers.txt'].first[1])
     assert_equal(1, match.size)
