Add Git::Lib#compare_version_to(other_version)

jcouball · jcouball · commit e46ddcc711c4 · 2023-09-17T15:32:18.000-07:00
Signed-off-by: James Couball &lt;jcouball@yahoo.com&gt;
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -1108,6 +1108,22 @@ def current_command_version
       version_parts.fill(0, version_parts.length...3)
     end
 
+    # Returns current_command_version <=> other_version
+    #
+    # @example
+    #   lib.current_command_version #=> [2, 42, 0]
+    #
+    #   lib.compare_version_to(2, 41, 0) #=> 1 
+    #   lib.compare_version_to(2, 42, 0) #=> 0
+    #   lib.compare_version_to(2, 43, 0) #=> -1
+    #
+    # @param other_version [Array<Object>] the other version to compare to
+    # @return [Integer] -1 if this version is less than other_version, 0 if equal, or 1 if greater than
+    #
+    def compare_version_to(*other_version)
+      current_command_version <=> other_version
+    end
+
     def required_command_version
       [1, 6]
     end
diff --git a/tests/units/test_lib.rb b/tests/units/test_lib.rb
@@ -325,4 +325,15 @@ def test_show
     assert(@lib.show('gitsearch1', 'scott/text.txt') == "hello\nthis is\na file\nthat is\nput here\nto search one\nto search two\nnothing!\n")
   end
 
+  def test_compare_version_to
+    lib = Git::Lib.new(nil, nil)
+    current_version = [2, 42, 0]
+    lib.define_singleton_method(:current_command_version) { current_version }
+    assert lib.compare_version_to(0, 43, 9) == 1
+    assert lib.compare_version_to(2, 41, 0) == 1
+    assert lib.compare_version_to(2, 42, 0) == 0
+    assert lib.compare_version_to(2, 42, 1) == -1
+    assert lib.compare_version_to(2, 43, 0) == -1
+    assert lib.compare_version_to(3, 0, 0) == -1
+  end
 end
