module Git::Base::Factory

Public Instance Methods

branch(branch_name = 'master') click to toggle source

@return [Git::Branch] an object for branch_name

# File lib/git/base/factory.rb, line 8
def branch(branch_name = 'master')
  Git::Branch.new(self, branch_name)
end
branches() click to toggle source

@return [Git::Branches] a collection of all the branches in the repository.

Each branch is represented as a {Git::Branch}.
# File lib/git/base/factory.rb, line 14
def branches
  Git::Branches.new(self)
end
commit_tree(tree = nil, opts = {}) click to toggle source

@return [Git::Object::Commit] a commit object

# File lib/git/base/factory.rb, line 30
def commit_tree(tree = nil, opts = {})
  Git::Object::Commit.new(self, self.lib.commit_tree(tree, opts))
end
diff(objectish = 'HEAD', obj2 = nil) click to toggle source

@return [Git::Diff] a Git::Diff object

# File lib/git/base/factory.rb, line 35
def diff(objectish = 'HEAD', obj2 = nil)
  Git::Diff.new(self, objectish, obj2)
end
gblob(objectish) click to toggle source

@return [Git::Object] a Git object

# File lib/git/base/factory.rb, line 40
def gblob(objectish)
  Git::Object.new(self, objectish, 'blob')
end
gcommit(objectish) click to toggle source

@return [Git::Object] a Git object

# File lib/git/base/factory.rb, line 45
def gcommit(objectish)
  Git::Object.new(self, objectish, 'commit')
end
gtree(objectish) click to toggle source

@return [Git::Object] a Git object

# File lib/git/base/factory.rb, line 50
def gtree(objectish)
  Git::Object.new(self, objectish, 'tree')
end
log(count = 30) click to toggle source

@return [Git::Log] a log with the specified number of commits

# File lib/git/base/factory.rb, line 55
def log(count = 30)
  Git::Log.new(self, count)
end
merge_base(*args) click to toggle source

Find as good common ancestors as possible for a merge example: g.merge_base(‘master’, ‘some_branch’, ‘some_sha’, octopus: true)

@return [Array<Git::Object::Commit>] a collection of common ancestors

# File lib/git/base/factory.rb, line 92
def merge_base(*args)
  shas = self.lib.merge_base(*args)
  shas.map { |sha| gcommit(sha) }
end
object(objectish) click to toggle source

returns a Git::Object of the appropriate type you can also call @git.gtree(‘tree’), but that’s just for readability. If you call @git.gtree(‘HEAD’) it will still return a Git::Object::Commit object.

object calls a factory method that will run a rev-parse on the objectish and determine the type of the object and return an appropriate object for that type

@return [Git::Object] an instance of the appropriate type of Git::Object

# File lib/git/base/factory.rb, line 69
def object(objectish)
  Git::Object.new(self, objectish)
end
remote(remote_name = 'origin') click to toggle source

@return [Git::Remote] a remote of the specified name

# File lib/git/base/factory.rb, line 74
def remote(remote_name = 'origin')
  Git::Remote.new(self, remote_name)
end
status() click to toggle source

@return [Git::Status] a status object

# File lib/git/base/factory.rb, line 79
def status
  Git::Status.new(self)
end
tag(tag_name) click to toggle source

@return [Git::Object::Tag] a tag object

# File lib/git/base/factory.rb, line 84
def tag(tag_name)
  Git::Object.new(self, tag_name, 'tag', true)
end
worktree(dir, commitish = nil) click to toggle source

returns a Git::Worktree object for dir, commitish

# File lib/git/base/factory.rb, line 19
def worktree(dir, commitish = nil)
  Git::Worktree.new(self, dir, commitish)
end
worktrees() click to toggle source

returns a Git::worktrees object of all the Git::Worktrees objects for this repo

# File lib/git/base/factory.rb, line 25
def worktrees
  Git::Worktrees.new(self)
end