git 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564087b850fc095e75b62f5fd231d27e7dc145b7839c795d8c84355cb0df0c67
-  data.tar.gz: 0d377c66918e25e2a52f1155db445657452be662553756c3e08cb5d66db29d2d
+  metadata.gz: df0d52946aa19627fbff62a47b86f694763e957e1f6d87b9a5e14e6cae46ff1d
+  data.tar.gz: f2b9e31a9cfb944da55c25b22b54aacd54d788e77ef2808d7cfba0a466cedb8a
 SHA512:
-  metadata.gz: 0e6bc7af5d099a33e79afabc655d62faa5e7ce7bcface1843f35a50fbafe2d02a26065b56d5cf2ec26fd7602363a232543ae8a5584952004d8253771a2753fdc
-  data.tar.gz: 732a2e8bbb690279caccc65dcedce95cb378d3554886574fbd71985b09dd77f74d3c82e5f0a71d5af19bddf943dd41b6b5a86be2e847205a26ff1db0ecaa2f1a
+  metadata.gz: 0a812bbdc6aabf7c63d30f96659edfe4a65a141dce613046d3f7e537f5105a80e48f6ae03cb30c4d806243cfd130b49bbc852f43df493191e26dfec2f03551f2
+  data.tar.gz: b0a634418e93055e3f3c2c5256176515aa990950f4927e2b0ee82055a87543f0695cf13ae4a1f5bd99ab1cec9f8e264153b8aa2ec3f4392c88c5890c17ce7c13

data/.github/workflows/continuous_integration.yml

@@ -5,6 +5,7 @@ on:
     branches: [master]
   pull_request:
     branches: [master]
+  workflow_dispatch:
 
 jobs:
   continuous_integration_build:
@@ -28,6 +29,9 @@ jobs:
 
     runs-on: ${{ matrix.operating-system }}
 
+    env:
+      JAVA_OPTS: -Djdk.io.File.enableADS=true
+
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2

data/CHANGELOG.md

@@ -5,6 +5,20 @@
 
 # Change Log
 
+## v1.13.0 (2022-12-10)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v1.12.0...v1.13.0)
+
+* 8349224 Update list of maintainers (#598)
+* 4fe8738 In ls-files do not unescape file paths with eval (#602)
+* 74b8e11 Add start_point option for checkout command (#597)
+* ff6dcf4 Do not assume the default branch is 'master' in tests
+* 8279298 Fix exception when Git is autoloaded (#594)
+
+## v1.12.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.12.0
+
 ## v1.11.0
 
 * 292087e Supress unneeded test output (#570)
@@ -147,4 +161,3 @@ See https://github.com/ruby-git/ruby-git/releases/tag/v1.4.0
 ## 1.0.1
 
 * Initial version
-

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gemspec :name => 'git'
+source 'https://rubygems.org'
 
+gemspec name: 'git'

data/MAINTAINERS.md

@@ -7,7 +7,6 @@
 
 When making changes in this repository, one of the maintainers below must review and approve your pull request.
 
-### Maintainers
-
+* [James Couball](https://github.com/jcouball)
+* [Frank Throckmorton](https://github.com/frankthrock)
 * [Per Lundberg](https://github.com/perlun)
-* [James Couball](https://github.com/jcouball)

data/README.md

@@ -108,7 +108,7 @@ g.index.writable?
 g.repo
 g.dir
 
-g.log   # returns array of Git::Commit objects
+g.log   # returns a Git::Log object, which is an Enumerator of Git::Commit objects
 g.log.since('2 weeks ago')
 g.log.between('v2.5', 'v2.6')
 g.log.each {|l| puts l.sha }
@@ -204,13 +204,23 @@ g = Git.init
   { :repository => '/opt/git/proj.git',
       :index => '/tmp/index'} )
 
-g = Git.clone(URI, NAME, :path => '/tmp/checkout')
+# Clone from a git url
+git_url = 'https://github.com/ruby-git/ruby-git.git'
+# Clone into the ruby-git directory
+g = Git.clone(git_url)
+
+# Clone into /tmp/clone/ruby-git-clean
+name = 'ruby-git-clean'
+path = '/tmp/clone'
+g = Git.clone(git_url, name, :path => path)
+g.dir #=> /tmp/clone/ruby-git-clean
+
 g.config('user.name', 'Scott Chacon')
 g.config('user.email', 'email@email.com')
 
 # Clone can take an optional logger
 logger = Logger.new
-g = Git.clone(URI, NAME, :log => logger)
+g = Git.clone(git_url, NAME, :log => logger)
 
 g.add                                   # git add -- "."
 g.add(:all=>true)                       # git add --all -- "."
@@ -234,6 +244,9 @@ g.commit('message', gpg_sign: true)
 key_id = '0A46826A'
 g.commit('message', gpg_sign: key_id)
 
+# Skip signing a commit (overriding any global gpgsign setting)
+g.commit('message', no_gpg_sign: true)
+
 g = Git.clone(repo, 'myrepo')
 g.chdir do
 new_file('test-file', 'blahblahblah')
@@ -252,6 +265,7 @@ g.branch('existing_branch').checkout
 g.branch('master').contains?('existing_branch')
 
 g.checkout('new_branch')
+g.checkout('new_branch', new_branch: true, start_point: 'master')
 g.checkout(g.branch('new_branch'))
 
 g.branch(name).merge(branch2)
@@ -278,6 +292,7 @@ g.remote(name).merge(branch)
 g.fetch
 g.fetch(g.remotes.first)
 g.fetch('origin', {:ref => 'some/ref/head'} )
+g.fetch(all: true, force: true, depth: 2)
 
 g.pull
 g.pull(Git::Repo, Git::Branch) # fetch and a merge

data/git.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
   s.requirements = ['git 1.6.0.0, or greater']
 
+  s.add_runtime_dependency 'addressable', '~> 2.8'
   s.add_runtime_dependency 'rchardet', '~> 1.8'
 
   s.add_development_dependency 'bump', '~> 0.10'
@@ -35,7 +36,7 @@ Gem::Specification.new do |s|
 
   unless RUBY_PLATFORM == 'java'
     s.add_development_dependency 'redcarpet', '~> 3.5'
-    s.add_development_dependency 'yard', '~> 0.9'
+    s.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
     s.add_development_dependency 'yardstick', '~> 0.9'
   end
 

data/lib/git/base.rb

@@ -17,10 +17,10 @@ module Git
     end
 
     # (see Git.clone)
-    def self.clone(repository, name, options = {})
-      new_options = Git::Lib.new(nil, options[:log]).clone(repository, name, options)
+    def self.clone(repository_url, directory, options = {})
+      new_options = Git::Lib.new(nil, options[:log]).clone(repository_url, directory, options)
       normalize_paths(new_options, bare: options[:bare] || options[:mirror])
-      self.new(new_options)
+      new(new_options)
     end
 
     # Returns (and initialize if needed) a Git::Config instance
@@ -336,7 +336,11 @@ module Git
 
     # fetches changes from a remote branch - this does not modify the working directory,
     # it just gets the changes from the remote if there are any
-    def fetch(remote = 'origin', opts={})
+    def fetch(remote = 'origin', opts = {})
+      if remote.is_a?(Hash)
+        opts = remote
+        remote = nil
+      end
       self.lib.fetch(remote, opts)
     end
 

data/lib/git/lib.rb

@@ -63,6 +63,8 @@ module Git
         @git_work_dir = base[:working_directory]
       end
       @logger = logger
+
+      Git::Lib.warn_if_old_command(self)
     end
 
     # creates or reinitializes the repository
@@ -95,9 +97,9 @@ module Git
     #
     # @return [Hash] the options to pass to {Git::Base.new}
     #
-    def clone(repository, name, opts = {})
+    def clone(repository_url, directory, opts = {})
       @path = opts[:path] || '.'
-      clone_dir = opts[:path] ? File.join(@path, name) : name
+      clone_dir = opts[:path] ? File.join(@path, directory) : directory
 
       arr_opts = []
       arr_opts << '--bare' if opts[:bare]
@@ -106,11 +108,11 @@ module Git
       arr_opts << '--config' << opts[:config] if opts[:config]
       arr_opts << '--origin' << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
       arr_opts << '--recursive' if opts[:recursive]
-      arr_opts << "--mirror" if opts[:mirror]
+      arr_opts << '--mirror' if opts[:mirror]
 
       arr_opts << '--'
 
-      arr_opts << repository
+      arr_opts << repository_url
       arr_opts << clone_dir
 
       command('clone', arr_opts)
@@ -486,7 +488,9 @@ module Git
       command_lines('ls-files', '--stage', location).each do |line|
         (info, file) = line.split("\t")
         (mode, sha, stage) = info.split
-        file = eval(file) if file =~ /^\".*\"$/ # This takes care of quoted strings returned from git
+        if file.start_with?('"') && file.end_with?('"')
+          file = Git::EscapedPath.new(file[1..-2]).unescape
+        end
         hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
       end
       hsh
@@ -647,7 +651,8 @@ module Git
     #  :date
     #  :no_verify
     #  :allow_empty_message
-    #  :gpg_sign
+    #  :gpg_sign (accepts true or a gpg key ID as a String)
+    #  :no_gpg_sign (conflicts with :gpg_sign)
     #
     # @param [String] message the commit message to be used
     # @param [Hash] opts the commit options to be used
@@ -661,13 +666,18 @@ module Git
       arr_opts << "--date=#{opts[:date]}" if opts[:date].is_a? String
       arr_opts << '--no-verify' if opts[:no_verify]
       arr_opts << '--allow-empty-message' if opts[:allow_empty_message]
-      if opts[:gpg_sign]
+
+      if opts[:gpg_sign] && opts[:no_gpg_sign]
+        raise ArgumentError, 'cannot specify :gpg_sign and :no_gpg_sign'
+      elsif opts[:gpg_sign]
         arr_opts <<
           if opts[:gpg_sign] == true
             '--gpg-sign'
           else
             "--gpg-sign=#{opts[:gpg_sign]}"
           end
+      elsif opts[:no_gpg_sign]
+        arr_opts << '--no-gpg-sign'
       end
 
       command('commit', arr_opts)
@@ -756,11 +766,21 @@ module Git
       command('branch', '-D', branch)
     end
 
+    # Runs checkout command to checkout or create branch
+    #
+    # accepts options:
+    #  :new_branch
+    #  :force
+    #  :start_point
+    #
+    # @param [String] branch
+    # @param [Hash] opts
     def checkout(branch, opts = {})
       arr_opts = []
       arr_opts << '-b' if opts[:new_branch] || opts[:b]
       arr_opts << '--force' if opts[:force] || opts[:f]
       arr_opts << branch
+      arr_opts << opts[:start_point] if opts[:start_point] && arr_opts.include?('-b')
 
       command('checkout', arr_opts)
     end
@@ -877,14 +897,15 @@ module Git
 
     def fetch(remote, opts)
       arr_opts = []
+      arr_opts << '--all' if opts[:all]
       arr_opts << '--tags' if opts[:t] || opts[:tags]
       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 << '--unshallow' if opts[:unshallow]
       arr_opts << '--depth' << opts[:depth] if opts[:depth]
-      arr_opts << '--'
-      arr_opts << remote
+      arr_opts << '--' if remote || opts[:ref]
+      arr_opts << remote if remote
       arr_opts << opts[:ref] if opts[:ref]
 
       command('fetch', arr_opts)
@@ -1020,6 +1041,13 @@ module Git
       (self.current_command_version <=>  self.required_command_version) >= 0
     end
 
+    def self.warn_if_old_command(lib)
+      return true if @version_checked
+      unless lib.meets_required_version?
+        $stderr.puts "[WARNING] The git gem requires git #{lib.required_command_version.join('.')} or later, but only found #{lib.current_command_version.join('.')}. You should probably upgrade."
+      end
+      @version_checked = true
+    end
 
     private
 

data/lib/git/url.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+
+module Git
+  # Methods for parsing a Git URL
+  #
+  # Any URL that can be passed to `git clone` can be parsed by this class.
+  #
+  # @see https://git-scm.com/docs/git-clone#_git_urls GIT URLs
+  # @see https://github.com/sporkmonger/addressable Addresable::URI
+  #
+  # @api public
+  #
+  class URL
+    # Regexp used to match a Git URL with an alternative SSH syntax
+    # such as `user@host:path`
+    #
+    GIT_ALTERNATIVE_SSH_SYNTAX = %r{
+      ^
+      (?:(?<user>[^@/]+)@)?  # user or nil
+      (?<host>[^:/]+)        # host is required
+      :(?!/)                 # : serparator is required, but must not be followed by /
+      (?<path>.*?)           # path is required
+      $
+    }x.freeze
+
+    # Parse a Git URL and return an Addressable::URI object
+    #
+    # The URI returned can be converted back to a string with 'to_s'. This is
+    # guaranteed to return the same URL string that was parsed.
+    #
+    # @example
+    #   uri = Git::URL.parse('https://github.com/ruby-git/ruby-git.git')
+    #     #=> #<Addressable::URI:0x44c URI:https://github.com/ruby-git/ruby-git.git>
+    #   uri.scheme #=> "https"
+    #   uri.host #=> "github.com"
+    #   uri.path #=> "/ruby-git/ruby-git.git"
+    #
+    #   Git::URL.parse('/Users/James/projects/ruby-git')
+    #     #=> #<Addressable::URI:0x438 URI:/Users/James/projects/ruby-git>
+    #
+    # @param url [String] the Git URL to parse
+    #
+    # @return [Addressable::URI] the parsed URI
+    #
+    def self.parse(url)
+      if !url.start_with?('file:') && (m = GIT_ALTERNATIVE_SSH_SYNTAX.match(url))
+        GitAltURI.new(user: m[:user], host: m[:host], path: m[:path])
+      else
+        Addressable::URI.parse(url)
+      end
+    end
+
+    # The directory `git clone` would use for the repository directory for the given URL
+    #
+    # @example
+    #   Git::URL.clone_to('https://github.com/ruby-git/ruby-git.git') #=> 'ruby-git'
+    #
+    # @param url [String] the Git URL containing the repository directory
+    #
+    # @return [String] the name of the repository directory
+    #
+    def self.clone_to(url, bare: false, mirror: false)
+      uri = parse(url)
+      path_parts = uri.path.split('/')
+      path_parts.pop if path_parts.last == '.git'
+      directory = path_parts.last
+      if bare || mirror
+        directory += '.git' unless directory.end_with?('.git')
+      elsif directory.end_with?('.git')
+        directory = directory[0..-5]
+      end
+      directory
+    end
+  end
+
+  # The URI for git's alternative scp-like syntax
+  #
+  # This class is necessary to ensure that #to_s returns the same string
+  # that was passed to the initializer.
+  #
+  # @api public
+  #
+  class GitAltURI < Addressable::URI
+    # Create a new GitAltURI object
+    #
+    # @example
+    #   uri = Git::GitAltURI.new(user: 'james', host: 'github.com', path: 'james/ruby-git')
+    #   uri.to_s #=> 'james@github.com/james/ruby-git'
+    #
+    # @param user [String, nil] the user from the URL or nil
+    # @param host [String] the host from the URL
+    # @param path [String] the path from the URL
+    #
+    def initialize(user:, host:, path:)
+      super(scheme: 'git-alt', user: user, host: host, path: path)
+    end
+
+    # Convert the URI to a String
+    #
+    # Addressible::URI forces path to be absolute by prepending a '/' to the
+    # path. This method removes the '/' when converting back to a string
+    # since that is what is expected by git. The following is a valid git URL:
+    #
+    #  `james@github.com:ruby-git/ruby-git.git`
+    #
+    # and the following (with the initial '/'' in the path) is NOT a valid git URL:
+    #
+    #  `james@github.com:/ruby-git/ruby-git.git`
+    #
+    # @example
+    #   uri = Git::GitAltURI.new(user: 'james', host: 'github.com', path: 'james/ruby-git')
+    #   uri.path #=> '/james/ruby-git'
+    #   uri.to_s #=> 'james@github.com:james/ruby-git'
+    #
+    # @return [String] the URI as a String
+    #
+    def to_s
+      if user
+        "#{user}@#{host}:#{path[1..-1]}"
+      else
+        "#{host}:#{path[1..-1]}"
+      end
+    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.11.0'
+  VERSION='1.13.0'
 end

data/lib/git.rb

@@ -21,16 +21,12 @@ require 'git/repository'
 require 'git/status'
 require 'git/stash'
 require 'git/stashes'
+require 'git/url'
 require 'git/version'
 require 'git/working_directory'
 require 'git/worktree'
 require 'git/worktrees'
 
-lib = Git::Lib.new(nil, nil)
-unless lib.meets_required_version?
-  $stderr.puts "[WARNING] The git gem requires git #{lib.required_command_version.join('.')} or later, but only found #{lib.current_command_version.join('.')}. You should probably upgrade."
-end
-
 # The Git module provides the basic functions to open a git
 # reference to work with. You can open a working directory,
 # open a bare repository, initialize a new repo or clone an
@@ -106,11 +102,23 @@ module Git
   # @see https://git-scm.com/docs/git-clone git clone
   # @see https://git-scm.com/docs/git-clone#_git_urls_a_id_urls_a GIT URLs
   #
-  # @param [URI, Pathname] repository The (possibly remote) repository to clone
+  # @param repository_url [URI, Pathname] The (possibly remote) repository url to clone
   #   from. See [GIT URLS](https://git-scm.com/docs/git-clone#_git_urls_a_id_urls_a)
   #   for more information.
   #
-  # @param [Pathname] name The directory to clone into.
+  # @param directory [Pathname, nil] The directory to clone into
+  #
+  #   If `directory` is a relative directory it is relative to the `path` option if
+  #   given. If `path` is not given, `directory` is relative to the current working
+  #   directory.
+  #
+  #   If `nil`, `directory` will be set to the basename of the last component of
+  #   the path from the `repository_url`. For example, for the URL:
+  #   `https://github.com/org/repo.git`, `directory` will be set to `repo`.
+  #
+  #   If the last component of the path is `.git`, the next-to-last component of
+  #   the path is used. For example, for the URL `/Users/me/foo/.git`, `directory`
+  #   will be set to `foo`.
   #
   # @param [Hash] options The options for this command (see list of valid
   #   options below)
@@ -157,8 +165,10 @@ module Git
   # @return [Git::Base] an object that can execute git commands in the context
   #   of the cloned local working copy or cloned repository.
   #
-  def self.clone(repository, name, options = {})
-    Base.clone(repository, name, options)
+  def self.clone(repository_url, directory = nil, options = {})
+    clone_to_options = options.select { |key, _value| %i[bare mirror].include?(key) }
+    directory ||= Git::URL.clone_to(repository_url, **clone_to_options)
+    Base.clone(repository_url, directory, options)
   end
 
   # Export the current HEAD (or a branch, if <tt>options[:branch]</tt>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-17 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,6 +125,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +189,7 @@ files:
 - lib/git/stash.rb
 - lib/git/stashes.rb
 - lib/git/status.rb
+- lib/git/url.rb
 - lib/git/version.rb
 - lib/git/working_directory.rb
 - lib/git/worktree.rb
@@ -196,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - git 1.6.0.0, or greater
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories