Class Grit::Commit
In: lib/grit/commit.rb
Parent: Object

Methods

actor   count   create   create_initialize   date   diff   diffs   find_all   id_abbrev   inspect   lazy_source   list_from_string   new   sha   show   to_hash   to_s  

Attributes

id  [R] 

Public Class methods

actor(line)

Parse out the actor (author or committer) info

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

count(repo, ref)

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

create(repo, atts)

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)

diff(repo, a, b = nil, paths = [])

Show diffs between two trees: 

  +repo+ is the Repo
  +a+ is a named commit
  +b+ is an optional named commit.  Passing an array assumes you
    wish to omit the second named commit and limit the diff to the
    given paths.
  +paths* is an array of paths to limit the diff.

Returns Grit::Diff[] (baked)

find_all(repo, ref, options = {})

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)

list_from_string(repo, text)

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
new(repo, id, parents, tree, author, authored_date, committer, committed_date, message)

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)

Public Instance methods

create_initialize(repo, atts)

Initializer for Commit.create 

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

Returns Grit::Commit (unbaked)

inspect()

Pretty object inspection

to_s()

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

[Validate]