git 1.19.1 → 4.4.5

data/lib/git/status.rb

@@ -1,108 +1,46 @@
+# frozen_string_literal: true
+
 module Git
+  # The Status class gets the status of a git repository. It identifies which
+  # files have been modified, added, or deleted, including untracked files.
+  # The Status object is an Enumerable of StatusFile objects.
   #
-  # A class for git status
+  # @api public
   #
   class Status
     include Enumerable
 
+    # @param base [Git::Base] The base git object
     def initialize(base)
       @base = base
-      construct_status
-    end
-
-    #
-    # Returns an Enumerable containing files that have changed from the
-    # git base directory
-    #
-    # @return [Enumerable]
-    def changed
-      @files.select { |_k, f| f.type == 'M' }
-    end
-
-    #
-    # Determines whether the given file has been changed.
-    # File path starts at git base directory
-    #
-    # @param file [String] The name of the file.
-    # @example Check if lib/git.rb has changed.
-    #     changed?('lib/git.rb')
-    # @return [Boolean]
-    def changed?(file)
-      changed.member?(file)
+      # The factory returns a hash of file paths to StatusFile objects.
+      @files = StatusFileFactory.new(base).construct_files
     end
 
-    #
-    # Returns an Enumerable containing files that have been added.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def added
-      @files.select { |_k, f| f.type == 'A' }
-    end
+    # File status collections, memoized for performance.
+    def changed   = @changed ||= select_files { |f| f.type == 'M' }
+    def added     = @added ||= select_files { |f| f.type == 'A' }
+    def deleted   = @deleted ||= select_files { |f| f.type == 'D' }
+    # This works with `true` or `nil`
+    def untracked = @untracked ||= select_files(&:untracked)
 
-    #
-    # Determines whether the given file has been added to the repository
-    # File path starts at git base directory
-    #
-    # @param file [String] The name of the file.
-    # @example Check if lib/git.rb is added.
-    #     added?('lib/git.rb')
-    # @return [Boolean]
-    def added?(file)
-      added.member?(file)
-    end
+    # Predicate methods to check the status of a specific file.
+    def changed?(file)   = file_in_collection?(:changed, file)
+    def added?(file)     = file_in_collection?(:added, file)
+    def deleted?(file)   = file_in_collection?(:deleted, file)
+    def untracked?(file) = file_in_collection?(:untracked, file)
 
-    #
-    # Returns an Enumerable containing files that have been deleted.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def deleted
-      @files.select { |_k, f| f.type == 'D' }
-    end
-
-    #
-    # Determines whether the given file has been deleted from the repository
-    # File path starts at git base directory
-    #
-    # @param file [String] The name of the file.
-    # @example Check if lib/git.rb is deleted.
-    #     deleted?('lib/git.rb')
-    # @return [Boolean]
-    def deleted?(file)
-      deleted.member?(file)
-    end
-
-    #
-    # Returns an Enumerable containing files that are not tracked in git.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def untracked
-      @files.select { |_k, f| f.untracked }
-    end
-
-    #
-    # Determines whether the given file has is tracked by git.
-    # File path starts at git base directory
-    #
-    # @param file [String] The name of the file.
-    # @example Check if lib/git.rb is an untracked file.
-    #     untracked?('lib/git.rb')
-    # @return [Boolean]
-    def untracked?(file)
-      untracked.member?(file)
-    end
+    # Access a status file by path, or iterate over all status files.
+    def [](file) = @files[file]
+    def each(&) = @files.values.each(&)
 
+    # Returns a formatted string representation of the status.
     def pretty
-      out = ''
-      each do |file|
-        out << pretty_file(file)
-      end
-      out << "\n"
-      out
+      map { |file| pretty_file(file) }.join << "\n"
     end
 
+    private
+
     def pretty_file(file)
       <<~FILE
         #{file.path}
@@ -114,84 +52,107 @@ module Git
       FILE
     end
 
-    # enumerable method
+    def select_files(&block)
+      @files.select { |_path, file| block.call(file) }
+    end
+
+    def file_in_collection?(collection_name, file_path)
+      collection = public_send(collection_name)
+      if ignore_case?
+        downcased_keys(collection_name).include?(file_path.downcase)
+      else
+        collection.key?(file_path)
+      end
+    end
 
-    def [](file)
-      @files[file]
+    def downcased_keys(collection_name)
+      @_downcased_keys ||= {}
+      @_downcased_keys[collection_name] ||=
+        public_send(collection_name).keys.to_set(&:downcase)
     end
 
-    def each(&block)
-      @files.values.each(&block)
+    def ignore_case?
+      return @_ignore_case if defined?(@_ignore_case)
+
+      @_ignore_case = (@base.config('core.ignoreCase') == 'true')
+    rescue Git::FailedError
+      @_ignore_case = false
     end
 
-    # subclass that does heavy lifting
+    # Represents a single file's status in the git repository. Each instance
+    # holds information about a file's state in the index and working tree.
     class StatusFile
-      attr_accessor :path, :type, :stage, :untracked
-      attr_accessor :mode_index, :mode_repo
-      attr_accessor :sha_index, :sha_repo
+      attr_reader :path, :type, :stage, :mode_index, :mode_repo,
+                  :sha_index, :sha_repo, :untracked
 
       def initialize(base, hash)
-        @base = base
-        @path = hash[:path]
-        @type = hash[:type]
-        @stage = hash[:stage]
+        @base       = base
+        @path       = hash[:path]
+        @type       = hash[:type]
+        @stage      = hash[:stage]
         @mode_index = hash[:mode_index]
-        @mode_repo = hash[:mode_repo]
-        @sha_index = hash[:sha_index]
-        @sha_repo = hash[:sha_repo]
-        @untracked = hash[:untracked]
+        @mode_repo  = hash[:mode_repo]
+        @sha_index  = hash[:sha_index]
+        @sha_repo   = hash[:sha_repo]
+        @untracked  = hash[:untracked]
       end
 
+      # Returns a Git::Object::Blob for either the index or repo version of the file.
       def blob(type = :index)
-        if type == :repo
-          @base.object(@sha_repo)
-        else
-          begin
-            @base.object(@sha_index)
-          rescue
-            @base.object(@sha_repo)
-          end
-        end
+        sha = type == :repo ? sha_repo : (sha_index || sha_repo)
+        @base.object(sha) if sha
       end
     end
 
-    private
-
-    def construct_status
-      @files = @base.lib.ls_files
-
-      fetch_untracked
-      fetch_modified
-      fetch_added
+    # A factory class responsible for fetching git status data and building
+    # a hash of StatusFile objects.
+    # @api private
+    class StatusFileFactory
+      def initialize(base)
+        @base = base
+        @lib = base.lib
+      end
 
-      @files.each do |k, file_hash|
-        @files[k] = StatusFile.new(@base, file_hash)
+      # Gathers all status data and builds a hash of file paths to
+      # StatusFile objects.
+      def construct_files
+        files_data = fetch_all_files_data
+        files_data.transform_values do |data|
+          StatusFile.new(@base, data)
+        end
       end
-    end
 
-    def fetch_untracked
-      ignore = @base.lib.ignored_files
+      private
 
-      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\/.+}
+      # Fetches and merges status information from multiple git commands.
+      def fetch_all_files_data
+        files = @lib.ls_files # Start with files tracked in the index.
+        merge_untracked_files(files)
+        merge_modified_files(files)
+        merge_head_diffs(files)
+        files
+      end
 
-        @files[file] = { path: file, untracked: true }
+      def merge_untracked_files(files)
+        @lib.untracked_files.each do |file|
+          files[file] = { path: file, untracked: true }
+        end
       end
-    end
 
-    def fetch_modified
-      # find modified in tree
-      @base.lib.diff_files.each do |path, data|
-        @files[path] ? @files[path].merge!(data) : @files[path] = data
+      def merge_modified_files(files)
+        # Merge changes between the index and the working directory.
+        @lib.diff_files.each do |path, data|
+          (files[path] ||= {}).merge!(data)
+        end
       end
-    end
 
-    def fetch_added
-      # find added but not committed - new files
-      @base.lib.diff_index('HEAD').each do |path, data|
-        @files[path] ? @files[path].merge!(data) : @files[path] = data
+      def merge_head_diffs(files)
+        return if @lib.empty?
+
+        # Merge changes between HEAD and the index.
+        @lib.diff_index('HEAD').each do |path, data|
+          (files[path] ||= {}).merge!(data)
+        end
       end
     end
   end

data/lib/git/url.rb

@@ -23,7 +23,7 @@ module Git
       :(?!/)                 # : serparator is required, but must not be followed by /
       (?<path>.*?)           # path is required
       $
-    }x.freeze
+    }x
 
     # Parse a Git URL and return an Addressable::URI object
     #
@@ -118,9 +118,9 @@ module Git
     #
     def to_s
       if user
-        "#{user}@#{host}:#{path[1..-1]}"
+        "#{user}@#{host}:#{path[1..]}"
       else
-        "#{host}:#{path[1..-1]}"
+        "#{host}:#{path[1..]}"
       end
     end
   end

data/lib/git/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='1.19.1'
+  VERSION = '4.4.5'
 end

data/lib/git/working_directory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Git
   class WorkingDirectory < Git::Path
   end

data/lib/git/worktree.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 require 'git/path'
 
 module Git
-
-  class Worktree < Path
-
-    attr_accessor :full, :dir, :gcommit
+  # A worktree in a Git repository
+  class Worktree
+    attr_accessor :full, :dir
 
     def initialize(base, dir, gcommit = nil)
       @full = dir
-      @full += ' ' + gcommit if !gcommit.nil?
+      @full += " #{gcommit}" unless gcommit.nil?
       @base = base
       @dir = dir
       @gcommit = gcommit

data/lib/git/worktrees.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Git
   # object that holds all the available worktrees
   class Worktrees
-
     include Enumerable
 
     def initialize(base)
@@ -21,20 +22,19 @@ module Git
       @worktrees.size
     end
 
-    def each(&block)
-      @worktrees.values.each(&block)
+    def each(&)
+      @worktrees.values.each(&)
     end
 
     def [](worktree_name)
-      @worktrees.values.inject(@worktrees) do |worktrees, worktree|
+      @worktrees.values.each_with_object(@worktrees) do |worktree, worktrees|
         worktrees[worktree.full] ||= worktree
-        worktrees
       end[worktree_name.to_s]
     end
 
     def to_s
       out = ''
-      @worktrees.each do |k, b|
+      @worktrees.each_value do |b|
         out << b.to_s << "\n"
       end
       out

data/lib/git.rb

@@ -1,19 +1,44 @@
-# Add the directory containing this file to the start of the load path if it
-# isn't there already.
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# frozen_string_literal: true
+
+require 'active_support/deprecation'
+
+# Define Git::Deprecation before requiring the rest of the library to ensure that
+# any deprecation warnings emitted during the loading of the library are properly
+# configured according to the GIT_DEPRECATION_BEHAVIOR environment variable.
+#
+module Git
+  # The deprecation instance used to emit deprecation warnings for the Git gem
+  #
+  # @api public
+  Deprecation = ActiveSupport::Deprecation.new('5.0.0', 'Git')
+
+  if (behavior = ENV.fetch('GIT_DEPRECATION_BEHAVIOR', nil))
+    behavior = behavior.strip
+    allowed_behaviors = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS.keys.map(&:to_s)
+
+    unless allowed_behaviors.include?(behavior)
+      raise ArgumentError,
+            "Invalid GIT_DEPRECATION_BEHAVIOR=#{behavior.inspect}; " \
+            "expected one of: #{allowed_behaviors.join(', ')}"
+    end
+
+    Deprecation.behavior = behavior.to_sym
+  end
+end
 
 require 'git/author'
 require 'git/base'
 require 'git/branch'
 require 'git/branches'
 require 'git/command_line_result'
+require 'git/command_line'
 require 'git/config'
 require 'git/diff'
 require 'git/encoding_utils'
+require 'git/errors'
 require 'git/escaped_path'
-require 'git/failed_error'
-require 'git/git_execute_error'
+require 'git/fsck_object'
+require 'git/fsck_result'
 require 'git/index'
 require 'git/lib'
 require 'git/log'
@@ -21,7 +46,6 @@ require 'git/object'
 require 'git/path'
 require 'git/remote'
 require 'git/repository'
-require 'git/signaled_error'
 require 'git/status'
 require 'git/stash'
 require 'git/stashes'
@@ -38,17 +62,33 @@ require 'git/worktrees'
 #
 # @author Scott Chacon (mailto:schacon@gmail.com)
 #
-module Git
-  #g.config('user.name', 'Scott Chacon') # sets value
-  #g.config('user.email', 'email@email.com')  # sets value
-  #g.config('user.name')  # returns 'Scott Chacon'
-  #g.config # returns whole config hash
+module Git # rubocop:disable Style/OneClassPerFile
+  # Internal alias for Git::Lib, used by the gem itself after the public constant
+  # is deprecated. Code outside the gem should not reference this constant.
+  # @api private
+  LibImpl = remove_const(:Lib)
+
+  # @api private
+  def self.const_missing(name)
+    return super unless name == :Lib
+
+    Git::Deprecation.warn(
+      'Git::Lib is deprecated and will be removed in version 5.x. ' \
+      'Use the #lib accessor on the object returned by Git.init, Git.open, or Git.clone instead.'
+    )
+    const_set(:Lib, LibImpl)
+  end
+
+  # g.config('user.name', 'Scott Chacon') # sets value
+  # g.config('user.email', 'email@email.com')  # sets value
+  # g.config('user.name')  # returns 'Scott Chacon'
+  # g.config # returns whole config hash
   def config(name = nil, value = nil)
-    lib = Git::Lib.new
-    if(name && value)
+    lib = LibImpl.new
+    if name && value
       # set value
       lib.config_set(name, value)
-    elsif (name)
+    elsif name
       # return value
       lib.config_get(name)
     else
@@ -62,7 +102,7 @@ module Git
   end
 
   def self.config
-    return Base.config
+    Base.config
   end
 
   def global_config(name = nil, value = nil)
@@ -90,6 +130,12 @@ module Git
   # @param [Hash] options The options for this command (see list of valid
   #   options below)
   #
+  # @option options [String, nil] :git_ssh An optional custom SSH command
+  #
+  #   - If not specified, uses the global config (Git.configure { |c| c.git_ssh = ... }).
+  #   - If nil, disables SSH for this instance.
+  #   - If a non-empty string, uses that value for this instance.
+  #
   # @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.
@@ -142,6 +188,20 @@ module Git
   # @option options [String] :filter Request that the server send a partial
   #   clone according to the given filter
   #
+  # @option options [Boolean, nil] :single_branch Control whether the clone
+  #   limits fetch refspecs to a single branch.
+  #   - If nil (default), no flag is passed and the Git default is used.
+  #   - If true, `--single-branch` is passed to limit the refspec to the
+  #     checkout branch.
+  #   - If false, `--no-single-branch` is passed to broaden the refspec (useful
+  #     for shallow clones that should include all branches).
+  #
+  # @option options [String, nil] :git_ssh An optional custom SSH command
+  #
+  #   - If not specified, uses the global config (Git.configure { |c| c.git_ssh = ... }).
+  #   - If nil, disables SSH for this instance.
+  #   - If a non-empty string, uses that value for this instance.
+  #
   # @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.
@@ -184,11 +244,18 @@ module Git
   #     config: ['user.name=John Doe', 'user.email=john@doe.com']
   #   )
   #
+  # @example Clone using a specific SSH key
+  #   git = Git.clone(
+  #     'git@github.com:ruby-git/ruby-git.git',
+  #     'local-dir',
+  #     git_ssh: 'ssh -i /path/to/private_key'
+  #   )
+  #
   # @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_url, directory = nil, options = {})
-    clone_to_options = options.select { |key, _value| %i[bare mirror].include?(key) }
+    clone_to_options = options.slice(:bare, :mirror)
     directory ||= Git::URL.clone_to(repository_url, **clone_to_options)
     Base.clone(repository_url, directory, options)
   end
@@ -213,7 +280,8 @@ module Git
   # @example with the logging option
   #   logger = Logger.new(STDOUT, level: Logger::INFO)
   #   Git.default_branch('.', log: logger) # => 'master'
-  #   I, [2022-04-13T16:01:33.221596 #18415]  INFO -- : git '-c' 'core.quotePath=true' '-c' 'color.ui=false' ls-remote '--symref' '--' '.' 'HEAD'  2>&1
+  #   I, [2022-04-13T16:01:33.221596 #18415]  INFO -- : git '-c' 'core.quotePath=true'
+  #     '-c' 'color.ui=false' ls-remote '--symref' '--' '.' 'HEAD'  2>&1
   #
   # @param repository [URI, Pathname, String] The (possibly remote) repository to get the default branch name for
   #
@@ -240,25 +308,37 @@ module Git
   # See +clone+ for options.  Does not obey the <tt>:remote</tt> option,
   # since the .git info will be deleted anyway; always uses the default
   # remote, 'origin.'
+  #
+  # <tt>options[:branch]</tt> is the short name of the ref: a branch name such as
+  # 'main' or a tag name such as 'v1.0.0'. A full ref path such as
+  # 'refs/tags/v1.0.0' or a commit SHA is not accepted.
+  #
+  # Removing +.git+ is not atomic. If it fails, the exported files are complete and
+  # usable, but the directory keeps whatever part of +.git+ could not be deleted.
+  # Nothing is cleaned up, because the exported files are the deliverable and the
+  # leftover has to be removed by hand once the cause of the failure is fixed.
+  #
+  # @raise [SystemCallError] if the +.git+ directory cannot be removed. The exported
+  #   files are left in place, and the directory keeps whatever part of +.git+ could
+  #   not be deleted.
   def self.export(repository, name, options = {})
     options.delete(:remote)
-    repo = clone(repository, name, {:depth => 1}.merge(options))
-    repo.checkout("origin/#{options[:branch]}") if options[:branch]
+    repo = clone(repository, name, { depth: 1 }.merge(options))
     FileUtils.rm_r File.join(repo.dir.to_s, '.git')
   end
 
   # Same as g.config, but forces it to be at the global level
   #
-  #g.config('user.name', 'Scott Chacon') # sets value
-  #g.config('user.email', 'email@email.com')  # sets value
-  #g.config('user.name')  # returns 'Scott Chacon'
-  #g.config # returns whole config hash
+  # g.config('user.name', 'Scott Chacon') # sets value
+  # g.config('user.email', 'email@email.com')  # sets value
+  # g.config('user.name')  # returns 'Scott Chacon'
+  # g.config # returns whole config hash
   def self.global_config(name = nil, value = nil)
-    lib = Git::Lib.new(nil, nil)
-    if(name && value)
+    lib = LibImpl.new(nil, nil)
+    if name && value
       # set value
       lib.global_config_set(name, value)
-    elsif (name)
+    elsif name
       # return value
       lib.global_config_get(name)
     else
@@ -296,6 +376,12 @@ module Git
   #   and converted to an absolute path using
   #   [File.expand_path](https://www.rubydoc.info/stdlib/core/File.expand_path).
   #
+  # @option options [String, nil] :git_ssh An optional custom SSH command
+  #
+  #   - If not specified, uses the global config (Git.configure { |c| c.git_ssh = ... }).
+  #   - If nil, disables SSH for this instance.
+  #   - If a non-empty string, uses that value for this instance.
+  #
   # @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.
@@ -330,7 +416,7 @@ module Git
   # @param [String|NilClass] location the target repository location or nil for '.'
   # @return [{String=>Hash}] the available references of the target repo.
   def self.ls_remote(location = nil, options = {})
-    Git::Lib.new.ls_remote(location, options)
+    LibImpl.new.ls_remote(location, options)
   end
 
   # Open a an existing Git working directory
@@ -370,6 +456,12 @@ module Git
   # @option options [Pathname] :index used to specify a non-standard path to an
   #   index file.  The default is `"#{working_dir}/.git/index"`
   #
+  # @option options [String, nil] :git_ssh An optional custom SSH command
+  #
+  #   - If not specified, uses the global config (Git.configure { |c| c.git_ssh = ... }).
+  #   - If nil, disables SSH for this instance.
+  #   - If a non-empty string, uses that value for this instance.
+  #
   # @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.
@@ -380,4 +472,15 @@ module Git
   def self.open(working_dir, options = {})
     Base.open(working_dir, options)
   end
+
+  # Return the version of the git binary
+  #
+  # @example
+  #  Git.binary_version # => [2, 46, 0]
+  #
+  # @return [Array<Integer>] the version of the git binary
+  #
+  def self.binary_version(binary_path = Git::Base.config.binary_path)
+    Base.binary_version(binary_path)
+  end
 end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.0",
+    "@commitlint/config-conventional": "^19.8.0",
+    "husky": "^9.1.7"
+  },
+  "scripts": {
+    "prepare": "husky"
+  }
+}