Support the commit --no-gpg-sign flag (#589)

bradleybuda · web-flow · commit e58cd2997670 · 2022-08-18T10:25:17.000-07:00
Support the commit --no-gpg-sign flag 
Signed-off-by: Bradley Buda &lt;bradleybuda@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -244,6 +244,9 @@ g.commit('message', gpg_sign: true)
 key_id = '0A46826A'
 g.commit('message', gpg_sign: key_id)
 
+# Skip signing a commit (overriding any global gpgsign setting)
+g.commit('message', no_gpg_sign: true)
+
 g = Git.clone(repo, 'myrepo')
 g.chdir do
 new_file('test-file', 'blahblahblah')
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -647,7 +647,8 @@ def remove(path = '.', opts = {})
     #  :date
     #  :no_verify
     #  :allow_empty_message
-    #  :gpg_sign
+    #  :gpg_sign (accepts true or a gpg key ID as a String)
+    #  :no_gpg_sign (conflicts with :gpg_sign)
     #
     # @param [String] message the commit message to be used
     # @param [Hash] opts the commit options to be used
@@ -661,13 +662,18 @@ def commit(message, opts = {})
       arr_opts << "--date=#{opts[:date]}" if opts[:date].is_a? String
       arr_opts << '--no-verify' if opts[:no_verify]
       arr_opts << '--allow-empty-message' if opts[:allow_empty_message]
-      if opts[:gpg_sign]
+
+      if opts[:gpg_sign] && opts[:no_gpg_sign]
+        raise ArgumentError, 'cannot specify :gpg_sign and :no_gpg_sign'
+      elsif opts[:gpg_sign]
         arr_opts <<
           if opts[:gpg_sign] == true
             '--gpg-sign'
           else
             "--gpg-sign=#{opts[:gpg_sign]}"
           end
+      elsif opts[:no_gpg_sign]
+        arr_opts << '--no-gpg-sign'
       end
 
       command('commit', arr_opts)
diff --git a/tests/units/test_commit_with_gpg.rb b/tests/units/test_commit_with_gpg.rb
@@ -34,4 +34,29 @@ def test_with_specific_gpg_keyid
       assert_match(/commit.*--gpg-sign=keykeykey['"]/, actual_cmd)
     end
   end
+
+  def test_disabling_gpg_sign
+    Dir.mktmpdir do |dir|
+      git = Git.init(dir)
+      actual_cmd = nil
+      git.lib.define_singleton_method(:run_command) do |git_cmd, &block|
+        actual_cmd = git_cmd
+        `true`
+      end
+      message = 'My commit message'
+      git.commit(message, no_gpg_sign: true)
+      assert_match(/commit.*--no-gpg-sign['"]/, actual_cmd)
+    end
+  end
+
+  def test_conflicting_gpg_sign_options
+    Dir.mktmpdir do |dir|
+      git = Git.init(dir)
+      message = 'My commit message'
+
+      assert_raises ArgumentError do
+        git.commit(message, gpg_sign: true, no_gpg_sign: true)
+      end
+    end
+  end
 end
