In Files

Parent

Included Modules

Files

Git::Log

object that holds the last X commits on given branch

Public Class Methods

new(base, count = 30) click to toggle source
    # File lib/git/log.rb, line 7
 7:     def initialize(base, count = 30)
 8:       dirty_log
 9:       @base = base
10:       @count = count
11:  
12:       @commits = nil
13:       @author = nil
14:       @grep = nil
15:       @object = nil
16:       @path = nil
17:       @since = nil
18:       @skip = nil
19:       @until = nil
20:       @between = nil
21:     end

Public Instance Methods

author(regex) click to toggle source
    # File lib/git/log.rb, line 29
29:     def author(regex)
30:       dirty_log
31:       @author = regex
32:       return self
33:     end
between(sha1, sha2 = nil) click to toggle source
    # File lib/git/log.rb, line 65
65:     def between(sha1, sha2 = nil)
66:       dirty_log
67:       @between = [sha1, sha2]
68:       return self
69:     end
each(&block) click to toggle source
    # File lib/git/log.rb, line 83
83:     def each(&block)
84:       check_log
85:       @commits.each(&block)
86:     end
first() click to toggle source
    # File lib/git/log.rb, line 88
88:     def first
89:       check_log
90:       @commits.first rescue nil
91:     end
grep(regex) click to toggle source
    # File lib/git/log.rb, line 35
35:     def grep(regex)
36:       dirty_log
37:       @grep = regex
38:       return self
39:     end
object(objectish) click to toggle source
    # File lib/git/log.rb, line 23
23:     def object(objectish)
24:       dirty_log
25:       @object = objectish
26:       return self
27:     end
path(path) click to toggle source
    # File lib/git/log.rb, line 41
41:     def path(path)
42:       dirty_log
43:       @path = path
44:       return self
45:     end
since(date) click to toggle source
    # File lib/git/log.rb, line 53
53:     def since(date)
54:       dirty_log
55:       @since = date
56:       return self
57:     end
size() click to toggle source

forces git log to run

    # File lib/git/log.rb, line 78
78:     def size
79:       check_log
80:       @commits.size rescue nil
81:     end
skip(num) click to toggle source
    # File lib/git/log.rb, line 47
47:     def skip(num)
48:       dirty_log
49:       @skip = num
50:       return self
51:     end
to_s() click to toggle source
    # File lib/git/log.rb, line 71
71:     def to_s
72:       self.map { |c| c.to_s }.join("\n")
73:     end
until(date) click to toggle source
    # File lib/git/log.rb, line 59
59:     def until(date)
60:       dirty_log
61:       @until = date
62:       return self
63:     end

Private Instance Methods

check_log() click to toggle source
     # File lib/git/log.rb, line 99
 99:       def check_log
100:         if @dirty_flag
101:           run_log
102:           @dirty_flag = false
103:         end
104:       end
dirty_log() click to toggle source
    # File lib/git/log.rb, line 95
95:       def dirty_log
96:         @dirty_flag = true
97:       end
run_log() click to toggle source

actually run the ‘git log’ command

     # File lib/git/log.rb, line 107
107:       def run_log      
108:         log = @base.lib.full_log_commits(:count => @count, :object => @object, 
109:                                     :path_limiter => @path, :since => @since, 
110:                                     :author => @author, :grep => @grep, :skip => @skip,
111:                                     :until => @until, :between => @between)
112:         @commits = log.map { |c| Git::Object::Commit.new(@base, c['sha'], c) }
113:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.