fix: fix Rubocop Metrics/ParameterLists offense

jcouball · jcouball · commit c7946b089aba · 2025-07-03T16:10:33.000-07:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -6,31 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 68
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 109
-
-# Offense count: 21
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 898
-
-# Offense count: 14
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 21
-
-# Offense count: 111
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 51
-
-# Offense count: 2
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
-Metrics/ParameterLists:
-  Max: 8
-
 # Offense count: 12
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
@@ -115,3 +90,23 @@ Style/OptionalBooleanParameter:
 # URISchemes: http, https
 Layout/LineLength:
   Max: 346
+
+# Offense count: 68
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 109
+
+# Offense count: 21
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 925
+
+# Offense count: 14
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 21
+
+# Offense count: 111
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 51
diff --git a/lib/git/command_line.rb b/lib/git/command_line.rb
@@ -97,6 +97,10 @@ def initialize(env, binary_path, global_opts, logger)
 
     # Execute a git command, wait for it to finish, and return the result
     #
+    # Non-option the command line arguements to pass to git. If you collect
+    # the command line arguments in an array, make sure you splat the array
+    # into the parameter list.
+    #
     # NORMALIZATION
     #
     # The command output is returned as a Unicde string containing the binary output
@@ -142,32 +146,30 @@ def initialize(env, binary_path, global_opts, logger)
     #     stderr.string #=> "unknown revision or path not in the working tree.\n"
     #   end
     #
-    # @param args [Array<String>] the command line arguements to pass to git
-    #
-    #   This array should be splatted into the parameter list.
+    # @param options_hash [Hash] the options to pass to the command
     #
-    # @param out [#write, nil] the object to write stdout to or nil to ignore stdout
+    # @option options_hash [#write, nil] :out the object to write stdout to or nil to ignore stdout
     #
     #   If this is a 'StringIO' object, then `stdout_writer.string` will be returned.
     #
     #   In general, only specify a `stdout_writer` object when you want to redirect
     #   stdout to a file or some other object that responds to `#write`. The default
     #   behavior will return the output of the command.
     #
-    # @param err [#write] the object to write stderr to or nil to ignore stderr
+    # @option options_hash [#write, nil] :err the object to write stderr to or nil to ignore stderr
     #
     #   If this is a 'StringIO' object and `merged_output` is `true`, then
     #   `stderr_writer.string` will be merged into the output returned by this method.
     #
-    # @param normalize [Boolean] whether to normalize the output to a valid encoding
+    # @option options_hash [Boolean] :normalize whether to normalize the output of stdout and stderr
     #
-    # @param chomp [Boolean] whether to chomp the output
+    # @option options_hash [Boolean] :chomp whether to chomp both stdout and stderr output
     #
-    # @param merge [Boolean] whether to merge stdout and stderr in the string returned
+    # @option options_hash [Boolean] :merge whether to merge stdout and stderr in the string returned
     #
-    # @param chdir [String] the directory to run the command in
+    # @option options_hash [String, nil] :chdir the directory to run the command in
     #
-    # @param timeout [Numeric, nil] the maximum seconds to wait for the command to complete
+    # @option options_hash [Numeric, nil] :timeout the maximum seconds to wait for the command to complete
     #
     #   If timeout is zero, the timeout will not be enforced.
     #
@@ -189,21 +191,50 @@ def initialize(env, binary_path, global_opts, logger)
     #
     # @raise [Git::TimeoutError] if the command times out
     #
-    def run(*args, normalize:, chomp:, merge:, out: nil, err: nil, chdir: nil, timeout: nil)
+    def run(*, **options_hash)
+      options_hash = RUN_ARGS.merge(options_hash)
+      extra_options = options_hash.keys - RUN_ARGS.keys
+      raise ArgumentError, "Unknown options: #{extra_options.join(', ')}" if extra_options.any?
+
+      result = run_with_capture(*, **options_hash)
+      process_result(result, options_hash[:normalize], options_hash[:chomp], options_hash[:timeout])
+    end
+
+    # @return [Git::CommandLineResult] the result of running the command
+    #
+    # @api private
+    #
+    def run_with_capture(*args, **options_hash)
       git_cmd = build_git_cmd(args)
-      begin
-        options = { chdir: chdir || :not_set, timeout_after: timeout, raise_errors: false }
+      options = run_with_capture_options(**options_hash)
+      ProcessExecuter.run_with_capture(env, *git_cmd, **options)
+    rescue ProcessExecuter::ProcessIOError => e
+      raise Git::ProcessIOError.new(e.message), cause: e.exception.cause
+    end
+
+    def run_with_capture_options(**options_hash)
+      chdir = options_hash[:chdir] || :not_set
+      timeout_after = options_hash[:timeout]
+      out = options_hash[:out]
+      err = options_hash[:err]
+      merge_output = options_hash[:merge] || false
+
+      { chdir:, timeout_after:, merge_output:, raise_errors: false }.tap do |options|
         options[:out] = out unless out.nil?
         options[:err] = err unless err.nil?
-        options[:merge_output] = merge unless merge.nil?
-
-        result = ProcessExecuter.run_with_capture(env, *git_cmd, **options)
-      rescue ProcessExecuter::ProcessIOError => e
-        raise Git::ProcessIOError.new(e.message), cause: e.exception.cause
       end
-      process_result(result, normalize, chomp, timeout)
     end
 
+    RUN_ARGS = {
+      normalize: false,
+      chomp: false,
+      merge: false,
+      out: nil,
+      err: nil,
+      chdir: nil,
+      timeout: nil
+    }.freeze
+
     private
 
     # Build the git command line from the available sources to send to `Process.spawn`
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -1522,6 +1522,16 @@ def self.warn_if_old_command(lib)
       true
     end
 
+    COMMAND_ARG_DEFAULTS = {
+      out: nil,
+      err: nil,
+      normalize: true,
+      chomp: true,
+      merge: false,
+      chdir: nil,
+      timeout: nil # Don't set to Git.config.timeout here since it is mutable
+    }.freeze
+
     private
 
     def command_lines(cmd, *opts, chdir: nil)
@@ -1569,26 +1579,20 @@ def command_line
     # Runs a git command and returns the output
     #
     # Additional args are passed to the command line. They should exclude the 'git'
-    # command itself and global options.
-    #
-    # For example, to run `git log --pretty=oneline`, you would pass `['log',
-    # '--pretty=oneline']`
-    #
-    # @param out [String, nil] the path to a file or an IO to write the command's
-    #   stdout to
-    #
-    # @param err [String, nil] the path to a file or an IO to write the command's
-    #   stdout to
-    #
-    # @param normalize [Boolean] true to normalize the output encoding
-    #
-    # @param chomp [Boolean] true to remove trailing newlines from the output
-    #
-    # @param merge [Boolean] true to merge stdout and stderr
+    # command itself and global options. Remember to splat the the arguments if given
+    # as an array.
     #
-    # @param chdir [String, nil] the directory to run the command in
+    # For example, to run `git log --pretty=oneline`, you would create the array
+    # `args = ['log', '--pretty=oneline']` and call `command(*args)`.
     #
-    # @param timeout [Numeric, nil] the maximum seconds to wait for the command to complete
+    # @param options_hash [Hash] the options to pass to the command
+    # @option options_hash [IO, String, #write, nil] :out the destination for captured stdout
+    # @option options_hash [IO, String, #write, nil] :err the destination for captured stderr
+    # @option options_hash [Boolean] :normalize true to normalize the output encoding to UTF-8
+    # @option options_hash [Boolean] :chomp true to remove trailing newlines from the output
+    # @option options_hash [Boolean] :merge true to merge stdout and stderr into a single output
+    # @option options_hash [String, nil] :chdir the directory to run the command in
+    # @option options_hash [Numeric, nil] :timeout the maximum seconds to wait for the command to complete
     #
     #   If timeout is nil, the global timeout from {Git::Config} is used.
     #
@@ -1603,9 +1607,14 @@ def command_line
     # @return [String] the command's stdout (or merged stdout and stderr if `merge`
     # is true)
     #
+    # @raise [ArgumentError] if an unknown option is passed
+    #
     # @raise [Git::FailedError] if the command failed
+    #
     # @raise [Git::SignaledError] if the command was signaled
+    #
     # @raise [Git::TimeoutError] if the command times out
+    #
     # @raise [Git::ProcessIOError] if an exception was raised while collecting subprocess output
     #
     #   The exception's `result` attribute is a {Git::CommandLineResult} which will
@@ -1614,10 +1623,14 @@ def command_line
     #
     # @api private
     #
-    def command(*, out: nil, err: nil, normalize: true, chomp: true, merge: false, chdir: nil, timeout: nil)
-      timeout ||= Git.config.timeout
-      result = command_line.run(*, out: out, err: err, normalize: normalize, chomp: chomp, merge: merge,
-                                   chdir: chdir, timeout: timeout)
+    def command(*, **options_hash)
+      options_hash = COMMAND_ARG_DEFAULTS.merge(options_hash)
+      options_hash[:timeout] ||= Git.config.timeout
+
+      extra_options = options_hash.keys - COMMAND_ARG_DEFAULTS.keys
+      raise ArgumentError, "Unknown options: #{extra_options.join(', ')}" if extra_options.any?
+
+      result = command_line.run(*, **options_hash)
       result.stdout
     end
 
