Class: Git::Log

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/git/log.rb

Overview

Builds and executes a git log query.

This class provides a fluent interface for building complex git log queries. The query is lazily executed when results are requested either via the modern #execute method or the deprecated Enumerable methods.

Examples:

Using the modern execute API

log = git.log.max_count(50).between('v1.0', 'v1.1').author('Scott')
results = log.execute
puts "Found #{results.size} commits."
results.each { |commit| puts commit.sha }

Constant Summary collapse

Result =

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

Data.define(:commits) do
  include Enumerable

  def each(&block) = commits.each(&block)
  def last = commits.last
  def [](index) = commits[index]
  def to_s = map(&:to_s).join("\n")
  def size = commits.size
end

Deprecated Enumerable Interface collapse

Instance Method Summary collapse

Constructor Details

#initialize(base, max_count = 30) ⇒ Log

Create a new Git::Log object

Examples:

git = Git.open('.')
Git::Log.new(git)

Parameters:

  • base (Git::Base) —

    the git repository object

  • max_count (Integer, Symbol, nil) (defaults to: 30) —

    the number of commits to return, or :all or nil to return all

    Passing max_count to #initialize is equivalent to calling #max_count on the object.



46
47
48
49
50
51
 
# File 'lib/git/log.rb', line 46

def initialize(base, max_count = 30)
  @base = base
  @options = {}
  @dirty = true
  self.max_count(max_count)
end

Instance Method Details

#[](index)

Deprecated.

Use #execute and call the method on the result.



137
138
139
140
141
142
143
 
# File 'lib/git/log.rb', line 137

def [](index)
  Git::Deprecation.warn(
    'Calling Git::Log#[] is deprecated. Call #execute and then #[] on the result object.'
  )
  run_log_if_dirty
  @commits&.[](index)
end

#all 



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

def all                 = set_option(:all, true)

#author(regex) 



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

def author(regex)       = set_option(:author, regex)

#between(val1, val2 = nil) 



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

def between(val1, val2 = nil) = set_option(:between, [val1, val2])

#cherry 



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

def cherry              = set_option(:cherry, true)

#each

Deprecated.

Use #execute and call each on the result.



92
93
94
95
96
97
98
 
# File 'lib/git/log.rb', line 92

def each(&)
  Git::Deprecation.warn(
    'Calling Git::Log#each is deprecated. Call #execute and then #each on the result object.'
  )
  run_log_if_dirty
  @commits.each(&)
end

#execute ⇒ Git::Log::Result

Executes the git log command and returns an immutable result object

This is the preferred way to get log data. It separates the query building from the execution, making the API more predictable.

Examples:

query = g.log.since('2 weeks ago').author('Scott')
results = query.execute
puts "Found #{results.size} commits"
results.each do |commit|
  # ...
end

Returns:



84
85
86
87
 
# File 'lib/git/log.rb', line 84

def execute
  run_log_if_dirty
  Result.new(@commits)
end

#first

Deprecated.

Use #execute and call the method on the result.



119
120
121
122
123
124
125
 
# File 'lib/git/log.rb', line 119

def first
  Git::Deprecation.warn(
    'Calling Git::Log#first is deprecated. Call #execute and then #first on the result object.'
  )
  run_log_if_dirty
  @commits&.first
end

#grep(regex) 



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

def grep(regex)         = set_option(:grep, regex)

#last

Deprecated.

Use #execute and call the method on the result.



128
129
130
131
132
133
134
 
# File 'lib/git/log.rb', line 128

def last
  Git::Deprecation.warn(
    'Calling Git::Log#last is deprecated. Call #execute and then #last on the result object.'
  )
  run_log_if_dirty
  @commits&.last
end

#max_count(num)

Set query options using a fluent interface. Each method returns self to allow for chaining.



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

def max_count(num)      = set_option(:count, num == :all ? nil : num)

#merges 



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

def merges              = set_option(:merges, true)

#object(objectish) 



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

def object(objectish)   = set_option(:object, objectish)

#path(path) 



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

def path(path)          = set_option(:path_limiter, path)

#since(date) 



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

def since(date)         = set_option(:since, date)

#size

Deprecated.

Use #execute and call size on the result.



101
102
103
104
105
106
107
 
# File 'lib/git/log.rb', line 101

def size
  Git::Deprecation.warn(
    'Calling Git::Log#size is deprecated. Call #execute and then #size on the result object.'
  )
  run_log_if_dirty
  @commits&.size
end

#skip(num) 



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

def skip(num)           = set_option(:skip, num)

#to_s

Deprecated.

Use #execute and call to_s on the result.



110
111
112
113
114
115
116
 
# File 'lib/git/log.rb', line 110

def to_s
  Git::Deprecation.warn(
    'Calling Git::Log#to_s is deprecated. Call #execute and then #to_s on the result object.'
  )
  run_log_if_dirty
  @commits&.map(&:to_s)&.join("\n")
end

#until(date) 



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

def until(date)         = set_option(:until, date)