Class: Git::Object::Commit

Inherits:
AbstractObject show all
Defined in:
lib/git/object.rb

Overview

A Git commit object

Instance Attribute Summary

Attributes inherited from AbstractObject

#mode, #objectish, #size, #type

Instance Method Summary collapse

Methods inherited from AbstractObject

#archive, #blob?, #contents, #contents_array, #diff, #grep, #log, #sha, #tag?, #to_s, #tree?

Constructor Details

#initialize(base, sha, init = nil) ⇒ Commit

Creates a commit object wrapper

Parameters:

  • base (Git::Repository) —

    the repository used to query object data

  • sha (String) —

    the commit SHA or object expression

  • init (Hash, nil) (defaults to: nil) —

    parsed commit data used to initialize eagerly



388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/git/object.rb', line 388

def initialize(base, sha, init = nil)
  super(base, sha)
  @tree = nil
  @parents = nil
  @author = nil
  @committer = nil
  @message = nil
  return unless init

  from_data(init)
end

Instance Method Details

#author ⇒ Git::AuthorInfo

Returns the commit author identity

Returns:



445
446
447
448
 
# File 'lib/git/object.rb', line 445

def author
  check_commit
  @author
end

#author_date ⇒ Time

Returns the author date

Returns:

  • (Time) —

    the author timestamp



454
455
456
 
# File 'lib/git/object.rb', line 454

def author_date
  author.date
end

#commit? ⇒ Boolean

Returns whether this object is a commit

Returns:

  • (Boolean) —

    true



519
520
521
 
# File 'lib/git/object.rb', line 519

def commit?
  true
end

#committer ⇒ Git::AuthorInfo

Returns the commit committer identity

Returns:



462
463
464
465
 
# File 'lib/git/object.rb', line 462

def committer
  check_commit
  @committer
end

#committer_date ⇒ Time Also known as: date

Returns the committer date

Returns:

  • (Time) —

    the committer timestamp



471
472
473
 
# File 'lib/git/object.rb', line 471

def committer_date
  committer.date
end

#diff_parent ⇒ Git::Diff

Returns the diff between this commit and its first parent

Returns:

  • (Git::Diff) —

    the diff from the first parent to this commit



480
481
482
 
# File 'lib/git/object.rb', line 480

def diff_parent
  diff(parent)
end

#from_data(data)

This method returns an undefined value.

Loads parsed commit data into this commit object

Parameters:

  • data (Hash) —

    parsed commit data from git cat-file commit



506
507
508
509
510
511
512
513
 
# File 'lib/git/object.rb', line 506

def from_data(data)
  @sha ||= data['sha']
  @committer = Git::AuthorInfo.parse(data['committer'])
  @author = Git::AuthorInfo.parse(data['author'])
  @tree = Git::Object::Tree.new(@base, data['tree'])
  @parents = data['parent'].map { |sha| Git::Object::Commit.new(@base, sha) }
  @message = data['message'].chomp
end

#gtree ⇒ Git::Object::Tree

Returns the tree for this commit

Returns:



421
422
423
424
 
# File 'lib/git/object.rb', line 421

def gtree
  check_commit
  Tree.new(@base, @tree)
end

#message ⇒ String

Returns the commit message

Returns:

  • (String) —

    the commit message without the trailing newline



404
405
406
407
 
# File 'lib/git/object.rb', line 404

def message
  check_commit
  @message
end

#name ⇒ String

Returns the symbolic name for this commit

Returns:

  • (String) —

    the name produced by git name-rev



413
414
415
 
# File 'lib/git/object.rb', line 413

def name
  object_repository.name_rev(sha)
end

#parent ⇒ Git::Object::Commit?

Returns the first parent commit

Returns:



431
432
433
 
# File 'lib/git/object.rb', line 431

def parent
  parents.first
end

#parents

array of all parent commits



436
437
438
439
 
# File 'lib/git/object.rb', line 436

def parents
  check_commit
  @parents
end

#set_commit(data)

Deprecated.

use #from_data instead

This method returns an undefined value.

Sets parsed commit data on this commit object

Parameters:

  • data (Hash) —

    parsed commit data



492
493
494
495
496
497
498
 
# File 'lib/git/object.rb', line 492

def set_commit(data) # rubocop:disable Naming/AccessorMethodName
  Git::Deprecation.warn(
    'Git::Object::Commit#set_commit is deprecated and will be removed in v6.0.0. ' \
    'Use #from_data instead.'
  )
  from_data(data)
end