git 5.6.0 → 6.0.0

data/lib/git/branches.rb

@@ -1,194 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  # Collection of all Git branches in a repository
-  #
-  # Wraps both local and remote-tracking branches and provides filtering,
-  # enumeration, and name-based lookup.
-  #
-  # @example Enumerate all branches
-  #   branches = repo.branches
-  #   branches.each { |b| puts b.name }
-  #
-  # @deprecated Use {Git::Repository::Branching#branch_list} instead
-  #
-  #   {Git::Repository::Branching#branch_list} returns `Array<Git::BranchInfo>`
-  #   (immutable value objects). Filter it with `select(&:remote?)` or
-  #   `reject(&:remote?)` in place of {#remote} and {#local}, and look a
-  #   branch up by name with `branch_list(name).first` in place of {#[]}.
-  #   Constructing a `Git::Branches` emits a deprecation warning.
-  #
-  # @api public
-  #
-  class Branches
-    include Enumerable
-
-    # Creates a new Branches collection populated from the given repository
-    #
-    # @param base [Git::Repository] the repository to enumerate
-    #   branches from
-    #
-    # @return [void]
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    # @deprecated Use {Git::Repository::Branching#branch_list} instead
-    #
-    # @see Git::Repository::Branching#branch_list
-    #
-    def initialize(base)
-      Git::Deprecation.warn(
-        'Git::Branches is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::Repository#branch_list instead.'
-      )
-      @branches = {}
-      @lookup = {}
-
-      @base = base
-
-      load_branches
-    end
-
-    # Returns all local (non-remote-tracking) branches
-    #
-    # @example List local branch names
-    #   repo.branches.local.map(&:name)
-    #
-    # @return [Array<Git::Branch>] the local branches
-    #
-    def local
-      reject(&:remote)
-    end
-
-    # Returns all remote-tracking branches
-    #
-    # @example List remote branch names
-    #   repo.branches.remote.map(&:name)
-    #
-    # @return [Array<Git::Branch>] the remote-tracking branches
-    #
-    def remote
-      self.select(&:remote)
-    end
-
-    # Returns the number of branches in the collection
-    #
-    # @example Count all branches
-    #   repo.branches.size  # => 3
-    #
-    # @return [Integer] the total number of branches
-    #
-    def size
-      @branches.size
-    end
-
-    # Iterates over every branch in the collection
-    #
-    # @overload each
-    #
-    #   @example Get an enumerator over all branches
-    #     enum = repo.branches.each
-    #
-    #   @return [Enumerator<Git::Branch>] an enumerator over all branches
-    #
-    # @overload each(&block)
-    #
-    #   @example Print every branch name
-    #     repo.branches.each { |b| puts b.name }
-    #
-    #   @return [Array<Git::Branch>] the full list of branches
-    #
-    #   @yield [branch] passes each branch to the block
-    #
-    #   @yieldparam branch [Git::Branch] a branch in the repository
-    #
-    #   @yieldreturn [void]
-    #
-    def each(&)
-      @branches.values.each(&)
-    end
-
-    # Returns the branch with the given name
-    #
-    # Supports short names (`'main'`), remote-qualified names
-    # (`'working/master'`), and full refspec names
-    # (`'remotes/working/master'`).
-    #
-    # @example Look up a branch by short name
-    #   repo.branches['main']
-    #
-    # @example Look up a remote-tracking branch
-    #   repo.branches['working/master']
-    #
-    # @param branch_name [#to_s] the name of the branch to retrieve
-    #
-    # @return [Git::Branch, nil] the matching branch, or `nil` if not found
-    #
-    def [](branch_name)
-      @lookup[branch_name.to_s]
-    end
-
-    # Returns a string listing all branches, prefixed with `*` for the current branch
-    #
-    # @example Display all branches
-    #   puts repo.branches.to_s
-    #
-    # @return [String] a formatted branch listing
-    #
-    def to_s
-      out = +''
-      @branches.each_value do |b|
-        # Git::Branch#current is deprecated too; silence it so one to_s call emits one warning
-        current = Git::Deprecation.silence { b.current }
-        out << (current ? '* ' : '  ') << b.to_s << "\n"
-      end
-      out
-    end
-
-    private
-
-    # Builds a Git::Branch for every branch in the repository and indexes it
-    #
-    # @return [void]
-    #
-    # @api private
-    #
-    def load_branches
-      branch_repository.branch_list.each do |branch_info|
-        branch = Git::Branch.new(@base, branch_info)
-
-        @branches[branch_info.refname] = branch
-        index_branch_lookup(branch, refname: branch_info.refname)
-      end
-    end
-
-    # @return [Git::Repository] the repository used to enumerate branches
-    #
-    # @api private
-    #
-    def branch_repository
-      @base
-    end
-
-    # Indexes all supported lookup keys for a branch without mutating
-    # the canonical `@branches` collection used by enumeration
-    #
-    # @param branch [Git::Branch] the branch to index
-    #
-    # @param refname [String] the full refname key to use for primary lookup
-    #
-    # @return [void]
-    #
-    # @api private
-    #
-    def index_branch_lookup(branch, refname:)
-      @lookup[refname] ||= branch
-      @lookup[branch.full] ||= branch
-
-      return unless branch.full.start_with?('remotes/')
-
-      # Mirror git compatibility: allow omitting a leading "remotes/".
-      @lookup[branch.full.delete_prefix('remotes/')] ||= branch
-    end
-  end
-end

data/lib/git/remote.rb

@@ -1,191 +0,0 @@
-# frozen_string_literal: true
-
-require 'git/branch'
-require 'git/branch_info'
-
-module Git
-  # A remote in a Git repository
-  #
-  # Remote objects provide access to remote metadata and operations like fetch,
-  # merge, and remove. This class and `Git::Repository#remote`, which returns
-  # it, are both deprecated: read remote configuration through
-  # {Git::Repository::RemoteOperations#remote_list} and call the
-  # repository-level operations with the remote name instead.
-  #
-  # @example Reading a remote and fetching from it without Git::Remote
-  #   git = Git.open('.')
-  #   origin = git.remote_list.find { |r| r.name == 'origin' }  #=> Git::RemoteInfo
-  #   origin.url.first
-  #   git.fetch(origin.name)
-  #
-  # @deprecated Use {Git::Repository::RemoteOperations#remote_list} and the
-  #   repository-level remote operations instead
-  #
-  #   {Git::Repository::RemoteOperations#remote_list} returns immutable
-  #   {Git::RemoteInfo} value objects. Operations that lived on this class are
-  #   called on the repository with the remote name instead (for example
-  #   {Git::Repository::RemoteOperations#fetch} and
-  #   {Git::Repository::RemoteOperations#remote_remove}). Constructing a
-  #   `Git::Remote` emits a deprecation warning.
-  #
-  # @api public
-  #
-  class Remote
-    # The name of this remote (e.g. `'origin'`)
-    #
-    # @return [String] the remote name
-    #
-    attr_accessor :name
-
-    # The URL of this remote
-    #
-    # @return [String, nil] the remote URL
-    #
-    attr_accessor :url
-
-    # The fetch refspec for this remote
-    #
-    # @return [String, nil] the fetch options string
-    #
-    attr_accessor :fetch_opts
-
-    # Initialize a new Remote object
-    #
-    # @param base [Git::Repository] the git repository
-    #
-    # @param name [String] the remote name (e.g. `'origin'`)
-    #
-    # @note Do not construct directly. `Git::Repository#remote` is deprecated as
-    #   well; use {Git::Repository::RemoteOperations#remote_list} and the
-    #   repository-level remote operations instead.
-    #
-    # @api private
-    #
-    def initialize(base, name)
-      Git::Deprecation.warn(
-        'Git::Remote is deprecated and will be removed in v6.0.0. ' \
-        'Use Git::Repository#remote_list and the repository-level remote operations instead.'
-      )
-      @base = base
-      # config_remote is deprecated too; silence it so one Git::Remote.new emits one warning
-      config = Git::Deprecation.silence { remote_repository.config_remote(name) }
-      @name = name
-      @url = config['url']
-      @fetch_opts = config['fetch']
-    end
-
-    # Fetches from this remote
-    #
-    # @example Fetch from origin
-    #   git.remote('origin').fetch
-    #
-    # @param opts [Hash] options for the fetch command
-    #
-    # @option opts [Boolean, nil] :tags (nil) fetch all tags from the remote
-    #   (`--tags`)
-    #
-    # @option opts [Boolean, nil] :prune (nil) remove remote-tracking references
-    #   that no longer exist on the remote (`--prune`)
-    #
-    # @option opts [Boolean, nil] :prune_tags (nil) remove local tags that no
-    #   longer exist on the remote (`--prune-tags`)
-    #
-    # @option opts [Boolean, nil] :force (nil) override the fast-forward check
-    #   when using explicit refspecs (`--force`)
-    #
-    # @option opts [Boolean, nil] :update_head_ok (nil) allow `git fetch` to
-    #   update the branch pointed to by `HEAD` (`--update-head-ok`)
-    #
-    # @option opts [Boolean, nil] :unshallow (nil) convert a shallow clone into a
-    #   full repository (`--unshallow`)
-    #
-    # @option opts [String, Integer, nil] :depth (nil) limit history to N commits
-    #   from each branch tip (`--depth=N`)
-    #
-    # @option opts [String, Array<String>, nil] :ref (nil) one or more refspecs to
-    #   fetch as positional arguments after the remote name
-    #
-    # @return [String] git's stdout from the fetch
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def fetch(opts = {})
-      remote_repository.fetch(@name, opts)
-    end
-
-    # Merges this remote into the given (or current) local branch
-    #
-    # @example Merge origin/main into the current branch
-    #   git.remote('origin').merge('main')
-    #
-    # @param branch [String] the local branch to merge into (defaults to current branch)
-    #
-    # @return [String] git's stdout from the merge
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def merge(branch = nil)
-      branch ||= remote_repository.current_branch
-      remote_tracking_branch = "#{@name}/#{branch}"
-      remote_repository.merge(remote_tracking_branch)
-    end
-
-    # Returns a {Git::Branch} object for the given branch on this remote
-    #
-    # @example Get the remote-tracking branch object
-    #   git.remote('origin').branch('main')  #=> #<Git::Branch 'origin/main'>
-    #
-    # @param branch [String] the branch name on this remote (defaults to current branch)
-    #
-    # @return [Git::Branch] a branch object representing `<remote>/<branch>`
-    #
-    # @deprecated Use
-    #   `Git::Repository#branch_list("#{name}/#{branch || current_branch}").first`
-    #   instead
-    #
-    #   With no argument this method falls back to the current branch, so the
-    #   replacement has to supply `Git::Repository#current_branch` itself. The
-    #   replacement returns a {Git::BranchInfo} value object rather than a
-    #   {Git::Branch}, and returns `nil` when the remote-tracking branch does
-    #   not exist.
-    #
-    def branch(branch = nil)
-      branch ||= remote_repository.current_branch
-      Git::Branch.new(@base, "#{@name}/#{branch}")
-    end
-
-    # Removes this remote from the repository
-    #
-    # @example Remove the upstream remote
-    #   git.remote('upstream').remove
-    #
-    # @return [Git::CommandLine::Result] the result of `git remote remove`
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def remove
-      remote_repository.remote_remove(@name)
-    end
-
-    # Returns the name of this remote as a string
-    #
-    # @example Get the remote name as a string
-    #   git.remote('origin').to_s  #=> 'origin'
-    #
-    # @return [String] the remote name
-    #
-    def to_s
-      @name
-    end
-
-    private
-
-    # @return [Git::Repository]
-    #
-    # @api private
-    #
-    def remote_repository
-      @base
-    end
-  end
-end

data/lib/git/stash.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  # Represents a single stash entry in a Git repository
-  #
-  # This class is deprecated and will be removed in v6.0.0. Use the
-  # {Git::Repository} stash methods and {Git::StashInfo} instead:
-  # {Git::Repository#stash_push} replaces `Git::Stash.new(repo, message)` and
-  # returns a {Git::StashInfo}, or `nil` when there was nothing to stash.
-  #
-  # @example Create a stash and inspect the result (deprecated)
-  #   stash = Git::Stash.new(repo, 'WIP: feature work')
-  #   stash.message  #=> "WIP: feature work"
-  #   stash.saved?   #=> true
-  #
-  # @example The replacement
-  #   info = repo.stash_push(message: 'WIP: feature work')
-  #   info.message   #=> "On main: WIP: feature work"
-  #   info.nil?      #=> false
-  #
-  # @deprecated Use {Git::Repository#stash_push} and {Git::StashInfo} instead
-  #
-  # @see Git::Repository#stash_push
-  #
-  # @api public
-  #
-  class Stash
-    # Initialize a Stash object
-    #
-    # When `existing` is `false` (the default), immediately calls {#save} to push
-    # the current working-directory state onto the stash stack.
-    #
-    # Emits one deprecation warning per object.
-    #
-    # @example Create a new stash entry
-    #   stash = Git::Stash.new(repo, 'WIP: feature work')
-    #   stash.saved?  #=> true
-    #
-    # @example Reference an existing stash without pushing
-    #   stash = Git::Stash.new(repo, 'WIP: feature work', existing: true)
-    #   stash.saved?  #=> nil
-    #
-    # @param base [Git::Repository] the git repository
-    #
-    # @param message [String] the stash message
-    #
-    # @param existing [Boolean] (false) when `true`, wraps an existing stash entry
-    #   without pushing any changes
-    #
-    # @return [void]
-    #
-    # @deprecated Use {Git::Repository#stash_push} and {Git::StashInfo} instead
-    #
-    def initialize(base, message, existing: false)
-      Git::Deprecation.warn(
-        'Git::Stash is deprecated and will be removed in v6.0.0. ' \
-        'Use the Git::Repository stash methods (stash_push, stash_infos, stash_apply) ' \
-        'and Git::StashInfo instead.'
-      )
-      @base = base
-      @message = message
-      save unless existing
-    end
-
-    # Saves the current working-directory state to the stash stack
-    #
-    # @example Save changes to the stash stack
-    #   stash = Git::Stash.new(repo, 'WIP', existing: true)
-    #   stash.save  #=> true
-    #
-    # @return [Boolean] `true` if changes were stashed, `false` if there were no
-    #   local changes to save
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def save
-      # stash_save is deprecated too; silence it so one Git::Stash call emits one warning
-      @saved = Git::Deprecation.silence { stash_repository.stash_save(@message) }
-    end
-
-    # Returns whether the stash was saved successfully
-    #
-    # @example Check if changes were stashed
-    #   stash = Git::Stash.new(repo, 'WIP: feature work')
-    #   stash.saved?  #=> true
-    #
-    # @return [Boolean, nil] `true` if changes were stashed, `false` if there were no
-    #   local changes, `nil` if {#save} has not been called (e.g. `existing: true`)
-    #
-    def saved?
-      @saved
-    end
-
-    # Returns the stash description
-    #
-    # @example Read the stash message
-    #   stash = Git::Stash.new(repo, 'WIP: feature work', existing: true)
-    #   stash.message  #=> "WIP: feature work"
-    #
-    # @return [String] the stash message
-    #
-    attr_reader :message
-
-    # Returns the stash description as a string
-    #
-    # @example Convert stash to string
-    #   stash = Git::Stash.new(repo, 'WIP: feature work', existing: true)
-    #   stash.to_s  #=> "WIP: feature work"
-    #
-    # @return [String] the stash message
-    #
-    def to_s
-      message
-    end
-
-    private
-
-    # @return [Git::Repository]
-    #
-    def stash_repository
-      @base
-    end
-  end
-end

data/lib/git/stashes.rb

@@ -1,198 +0,0 @@
-# frozen_string_literal: true
-
-module Git
-  # Collection of stash entries for a Git repository
-  #
-  # This class is deprecated and will be removed in v6.0.0. Use the
-  # {Git::Repository} stash methods and {Git::StashInfo} instead:
-  # {Git::Repository#stash_infos} replaces the collection, and
-  # {Git::Repository#stash_push}, {Git::Repository#stash_apply}, and
-  # {Git::Repository#stash_clear} replace {#save}, {#apply}, and {#clear}.
-  #
-  # @example Iterate over stash entries (deprecated)
-  #   git.stashes.each { |s| puts s.message }
-  #
-  # @example The replacement
-  #   repo.stash_infos.each { |info| puts info.message }
-  #   repo.stash_infos.size   #=> 2
-  #   repo.stash_apply
-  #
-  # @deprecated Use {Git::Repository#stash_infos} and {Git::StashInfo} instead
-  #
-  # @see Git::Repository#stash_infos
-  #
-  # @api public
-  #
-  class Stashes
-    include Enumerable
-
-    # Initialize the stashes collection
-    #
-    # Loads all existing stash entries from the repository at construction time.
-    # Emits one deprecation warning per object.
-    #
-    # @example Load stashes for a repository
-    #   stashes = Git::Stashes.new(repo)
-    #   stashes.size  #=> 2
-    #
-    # @param base [Git::Repository] the git repository
-    #
-    # @return [void]
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    # @deprecated Use {Git::Repository#stash_infos} and {Git::StashInfo} instead
-    #
-    def initialize(base)
-      Git::Deprecation.warn(
-        'Git::Stashes is deprecated and will be removed in v6.0.0. ' \
-        'Use the Git::Repository stash methods (stash_infos, stash_push, stash_apply, stash_clear) ' \
-        'and Git::StashInfo instead.'
-      )
-      @stashes = []
-      @base = base
-      # stashes_all and Git::Stash are deprecated too; silence them so one
-      # Git::Stashes.new emits one warning
-      Git::Deprecation.silence { load_stashes }
-    end
-
-    # Returns all stash entries as an array of index and message pairs
-    #
-    # Entries are listed in oldest-first order matching {Git::Repository#stashes_all}.
-    #
-    # @example List all stash entries
-    #   git.stashes.all  #=> [[0, "testing-stash-all"], [1, "another-stash"]]
-    #
-    # @return [Array<Array(Integer, String)>] array of `[index, message]` pairs where
-    #   index 0 is the oldest stash
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def all
-      # stashes_all is deprecated too; silence it so this call emits no second warning
-      Git::Deprecation.silence { stash_repository.stashes_all }
-    end
-
-    # Saves the current working-directory state to a new stash entry
-    #
-    # @example Save current changes to the stash
-    #   git.stashes.save('WIP: feature work')
-    #   git.stashes.size  #=> 1
-    #
-    # @param message [String] the stash message
-    #
-    # @return [void]
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def save(message)
-      # Git::Stash is deprecated too; silence it so this call emits no second warning
-      s = Git::Deprecation.silence { Git::Stash.new(@base, message) }
-      @stashes.unshift(s) if s.saved?
-    end
-
-    # Applies a stash entry to the working directory
-    #
-    # @example Apply the most recent stash
-    #   git.stashes.apply
-    #
-    # @example Apply a specific stash by index
-    #   git.stashes.apply(1)
-    #
-    # @param index [Integer, nil] the stash index to apply (default: latest)
-    #
-    # @return [String] the output from the git stash apply command
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def apply(index = nil)
-      stash_repository.stash_apply(index)
-    end
-
-    # Removes all stash entries
-    #
-    # @example Clear all stashes
-    #   git.stashes.clear
-    #   git.stashes.size  #=> 0
-    #
-    # @return [void]
-    #
-    # @raise [Git::FailedError] if git exits with a non-zero exit status
-    #
-    def clear
-      stash_repository.stash_clear
-      @stashes = []
-      nil
-    end
-
-    # Returns the number of stash entries
-    #
-    # @example Check how many stashes exist
-    #   git.stashes.size  #=> 2
-    #
-    # @return [Integer] the number of stashes
-    #
-    def size
-      @stashes.size
-    end
-
-    # Iterates over each stash entry in newest-first order
-    #
-    # @example Iterate over stashes
-    #   git.stashes.each { |s| puts s.message }
-    #
-    # @overload each
-    #
-    #   @return [Enumerator<Git::Stash>] an enumerator over stash entries
-    #
-    # @overload each(&block)
-    #
-    #   @yield [stash] each stash entry
-    #
-    #   @yieldparam stash [Git::Stash] the current stash entry
-    #
-    #   @yieldreturn [void]
-    #
-    #   @return [Array<Git::Stash>] the stash entries
-    #
-    def each(&)
-      @stashes.each(&)
-    end
-
-    # Returns the stash entry at the given index
-    #
-    # Stashes are stored in newest-first order; index 0 is the most recent stash.
-    #
-    # @example Access the most recent stash
-    #   git.stashes[0].message  #=> "WIP: feature work"
-    #
-    # @param index [Integer, #to_i] the stash index (0 = most recent)
-    #
-    # @return [Git::Stash, nil] the stash entry, or `nil` if the index is out of bounds
-    #
-    def [](index)
-      @stashes[index.to_i]
-    end
-
-    private
-
-    # Wraps every entry from the repository in a Git::Stash, newest first
-    #
-    # @return [void]
-    #
-    def load_stashes
-      stash_repository.stashes_all.each do |stash|
-        message = stash[1]
-        @stashes.unshift(Git::Stash.new(@base, message, existing: true))
-      end
-    end
-
-    # Returns the facade interface for stash operations
-    #
-    # @return [Git::Repository]
-    #
-    def stash_repository
-      @base
-    end
-  end
-end