class Git::Stashes

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

Public Class Methods

new (base)

Source

# File lib/git/stashes.rb, line 46
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

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

Public Instance Methods

[] (index)

Source

# File lib/git/stashes.rb, line 173
def [](index)
  @stashes[index.to_i]
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

all ()

Source

# File lib/git/stashes.rb, line 71
def all
  # stashes_all is deprecated too; silence it so this call emits no second warning
  Git::Deprecation.silence { stash_repository.stashes_all }
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

apply (index = nil)

Source

# File lib/git/stashes.rb, line 108
def apply(index = nil)
  stash_repository.stash_apply(index)
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

clear ()

Source

# File lib/git/stashes.rb, line 122
def clear
  stash_repository.stash_clear
  @stashes = []
  nil
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

each (&)

Source

# File lib/git/stashes.rb, line 158
def each(&)
  @stashes.each(&)
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

save (message)

Source

# File lib/git/stashes.rb, line 88
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

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

size ()

Source

# File lib/git/stashes.rb, line 135
def size
  @stashes.size
end

Returns the number of stash entries

@example Check how many stashes exist

git.stashes.size  #=> 2

@return [Integer] the number of stashes

Private Instance Methods

load_stashes ()

Source

# File lib/git/stashes.rb, line 183
def load_stashes
  stash_repository.stashes_all.each do |stash|
    message = stash[1]
    @stashes.unshift(Git::Stash.new(@base, message, existing: true))
  end
end

Wraps every entry from the repository in a Git::Stash, newest first

@return [void]

stash_repository ()

Source

# File lib/git/stashes.rb, line 194
def stash_repository
  @base
end

Returns the facade interface for stash operations

@return [Git::Repository]