Merge pull request #657 from libgit2/arthur/add-commit-summary

Add `Rugged::Commit#summary`

Author: arthurschreiber

ext/rugged/rugged_commit.c

@@ -19,7 +19,7 @@ VALUE rb_cRuggedCommit;
  *    commit.message -> msg
  *
  *  Return the message of this commit. This includes the full body of the
- *  message, with the short description, detailed descritpion, and any
+ *  message, with the short description, detailed description, and any
  *  optional footers or signatures after it.
  *
  *  In Ruby 1.9+, the returned string will be encoded with the encoding
@@ -44,6 +44,35 @@ static VALUE rb_git_commit_message_GET(VALUE self)
 	return rb_enc_str_new(message, strlen(message), encoding);
 }
 
+/*
+ *  call-seq:
+ *    commit.summary -> summary
+ *
+ *  Return the short summary message of this commit.
+ *
+ *  In Ruby 1.9+, the returned string will be encoded with the encoding
+ *  specified in the +Encoding+ header of the commit, if available.
+ *
+ *    commit.message #=> "add a lot of RDoc docs\n\nthis includes docs for commit and blob"
+ *    commit.summary #=> "add a lot of RDoc docs"
+ */
+static VALUE rb_git_commit_summary_GET(VALUE self)
+{
+	git_commit *commit;
+	rb_encoding *encoding = rb_utf8_encoding();
+	const char *encoding_name;
+	const char *summary;
+
+	Data_Get_Struct(self, git_commit, commit);
+
+	summary = git_commit_summary(commit);
+	encoding_name = git_commit_message_encoding(commit);
+	if (encoding_name != NULL)
+		encoding = rb_enc_find(encoding_name);
+
+	return rb_enc_str_new(summary, strlen(summary), encoding);
+}
+
 /*
  *  call-seq:
  *    commit.committer -> signature
@@ -790,6 +819,7 @@ void Init_rugged_commit(void)
 	rb_define_singleton_method(rb_cRuggedCommit, "extract_signature", rb_git_commit_extract_signature, -1);
 
 	rb_define_method(rb_cRuggedCommit, "message", rb_git_commit_message_GET, 0);
+	rb_define_method(rb_cRuggedCommit, "summary", rb_git_commit_summary_GET, 0);
 	rb_define_method(rb_cRuggedCommit, "epoch_time", rb_git_commit_epoch_time_GET, 0);
 	rb_define_method(rb_cRuggedCommit, "committer", rb_git_commit_committer_GET, 0);
 	rb_define_method(rb_cRuggedCommit, "author", rb_git_commit_author_GET, 0);

test/commit_test.rb

@@ -348,6 +348,20 @@ def test_create_with_signature
     raw_commit = Rugged::Commit::lookup(@repo, id1).read_raw.data
     assert_equal signed_commit, raw_commit
   end
+
+  def test_commit_summary
+    person = {:name => 'Scott', :email => '[email protected]', :time => Time.now }
+
+    commit_id = Rugged::Commit.create(@repo,
+      :message => "This is the commit message\n\nThis commit is created from Rugged",
+      :committer => person,
+      :author => person,
+      :parents => [@repo.head.target],
+      :tree => "c4dc1555e4d4fa0e0c9c3fc46734c7c35b3ce90b")
+
+    commit = Rugged::Commit.lookup(@repo, commit_id)
+    assert_equal "This is the commit message", commit.summary
+  end
 end
 
 class CommitWriteTest < Rugged::TestCase