class Git::Stash

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

Attributes

message [R]

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

Public Class Methods

new (base, message, existing: false)

Source

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

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

Public Instance Methods

save ()

Source

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

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

saved? ()

Source

# File lib/git/stash.rb, line 90
def saved?
  @saved
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`)

to_s ()

Source

# File lib/git/stash.rb, line 112
def to_s
  message
end

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

Private Instance Methods

stash_repository ()

Source

# File lib/git/stash.rb, line 120
def stash_repository
  @base
end

@return [Git::Repository]