git 2.3.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e24e434e4639e6c31133234cee6d96708baf23d212c2f78cf4b94159810b090
-  data.tar.gz: 9fc37b011ac0cb0e87a0ee50b7993e751a7075a7496d6feb41431d2f3612e823
+  metadata.gz: f4c3080ee5b1fd4b591abe1e3e94917ea4307c97a3cf75f93cbc910e5320142b
+  data.tar.gz: 1b5a4682825b282577918929d21967846191fdcf16a8dc3c72de71820fee74f9
 SHA512:
-  metadata.gz: 232624614200233e3f2ed308a4e73580345fef5be0a98e64f35992ecb222fa96c4163399b2f08afbfcdf69cd3b2f8f6c57c309fe9122f18a56e9bc31f827b301
-  data.tar.gz: 4ae699244e5ff9f679795279b8dbfeebe35ce8c9bfb7e5d9a18552b77b3d86b630f50bd9fedb4eec4f697269cfec6c90f72adfa2edeada25258ab457f3b5dad8
+  metadata.gz: 57434c5742779e9769f3a6ce85a5b25c5f3c4e5974427965bca0df4922a266ffb3225839ccf2964f2391d5b8c7eda68de4aa1d46bbbd264b6d5c53a2c7852f77
+  data.tar.gz: 6c1a1bc6010f883eb8b0d4ccd677a5f46c98db9f3f9e582b8c06f6b4294903c1949fe288fe2ae2c17c41ae9e5319fdc9fc64870e5f3f1219b03351a22f475d4c

data/CHANGELOG.md

@@ -5,6 +5,28 @@
 
 # Change Log
 
+## v2.3.2 (2024-11-19)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v2.3.1..v2.3.2)
+
+Changes since v2.3.1:
+
+* 7646e38 fix: improve error message for Git::Lib#branches_all
+
+## v2.3.1 (2024-10-23)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v2.3.0..v2.3.1)
+
+Changes since v2.3.0:
+
+* e236007 test: allow bin/test-in-docker to accept the test file(s) to run on command line
+* f4747e1 test: rename bin/tests to bin/test-in-docker
+* 51f781c test: remove duplicate test from test_stashes.rb
+* 2e79dbe Fixed "unbranched" stash message support:
+* da6fa6e Conatinerised the test suite with Docker:
+* 2e23d47 Update instructions for building a specific version of Git
+* 70565e3 Add Git.binary_version to return the version of the git command line
+
 ## v2.3.0 (2024-09-01)
 
 [Full Changelog](https://github.com/ruby-git/ruby-git/compare/v2.2.0..v2.3.0)

data/CONTRIBUTING.md

@@ -3,6 +3,9 @@
 # @title How To Contribute
 -->
 
+# Contributing to the git gem
+
+* [Summary](#summary)
 * [How to contribute](#how-to-contribute)
 * [How to report an issue or request a feature](#how-to-report-an-issue-or-request-a-feature)
 * [How to submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
@@ -18,10 +21,14 @@
   * [Unit tests](#unit-tests)
   * [Continuous integration](#continuous-integration)
   * [Documentation](#documentation)
+* [Building a specific version of the Git command-line](#building-a-specific-version-of-the-git-command-line)
+  * [Install pre-requisites](#install-pre-requisites)
+  * [Obtain Git source code](#obtain-git-source-code)
+  * [Build git](#build-git)
+  * [Use the new Git version](#use-the-new-git-version)
 * [Licensing](#licensing)
 
-
-# Contributing to the git gem
+## Summary
 
 Thank you for your interest in contributing to the `ruby-git` project.
 
@@ -172,22 +179,100 @@ $ bin/test test_object test_archive
 
 # run all unit tests:
 $ bin/test
+
+# run unit tests with a different version of the git command line:
+$ GIT_PATH=/Users/james/Downloads/git-2.30.2/bin-wrappers bin/test
 ```
 
 ### Continuous integration
 
-All tests must pass in the project's [GitHub Continuous Integration build](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI) before the pull request will be merged.
+All tests must pass in the project's [GitHub Continuous Integration
+build](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI) before the
+pull request will be merged.
 
-The [Continuous Integration workflow](https://github.com/ruby-git/ruby-git/blob/master/.github/workflows/continuous_integration.yml) runs both `bundle exec rake default` and `bundle exec rake test:gem` from the project's [Rakefile](https://github.com/ruby-git/ruby-git/blob/master/Rakefile).
+The [Continuous Integration
+workflow](https://github.com/ruby-git/ruby-git/blob/master/.github/workflows/continuous_integration.yml)
+runs both `bundle exec rake default` and `bundle exec rake test:gem` from the
+project's [Rakefile](https://github.com/ruby-git/ruby-git/blob/master/Rakefile).
 
 ### Documentation
 
-New and updated public methods must include [YARD](https://yardoc.org/) documentation.
+New and updated public methods must include [YARD](https://yardoc.org/)
+documentation.
+
+New and updated public-facing features should be documented in the project's
+[README.md](README.md).
+
+## Building a specific version of the Git command-line
+
+To test with a specific version of the Git command-line, you may need to build that
+version from source code. The following instructions are adapted from Atlassian’s
+[How to install Git](https://www.atlassian.com/git/tutorials/install-git) page for
+building Git on macOS.
+
+### Install pre-requisites
+
+Prerequisites only need to be installed if they are not already present.
+
+From your terminal, install Xcode’s Command Line Tools:
+
+```shell
+xcode-select --install
+```
+
+Install [Homebrew](http://brew.sh/) by following the instructions on the Homebrew
+page.
+
+Using Homebrew, install OpenSSL:
+
+```shell
+brew install openssl
+```
+
+### Obtain Git source code
+
+Download and extract the source tarball for the desired Git version from [this source
+code mirror](https://mirrors.edge.kernel.org/pub/software/scm/git/).
+
+### Build git
+
+From your terminal, change to the root directory of the extracted source code and run
+the build with following command:
+
+```shell
+NO_GETTEXT=1 make CFLAGS="-I/usr/local/opt/openssl/include" LDFLAGS="-L/usr/local/opt/openssl/lib"
+```
+
+The build script will place the newly compiled Git executables in the `bin-wrappers`
+directory (e.g., `bin-wrappers/git`).
+
+### Use the new Git version
+
+To configure programs that use the Git gem to utilize the newly built version, do the
+following:
+
+```ruby
+require 'git'
+
+# Set the binary path
+Git.configure { |c| c.binary_path = '/Users/james/Downloads/git-2.30.2/bin-wrappers/git' }
+
+# Validate the version (if desired)
+assert_equal([2, 30, 2], Git.binary_version)
+```
+
+Tests can be run using the newly built Git version as follows:
+
+```shell
+GIT_PATH=/Users/james/Downloads/git-2.30.2/bin-wrappers bin/test
+```
 
-New and updated public-facing features should be documented in the project's [README.md](README.md).
+Note: `GIT_PATH` refers to the directory containing the `git` executable.
 
 ## Licensing
 
-`ruby-git` uses [the MIT license](https://choosealicense.com/licenses/mit/) as declared in the [LICENSE](LICENSE) file.
+`ruby-git` uses [the MIT license](https://choosealicense.com/licenses/mit/) as
+declared in the [LICENSE](LICENSE) file.
 
-Licensing is critical to open-source projects as it ensures the software remains available under the terms desired by the author.
+Licensing is critical to open-source projects as it ensures the software remains
+available under the terms desired by the author.

data/lib/git/base.rb

@@ -36,6 +36,20 @@ module Git
       @@config ||= Config.new
     end
 
+    def self.binary_version(binary_path)
+      git_cmd = "#{binary_path} -c core.quotePath=true -c color.ui=false version 2>&1"
+      result, status = Open3.capture2(git_cmd)
+      result = result.chomp
+
+      if status.success?
+        version = result[/\d+(\.\d+)+/]
+        version_parts = version.split('.').collect { |i| i.to_i }
+        version_parts.fill(0, version_parts.length...3)
+      else
+        raise RuntimeError, "Failed to get git version: #{status}\n#{result}"
+      end
+    end
+
     # (see Git.init)
     def self.init(directory = '.', options = {})
       normalize_paths(options, default_working_directory: directory, default_repository: directory, bare: options[:bare])

data/lib/git/lib.rb

@@ -362,7 +362,7 @@ module Git
     #
     # @example Get the contents of a file with a block
     #  lib.cat_file_contents('README.md') { |f| f.read } # => "This is a README file\n"
-    #  
+    #
     # @param object [String] the object whose contents to return
     #
     # @return [String] the object contents
@@ -641,10 +641,13 @@ module Git
     /x
 
     def branches_all
-      command_lines('branch', '-a').map do |line|
+      lines = command_lines('branch', '-a')
+      lines.each_with_index.map do |line, line_index|
         match_data = line.match(BRANCH_LINE_REGEXP)
-        raise Git::UnexpectedResultError, 'Unexpected branch line format' unless match_data
+
+        raise Git::UnexpectedResultError, unexpected_branch_line_error(lines, line, line_index) unless match_data
         next nil if match_data[:not_a_branch] || match_data[:detached_ref]
+
         [
           match_data[:refname],
           !match_data[:current].nil?,
@@ -654,6 +657,18 @@ module Git
       end.compact
     end
 
+    def unexpected_branch_line_error(lines, line, index)
+      <<~ERROR
+        Unexpected line in output from `git branch -a`, line #{index + 1}
+
+        Full output:
+          #{lines.join("\n  ")}
+
+        Line #{index + 1}:
+          "#{line}"
+      ERROR
+    end
+
     def worktrees_all
       arr = []
       directory = ''
@@ -1134,8 +1149,10 @@ module Git
       if File.exist?(filename)
         File.open(filename) do |f|
           f.each_with_index do |line, i|
-            m = line.match(/:(.*)$/)
-            arr << [i, m[1].strip]
+            _, msg = line.split("\t")
+            # NOTE this logic may be removed/changed in 3.x
+            m = msg.match(/^[^:]+:(.*)$/)
+            arr << [i, (m ? m[1] : msg).strip]
           end
         end
       end

data/lib/git/version.rb

@@ -1,5 +1,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='2.3.0'
+  VERSION='2.3.2'
 end

data/lib/git.rb

@@ -381,4 +381,15 @@ module Git
   def self.open(working_dir, options = {})
     Base.open(working_dir, options)
   end
+
+  # Return the version of the git binary
+  #
+  # @example
+  #  Git.binary_version # => [2, 46, 0]
+  #
+  # @return [Array<Integer>] the version of the git binary
+  #
+  def self.binary_version(binary_path = Git::Base.config.binary_path)
+    Base.binary_version(binary_path)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,8 +243,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: https://rubydoc.info/gems/git/2.3.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/2.3.0
+  changelog_uri: https://rubydoc.info/gems/git/2.3.2/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/2.3.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - git 2.28.0 or greater
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories