git 1.18.0 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3c801f928c5b75999c02cecd054c0007a8e2f0460c27bc2b983741824d7b194
-  data.tar.gz: 861bf03f14ed76dcf43acefcc8fe33787e202a9af52e7789d6d1660f84b4fc51
+  metadata.gz: 6f12803468275850ae680a4df2719890e8f84de95258f30dc898f817c7155d44
+  data.tar.gz: d24540a708538775d2ff1af495f04e7f42a297aaf790d0fe7b65ad71fe402550
 SHA512:
-  metadata.gz: 4a4bf752eb3332572f968ea23a5cc4a4e4547279f60ce2341d6d6d815f5d9f4cbd17237b266c9cd2850c77c2c9a189ff98034af5385333632f557e765cb7b64a
-  data.tar.gz: e678b9da94ccd8295347688d3dd3e400764da4af3f850ceaa0038e4ddb34804fd2cc3942119a9f66968b4c014fb07a040352c7b6494556298cebd826bc765fd8
+  metadata.gz: 15a09f75d84fb1ff7547403eb36c7342bee11fc1a23cf86e5eae224a2494da0e0bc60bf288c04924c87bdf6736f156f4d98f0468cf815d03b3291509ab234e8d
+  data.tar.gz: 7fe2633018ec2e38805b987271cc033d023b1a32b429cf2f75e88d1ac1c86c913689fc46806ea49c38fce66005215b05fc700ca3adc925afd0b3dcd3fefdc091

data/CHANGELOG.md

@@ -5,6 +5,29 @@
 
 # Change Log
 
+## v1.19.1 (2024-01-13)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.19.0..v1.19.1)
+
+Changes since v1.19.0:
+
+* f97c57c Announce the 2.0.0 pre-release (#682)
+
+## v1.19.0 (2023-12-28)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.18.0..v1.19.0)
+
+Changes since v1.18.0:
+
+* 3bdb280 Add option to push all branches to a remote repo at one time (#678)
+* b0d89ac Remove calls to Dir.chdir (#673)
+* e64c2f6 Refactor tests for read_tree, write_tree, and commit_tree (#679)
+* 0bb965d Explicitly name remote tracking branch in test (#676)
+* 8481f8c Document how to delete a remote branch (#672)
+* dce6816 show .log example with count in README, fixes #667 (#668)
+* b1799f6 Update test of 'git worktree add' with no commits (#670)
+* dd5a24d Add --filter to Git.clone for partial clones (#663)
+
 ## v1.18.0 (2023-03-19)
 
 [Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.17.2..v1.18.0)

data/README.md

@@ -5,11 +5,41 @@
 
 # The Git Gem
 
-The Git Gem provides an API that can be used to create, read, and manipulate
-Git repositories by wrapping system calls to the `git` binary. The API can be
-used for working with Git in complex interactions including branching and
-merging, object inspection and manipulation, history, patch generation and
-more.
+[![Gem Version](https://badge.fury.io/rb/git.svg)](https://badge.fury.io/rb/git)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/git/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/git/file/CHANGELOG.md)
+[![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=master)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
+[![Code Climate](https://codeclimate.com/github/ruby-git/ruby-git.png)](https://codeclimate.com/github/ruby-git/ruby-git)
+
+The [git gem](https://rubygems.org/gems/git) provides an API that can be used to
+create, read, and manipulate Git repositories by wrapping system calls to the `git`
+command line. The API can be used for working with Git in complex interactions
+including branching and merging, object inspection and manipulation, history, patch
+generation and more.
+
+## v2.0.0 pre-release
+
+git 2.0.0 is available as a pre-release version for testing! Please give it a try.
+
+**JRuby on Windows is not yet supported by the 2.x release line. Users running JRuby
+on Windows should continue to use the 1.x release line.**
+
+The changes coming in this major release include:
+
+* Create a policy of supported Ruby versions to support only non-EOL Ruby versions
+* Create a policy of supported Git CLI versions (released 2020-12-25)
+* Update the required Ruby version to at least 3.0 (released 2020-07-27)
+* Update the required Git command line version to at least 2.28
+* Update how CLI commands are called to use the [process_executer](https://github.com/main-branch/process_executer)
+  gem which is built on top of [Kernel.spawn](https://ruby-doc.org/3.3.0/Kernel.html#method-i-spawn).
+  See [PR #617](https://github.com/ruby-git/ruby-git/pull/617) for more details
+  on the motivation for this implementation.
+
+The tentative plan is to release `2.0.0` near the end of March 2024 depending on
+the feedback received during the pre-release period.
+
+The `master` branch will be used for `2.x` development. If needed, fixes for `1.x`
+version will be done on the `v1` branch.
 
 ## Homepage
 
@@ -41,9 +71,6 @@ sudo gem install git
 
 ## Code Status
 
-* [![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=master)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
-* [![Code Climate](https://codeclimate.com/github/ruby-git/ruby-git.png)](https://codeclimate.com/github/ruby-git/ruby-git)
-* [![Gem Version](https://badge.fury.io/rb/git.svg)](https://badge.fury.io/rb/git)
 
 ## Major Objects
 
@@ -113,6 +140,7 @@ g.repo
 g.dir
 
 g.log   # returns a Git::Log object, which is an Enumerator of Git::Commit objects
+g.log(200)
 g.log.since('2 weeks ago')
 g.log.between('v2.5', 'v2.6')
 g.log.each {|l| puts l.sha }
@@ -236,6 +264,9 @@ g.dir #=> /tmp/clone/ruby-git-clean
 g.config('user.name', 'Scott Chacon')
 g.config('user.email', 'email@email.com')
 
+# Clone can take a filter to tell the serve to send a partial clone
+g = Git.clone(git_url, name, :path => path, :filter => 'tree:0')
+
 # Clone can take an optional logger
 logger = Logger.new
 g = Git.clone(git_url, NAME, :log => logger)
@@ -282,6 +313,9 @@ g.branch('new_branch').delete
 g.branch('existing_branch').checkout
 g.branch('master').contains?('existing_branch')
 
+# delete remote branch
+g.push('origin', 'remote_branch_name', force: true, delete: true)
+
 g.checkout('new_branch')
 g.checkout('new_branch', new_branch: true, start_point: 'master')
 g.checkout(g.branch('new_branch'))
@@ -335,6 +369,12 @@ g.repack
 g.push
 g.push(g.remote('name'))
 
+# delete remote branch
+g.push('origin', 'remote_branch_name', force: true, delete: true)
+
+# push all branches to remote at one time
+g.push('origin', all: true)
+
 g.worktree('/tmp/new_worktree').add
 g.worktree('/tmp/new_worktree', 'branch1').add
 g.worktree('/tmp/new_worktree').remove

data/git.gemspec

@@ -9,17 +9,19 @@ Gem::Specification.new do |s|
   s.name = 'git'
   s.summary = 'An API to create, read, and manipulate Git repositories'
   s.description = <<~DESCRIPTION
-    The Git Gem provides an API that can be used to create, read, and manipulate
-    Git repositories by wrapping system calls to the `git` binary. The API can be
-    used for working with Git in complex interactions including branching and
-    merging, object inspection and manipulation, history, patch generation and
-    more.
+    The git gem provides an API that can be used to
+    create, read, and manipulate Git repositories by wrapping system calls to the git
+    command line. The API can be used for working with Git in complex interactions
+    including branching and merging, object inspection and manipulation, history, patch
+    generation and more.
   DESCRIPTION
   s.version = Git::VERSION
 
+
   s.metadata['homepage_uri'] = s.homepage
   s.metadata['source_code_uri'] = s.homepage
-  s.metadata['changelog_uri'] = 'http://rubydoc.info/gems/git/file.CHANGELOG.html'
+  s.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}/file/CHANGELOG.md"
+  s.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{s.name}/#{s.version}"
 
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 2.3'
@@ -32,6 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bump', '~> 0.10'
   s.add_development_dependency 'create_github_release', '~> 0.2'
   s.add_development_dependency 'minitar', '~> 0.9'
+  s.add_development_dependency 'mocha', '~> 2.1'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'test-unit', '~> 3.3'
 

data/lib/git/base.rb

@@ -1,5 +1,6 @@
 require 'git/base/factory'
 require 'logger'
+require 'open3'
 
 module Git
   # Git::Base is the main public interface for interacting with Git commands.
@@ -66,11 +67,11 @@ module Git
     def self.root_of_worktree(working_dir)
       result = working_dir
       status = nil
-      Dir.chdir(working_dir) do
-        git_cmd = "#{Git::Base.config.binary_path} -c core.quotePath=true -c color.ui=false rev-parse --show-toplevel 2>&1"
-        result = `#{git_cmd}`.chomp
-        status = $?
-      end
+
+      git_cmd = "#{Git::Base.config.binary_path} -c core.quotePath=true -c color.ui=false rev-parse --show-toplevel 2>&1"
+      result, status = Open3.capture2(git_cmd, chdir: File.expand_path(working_dir))
+      result = result.chomp
+
       raise ArgumentError, "'#{working_dir}' is not in a git working tree" unless status.success?
       result
     end

data/lib/git/lib.rb

@@ -2,6 +2,7 @@ require 'git/failed_error'
 require 'logger'
 require 'tempfile'
 require 'zlib'
+require 'open3'
 
 module Git
   class Lib
@@ -84,6 +85,7 @@ module Git
     #  :bare::      no working directory
     #  :branch::    name of branch to track (rather than 'master')
     #  :depth::     the number of commits back to pull
+    #  :filter::    specify partial clone
     #  :origin::    name of remote (same as remote)
     #  :path::      directory where the repo will be cloned
     #  :remote::    name of remote (rather than 'origin')
@@ -101,6 +103,7 @@ module Git
       arr_opts << '--bare' if opts[:bare]
       arr_opts << '--branch' << opts[:branch] if opts[:branch]
       arr_opts << '--depth' << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0
+      arr_opts << '--filter' << opts[:filter] if opts[:filter]
       Array(opts[:config]).each { |c| arr_opts << '--config' << c }
       arr_opts << '--origin' << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
       arr_opts << '--recursive' if opts[:recursive]
@@ -439,7 +442,10 @@ module Git
     def list_files(ref_dir)
       dir = File.join(@git_dir, 'refs', ref_dir)
       files = []
-      Dir.chdir(dir) { files = Dir.glob('**/*').select { |f| File.file?(f) } } rescue nil
+      begin
+        files = Dir.glob('**/*', base: dir).select { |f| File.file?(File.join(dir, f)) }
+      rescue
+      end
       files
     end
 
@@ -577,15 +583,7 @@ module Git
     end
 
     def config_get(name)
-      do_get = Proc.new do |path|
-        command('config', '--get', name)
-      end
-
-      if @git_dir
-        Dir.chdir(@git_dir, &do_get)
-      else
-        do_get.call
-      end
+      command('config', '--get', name, chdir: @git_dir)
     end
 
     def global_config_get(name)
@@ -593,15 +591,7 @@ module Git
     end
 
     def config_list
-      build_list = Proc.new do |path|
-        parse_config_list command_lines('config', '--list')
-      end
-
-      if @git_dir
-        Dir.chdir(@git_dir, &build_list)
-      else
-        build_list.call
-      end
+      parse_config_list command_lines('config', '--list', chdir: @git_dir)
     end
 
     def global_config_list
@@ -982,7 +972,9 @@ module Git
       arr_opts = []
       arr_opts << '--mirror'  if opts[:mirror]
       arr_opts << '--delete'  if opts[:delete]
-      arr_opts << '--force'  if opts[:force] || opts[:f]
+      arr_opts << '--force'   if opts[:force] || opts[:f]
+      arr_opts << '--all'     if opts[:all] && remote
+
       Array(opts[:push_option]).each { |o| arr_opts << '--push-option' << o } if opts[:push_option]
       arr_opts << remote if remote
       arr_opts_with_branch = arr_opts.dup
@@ -1041,7 +1033,7 @@ module Git
       arr_opts = []
       arr_opts << tree
       arr_opts << '-p' << opts[:parent] if opts[:parent]
-      arr_opts += [opts[:parents]].map { |p| ['-p', p] }.flatten if opts[:parents]
+      arr_opts += Array(opts[:parents]).map { |p| ['-p', p] }.flatten if opts[:parents]
       command('commit-tree', *arr_opts, redirect: "< #{escape t.path}")
     end
 
@@ -1106,6 +1098,22 @@ module Git
       version_parts.fill(0, version_parts.length...3)
     end
 
+    # Returns current_command_version <=> other_version
+    #
+    # @example
+    #   lib.current_command_version #=> [2, 42, 0]
+    #
+    #   lib.compare_version_to(2, 41, 0) #=> 1
+    #   lib.compare_version_to(2, 42, 0) #=> 0
+    #   lib.compare_version_to(2, 43, 0) #=> -1
+    #
+    # @param other_version [Array<Object>] the other version to compare to
+    # @return [Integer] -1 if this version is less than other_version, 0 if equal, or 1 if greater than
+    #
+    def compare_version_to(*other_version)
+      current_command_version <=> other_version
+    end
+
     def required_command_version
       [1, 6]
     end
@@ -1130,8 +1138,8 @@ module Git
     # @return [<String>] the names of the EVN variables involved in the git commands
     ENV_VARIABLE_NAMES = ['GIT_DIR', 'GIT_WORK_TREE', 'GIT_INDEX_FILE', 'GIT_SSH']
 
-    def command_lines(cmd, *opts)
-      cmd_op = command(cmd, *opts)
+    def command_lines(cmd, *opts, chdir: nil)
+      cmd_op = command(cmd, *opts, chdir: chdir)
       if cmd_op.encoding.name != "UTF-8"
         op = cmd_op.encode("UTF-8", "binary", :invalid => :replace, :undef => :replace)
       else
@@ -1177,7 +1185,7 @@ module Git
       restore_git_system_env_variables()
     end
 
-    def command(*cmd, redirect: '', chomp: true, &block)
+    def command(*cmd, redirect: '', chomp: true, chdir: nil, &block)
       Git::Lib.warn_if_old_command(self)
 
       raise 'cmd can not include a nested array' if cmd.any? { |o| o.is_a? Array }
@@ -1202,8 +1210,7 @@ module Git
 
       with_custom_env_variables do
         command_thread = Thread.new do
-          output = run_command(git_cmd, &block)
-          status = $?
+          output, status = run_command(git_cmd, chdir, &block)
         end
         command_thread.join
       end
@@ -1285,10 +1292,17 @@ module Git
       arr_opts
     end
 
-    def run_command(git_cmd, &block)
-      return IO.popen(git_cmd, &block) if block_given?
+    def run_command(git_cmd, chdir=nil, &block)
+      block ||= Proc.new do |io|
+        io.readlines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join
+      end
+
+      opts = {}
+      opts[:chdir] = File.expand_path(chdir) if chdir
 
-      `#{git_cmd}`.lines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join
+      Open3.popen2(git_cmd, opts) do |stdin, stdout, wait_thr|
+        [block.call(stdout), wait_thr.value]
+      end
     end
 
     def escape(s)

data/lib/git/status.rb

@@ -172,13 +172,12 @@ module Git
     def fetch_untracked
       ignore = @base.lib.ignored_files
 
-      Dir.chdir(@base.dir.path) do
-        Dir.glob('**/*', File::FNM_DOTMATCH) do |file|
-          next if @files[file] || File.directory?(file) ||
-                  ignore.include?(file) || file =~ %r{^.git\/.+}
+      root_dir = @base.dir.path
+      Dir.glob('**/*', File::FNM_DOTMATCH, base: root_dir) do |file|
+        next if @files[file] || File.directory?(File.join(root_dir, file)) ||
+                ignore.include?(file) || file =~ %r{^.git\/.+}
 
-          @files[file] = { path: file, untracked: true }
-        end
+        @files[file] = { path: file, untracked: true }
       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.18.0'
+  VERSION='1.19.1'
 end

data/lib/git.rb

@@ -139,6 +139,9 @@ module Git
   # @option options [Integer] :depth Create a shallow clone with a history
   #   truncated to the specified number of commits.
   #
+  # @option options [String] :filter Request that the server send a partial
+  #   clone according to the given filter
+  #
   # @option options [Logger] :log A logger to use for Git operations.  Git
   #   commands are logged at the `:info` level.  Additional logging is done
   #   at the `:debug` level.
@@ -241,7 +244,7 @@ module Git
     options.delete(:remote)
     repo = clone(repository, name, {:depth => 1}.merge(options))
     repo.checkout("origin/#{options[:branch]}") if options[:branch]
-    Dir.chdir(repo.dir.to_s) { FileUtils.rm_r '.git' }
+    FileUtils.rm_r File.join(repo.dir.to_s, '.git')
   end
 
   # Same as g.config, but forces it to be at the global level

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.1
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -157,11 +171,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: |
-  The Git Gem provides an API that can be used to create, read, and manipulate
-  Git repositories by wrapping system calls to the `git` binary. The API can be
-  used for working with Git in complex interactions including branching and
-  merging, object inspection and manipulation, history, patch generation and
-  more.
+  The git gem provides an API that can be used to
+  create, read, and manipulate Git repositories by wrapping system calls to the git
+  command line. The API can be used for working with Git in complex interactions
+  including branching and merging, object inspection and manipulation, history, patch
+  generation and more.
 email: schacon@gmail.com
 executables: []
 extensions: []
@@ -218,7 +232,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: http://rubydoc.info/gems/git/file.CHANGELOG.html
+  changelog_uri: https://rubydoc.info/gems/git/1.19.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/1.19.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -235,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - git 1.6.0.0, or greater
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories