Your checklist for this pull request

🚨Please review the guidelines for contributing to this repository.

• Ensure all commits include DCO sign-off.
• Ensure that your contributions pass unit testing.
• Ensure that your contributions contain documentation if applicable.

TODO

Waiting for the following issues to be addressed:

• JRuby on Windows
  • DONE Process#spawn should call #to_io on non-IO file descriptor objects jruby/jruby#7565
  • Process.wait and Process.wait2 not behaving as expected on Windows with JDK > 8 jruby/jruby#7515
• Truffle Ruby
  • DONE Process#spawn should call #to_io on non-IO file descriptor objects oracle/truffleruby#2809

Description

Fixes #355, Fixes #363, Fixes #441, Fixes #495, Fixes #516, Fixes #574

In the current implementation, all calls to git are done using backticks which has several disadvantages:

• STDOUT and STDERR are commingled (via redirection added to the command line using 2>&1) which can cause processing errors.
• Changes to the environment's subprocess have to be global which could impact users of this gem
• Arguments passed on the command line go through the system shell making it difficult to escape args correctly for all platforms AND leaving this gem open to security vulnerabilities

Requirements

Implement a cross platform (Windows, Linux, and Mac) and cross Ruby (MRI, JRuby, and TruffleRuby) solution that meets the following requirements:

1. Independently capture STDOUT and STDERR
2. Be able to both capture STDOUT and STDIN as well as stream them to the terminal and a file at the same time if desired (e.g. for debugging)
3. Provide a isolated environment and current working directory for the git command subprocess that does not change these global variables in the process that this gem is running in
4. Pass command line args to the git command without being interpreted by the system shell
5. Be able to implement a timeout on git subprocesses so they do not hang forever if input is asked for

Alternative Implementations Examined

Option 6 was chosen because it is the least complex implementation that implements all the requirements.

Changes Made in this PR

This PR re-implements Git::Lib#command. In order to get the desired results, some changes were needed to the signature of this method which caused some changes in code and tests.

The implementation of Git::Lib#command is handled by the new class Git::CommandLine. This class has a small interface: #initialize which accepts attribute values that do not change between git command invocations (env, binary_path, global_opts, and logger) and #run which takes the git command args, redirection, and flags for normalization, chomping, and merging stderr with stdout.