git 1.17.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c893cd566fdfc36e3f6ea4fc742d7665b5daf14c299ff1acd19c40de49e3eb2
-  data.tar.gz: cc08038a56beb1ba3195600e80a666d66a7d58dd1abb16d4e5282718cd067bcd
+  metadata.gz: b3c801f928c5b75999c02cecd054c0007a8e2f0460c27bc2b983741824d7b194
+  data.tar.gz: 861bf03f14ed76dcf43acefcc8fe33787e202a9af52e7789d6d1660f84b4fc51
 SHA512:
-  metadata.gz: 82e6441de9ff798080bddc79ca411386a7c20b5d4208d584fa12925777bb66de1ddc3532d512087eb815c083184d30cf445ef097a47cc8a8089027b1498820c1
-  data.tar.gz: f0657f1ee3f3142612fdd904bc8649207e6bc1a115cbb3a969105c99a0fff15c0d1851b755c527351f06b462e6ff22b98e85ed4139acdcdcf949c434417becb2
+  metadata.gz: 4a4bf752eb3332572f968ea23a5cc4a4e4547279f60ce2341d6d6d815f5d9f4cbd17237b266c9cd2850c77c2c9a189ff98034af5385333632f557e765cb7b64a
+  data.tar.gz: e678b9da94ccd8295347688d3dd3e400764da4af3f850ceaa0038e4ddb34804fd2cc3942119a9f66968b4c014fb07a040352c7b6494556298cebd826bc765fd8

data/CHANGELOG.md

@@ -5,6 +5,26 @@
 
 # Change Log
 
+## 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)
+
+Changes since v1.17.1:
+
+* f43d6 Fix branch name parsing to handle names that include slashes (#651)
+
 ## v1.17.1 (2023-03-06)
 
 [Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.17.0..v1.17.1)

data/README.md

@@ -188,6 +188,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()
@@ -299,6 +311,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

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/lib/git/branch.rb

@@ -1,11 +1,9 @@
 require 'git/path'
 
 module Git
-
   class Branch < Path
-    
     attr_accessor :full, :remote, :name
-    
+
     def initialize(base, name)
       @full = name
       @base = base
@@ -13,25 +11,25 @@ module Git
       @stashes = nil
       @remote, @name = parse_name(name)
     end
-    
+
     def gcommit
       @gcommit ||= @base.gcommit(@full)
       @gcommit
     end
-    
+
     def stashes
       @stashes ||= Git::Stashes.new(@base)
     end
-    
+
     def checkout
       check_if_create
       @base.checkout(@full)
     end
-    
+
     def archive(file, opts = {})
       @base.lib.archive(@full, file, opts)
     end
-    
+
     # g.branch('new_branch').in_branch do
     #   # create new file
     #   # do other stuff
@@ -47,26 +45,26 @@ module Git
       end
       @base.checkout(old_current)
     end
-    
+
     def create
       check_if_create
     end
-    
+
     def delete
       @base.lib.branch_delete(@name)
     end
-    
+
     def current
       determine_current
     end
-    
+
     def contains?(commit)
       !@base.lib.branch_contains(commit, self.name).empty?
     end
-    
+
     def merge(branch = nil, message = nil)
       if branch
-        in_branch do 
+        in_branch do
           @base.merge(branch, message)
           false
         end
@@ -76,7 +74,7 @@ module Git
         @base.merge(@name)
       end
     end
-    
+
     def update_ref(commit)
       if @remote
         @base.lib.update_ref("refs/remotes/#{@remote.name}/#{@name}", commit)
@@ -84,47 +82,62 @@ module Git
         @base.lib.update_ref("refs/heads/#{@name}", commit)
       end
     end
-    
+
     def to_a
       [@full]
     end
-    
+
     def to_s
       @full
     end
-    
-    private 
 
-      def check_if_create
-        @base.lib.branch_new(@name) rescue nil
-      end
-      
-      def determine_current
-        @base.lib.branch_current == @name
-      end
-    
-      # Given a full branch name return an Array containing the remote and branch names.
-      #
-      # Removes 'remotes' from the beggining of the name (if present).
-      # Takes the second part (splittign by '/') as the remote name.
-      # Takes the rest as the repo name (can also hold one or more '/').
-      #
-      # Example:
-      #   parse_name('master') #=> [nil, 'master']
-      #   parse_name('origin/master') #=> ['origin', 'master']
-      #   parse_name('remotes/origin/master') #=> ['origin', 'master']
-      #   parse_name('origin/master/v2') #=> ['origin', 'master/v2'] 
-      #
-      # param [String] name branch full name.
-      # return [<Git::Remote,NilClass,String>] an Array containing the remote and branch names. 
-      def parse_name(name)
-        if name.match(/^(?:remotes\/)?([^\/]+)\/(.+)/)
-          return [Git::Remote.new(@base, $1), $2]
-        end
+    private
 
-        return [nil, name]
-      end
-    
+    def check_if_create
+      @base.lib.branch_new(@name) rescue nil
+    end
+
+    def determine_current
+      @base.lib.branch_current == @name
+    end
+
+    BRANCH_NAME_REGEXP = %r{
+      ^
+        # Optional 'refs/remotes/' at the beggining to specify a remote tracking branch
+        # with a <remote_name>. <remote_name> is nil if not present.
+        (?:
+          (?:(?:refs/)?remotes/)(?<remote_name>[^/]+)/
+        )?
+        (?<branch_name>.*)
+      $
+    }x
+
+    # Given a full branch name return an Array containing the remote and branch names.
+    #
+    # Removes 'remotes' from the beggining of the name (if present).
+    # Takes the second part (splittign by '/') as the remote name.
+    # Takes the rest as the repo name (can also hold one or more '/').
+    #
+    # Example:
+    #   # local branches
+    #   parse_name('master') #=> [nil, 'master']
+    #   parse_name('origin/master') #=> [nil, 'origin/master']
+    #   parse_name('origin/master/v2') #=> [nil, 'origin/master']
+    #
+    #   # remote branches
+    #   parse_name('remotes/origin/master') #=> ['origin', 'master']
+    #   parse_name('remotes/origin/master/v2') #=> ['origin', 'master/v2']
+    #   parse_name('refs/remotes/origin/master') #=> ['origin', 'master']
+    #   parse_name('refs/remotes/origin/master/v2') #=> ['origin', 'master/v2']
+    #
+    # param [String] name branch full name.
+    # return [<Git::Remote,NilClass,String>] an Array containing the remote and branch names.
+    def parse_name(name)
+      # Expect this will always match
+      match = name.match(BRANCH_NAME_REGEXP)
+      remote = match[:remote_name] ? Git::Remote.new(@base, match[:remote_name]) : nil
+      branch_name = match[:branch_name]
+      [ remote, branch_name ]
+    end
   end
-  
 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

@@ -101,7 +101,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 << '--config' << opts[:config] if opts[:config]
+      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]
@@ -951,6 +951,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]

data/lib/git/version.rb

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

data/lib/git.rb

@@ -133,6 +133,9 @@ 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.
   #
@@ -166,6 +169,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.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.18.0
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable