git 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d02f0f135a2a2f9e4f8d661bc4c5d4323af8b46a527581c0f47ff17df88019
-  data.tar.gz: c45684c1b8f6af0c5a44a90c0e8918860653a6abb4a6464d11faff90278ef7c7
+  metadata.gz: 6dd58567bba3a5effab0e3d3f565f5b3891dcf056ef4df11c1521037bbe9f489
+  data.tar.gz: a1f8f9968a3927ce99f393805c34b0ca23941c37f27607d296eaecba9dc0f872
 SHA512:
-  metadata.gz: 5bd13aa06dcdb48d0f47ac72d82608120a73b9fb83db278070715d9ce98023e18e75f61c5c42ea13fc24a8f125bde989e8afbc0460c94e1a6eb5c4cd658f7639
-  data.tar.gz: 5c9a4e9d8734a23162e9c858246ac705ac3413db73f8e728845b7ae62aec7b6096f2b06ddcdc195c57efe052058e26c5b9340f1d9dbdc972bf8f68f303c7eba9
+  metadata.gz: b1231323bde0b63677f46945800dc950a004cd854bee8c1d5a6711c8709c3dd87fb0c187f54c39c94ae07f92674f27a94b23fe3200a1799992f272c0bd84d315
+  data.tar.gz: 8d89a33a9cbee9357f9a4ffb568ec38506749aa81b931f9b2e862af0420c549c1738fde90e48eede6650c3202d31b9463e852eea5b358020b5561e5a60e12ef3

data/.github/workflows/continuous_integration.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.3, 2.7]
+        ruby: [2.3, 2.7, 3.0]
         operating-system: [ubuntu-latest]
         include:
           - ruby: head

data/CHANGELOG.md

@@ -5,6 +5,10 @@
 
 # Change Log
 
+## 1.10.1
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.10.1
+
 ## 1.10.0
 
 See https://github.com/ruby-git/ruby-git/releases/tag/v1.10.0

data/Dockerfile.changelog-rs

@@ -0,0 +1,12 @@
+FROM rust
+
+# Build the docker image (from this project's root directory):
+# docker build --file Dockerfile.changelog-rs --tag changelog-rs .
+#
+# Use this image to output a changelog (from this project's root directory):
+# docker run --rm --volume "$PWD:/worktree" changelog-rs v1.9.1 v1.10.0
+
+RUN cargo install changelog-rs
+WORKDIR /worktree
+
+ENTRYPOINT ["/usr/local/cargo/bin/changelog-rs", "/worktree"]

data/RELEASING.md

@@ -6,9 +6,11 @@
 # How to release a new git.gem
 
 Releasing a new version of the `git` gem requires these steps:
-  * [Prepare the release](#prepare-the-release)
-  * [Create a GitHub release](#create-a-github-release)
-  * [Build and release the gem](#build-and-release-the-gem)
+
+- [How to release a new git.gem](#how-to-release-a-new-gitgem)
+  - [Prepare the release](#prepare-the-release)
+  - [Create a GitHub release](#create-a-github-release)
+  - [Build and release the gem](#build-and-release-the-gem)
 
 These instructions use an example where the current release version is `1.5.0`
 and the new release version to be created is `1.6.0.pre1`.
@@ -18,45 +20,49 @@ and the new release version to be created is `1.6.0.pre1`.
 From a fork of ruby-git, create a PR containing changes to (1) bump the
 version number, (2) update the CHANGELOG.md, and (3) tag the release.
 
-  * Bump the version number in lib/git/version.rb following [Semantic Versioning](https://semver.org)
-    guidelines
-  * Add a link in CHANGELOG.md to the release tag which will be created later
-    in this guide
-  * Create a new tag using [git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-release)
-    `git release` command
-    * For example: `git release v1.6.0.pre1`
-  * These should be the only changes in the PR
-  * An example of these changes for `v1.6.0.pre1` can be found in [PR #435](https://github.com/ruby-git/ruby-git/pull/435)
-  * Get the PR reviewed, approved and merged to master.
+- Bump the version number in lib/git/version.rb following [Semantic Versioning](https://semver.org)
+  guidelines
+- Add a link in CHANGELOG.md to the release tag which will be created later
+  in this guide
+- Create a new tag using [git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-release)
+  `git release` command
+  - For example: `git release v1.6.0.pre1`
+- These should be the only changes in the PR
+- An example of these changes for `v1.6.0.pre1` can be found in [PR #435](https://github.com/ruby-git/ruby-git/pull/435)
+- Get the PR reviewed, approved and merged to master.
 
 ## Create a GitHub release
 
 On [the ruby-git releases page](https://github.com/ruby-git/ruby-git/releases),
 select `Draft a new release`
 
-  * Select the tag corresponding to the version being released `v1.6.0.pre1`
-  * The Target should be `master`
-  * For the release description, use the output of [changelog-rs](https://github.com/perlun/changelog-rs)
-    * Since the release has not been created yet, you will need to supply
-      `changeling-rs` with the current release tag and the tag the new release
-      is being created from
-    * For example: `changelog-rs . v1.5.0 v1.6.0.pre1`
-    * Copy the output, omitting the tag header `## v1.6.0.pre1` and paste into
-      the release description
-    * The release description can be edited later if needed
-  * Select the appropriate value for `This is a pre-release`
-    * Since `v1.6.0.pre1` is a pre-release, check `This is a pre-release`
+- Select the tag corresponding to the version being released `v1.6.0.pre1`
+- The Target should be `master`
+- For the release description, use the output of [changelog-rs](https://github.com/perlun/changelog-rs)
+  - A Docker image is provided in [Dockerfile.changelog-rs](https://github.com/ruby-git/ruby-git/blob/master/Dockerfile.changelog-rs)
+    so you don't have to install changelog-rs or the Rust tool chain. To build the
+    Docker image, run this command from this project's root directory:
+    - `docker build --file Dockerfile.changelog-rs --tag changelog-rs .`
+  - To run the changelog-rs command using this image, run the following command
+    from this project's root directory (replace the tag names appropriate for the
+    current release):
+    - `docker run --rm --volume "$PWD:/worktree" changelog-rs v1.5.0 v1.6.0.pre1`
+  - Copy the output, omitting the tag header `## v1.6.0.pre1` and paste into
+    the release description
+  - The release description can be edited later if needed
+- Select the appropriate value for `This is a pre-release`
+  - Since `v1.6.0.pre1` is a pre-release, check `This is a pre-release`
 
 ## Build and release the gem
 
 Clone [ruby-git/ruby-git](https://github.com/ruby-git/ruby-git) directly (not a
 fork) and ensure your local working copy is on the master branch
 
-  * Verify that you are not on a fork with the command `git remote -v`
-  * Verify that the version number is correct by running `rake -T` and inspecting
-    the output for the `release[remote]` task
+- Verify that you are not on a fork with the command `git remote -v`
+- Verify that the version number is correct by running `rake -T` and inspecting
+  the output for the `release[remote]` task
 
 Build the git gem and push it to rubygems.org with the command `rake release`
 
-  * Ensure that your `gem sources list` includes `https://rubygems.org` (in my
-    case, I usually have my work’s internal gem repository listed)
+- Ensure that your `gem sources list` includes `https://rubygems.org` (in my
+  case, I usually have my work’s internal gem repository listed)

data/lib/git/base.rb

@@ -36,7 +36,7 @@ module Git
 
       init_options = {
         :bare => options[:bare],
-        :initial_branch => options[:initial_branch],
+        :initial_branch => options[:initial_branch]
       }
 
       directory = options[:bare] ? options[:repository] : options[:working_directory]

data/lib/git/diff.rb

@@ -129,8 +129,8 @@ module Git
         final = {}
         current_file = nil
         @full_diff.split("\n").each do |line|
-          if m = /^diff --git a\/(.*?) b\/(.*?)/.match(line)
-            current_file = m[1]
+          if m = %r{\Adiff --git ("?)a/(.+?)\1 ("?)b/(.+?)\3\z}.match(line)
+            current_file = Git::EscapedPath.new(m[2]).unescape
             final[current_file] = defaults.merge({:patch => line, :path => current_file})
           else
             if m = /^index ([0-9a-f]{4,40})\.\.([0-9a-f]{4,40})( ......)*/.match(line)

data/lib/git/encoding_utils.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rchardet'
+
+module Git
+  # Method that can be used to detect and normalize string encoding
+  module EncodingUtils
+    def self.default_encoding
+      __ENCODING__.name
+    end
+
+    def self.best_guess_encoding
+      # Encoding::ASCII_8BIT.name
+      Encoding::UTF_8.name
+    end
+
+    def self.detected_encoding(str)
+      CharDet.detect(str)['encoding'] || best_guess_encoding
+    end
+
+    def self.encoding_options
+      { invalid: :replace, undef: :replace }
+    end
+
+    def self.normalize_encoding(str)
+      return str if str.valid_encoding? && str.encoding.name == default_encoding
+
+      return str.encode(default_encoding, str.encoding, **encoding_options) if str.valid_encoding?
+
+      str.encode(default_encoding, detected_encoding(str), **encoding_options)
+    end
+  end
+end

data/lib/git/escaped_path.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Git
+  # Represents an escaped Git path string
+  #
+  # Git commands that output paths (e.g. ls-files, diff), will escape usual
+  # characters in the path with backslashes in the same way C escapes control
+  # characters (e.g. \t for TAB, \n for LF, \\ for backslash) or bytes with values
+  # larger than 0x80 (e.g. octal \302\265 for "micro" in UTF-8).
+  #
+  # @example
+  #   Git::GitPath.new('\302\265').unescape # => "µ"
+  #
+  class EscapedPath
+    UNESCAPES = {
+      'a' => 0x07,
+      'b' => 0x08,
+      't' => 0x09,
+      'n' => 0x0a,
+      'v' => 0x0b,
+      'f' => 0x0c,
+      'r' => 0x0d,
+      'e' => 0x1b,
+      '\\' => 0x5c,
+      '"' => 0x22,
+      "'" => 0x27
+    }.freeze
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    # Convert an escaped path to an unescaped path
+    def unescape
+      bytes = escaped_path_to_bytes(path)
+      str = bytes.pack('C*')
+      str.force_encoding(Encoding::UTF_8)
+    end
+
+    private
+
+    def extract_octal(path, index)
+      [path[index + 1..index + 4].to_i(8), 4]
+    end
+
+    def extract_escape(path, index)
+      [UNESCAPES[path[index + 1]], 2]
+    end
+
+    def extract_single_char(path, index)
+      [path[index].ord, 1]
+    end
+
+    def next_byte(path, index)
+      if path[index] == '\\' && path[index + 1] >= '0' && path[index + 1] <= '7'
+        extract_octal(path, index)
+      elsif path[index] == '\\' && UNESCAPES.include?(path[index + 1])
+        extract_escape(path, index)
+      else
+        extract_single_char(path, index)
+      end
+    end
+
+    def escaped_path_to_bytes(path)
+      index = 0
+      [].tap do |bytes|
+        while index < path.length
+          byte, chars_used = next_byte(path, index)
+          bytes << byte
+          index += chars_used
+        end
+      end
+    end
+  end
+end

data/lib/git/lib.rb

@@ -1,4 +1,3 @@
-require 'rchardet'
 require 'tempfile'
 require 'zlib'
 
@@ -1085,7 +1084,8 @@ module Git
       global_opts = []
       global_opts << "--git-dir=#{@git_dir}" if !@git_dir.nil?
       global_opts << "--work-tree=#{@git_work_dir}" if !@git_work_dir.nil?
-      global_opts << ["-c", "color.ui=false"]
+      global_opts << %w[-c core.quotePath=true]
+      global_opts << %w[-c color.ui=false]
 
       opts = [opts].flatten.map {|s| escape(s) }.join(' ')
 
@@ -1176,35 +1176,10 @@ module Git
       arr_opts
     end
 
-    def default_encoding
-      __ENCODING__.name
-    end
-
-    def best_guess_encoding
-      # Encoding::ASCII_8BIT.name
-      Encoding::UTF_8.name
-    end
-
-    def detected_encoding(str)
-      CharDet.detect(str)['encoding'] || best_guess_encoding
-    end
-
-    def encoding_options
-      { invalid: :replace, undef: :replace }
-    end
-
-    def normalize_encoding(str)
-      return str if str.valid_encoding? && str.encoding.name == default_encoding
-
-      return str.encode(default_encoding, str.encoding, **encoding_options) if str.valid_encoding?
-
-      str.encode(default_encoding, detected_encoding(str), **encoding_options)
-    end
-
     def run_command(git_cmd, &block)
       return IO.popen(git_cmd, &block) if block_given?
 
-      `#{git_cmd}`.lines.map { |l| normalize_encoding(l) }.join
+      `#{git_cmd}`.lines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join
     end
 
     def escape(s)
@@ -1216,8 +1191,9 @@ module Git
     end
 
     def escape_for_windows(s)
-      # Windows does not need single quote escaping inside double quotes
-      %Q{"#{s}"}
+      # Escape existing double quotes in s and then wrap the result with double quotes
+      escaped_string = s.to_s.gsub('"','\\"')
+      %Q{"#{escaped_string}"}
     end
 
     def windows_platform?
@@ -1225,6 +1201,5 @@ module Git
       win_platform_regex = /mingw|mswin/
       RUBY_PLATFORM =~ win_platform_regex || RUBY_DESCRIPTION =~ win_platform_regex
     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='1.10.0'
+  VERSION='1.10.1'
 end

data/lib/git.rb

@@ -9,6 +9,8 @@ require 'git/branch'
 require 'git/branches'
 require 'git/config'
 require 'git/diff'
+require 'git/encoding_utils'
+require 'git/escaped_path'
 require 'git/index'
 require 'git/lib'
 require 'git/log'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rchardet
@@ -125,6 +125,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dockerfile.changelog-rs
 - Gemfile
 - ISSUE_TEMPLATE.md
 - LICENSE
@@ -142,6 +143,8 @@ files:
 - lib/git/branches.rb
 - lib/git/config.rb
 - lib/git/diff.rb
+- lib/git/encoding_utils.rb
+- lib/git/escaped_path.rb
 - lib/git/index.rb
 - lib/git/lib.rb
 - lib/git/log.rb