git 1.17.2 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cebf2eab3cc2c8cc605b1e3b9aeafa2f2c82ef0a50be725fc211fdb55a7980c0
-  data.tar.gz: 9df1a5d2f067aa183a65cea1cd21e7260b72213f92c50b60bda26f261b2e7d23
+  metadata.gz: 41e2cebd7f83840b2e72176aa0d0a9f7b2441dbbe26f916b795877037bc82b6c
+  data.tar.gz: 03d373beb11219313117e419afdfce5be3ee225fd2f69dbee8d2e75b76ff7f10
 SHA512:
-  metadata.gz: 57019fb39b7476d7ee5d97fd1c21f1bffa3b1fbd59413e5bb602794c106f38c2bc528c1a86b98b89bc835976671ea836a1bdf911aa9a281b81b97d221c12b80d
-  data.tar.gz: d2f2927fbdf6b13b66d931183d6effb5fbb651e10c77a393e6b035ccc88e5b6ffd60dbed859fa6c400cd4551df253be89074e20aaa0f40379b609e79bd3553fa
+  metadata.gz: f0eb02c8af807265598c6e1fce6910d46dc6de257b4874e5957a65fd5788457eb084a4bec94b9e20ab69f05e4dff1d8bd7704f5a5af80679e0ab0ed819f3ef06
+  data.tar.gz: 78e566642f10ce5d18ff7112e864a9b1e4b6347cb4445abe5d1e0dea2e6f4b316e7218b896fdef39e17efdb928a0b1a2a2d169b640675f6d282f2537f99dfc86

data/CHANGELOG.md

@@ -5,6 +5,33 @@
 
 # Change Log
 
+## 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)
+
+Changes since v1.17.2:
+
+* 3c70 Add support for `--update-head-ok` to `fetch` (#660)
+* b53d Do not generate yard documentation when building in TruffleRuby (#659)
+* 5af1 Correctly report command output when there is an error (#658)
+* b27a Add test to ensure that `Git.open` works to open a submodule (#655)
+* 5b0e Update Git.clone to set multiple config variables (#653)
+
 ## v1.17.2 (2023-03-07)
 
 [Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.17.1..v1.17.2)

data/README.md

@@ -113,6 +113,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 }
@@ -188,6 +189,18 @@ end
 g.config('user.name')  # returns 'Scott Chacon'
 g.config # returns whole config hash
 
+# Configuration can be set when cloning using the :config option.
+# This option can be an single configuration String or an Array
+# if multiple config items need to be set.
+#
+g = Git.clone(
+  git_uri, destination_path,
+  :config => [
+    'core.sshCommand=ssh -i /home/user/.ssh/id_rsa',
+    'submodule.recurse=true'
+  ]
+)
+
 g.tags # returns array of Git::Tag objects
 
 g.show()
@@ -224,6 +237,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)
@@ -270,6 +286,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'))
@@ -299,6 +318,7 @@ g.fetch
 g.fetch(g.remotes.first)
 g.fetch('origin', {:ref => 'some/ref/head'} )
 g.fetch(all: true, force: true, depth: 2)
+g.fetch('origin', {:'update-head-ok' => true})
 
 g.pull
 g.pull(Git::Repo, Git::Branch) # fetch and a merge
@@ -322,6 +342,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/Rakefile

@@ -18,7 +18,7 @@ task :test do
 end
 default_tasks << :test
 
-unless RUBY_PLATFORM == 'java'
+unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
   #
   # YARD documentation for this project can NOT be built with JRuby.
   # This project uses the redcarpet gem which can not be installed on JRuby.

data/git.gemspec

@@ -32,6 +32,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/failed_error.rb

@@ -14,18 +14,20 @@ module Git
   class FailedError < Git::GitExecuteError
     # Create a FailedError object
     #
+    # Since this gem redirects stderr to stdout, the stdout of the process is used.
+    #
     # @example
     #   `exit 1` # set $? appropriately for this example
-    #   result = Git::CommandLineResult.new(%w[git status], $?, '', "failed")
+    #   result = Git::CommandLineResult.new(%w[git status], $?, 'stdout', 'stderr')
     #   error = Git::FailedError.new(result)
     #   error.message #=>
-    #     "[\"git\", \"status\"]\nstatus: pid 89784 exit 1\nstderr: \"failed\""
+    #     "[\"git\", \"status\"]\nstatus: pid 89784 exit 1\noutput: \"stdout\""
     #
     # @param result [Git::CommandLineResult] the result of the git command including
     #   the git command, status, stdout, and stderr
     #
     def initialize(result)
-      super("#{result.git_cmd}\nstatus: #{result.status}\nstderr: #{result.stderr.inspect}")
+      super("#{result.git_cmd}\nstatus: #{result.status}\noutput: #{result.stdout.inspect}")
       @result = result
     end
 
@@ -35,14 +37,14 @@ module Git
     #
     # @example
     #   `exit 1` # set $? appropriately for this example
-    #   result = Git::CommandLineResult.new(%w[git status], $?, '', "failed")
+    #   result = Git::CommandLineResult.new(%w[git status], $?, 'stdout', 'stderr')
     #   error = Git::FailedError.new(result)
     #   error.result #=>
     #     #<Git::CommandLineResult:0x00000001046bd488
     #       @git_cmd=["git", "status"],
     #       @status=#<Process::Status: pid 89784 exit 1>,
-    #       @stderr="failed",
-    #       @stdout="">
+    #       @stderr="stderr",
+    #       @stdout="stdout">
     #
     # @return [Git::CommandLineResult]
     #

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,7 +103,8 @@ 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 << '--config' << opts[:config] if opts[:config]
+      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]
       arr_opts << '--mirror' if opts[:mirror]
@@ -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
@@ -951,6 +941,7 @@ module Git
       arr_opts << '--prune' if opts[:p] || opts[:prune]
       arr_opts << '--prune-tags' if opts[:P] || opts[:'prune-tags']
       arr_opts << '--force' if opts[:f] || opts[:force]
+      arr_opts << '--update-head-ok' if opts[:u] || opts[:'update-head-ok']
       arr_opts << '--unshallow' if opts[:unshallow]
       arr_opts << '--depth' << opts[:depth] if opts[:depth]
       arr_opts << '--' if remote || opts[:ref]
@@ -981,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
@@ -1040,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
 
@@ -1105,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
@@ -1129,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
@@ -1176,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 }
@@ -1201,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
@@ -1284,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.17.2'
+  VERSION='1.19.0'
 end

data/lib/git.rb

@@ -133,9 +133,15 @@ module Git
   # @option options [String] :branch The name of a branch or tag to checkout
   #   instead of the default branch.
   #
+  # @option options [Array, String] :config A list of configuration options to
+  #  set on the newly created repository.
+  #
   # @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.
@@ -166,6 +172,18 @@ module Git
   # @example Create a bare repository in the directory `ruby-git.git`
   #   git = Git.clone('https://github.com/ruby-git/ruby-git.git', bare: true)
   #
+  # @example Clone a repository and set a single config option
+  #   git = Git.clone(
+  #     'https://github.com/ruby-git/ruby-git.git',
+  #     config: 'submodule.recurse=true'
+  #   )
+  #
+  # @example Clone a repository and set multiple config options
+  #   git = Git.clone(
+  #     'https://github.com/ruby-git/ruby-git.git',
+  #     config: ['user.name=John Doe', 'user.email=john@doe.com']
+  #   )
+  #
   # @return [Git::Base] an object that can execute git commands in the context
   #   of the cloned local working copy or cloned repository.
   #
@@ -226,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.17.2
+  version: 1.19.0
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-12-29 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
@@ -235,7 +249,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.4.14
 signing_key:
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories