git 5.7.0 → 6.0.0

data/lib/git/status.rb

@@ -1,384 +0,0 @@
-# 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.
-  #
-  # @example Inspect repository status
-  #   repo = Git.open('/path/to/repo')
-  #   status = repo.status
-  #   status.changed.each { |path, _file| puts "Modified: #{path}" }
-  #   status.added.each { |path, _file| puts "Added: #{path}" }
-  #   status.deleted.each { |path, _file| puts "Deleted: #{path}" }
-  #   status.untracked.each { |path, _file| puts "Untracked: #{path}" }
-  #
-  # @deprecated Use {Git::StatusInfo}, returned by {Git::Repository#status_info},
-  #   instead; this class will be removed in v6.0.0
-  #
-  # @api public
-  #
-  class Status
-    include Enumerable
-
-    # Create a new Status for the given repository
-    #
-    # @param base [Git::Repository] the git object backing this status
-    #
-    # @deprecated Use {Git::Repository#status_info} instead
-    #
-    def initialize(base)
-      if defined?(Git::Deprecation)
-        Git::Deprecation.warn(
-          'Git::Status is deprecated and will be removed in v6.0.0. ' \
-          'Use Git::Repository#status_info instead.'
-        )
-      end
-      @base = base
-      # The factory returns a hash of file paths to StatusFile objects.
-      @files = StatusFileFactory.new(base).construct_files
-    end
-
-    # Return files modified in the index and/or working tree
-    #
-    # Includes both staged modifications (index vs HEAD) and unstaged modifications
-    # (working tree vs index).
-    #
-    # @return [Hash{String => Git::Status::StatusFile}] changed files keyed by path
-    #
-    def changed   = @changed ||= select_files { |f| f.type == 'M' }
-
-    # Return files added to the index that are not yet in HEAD
-    #
-    # @return [Hash{String => Git::Status::StatusFile}] added files keyed by path
-    #
-    def added     = @added ||= select_files { |f| f.type == 'A' }
-
-    # Return files deleted from the index
-    #
-    # @return [Hash{String => Git::Status::StatusFile}] deleted files keyed by path
-    #
-    def deleted   = @deleted ||= select_files { |f| f.type == 'D' }
-
-    # Return files present in the working tree but not tracked by git
-    #
-    # @return [Hash{String => Git::Status::StatusFile}] untracked files keyed by path
-    #
-    def untracked = @untracked ||= select_files(&:untracked)
-
-    # Return `true` if `file` has been modified in the index or working tree
-    #
-    # @param file [String] the repository-relative path to check
-    #
-    # @return [Boolean] `true` if the file has been modified
-    #
-    def changed?(file)   = file_in_collection?(:changed, file)
-
-    # Return `true` if `file` has been added to the index
-    #
-    # @param file [String] the repository-relative path to check
-    #
-    # @return [Boolean] `true` if the file has been added
-    #
-    def added?(file)     = file_in_collection?(:added, file)
-
-    # Return `true` if `file` has been deleted from the index
-    #
-    # @param file [String] the repository-relative path to check
-    #
-    # @return [Boolean] `true` if the file has been deleted
-    #
-    def deleted?(file)   = file_in_collection?(:deleted, file)
-
-    # Return `true` if `file` is not tracked by git
-    #
-    # @param file [String] the repository-relative path to check
-    #
-    # @return [Boolean] `true` if the file is untracked
-    #
-    def untracked?(file) = file_in_collection?(:untracked, file)
-
-    # Return the {Git::Status::StatusFile} for the given path
-    #
-    # @param file [String] the repository-relative path
-    #
-    # @return [Git::Status::StatusFile, nil] the status file, or `nil` if not found
-    #
-    def [](file) = @files[file]
-
-    # Iterate over all status files
-    #
-    # @overload each
-    #
-    #   @return [Enumerator<Git::Status::StatusFile>] an enumerator over all status files
-    #
-    # @overload each(&block)
-    #
-    #   @return [Array<Git::Status::StatusFile>] the full list of status files
-    #
-    #   @yield [file] each {Git::Status::StatusFile} in the repository
-    #
-    #   @yieldparam file [Git::Status::StatusFile] a single file's status
-    #
-    #   @yieldreturn [void]
-    #
-    def each(&) = @files.values.each(&)
-
-    # Return a formatted multi-line string representation of the status
-    #
-    # @return [String] one indented block per file showing its SHA, mode, type,
-    #   stage, and untracked flag
-    #
-    def pretty
-      map { |file| pretty_file(file) }.join << "\n"
-    end
-
-    private
-
-    # Format a single file's status as an indented multi-line string
-    #
-    # @param file [Git::Status::StatusFile] the file to format
-    #
-    # @return [String] the formatted status block for this file
-    #
-    def pretty_file(file)
-      <<~FILE
-        #{file.path}
-        \tsha(r) #{file.sha_repo} #{file.mode_repo}
-        \tsha(i) #{file.sha_index} #{file.mode_index}
-        \ttype   #{file.type}
-        \tstage  #{file.stage}
-        \tuntrac #{file.untracked}
-      FILE
-    end
-
-    # Return a hash of files for which the block returns a truthy value
-    #
-    # @return [Hash{String => Git::Status::StatusFile}] matching files keyed by path
-    #
-    # @yield [file] each {Git::Status::StatusFile} in the repository
-    #
-    # @yieldparam file [Git::Status::StatusFile] a single file's status
-    #
-    # @yieldreturn [Boolean] truthy to include the file in the result
-    #
-    def select_files(&block)
-      @files.select { |_path, file| block.call(file) }
-    end
-
-    # Return `true` if `file_path` exists in the named status collection
-    #
-    # @param collection_name [Symbol] the collection to check (e.g. `:changed`)
-    #
-    # @param file_path [String] the repository-relative path to look up
-    #
-    # @return [Boolean] `true` if the path is present in the collection
-    #
-    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
-
-    # Return a memoized set of downcased keys for the named collection
-    #
-    # @param collection_name [Symbol] the collection whose keys to downcase
-    #
-    # @return [Set<String>] the lowercased path keys
-    #
-    def downcased_keys(collection_name)
-      @_downcased_keys ||= {}
-      @_downcased_keys[collection_name] ||=
-        public_send(collection_name).keys.to_set(&:downcase)
-    end
-
-    # Return `true` when git is configured to ignore filename case
-    #
-    # Reads `core.ignoreCase` with {Git::Repository#config_get}. Returns `false`
-    # when the config value is absent.
-    #
-    # @return [Boolean] `true` when `core.ignoreCase` is `"true"`
-    #
-    def ignore_case?
-      return @ignore_case if defined?(@ignore_case)
-
-      @ignore_case = (@base.config_get('core.ignoreCase')&.value == 'true')
-    end
-  end
-end
-
-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.
-    #
-    # @deprecated Use {Git::StatusFileInfo}, held by {Git::StatusInfo#files},
-    #   instead; this class will be removed in v6.0.0
-    #
-    # @api public
-    #
-    class StatusFile
-      # The repository-relative file path
-      #
-      # @return [String] the path
-      attr_reader :path
-
-      # The change type for this file
-      #
-      # @return [String, nil] `"M"` for modified, `"A"` for added, `"D"` for deleted,
-      #   or `nil` when not applicable
-      attr_reader :type
-
-      # The merge stage for this file
-      #
-      # @return [String, nil] `"0"` for normal entries, or a non-zero value during
-      #   a merge conflict
-      attr_reader :stage
-
-      # The file mode recorded in the index
-      #
-      # @return [String, nil] the octal file mode (e.g. `"100644"`), or `nil`
-      attr_reader :mode_index
-
-      # The file mode recorded in HEAD
-      #
-      # @return [String, nil] the octal file mode (e.g. `"100644"`), or `nil`
-      attr_reader :mode_repo
-
-      # The SHA of the index version of this file
-      #
-      # @return [String, nil] the SHA-1 hex digest, or `nil` if unavailable
-      attr_reader :sha_index
-
-      # The SHA of the HEAD version of this file
-      #
-      # @return [String, nil] the SHA-1 hex digest, or `nil` if unavailable
-      attr_reader :sha_repo
-
-      # Whether this file is untracked
-      #
-      # @return [Boolean, nil] `true` when the file is not tracked by git
-      attr_reader :untracked
-
-      # Initialize a new StatusFile with the given git object and data hash
-      #
-      # @param base [Git::Repository] the git object
-      #
-      # @param hash [Hash] raw status data for this file
-      #
-      def initialize(base, hash)
-        @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]
-      end
-
-      # Return a blob object for the index or repo version of this file
-      #
-      # @param type [Symbol] `:index` (default) for the index version, or
-      #   `:repo` for the HEAD version
-      #
-      # @return [Git::Object::Blob, nil] the blob object, or `nil` if no SHA
-      #   is available for the requested version
-      #
-      def blob(type = :index)
-        sha = type == :repo ? sha_repo : (sha_index || sha_repo)
-        @base.object(sha) if sha
-      end
-    end
-  end
-end
-
-module Git
-  class Status
-    # A factory class responsible for fetching git status data and building
-    # a hash of StatusFile objects.
-    #
-    # @api private
-    #
-    class StatusFileFactory
-      # Create a new factory backed by the given git object
-      #
-      # @param base [Git::Repository] the git object used as the status data provider
-      #
-      def initialize(base)
-        @base = base
-      end
-
-      # Gather all status data and build a hash of file paths to StatusFile objects
-      #
-      # @return [Hash{String => Git::Status::StatusFile}] file paths mapped to
-      #   their status objects
-      #
-      def construct_files
-        files_data = fetch_all_files_data
-        files_data.transform_values do |data|
-          StatusFile.new(@base, data)
-        end
-      end
-
-      private
-
-      # Fetch and merge status information from multiple git commands
-      #
-      # @return [Hash{String => Hash}] raw per-file status data keyed by path
-      #
-      def fetch_all_files_data
-        files = @base.ls_files # Start with files tracked in the index.
-        merge_untracked_files(files)
-        merge_modified_files(files)
-        merge_head_diffs(files)
-        files
-      end
-
-      # Merge untracked working-tree files into `files`
-      #
-      # @param files [Hash] the in-progress files hash to update in place
-      #
-      # @return [void]
-      #
-      def merge_untracked_files(files)
-        @base.untracked_files.each do |file|
-          files[file] = { path: file, untracked: true }
-        end
-      end
-
-      # Merge index-versus-working-tree diff data into `files`
-      #
-      # @param files [Hash] the in-progress files hash to update in place
-      #
-      # @return [void]
-      #
-      def merge_modified_files(files)
-        # Merge changes between the index and the working directory.
-        @base.diff_files.each do |path, data|
-          (files[path] ||= {}).merge!(data)
-        end
-      end
-
-      # Merge HEAD-versus-index diff data into `files`, if commits exist
-      #
-      # @param files [Hash] the in-progress files hash to update in place
-      #
-      # @return [void]
-      #
-      def merge_head_diffs(files)
-        is_empty = @base.no_commits?
-        return if is_empty
-
-        # Merge changes between HEAD and the index.
-        @base.diff_index('HEAD').each do |path, data|
-          (files[path] ||= {}).merge!(data)
-        end
-      end
-    end
-  end
-end

data/lib/git/worktree.rb

@@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  # A worktree in a Git repository
-  #
-  # Represents a single linked or main worktree. Constructed by
-  # {Git::Repository::WorktreeOperations#worktree} or populated by
-  # {Git::Worktrees}.
-  #
-  # @example Add and remove a linked worktree
-  #   worktree = repo.worktree('/path/to/new-worktree')
-  #   worktree.add
-  #   worktree.remove
-  #
-  # @deprecated Use {Git::Repository::WorktreeOperations#worktree_list} and the
-  #   path-based worktree operations on {Git::Repository} instead
-  #
-  #   {Git::Repository::WorktreeOperations#worktree_list} returns immutable
-  #   {Git::WorktreeInfo} value objects. Operations that lived on this class are
-  #   called on the repository with the worktree path instead (for example
-  #   {Git::Repository::WorktreeOperations#worktree_add} and
-  #   {Git::Repository::WorktreeOperations#worktree_remove}). {#gcommit},
-  #   {#add}, and {#remove} each emit a deprecation warning; the `dir`, `full`,
-  #   `to_s`, and `to_a` readers do not.
-  #
-  # @api public
-  #
-  class Worktree
-    # Full worktree descriptor including the optional commitish
-    #
-    # @return [String] the filesystem path, space-separated with the commitish
-    #   when one was given at construction time
-    #
-    attr_accessor :full
-
-    # Filesystem path of this worktree
-    #
-    # @return [String] the filesystem path of the worktree directory
-    #
-    attr_accessor :dir
-
-    # Creates a new Worktree object
-    #
-    # @param base [Git::Repository] the repository that owns this
-    #   worktree
-    #
-    # @param dir [String] filesystem path of the worktree
-    #
-    # @param gcommit [String, nil] commitish associated with the worktree;
-    #   when non-nil it is appended to {#full}
-    #
-    # @return [void]
-    #
-    def initialize(base, dir, gcommit = nil)
-      @full = dir
-      @full += " #{gcommit}" unless gcommit.nil?
-      @base = base
-      @dir = dir
-      @gcommit = gcommit
-    end
-
-    # Returns the commit (or commitish string) associated with this worktree
-    #
-    # When a commitish string was supplied at construction time (e.g. by
-    # {Git::Worktrees} which passes the raw SHA from `git worktree list`), that
-    # string is returned as-is. Otherwise the value is lazily resolved on first
-    # call via `worktree_repository.gcommit(@full)` and the result is memoized.
-    #
-    # @example When resolved lazily (no commitish at construction)
-    #   worktree = repo.worktree('/path/to/wt')
-    #   worktree.gcommit  # => #<Git::Object::Commit ...>
-    #
-    # @example When the commitish was given at construction
-    #   worktree = repo.worktrees['/path/to/wt']
-    #   worktree.gcommit  # => "4bef5ab8c9..."   (raw SHA string)
-    #
-    # @return [Git::Object::Commit, String] a commit object when lazily
-    #   resolved, or the raw commitish string when pre-set at construction
-    #
-    # @raise [Git::FailedError] if git must resolve the commit and exits with a
-    #   non-zero exit status
-    #
-    # @deprecated Use {Git::WorktreeInfo#head} from
-    #   {Git::Repository::WorktreeOperations#worktree_list} instead
-    #
-    #   `head` is always the commit SHA as a `String` (or `nil` for a bare main
-    #   worktree). Call `repo.gcommit(info.head)` for the commit object.
-    #
-    # @see Git::WorktreeInfo#head
-    #
-    def gcommit
-      Git::Deprecation.warn(
-        'Git::Worktree#gcommit is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::WorktreeInfo#head from Git::Repository#worktree_list instead.'
-      )
-      @gcommit ||= worktree_repository.gcommit(@full)
-      @gcommit
-    end
-
-    # Creates this worktree on disk
-    #
-    # Runs `git worktree add` for {#dir}, optionally at the commitish passed
-    # at construction time.
-    #
-    # @example Add a worktree
-    #   worktree = repo.worktree('/path/to/new-worktree')
-    #   worktree.add
-    #
-    # @return [String] stdout from the git command
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    # @deprecated Use {Git::Repository::WorktreeOperations#worktree_add} instead
-    #
-    # @see Git::Repository::WorktreeOperations#worktree_add
-    #
-    def add
-      Git::Deprecation.warn(
-        'Git::Worktree#add is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::Repository#worktree_add instead.'
-      )
-      worktree_repository.worktree_add(@dir, @gcommit)
-    end
-
-    # Removes this worktree from disk
-    #
-    # Runs `git worktree remove` for {#dir}.
-    #
-    # @example Remove a worktree
-    #   worktree.remove
-    #
-    # @return [String] stdout from the git command (typically empty)
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    # @deprecated Use {Git::Repository::WorktreeOperations#worktree_remove} instead
-    #
-    # @see Git::Repository::WorktreeOperations#worktree_remove
-    #
-    def remove
-      Git::Deprecation.warn(
-        'Git::Worktree#remove is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::Repository#worktree_remove instead.'
-      )
-      worktree_repository.worktree_remove(@dir)
-    end
-
-    # Returns an array containing the full worktree descriptor
-    #
-    # @example Get the descriptor array
-    #   worktree.to_a  # => ["/path/to/worktree"]
-    #
-    # @return [Array<String>] array containing the full worktree descriptor
-    #
-    def to_a
-      [@full]
-    end
-
-    # Returns the full worktree descriptor as a string
-    #
-    # @example Get the descriptor string
-    #   worktree.to_s  # => "/path/to/worktree"
-    #
-    # @return [String] the full worktree descriptor (path and optional commitish)
-    #
-    def to_s
-      @full
-    end
-
-    private
-
-    # @return [Git::Repository] the repository used for worktree operations
-    #
-    # @api private
-    #
-    def worktree_repository
-      @base
-    end
-  end
-end

data/lib/git/worktrees.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  # Collection of all Git worktrees in a repository
-  #
-  # Wraps every linked and main worktree and provides enumeration and
-  # path-based lookup.
-  #
-  # @example Enumerate all worktrees
-  #   worktrees = repo.worktrees
-  #   worktrees.each { |wt| puts wt.dir }
-  #
-  # @deprecated Use {Git::Repository::WorktreeOperations#worktree_list} instead
-  #
-  #   {Git::Repository::WorktreeOperations#worktree_list} returns
-  #   `Array<Git::WorktreeInfo>` (immutable value objects). Look a worktree up
-  #   by path with `worktree_list.find { |w| w.path == path }` in place of
-  #   {#[]}, and call {Git::Repository::WorktreeOperations#worktree_prune} in
-  #   place of {#prune}. Constructing a `Git::Worktrees` emits a deprecation
-  #   warning.
-  #
-  # @api public
-  #
-  class Worktrees
-    include Enumerable
-
-    # Creates a new Worktrees collection populated from the given repository
-    #
-    # @param base [Git::Repository] the repository to enumerate
-    #   worktrees from
-    #
-    # @return [void]
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    # @deprecated Use {Git::Repository::WorktreeOperations#worktree_list} instead
-    #
-    # @see Git::Repository::WorktreeOperations#worktree_list
-    #
-    def initialize(base)
-      Git::Deprecation.warn(
-        'Git::Worktrees is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::Repository#worktree_list instead.'
-      )
-      @worktrees = {}
-
-      @base = base
-
-      # worktrees_all is deprecated too; silence it so one Git::Worktrees.new emits one warning
-      Git::Deprecation.silence { worktree_repository.worktrees_all }.each do |w|
-        @worktrees[w[0]] = Git::Worktree.new(@base, w[0], w[1])
-      end
-    end
-
-    # Returns the number of worktrees in the collection
-    #
-    # @example Count all worktrees
-    #   repo.worktrees.size  # => 2
-    #
-    # @return [Integer] the total number of worktrees
-    #
-    def size
-      @worktrees.size
-    end
-
-    # Iterates over every worktree in the collection
-    #
-    # @overload each
-    #
-    #   @example Get an enumerator over all worktrees
-    #     enum = repo.worktrees.each
-    #
-    #   @return [Enumerator<Git::Worktree>] an enumerator over all worktrees
-    #
-    # @overload each(&block)
-    #
-    #   @example Print every worktree path
-    #     repo.worktrees.each { |wt| puts wt.dir }
-    #
-    #   @return [Array<Git::Worktree>] the full list of worktrees
-    #
-    #   @yield [worktree] passes each worktree to the block
-    #
-    #   @yieldparam worktree [Git::Worktree] a worktree in the repository
-    #
-    #   @yieldreturn [void]
-    #
-    def each(&)
-      @worktrees.values.each(&)
-    end
-
-    # Returns the worktree with the given path
-    #
-    # Supports lookup by the filesystem path of the worktree directory or by
-    # the full worktree descriptor (path and optional commitish).
-    #
-    # @example Look up a worktree by path
-    #   repo.worktrees['/path/to/linked-worktree']
-    #
-    # @param worktree_name [#to_s] the path (or full descriptor) of the
-    #   worktree to retrieve
-    #
-    # @return [Git::Worktree, nil] the matching worktree, or `nil` if not found
-    #
-    def [](worktree_name)
-      @worktrees.values.each_with_object(@worktrees) do |worktree, worktrees|
-        worktrees[worktree.full] ||= worktree
-      end[worktree_name.to_s]
-    end
-
-    # Returns a string listing all worktrees, one per line
-    #
-    # @example Display all worktrees
-    #   puts repo.worktrees.to_s
-    #
-    # @return [String] a newline-separated listing of worktree descriptors
-    #
-    def to_s
-      out = +''
-      @worktrees.each_value do |b|
-        out << b.to_s << "\n"
-      end
-      out
-    end
-
-    # Removes stale administrative files for worktrees that no longer exist
-    #
-    # Runs `git worktree prune` to clean up any lingering worktree metadata
-    # for linked worktrees whose directories have been deleted.
-    #
-    # @example Prune stale worktree metadata
-    #   repo.worktrees.prune
-    #
-    # @return [String] stdout from the git command (typically empty)
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def prune
-      worktree_repository.worktree_prune
-    end
-
-    private
-
-    # @return [Git::Repository] the repository used to enumerate worktrees
-    #
-    # @api private
-    #
-    def worktree_repository
-      @base
-    end
-  end
-end