Class: Grit::Commit

Inherits:
Object
  • Object
show all
Extended by:
Lazy
Defined in:
lib/grit/commit.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Lazy

extended, lazy_reader

Constructor Details

#initialize(repo, id, parents, tree, author, authored_date, committer, committed_date, message) ⇒ Commit

Instantiate a new Commit

+id+ is the id of the commit
+parents+ is an array of commit ids (will be converted into Commit instances)
+tree+ is the correspdonding tree id (will be converted into a Tree object)
+author+ is the author string
+authored_date+ is the authored Time
+committer+ is the committer string
+committed_date+ is the committed Time
+message+ is an array of commit message lines

Returns Grit::Commit (baked)


54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/grit/commit.rb', line 54

def initialize(repo, id, parents, tree, author, authored_date, committer, committed_date, message)
  @repo = repo
  @id = id
  @parents = parents.map { |p| Commit.create(repo, :id => p) }
  @tree = Tree.create(repo, :id => tree)
  @author = author
  @authored_date = authored_date
  @committer = committer
  @committed_date = committed_date
  @message = message.join("\n")
  @short_message = message.select { |x| !x.strip.empty? }[0] || ''
end

Instance Attribute Details

#idObject (readonly)

Returns the value of attribute id


6
7
8
# File 'lib/grit/commit.rb', line 6

def id
  @id
end

#repoObject (readonly)

Returns the value of attribute repo


7
8
9
# File 'lib/grit/commit.rb', line 7

def repo
  @repo
end

Class Method Details

.actor(line) ⇒ Object

Parse out the actor (author or committer) info

Returns [String (actor name and email), Time (acted at time)]


265
266
267
268
# File 'lib/grit/commit.rb', line 265

def self.actor(line)
  m, actor, epoch = *line.match(/^.+? (.*) (\d+) .*$/)
  [Actor.from_string(actor), Time.at(epoch.to_i)]
end

.count(repo, ref) ⇒ Object

Count the number of commits reachable from this ref

+repo+ is the Repo
+ref+ is the ref from which to begin (SHA1 or name)

Returns Integer


102
103
104
# File 'lib/grit/commit.rb', line 102

def self.count(repo, ref)
  repo.git.rev_list({}, ref).size / 41
end

.create(repo, atts) ⇒ Object

Create an unbaked Commit containing just the specified attributes

+repo+ is the Repo
+atts+ is a Hash of instance variable data

Returns Grit::Commit (unbaked)


76
77
78
# File 'lib/grit/commit.rb', line 76

def self.create(repo, atts)
  self.allocate.create_initialize(repo, atts)
end

.diff(repo, a, b = nil, paths = [], options = {}) ⇒ Object

Show diffs between two trees.

repo - The current Grit::Repo instance. a - A String named commit. b - An optional String named commit. Passing an array assumes you

wish to omit the second named commit and limit the diff to the
given paths.

paths - An optional Array of paths to limit the diff. options - An optional Hash of options. Merged into => true.

Returns Grit::Diff[] (baked)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/grit/commit.rb', line 182

def self.diff(repo, a, b = nil, paths = [], options = {})
  if b.is_a?(Array)
    paths = b
    b     = nil
  end
  paths.unshift("--") unless paths.empty?
  paths.unshift(b)    unless b.nil?
  paths.unshift(a)
  options = {:full_index => true}.update(options)
  text    = repo.git.diff(options, *paths)
  Diff.list_from_string(repo, text)
end

.find_all(repo, ref, options = {}) ⇒ Object

Find all commits matching the given criteria.

+repo+ is the Repo
+ref+ is the ref from which to begin (SHA1 or name) or nil for --all
+options+ is a Hash of optional arguments to git
  :max_count is the maximum number of commits to fetch
  :skip is the number of commits to skip

Returns Grit::Commit[] (baked)


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/grit/commit.rb', line 114

def self.find_all(repo, ref, options = {})
  allowed_options = [:max_count, :skip, :since]

  default_options = {:pretty => "raw"}
  actual_options = default_options.merge(options)

  if ref
    output = repo.git.rev_list(actual_options, ref)
  else
    output = repo.git.rev_list(actual_options.merge(:all => true))
  end

  self.list_from_string(repo, output)
rescue Grit::GitRuby::Repository::NoSuchShaFound
  []
end

.list_from_string(repo, text) ⇒ Object

Parse out commit information into an array of baked Commit objects

+repo+ is the Repo
+text+ is the text output from the git command (raw format)

Returns Grit::Commit[] (baked)

really should re-write this to be more accepting of non-standard commit messages

  • it broke when 'encoding' was introduced - not sure what else might show up


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/grit/commit.rb', line 140

def self.list_from_string(repo, text)
  lines = text.split("\n")

  commits = []

  while !lines.empty?
    id = lines.shift.split.last
    tree = lines.shift.split.last

    parents = []
    parents << lines.shift.split.last while lines.first =~ /^parent/

    author, authored_date = self.actor(lines.shift)
    committer, committed_date = self.actor(lines.shift)

    # not doing anything with this yet, but it's sometimes there
    encoding = lines.shift.split.last if lines.first =~ /^encoding/

    lines.shift

    message_lines = []
    message_lines << lines.shift[4..-1] while lines.first =~ /^ {4}/

    lines.shift while lines.first && lines.first.empty?

    commits << Commit.new(repo, id, parents, tree, author, authored_date, committer, committed_date, message_lines)
  end

  commits
end

.parse_batch(repo, sha, size, object) ⇒ Object

Parses output from the `git-cat-file –batch'.

repo - Grit::Repo instance. sha - String SHA of the Commit. size - Fixnum size of the object. object - Parsed String output from `git cat-file –batch`.

Returns an Array of Grit::Commit objects.


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/grit/commit.rb', line 26

def self.parse_batch(repo, sha, size, object)
  info, message = object.split("\n\n", 2)

  lines = info.split("\n")
  tree = lines.shift.split(' ', 2).last
  parents = []
  parents << lines.shift[7..-1] while lines.first[0, 6] == 'parent'
  author,    authored_date  = Grit::Commit.actor(lines.shift)
  committer, committed_date = Grit::Commit.actor(lines.shift)

  Grit::Commit.new(
    repo, sha, parents, tree,
    author, authored_date,
    committer, committed_date,
    message.to_s.split("\n"))
end

Instance Method Details

#author_stringObject


270
271
272
# File 'lib/grit/commit.rb', line 270

def author_string
  "%s <%s> %s %+05d" % [author.name, author.email, authored_date.to_i, 800]
end

#create_initialize(repo, atts) ⇒ Object

Initializer for Commit.create

+repo+ is the Repo
+atts+ is a Hash of instance variable data

Returns Grit::Commit (unbaked)


85
86
87
88
89
90
91
# File 'lib/grit/commit.rb', line 85

def create_initialize(repo, atts)
  @repo = repo
  atts.each do |k, v|
    instance_variable_set("@#{k}", v)
  end
  self
end

#dateObject


236
237
238
# File 'lib/grit/commit.rb', line 236

def date
  @committed_date
end

#diffs(options = {}) ⇒ Object

Shows diffs between the commit's parent and the commit.

options - An optional Hash of options, passed to Grit::Commit.diff.

Returns Grit::Diff[] (baked)


215
216
217
218
219
220
221
# File 'lib/grit/commit.rb', line 215

def diffs(options = {})
  if parents.empty?
    show
  else
    self.class.diff(@repo, parents.first.id, @id, [], options)
  end
end

#id_abbrevObject


67
68
69
# File 'lib/grit/commit.rb', line 67

def id_abbrev
  @id_abbrev ||= @repo.git.rev_parse({}, self.id).chomp[0, 7]
end

#inspectObject

Pretty object inspection


256
257
258
# File 'lib/grit/commit.rb', line 256

def inspect
  %Q{#<Grit::Commit "#{@id}">}
end

#lazy_sourceObject


93
94
95
# File 'lib/grit/commit.rb', line 93

def lazy_source
  self.class.find_all(@repo, @id, {:max_count => 1}).first
end

#notesObject


244
245
246
247
248
249
250
251
252
253
# File 'lib/grit/commit.rb', line 244

def notes
  ret = {}
  notes = Note.find_all(@repo)
  notes.each do |note|
    if n = note.commit.tree/(self.id)
      ret[note.name] = n.data
    end
  end
  ret
end

#shaObject


232
233
234
# File 'lib/grit/commit.rb', line 232

def sha
  @id
end

#showObject


195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/grit/commit.rb', line 195

def show
  if parents.size > 1
    diff = @repo.git.native(:diff, {:full_index => true}, "#{parents[0].id}...#{parents[1].id}")
  else
    diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
  end

  if diff =~ /diff --git a/
    diff = diff.sub(/.+?(diff --git a)/m, '\1')
  else
    diff = ''
  end
  Diff.list_from_string(@repo, diff)
end

#statsObject


223
224
225
# File 'lib/grit/commit.rb', line 223

def stats
  stats = @repo.commit_stats(self.sha, 1)[0][-1]
end

#to_hashObject


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/grit/commit.rb', line 274

def to_hash
  {
    'id'       => id,
    'parents'  => parents.map { |p| { 'id' => p.id } },
    'tree'     => tree.id,
    'message'  => message,
    'author'   => {
      'name'  => author.name,
      'email' => author.email
    },
    'committer' => {
      'name'  => committer.name,
      'email' => committer.email
    },
    'authored_date'  => authored_date.xmlschema,
    'committed_date' => committed_date.xmlschema,
  }
end

#to_patchObject


240
241
242
# File 'lib/grit/commit.rb', line 240

def to_patch
  @repo.git.format_patch({'1' => true, :stdout => true}, to_s)
end

#to_sObject

Convert this Commit to a String which is just the SHA1 id


228
229
230
# File 'lib/grit/commit.rb', line 228

def to_s
  @id
end