git 4.0.0 → 4.0.1

data/lib/git/remote.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Git
-  class Remote < Path
-
+  # A remote in a Git repository
+  class Remote
     attr_accessor :name, :url, :fetch_opts
 
     def initialize(base, name)
@@ -13,7 +13,7 @@ module Git
       @fetch_opts = config['fetch']
     end
 
-    def fetch(opts={})
+    def fetch(opts = {})
       @base.fetch(@name, opts)
     end
 
@@ -35,6 +35,5 @@ module Git
     def to_s
       @name
     end
-
   end
 end

data/lib/git/repository.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module Git
-
   class Repository < Path
   end
-
 end

data/lib/git/stash.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
 module Git
+  # A stash in a Git repository
   class Stash
+    def initialize(base, message, existing = nil, save: nil)
+      unless existing.nil?
+        Git::Deprecation.warn(
+          'The "existing" argument is deprecated and will be removed in a future version. Use "save:" instead.'
+        )
+      end
+
+      # default is false
+      save = existing.nil? && save.nil? ? false : save | existing
 
-    def initialize(base, message, existing=false)
       @base = base
       @message = message
-      save unless existing
+      self.save unless save
     end
 
     def save
@@ -17,12 +26,10 @@ module Git
       @saved
     end
 
-    def message
-      @message
-    end
+    attr_reader :message
 
     def to_s
       message
     end
   end
-end
+end

data/lib/git/stashes.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Git
-
   # object that holds all the available stashes
   class Stashes
     include Enumerable
@@ -11,7 +10,8 @@ module Git
 
       @base = base
 
-      @base.lib.stashes_all.each do |id, message|
+      @base.lib.stashes_all.each do |indexed_message|
+        _index, message = indexed_message
         @stashes.unshift(Git::Stash.new(@base, message, true))
       end
     end
@@ -32,7 +32,7 @@ module Git
       @stashes.unshift(s) if s.saved?
     end
 
-    def apply(index=nil)
+    def apply(index = nil)
       @base.lib.stash_apply(index)
     end
 
@@ -45,8 +45,8 @@ module Git
       @stashes.size
     end
 
-    def each(&block)
-      @stashes.each(&block)
+    def each(&)
+      @stashes.each(&)
     end
 
     def [](index)

data/lib/git/status.rb

@@ -1,115 +1,48 @@
 # frozen_string_literal: true
 
+# These would be required by the main `git.rb` file
+
 module Git
-  # The status class gets the status of a git repository
-  #
-  # This identifies which files have been modified, added, or deleted from the
-  # worktree. Untracked files are also identified.
-  #
-  # The Status object is an Enumerable that contains StatusFile objects.
+  # 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.
   #
   # @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
-      @_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)
-      case_aware_include?(:changed, :lc_changed, file)
-    end
-
-    # Returns an Enumerable containing files that have been added.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def added
-      @_added ||= @files.select { |_k, f| f.type == 'A' }
-    end
-
-    # 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)
-      case_aware_include?(:added, :lc_added, 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 deleted.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def deleted
-      @_deleted ||= @files.select { |_k, f| f.type == 'D' }
-    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 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)
-      case_aware_include?(:deleted, :lc_deleted, file)
-    end
-
-    #
-    # Returns an Enumerable containing files that are not tracked in git.
-    # File path starts at git base directory
-    #
-    # @return [Enumerable]
-    def untracked
-      @_untracked ||= @files.select { |_k, f| f.untracked }
-    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)
 
-    #
-    # 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)
-      case_aware_include?(:untracked, :lc_untracked, 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}
@@ -121,187 +54,115 @@ module Git
       FILE
     end
 
-    # enumerable method
-
-    def [](file)
-      @files[file]
+    def select_files(&block)
+      @files.select { |_path, file| block.call(file) }
     end
 
-    def each(&block)
-      @files.values.each(&block)
+    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
 
-    # subclass that does heavy lifting
-    class StatusFile
-      # @!attribute [r] path
-      #   The path of the file relative to the project root directory
-      #   @return [String]
-      attr_accessor :path
-
-      # @!attribute [r] type
-      #   The type of change
-      #
-      #   * 'M': modified
-      #   * 'A': added
-      #   * 'D': deleted
-      #   * nil: ???
-      #
-      #   @return [String]
-      attr_accessor :type
-
-      # @!attribute [r] mode_index
-      #   The mode of the file in the index
-      #   @return [String]
-      #   @example 100644
-      #
-      attr_accessor :mode_index
-
-      # @!attribute [r] mode_repo
-      #   The mode of the file in the repo
-      #   @return [String]
-      #   @example 100644
-      #
-      attr_accessor :mode_repo
-
-      # @!attribute [r] sha_index
-      #   The sha of the file in the index
-      #   @return [String]
-      #   @example 123456
-      #
-      attr_accessor :sha_index
+    def downcased_keys(collection_name)
+      @_downcased_keys ||= {}
+      @_downcased_keys[collection_name] ||=
+        public_send(collection_name).keys.to_set(&:downcase)
+    end
 
-      # @!attribute [r] sha_repo
-      #   The sha of the file in the repo
-      #   @return [String]
-      #   @example 123456
-      attr_accessor :sha_repo
+    def ignore_case?
+      return @_ignore_case if defined?(@_ignore_case)
 
-      # @!attribute [r] untracked
-      #   Whether the file is untracked
-      #   @return [Boolean]
-      attr_accessor :untracked
+      @_ignore_case = (@base.config('core.ignoreCase') == 'true')
+    rescue Git::FailedError
+      @_ignore_case = false
+    end
+  end
+end
 
-      # @!attribute [r] stage
-      #   The stage of the file
-      #
-      #   * '0': the unmerged state
-      #   * '1': the common ancestor (or original) version
-      #   * '2': "our version" from the current branch head
-      #   * '3': "their version" from the other branch head
-      #   @return [String]
-      attr_accessor :stage
+module Git
+  class Status
+    # 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_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
+  end
+end
 
-    private
-
-    def construct_status
-      # Lists all files in the index and the worktree
-      # git ls-files --stage
-      # { file => { path: file, mode_index: '100644', sha_index: 'dd4fc23', stage: '0' } }
-      @files = @base.lib.ls_files
-
-      # Lists files in the worktree that are not in the index
-      # Add untracked files to @files
-      fetch_untracked
-
-      # Lists files that are different between the index vs. the worktree
-      fetch_modified
-
-      # Lists files that are different between the repo HEAD vs. the worktree
-      fetch_added
-
-      @files.each do |k, file_hash|
-        @files[k] = StatusFile.new(@base, file_hash)
+module Git
+  class Status
+    # 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
-    end
 
-    def fetch_untracked
-      # git ls-files --others --exclude-standard, chdir: @git_work_dir)
-      # { file => { path: file, untracked: true } }
-      @base.lib.untracked_files.each do |file|
-        @files[file] = { path: file, untracked: true }
+      # 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_modified
-      # Files changed between the index vs. the worktree
-      # git diff-files
-      # { file => { path: file, type: 'M', mode_index: '100644', mode_repo: '100644', sha_index: '0000000', :sha_repo: '52c6c4e' } }
-      @base.lib.diff_files.each do |path, data|
-        @files[path] ? @files[path].merge!(data) : @files[path] = data
+      private
+
+      # 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
-    end
 
-    def fetch_added
-      unless @base.lib.empty?
-      # Files changed between the repo HEAD vs. the worktree
-      # git diff-index HEAD
-      # { file => { path: file, type: 'M', mode_index: '100644', mode_repo: '100644', sha_index: '0000000', :sha_repo: '52c6c4e' } }
-      @base.lib.diff_index('HEAD').each do |path, data|
-          @files[path] ? @files[path].merge!(data) : @files[path] = data
+      def merge_untracked_files(files)
+        @lib.untracked_files.each do |file|
+          files[file] = { path: file, untracked: true }
         end
       end
-    end
 
-    # It's worth noting that (like git itself) this gem will not behave well if
-    # ignoreCase is set inconsistently with the file-system itself. For details:
-    # https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase
-    def ignore_case?
-      return @_ignore_case if defined?(@_ignore_case)
-      @_ignore_case = @base.config('core.ignoreCase') == 'true'
-    rescue Git::FailedError
-      @_ignore_case = false
-    end
-
-    def downcase_keys(hash)
-      hash.map { |k, v| [k.downcase, v] }.to_h
-    end
-
-    def lc_changed
-      @_lc_changed ||= changed.transform_keys(&:downcase)
-    end
-
-    def lc_added
-      @_lc_added ||= added.transform_keys(&:downcase)
-    end
+      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
 
-    def lc_deleted
-      @_lc_deleted ||= deleted.transform_keys(&:downcase)
-    end
+      def merge_head_diffs(files)
+        return if @lib.empty?
 
-    def lc_untracked
-      @_lc_untracked ||= untracked.transform_keys(&:downcase)
-    end
-
-    def case_aware_include?(cased_hash, downcased_hash, file)
-      if ignore_case?
-        send(downcased_hash).include?(file.downcase)
-      else
-        send(cased_hash).include?(file)
+        # 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

@@ -3,5 +3,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='4.0.0'
+  VERSION = '4.0.1'
 end

data/lib/git/worktree.rb

@@ -3,14 +3,13 @@
 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

@@ -3,7 +3,6 @@
 module Git
   # object that holds all the available worktrees
   class Worktrees
-
     include Enumerable
 
     def initialize(base)
@@ -23,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

@@ -42,16 +42,16 @@ 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
+  # 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)
+    if name && value
       # set value
       lib.config_set(name, value)
-    elsif (name)
+    elsif name
       # return value
       lib.config_get(name)
     else
@@ -191,7 +191,7 @@ module Git
   #   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
@@ -216,7 +216,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
   #
@@ -245,23 +246,23 @@ module Git
   # remote, 'origin.'
   def self.export(repository, name, options = {})
     options.delete(:remote)
-    repo = clone(repository, name, {:depth => 1}.merge(options))
+    repo = clone(repository, name, { depth: 1 }.merge(options))
     repo.checkout("origin/#{options[:branch]}") if options[:branch]
     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)
+    if name && value
       # set value
       lib.global_config_set(name, value)
-    elsif (name)
+    elsif name
       # return value
       lib.global_config_get(name)
     else