class Git::Worktree
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
@api public
Attributes
Filesystem path of this worktree
@return [String] the filesystem path of the worktree directory
Full worktree descriptor including the optional commitish
@return [String] the filesystem path, space-separated with the commitish
when one was given at construction time
Public Class Methods
Source
# File lib/git/worktree.rb, line 43 def initialize(base, dir, gcommit = nil) @full = dir @full += " #{gcommit}" unless gcommit.nil? @base = base @dir = dir @gcommit = gcommit end
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]
Public Instance Methods
Source
# File lib/git/worktree.rb, line 90 def add worktree_repository.worktree_add(@dir, @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
Source
# File lib/git/worktree.rb, line 72 def gcommit @gcommit ||= worktree_repository.gcommit(@full) @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
Source
# File lib/git/worktree.rb, line 105 def remove worktree_repository.worktree_remove(@dir) 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
Source
# File lib/git/worktree.rb, line 116 def to_a [@full] 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
Source
# File lib/git/worktree.rb, line 127 def to_s @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)
Private Instance Methods
Source
# File lib/git/worktree.rb, line 137 def worktree_repository @base end
@return [Git::Repository] the repository used for worktree operations
@api private