Class: Git::Log::Result

Inherits:

Data

• Object
• Data
• Git::Log::Result

Includes:

Enumerable

Defined in:

lib/git/log.rb

Overview

An immutable, Enumerable collection of Git::Object::Commit objects. Returned by Git::Log#execute.

Instance Attribute Summary

• #commits ⇒ Object readonly

  Returns the value of attribute commits.

Instance Method Summary

• #[](index) ⇒ Git::Object::Commit, ...

  Returns a commit by index or a slice of commits by range.

• #each(&block)

  Iterates over each commit in query order.

• #last ⇒ Git::Object::Commit^?

  Returns the last commit in the result.

• #size ⇒ Integer

  Returns the number of commits in the result.

• #to_s ⇒ String

  Returns the commits joined with newlines.

Instance Attribute Details

#commits ⇒ Object (readonly)

Returns the value of attribute commits

Returns:

• (Object) —

  the current value of commits

# File 'lib/git/log.rb', line 30

def commits
  @commits
end

Instance Method Details

#[](index) ⇒ Git::Object::Commit, ...

Returns a commit by index or a slice of commits by range

Parameters:

• index (Integer, Range) —

  the commit index or range to retrieve

Returns:

• (Git::Object::Commit, Array<Git::Object::Commit>, nil) —

  the selected commit or commits

# File 'lib/git/log.rb', line 68

def [](index) = commits[index]

#each ⇒ Enumerator<Git::Object::Commit> #each {|commit| ... } ⇒ Array<Git::Object::Commit>

Iterates over each commit in query order

Overloads:

• #each ⇒ Enumerator<Git::Object::Commit>

  Returns an enumerator over commits.

  Examples:

  Get an enumerator

  results.each.map(&:sha)

  Returns:

  • (Enumerator<Git::Object::Commit>) —

    an enumerator over commits

• #each {|commit| ... } ⇒ Array<Git::Object::Commit>

  Returns the commit array.

  Examples:

  Iterate with a block

  results.each { |commit| puts commit.sha }

  Yields:

  • (commit) —

    each commit from the result

  Yield Parameters:

  • commit (Git::Object::Commit) —

    a commit in query order

  Yield Returns:

  • (void)

  Returns:

  • (Array<Git::Object::Commit>) —

    the commit array

# File 'lib/git/log.rb', line 53

def each(&block) = commits.each(&block)

#last ⇒ Git::Object::Commit^?

Returns the last commit in the result

Returns:

• (Git::Object::Commit, nil) —

  the last commit, or nil when empty

# File 'lib/git/log.rb', line 59

def last = commits.last

#size ⇒ Integer

Returns the number of commits in the result

Returns:

• (Integer) —

  the commit count

# File 'lib/git/log.rb', line 80

def size = commits.size

#to_s ⇒ String

Returns the commits joined with newlines

Returns:

• (String) —

  newline-separated commits

# File 'lib/git/log.rb', line 74

def to_s = commits.join("\n")