Class: Rugged::Commit

Inherits:
Object
  • Object
show all
Defined in:
lib/rugged/commit.rb,
ext/rugged/rugged_commit.c

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#<=>, #==, #create_note, lookup, new, #notes, #oid, #read_raw, #remove_note, rev_parse, rev_parse_oid, #type

Class Method Details

.create(repository, data = {}) ⇒ Object

Write a new Commit object to repository, with the given data arguments, passed as a Hash:

  • :message: a string with the full text for the commit's message

  • :committer (optional): a hash with the signature for the committer, defaults to the signature from the configuration

  • :author (optional): a hash with the signature for the author, defaults to the signature from the configuration

  • :parents: an Array with zero or more parents for this commit, represented as Rugged::Commit instances, or OID String.

  • :tree: the tree for this commit, represented as a Rugged::Tree instance or an OID String.

  • :update_ref (optional): a String with the name of a reference in the repository which should be updated to point to this commit (e.g. “HEAD”)

When the commit is successfully written to disk, its oid will be returned as a hex String.

author = {:email=>"[email protected]", :time=>Time.now, :name=>"Vicent Mart\303\255"}

Rugged::Commit.create(r,
  :author => author,
  :message => "Hello world\n\n",
  :committer => author,
  :parents => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1"],
  :tree => some_tree) #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"

542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
# File 'ext/rugged/rugged_commit.c', line 542

static VALUE rb_git_commit_create(VALUE self, VALUE rb_repo, VALUE rb_data)
{
	int error = 0;
	struct commit_data commit_data = { Qnil };
	git_oid commit_oid;
	git_repository *repo;

	Check_Type(rb_data, T_HASH);

	rugged_check_repo(rb_repo);
	Data_Get_Struct(rb_repo, git_repository, repo);

	if ((error = parse_commit_options(&commit_data, repo, rb_data)) < 0)
		goto cleanup;

	error = git_commit_create(
		&commit_oid,
		repo,
		commit_data.update_ref,
		commit_data.author,
		commit_data.committer,
		NULL,
		commit_data.message,
		commit_data.tree,
		commit_data.parent_count,
		commit_data.parents);

cleanup:
	free_commit_options(&commit_data);
	if (!NIL_P(commit_data.rb_err_obj))
		rb_exc_raise(commit_data.rb_err_obj);

	rugged_exception_check(error);

	return rugged_create_oid(&commit_oid);
}

.create_to_s(repository, data = {}) ⇒ String

Create a string with the contents of the commit, created with the given data arguments, passed as a Hash:

  • :message: a string with the full text for the commit's message

  • :committer (optional): a hash with the signature for the committer, defaults to the signature from the configuration

  • :author (optional): a hash with the signature for the author, defaults to the signature from the configuration

  • :parents: an Array with zero or more parents for this commit, represented as Rugged::Commit instances, or OID String.

  • :tree: the tree for this commit, represented as a Rugged::Tree instance or an OID String.

    author = :time=>Time.now, :name=>“Vicent Mart303255”

    Rugged::Commit.create(r,

    :author => author,
    :message => "Hello world\n\n",
    :committer => author,
    :parents => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1"],
    :tree => some_tree) #=> "tree some_tree\nparent 2cb831...."
    

Returns:

  • (String)

791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
# File 'ext/rugged/rugged_commit.c', line 791

static VALUE rb_git_commit_create_to_s(VALUE self, VALUE rb_repo, VALUE rb_data)
{
	int error = 0;
	struct commit_data commit_data = { Qnil };
	git_repository *repo;
	git_buf buf = { 0 };
	VALUE ret;

	Check_Type(rb_data, T_HASH);

	rugged_check_repo(rb_repo);
	Data_Get_Struct(rb_repo, git_repository, repo);

	if ((error = parse_commit_options(&commit_data, repo, rb_data)) < 0)
		goto cleanup;

	error = git_commit_create_buffer(
		&buf,
		repo,
		commit_data.author,
		commit_data.committer,
		NULL,
		commit_data.message,
		commit_data.tree,
		commit_data.parent_count,
		commit_data.parents);

cleanup:
	free_commit_options(&commit_data);
	if (!NIL_P(commit_data.rb_err_obj))
		rb_exc_raise(commit_data.rb_err_obj);

	rugged_exception_check(error);

	ret = rb_str_new_utf8(buf.ptr);
	git_buf_dispose(&buf);

	return ret;
}

.create_with_signature(repo, content, signature, field_name = "gpgsig") ⇒ Object

Create a commit from the content string and the signature, adding this data to the field_name header field in the resulting commit.

Returns the new commit's object id.


842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
# File 'ext/rugged/rugged_commit.c', line 842

static VALUE rb_git_commit_create_with_signature(int argc, VALUE *argv, VALUE self)
{
	int error;
	git_oid id;
	const char *field = NULL;
	git_repository *repo;
	VALUE rb_repo, rb_content, rb_signature, rb_field = Qnil;

	rb_scan_args(argc, argv, "31", &rb_repo, &rb_content, &rb_signature, &rb_field);

	rugged_check_repo(rb_repo);
	Data_Get_Struct(rb_repo, git_repository, repo);

	Check_Type(rb_content, T_STRING);
	Check_Type(rb_signature, T_STRING);

	if (!NIL_P(rb_field)) {
		Check_Type(rb_field, T_STRING);
		field = StringValueCStr(rb_field);
	}

	error = git_commit_create_with_signature(&id, repo, StringValueCStr(rb_content), StringValueCStr(rb_signature), field);
	rugged_exception_check(error);

	return rugged_create_oid(&id);
}

.extract_signature(repo, commit, field_name) ⇒ Array

Returns commit's signature in 'field' and the signed data

The signature is done over the contents of the commit without the signature block in the header, which is the data in the second element in the return array.

Returns:

  • (Array)

725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
# File 'ext/rugged/rugged_commit.c', line 725

static VALUE rb_git_commit_extract_signature(int argc, VALUE *argv, VALUE self)
{
	int error;
	VALUE ret;
	git_oid commit_id;
	const char *field;
	git_repository *repo;
	git_buf signature = {0}, signed_data = {0};
	VALUE rb_repo, rb_commit, rb_field = Qnil;

	rb_scan_args(argc, argv, "21", &rb_repo, &rb_commit, &rb_field);

	rugged_check_repo(rb_repo);
	Data_Get_Struct(rb_repo, git_repository, repo);

	error = git_oid_fromstr(&commit_id, StringValueCStr(rb_commit));
	rugged_exception_check(error);

	field = NIL_P(rb_field) ? NULL : StringValueCStr(rb_field);
	error = git_commit_extract_signature(&signature, &signed_data, repo, &commit_id, field);
	if (error < 0) {
		git_buf_dispose(&signature);
		git_buf_dispose(&signed_data);
	}

	if (error == GIT_ENOTFOUND && giterr_last()->klass == GITERR_OBJECT ) {
		ret = Qnil;
	} else {
		rugged_exception_check(error);

		ret = rb_ary_new3(2, rb_str_new(signature.ptr, signature.size),
				     rb_str_new(signed_data.ptr, signed_data.size));
	}

	git_buf_dispose(&signature);
	git_buf_dispose(&signed_data);

	return ret;
}

.prettify_message(msg, strip_comments = true) ⇒ Object


8
9
10
# File 'lib/rugged/commit.rb', line 8

def self.prettify_message(msg, strip_comments = true)
  Rugged::prettify_message(msg, strip_comments)
end

Instance Method Details

#amend(data = {}) ⇒ Object

Amend a commit object, with the given data arguments, passed as a Hash:

  • :message: a string with the full text for the commit's message

  • :committer (optional): a hash with the signature for the committer, defaults to the signature from the configuration

  • :author (optional): a hash with the signature for the author, defaults to the signature from the configuration

  • :tree: the tree for this amended commit, represented as a Rugged::Tree instance or an OID String.

  • :update_ref (optional): a String with the name of a reference in the

repository which should be updated to point to this amended commit (e.g. “HEAD”)

When the amended commit is successfully written to disk, its oid will be returned as a hex String.

author = {:email=>"[email protected]", :time=>Time.now, :name=>"Vicent Mart\303\255"}

commit.amend(
  :author => author,
  :message => "Updated Hello world\n\n",
  :committer => author,
  :tree => some_tree) #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"

343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'ext/rugged/rugged_commit.c', line 343

static VALUE rb_git_commit_amend(VALUE self, VALUE rb_data)
{
	VALUE rb_message, rb_tree, rb_ref, owner;
	int error = 0;
	git_commit *commit_to_amend;
	char *message = NULL;
	git_tree *tree = NULL;
	git_signature *author = NULL, *committer = NULL;
	git_oid commit_oid;
	git_repository *repo;
	const char *update_ref = NULL;

	Check_Type(rb_data, T_HASH);

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit_to_amend);

	owner = rugged_owner(self);
	Data_Get_Struct(owner, git_repository, repo);

	rb_ref = rb_hash_aref(rb_data, CSTR2SYM("update_ref"));
	if (!NIL_P(rb_ref)) {
		Check_Type(rb_ref, T_STRING);
		update_ref = StringValueCStr(rb_ref);
	}

	rb_message = rb_hash_aref(rb_data, CSTR2SYM("message"));
	if (!NIL_P(rb_message)) {
		Check_Type(rb_message, T_STRING);
		message = StringValueCStr(rb_message);
	}

	rb_tree = rb_hash_aref(rb_data, CSTR2SYM("tree"));
	if (!NIL_P(rb_tree))
		tree = (git_tree *)rugged_object_get(repo, rb_tree, GIT_OBJ_TREE);

	if (!NIL_P(rb_hash_aref(rb_data, CSTR2SYM("committer")))) {
		committer = rugged_signature_get(
			rb_hash_aref(rb_data, CSTR2SYM("committer")), repo
		);
	}

	if (!NIL_P(rb_hash_aref(rb_data, CSTR2SYM("author")))) {
		author = rugged_signature_get(
			rb_hash_aref(rb_data, CSTR2SYM("author")), repo
		);
	}

	error = git_commit_amend(
		&commit_oid,
		commit_to_amend,
		update_ref,
		author,
		committer,
		NULL,
		message,
		tree);

	git_signature_free(author);
	git_signature_free(committer);

	git_object_free((git_object *)tree);

	rugged_exception_check(error);

	return rugged_create_oid(&commit_oid);
}

#authorObject

Return the signature for the author of this commit. The signature is returned as a Hash containing :name, :email of the author and :time of the change.

The author of the commit is the person who intially created the changes.

In Ruby 1.9+, the returned string will be encoded with the encoding specified in the Encoding header of the commit, if available.

commit.author #=> {:email=>"[email protected]", :time=>Tue Jan 24 05:42:45 UTC 2012, :name=>"Vicent Mart\303\255"}

174
175
176
177
178
179
180
181
182
# File 'ext/rugged/rugged_commit.c', line 174

static VALUE rb_git_commit_author_GET(VALUE self)
{
	git_commit *commit;
	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	return rugged_signature_new(
		git_commit_author(commit),
		git_commit_message_encoding(commit));
}

#committerObject

Return the signature for the committer of this commit. The signature is returned as a Hash containing :name, :email of the author and :time of the change.

The committer of a commit is the person who actually applied the changes of the commit; in most cases it's the same as the author.

In Ruby 1.9+, the returned string will be encoded with the encoding specified in the Encoding header of the commit, if available.

commit.committer #=> {:email=>"[email protected]", :time=>Tue Jan 24 05:42:45 UTC 2012, :name=>"Vicent Mart\303\255"}

149
150
151
152
153
154
155
156
157
# File 'ext/rugged/rugged_commit.c', line 149

static VALUE rb_git_commit_committer_GET(VALUE self)
{
	git_commit *commit;
	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	return rugged_signature_new(
		git_commit_committer(commit),
		git_commit_message_encoding(commit));
}

#diff(*args) ⇒ Object

Return a diff between this commit and its first parent or another commit or tree.

The commit is treated as the new side of the diff by default

See Rugged::Tree#diff for more details.


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

def diff(*args)
  raise ArgumentError("wrong number of arguments (given #{args.length}, expected 0..2") if args.length > 2
  other, opts = args
  if other.is_a?(Hash)
    opts = other
    other = nil
  end
  opts ||= {}
  # if other is not provided at all (as opposed to explicitly nil, or given)
  # then diff against the prior commit
  if args.empty? || args.first.is_a?(Hash)
    other = parents.first
    opts[:reverse] = !opts[:reverse]
  end
  self.tree.diff(other, opts)
end

#diff_workdir(options = {}) ⇒ Object

Return a diff between this commit and the workdir.

See Rugged::Tree#diff_workdir for more details.


45
46
47
# File 'lib/rugged/commit.rb', line 45

def diff_workdir(options = {})
  self.tree.diff_workdir(**options)
end

#epoch_timeInteger

Return the time when this commit was made effective. This is the same value as the :time attribute for commit.committer, but represented as an Integer value in seconds since the Epoch.

commit.time #=> 1327383765

Returns:

  • (Integer)

194
195
196
197
198
199
200
# File 'ext/rugged/rugged_commit.c', line 194

static VALUE rb_git_commit_epoch_time_GET(VALUE self)
{
	git_commit *commit;
	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	return ULONG2NUM(git_commit_time(commit));
}

#headerString

Returns commit's entire raw header.

Returns:

  • (String)

704
705
706
707
708
709
710
711
712
713
# File 'ext/rugged/rugged_commit.c', line 704

static VALUE rb_git_commit_header(VALUE self)
{
	git_commit *commit;
	const char *raw_header;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	raw_header = git_commit_raw_header(commit);
	return rb_str_new_utf8(raw_header);
}

#header_field(field_name) ⇒ String

Returns commit's header field value.

Returns:

  • (String)

666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
# File 'ext/rugged/rugged_commit.c', line 666

static VALUE rb_git_commit_header_field(VALUE self, VALUE rb_field)
{
	git_buf header_field = { 0 };
	git_commit *commit = NULL;

	const char *encoding_name;
	rb_encoding *encoding = rb_utf8_encoding();
	VALUE rb_result;

	int error;

	Check_Type(rb_field, T_STRING);
	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	error = git_commit_header_field(&header_field, commit, StringValueCStr(rb_field));

	if (error < 0) {
		git_buf_dispose(&header_field);
		if (error == GIT_ENOTFOUND)
			return Qnil;
		rugged_exception_check(error);
	}

	encoding_name = git_commit_message_encoding(commit);
	if (encoding_name != NULL)
		encoding = rb_enc_find(encoding_name);

	rb_result = rb_enc_str_new(header_field.ptr, header_field.size, encoding);
	git_buf_dispose(&header_field);
	return rb_result;
}

#header_field?(field) ⇒ Boolean

Returns:

  • (Boolean)

16
17
18
# File 'lib/rugged/commit.rb', line 16

def header_field?(field)
  !!header_field(field)
end

#inspectObject


12
13
14
# File 'lib/rugged/commit.rb', line 12

def inspect
  "#<Rugged::Commit:#{object_id} {message: #{message.inspect}, tree: #{tree.inspect}, parents: #{parent_oids}}>"
end

#messageObject

Return the message of this commit. This includes the full body of the 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 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"

33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'ext/rugged/rugged_commit.c', line 33

static VALUE rb_git_commit_message_GET(VALUE self)
{
	git_commit *commit;
	rb_encoding *encoding = rb_utf8_encoding();
	const char *encoding_name;
	const char *message;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	message = git_commit_message(commit);
	encoding_name = git_commit_message_encoding(commit);
	if (encoding_name != NULL)
		encoding = rb_enc_find(encoding_name);

	return rb_enc_str_new(message, strlen(message), encoding);
}

#modify(new_args, update_ref = nil) ⇒ Object


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

def modify(new_args, update_ref=nil)
  args = self.to_hash.merge(new_args)
  Commit.create(args, update_ref)
end

#parent_idsArray

Return the parent oid(s) of this commit as an array of oid String objects. An array is always returned even when the commit has only one or zero parents.

commit.parent_ids #=> => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1", ...]
root.parent_ids #=> []

Returns:

  • (Array)

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'ext/rugged/rugged_commit.c', line 293

static VALUE rb_git_commit_parent_ids_GET(VALUE self)
{
	git_commit *commit;
	const git_oid *parent_id;
	unsigned int n, parent_count;
	VALUE ret_arr;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	parent_count = git_commit_parentcount(commit);
	ret_arr = rb_ary_new2((long)parent_count);

	for (n = 0; n < parent_count; n++) {
		parent_id = git_commit_parent_id(commit, n);
		if (parent_id) {
			rb_ary_push(ret_arr, rugged_create_oid(parent_id));
		}
	}

	return ret_arr;
}

#parent_idsArray

Return the parent oid(s) of this commit as an array of oid String objects. An array is always returned even when the commit has only one or zero parents.

commit.parent_ids #=> => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1", ...]
root.parent_ids #=> []

Returns:

  • (Array)

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'ext/rugged/rugged_commit.c', line 293

static VALUE rb_git_commit_parent_ids_GET(VALUE self)
{
	git_commit *commit;
	const git_oid *parent_id;
	unsigned int n, parent_count;
	VALUE ret_arr;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	parent_count = git_commit_parentcount(commit);
	ret_arr = rb_ary_new2((long)parent_count);

	for (n = 0; n < parent_count; n++) {
		parent_id = git_commit_parent_id(commit, n);
		if (parent_id) {
			rb_ary_push(ret_arr, rugged_create_oid(parent_id));
		}
	}

	return ret_arr;
}

#parentsArray

Return the parent(s) of this commit as an array of Rugged::Commit objects. An array is always returned even when the commit has only one or zero parents.

commit.parents #=> => [#<Rugged::Commit:0x108828918>]
root.parents #=> []

Returns:

  • (Array)

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'ext/rugged/rugged_commit.c', line 259

static VALUE rb_git_commit_parents_GET(VALUE self)
{
	git_commit *commit;
	git_commit *parent;
	unsigned int n, parent_count;
	VALUE ret_arr, owner;
	int error;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);
	owner = rugged_owner(self);

	parent_count = git_commit_parentcount(commit);
	ret_arr = rb_ary_new2((long)parent_count);

	for (n = 0; n < parent_count; n++) {
		error = git_commit_parent(&parent, commit, n);
		rugged_exception_check(error);
		rb_ary_push(ret_arr, rugged_object_new(owner, (git_object *)parent));
	}

	return ret_arr;
}

#summaryObject

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"

116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'ext/rugged/rugged_commit.c', line 116

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;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, 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);
}

#timeObject

The time when this commit was made effective. This is the same value as the :time attribute for commit.committer.

Returns a Time object


53
54
55
# File 'lib/rugged/commit.rb', line 53

def time
  @time ||= Time.at(self.epoch_time)
end

#to_hashObject


57
58
59
60
61
62
63
64
65
# File 'lib/rugged/commit.rb', line 57

def to_hash
  {
    :message => message,
    :committer => committer,
    :author => author,
    :tree => tree,
    :parents => parents,
  }
end

#to_mbox(options = {}) ⇒ String

Returns commit's contents formatted to resemble UNIX mailbox format.

Does not (yet) support merge commits.

The following options can be passed in the options Hash:

:patch_no

Number for this patch in the series. Defaults to 1.

:total_patches

Total number of patches in the series. Defaults to 1.

:exclude_subject_patch_marker

If set to true, no “[PATCH]” marker will be added to the beginning of the subject line.

Additionally, you can also pass the same options as for Rugged::Tree#diff.

Returns:

  • (String)

601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
# File 'ext/rugged/rugged_commit.c', line 601

static VALUE rb_git_commit_to_mbox(int argc, VALUE *argv, VALUE self)
{
	git_buf email_patch = { NULL };
	git_repository *repo;
	git_commit *commit;
	git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
	git_diff_format_email_flags_t flags = GIT_DIFF_FORMAT_EMAIL_NONE;

	VALUE rb_repo = rugged_owner(self), rb_email_patch = Qnil, rb_val, rb_options;

	int error;
	size_t patch_no = 1, total_patches = 1;

	rb_scan_args(argc, argv, ":", &rb_options);

	rugged_check_repo(rb_repo);
	Data_Get_Struct(rb_repo, git_repository, repo);

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	if (!NIL_P(rb_options)) {
		Check_Type(rb_options, T_HASH);

		rb_val = rb_hash_aref(rb_options, CSTR2SYM("patch_no"));
		if (!NIL_P(rb_val))
			patch_no = NUM2INT(rb_val);

		rb_val = rb_hash_aref(rb_options, CSTR2SYM("total_patches"));
		if (!NIL_P(rb_val))
			total_patches = NUM2INT(rb_val);

		if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("exclude_subject_patch_marker"))))
			flags |= GIT_DIFF_FORMAT_EMAIL_EXCLUDE_SUBJECT_PATCH_MARKER;

		rugged_parse_diff_options(&opts, rb_options);
	}

	error = git_diff_commit_as_email(
		&email_patch,
		repo,
		commit,
		patch_no,
		total_patches,
		flags,
		&opts);

	if (error) goto cleanup;

	rb_email_patch = rb_enc_str_new(email_patch.ptr, email_patch.size, rb_utf8_encoding());

	cleanup:

	xfree(opts.pathspec.strings);
	git_buf_dispose(&email_patch);
	rugged_exception_check(error);

	return rb_email_patch;
}

#trailersArray

Return an array of arrays, each of which is a key/value pair representing a commit message trailer. Both the keys and values will be strings. An array is used to preserve the order the trailers were found.

In Ruby 1.9+, the returned strings will be encoded with the encoding specified in the Encoding header of the commit, if available.

Returns:

  • (Array)

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'ext/rugged/rugged_commit.c', line 62

static VALUE rb_git_commit_trailers_GET(VALUE self)
{
	git_commit *commit;
	const char *message;
	rb_encoding *encoding = rb_utf8_encoding();
	const char *encoding_name;
	git_message_trailer_array arr;
	VALUE trailers = rb_ary_new();
	int error;
	size_t i;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	encoding_name = git_commit_message_encoding(commit);
	if (encoding_name != NULL)
		encoding = rb_enc_find(encoding_name);

	message = git_commit_message(commit);

	error = git_message_trailers(&arr, message);
	rugged_exception_check(error);

	for(i = 0; i < arr.count; i++) {
		VALUE pair = rb_ary_new();
		const char *key = arr.trailers[i].key;
		const char *value = arr.trailers[i].value;

		// trailer key
		rb_ary_push(pair, rb_enc_str_new(key, strlen(key), encoding));

		// trailer value
		rb_ary_push(pair, rb_enc_str_new(value, strlen(value), encoding));

		// add it to the list
		rb_ary_push(trailers, pair);
	}

	git_message_trailer_array_free(&arr);

	return trailers;
}

#treeObject

Return the tree pointed at by this commit. The tree is returned as a Rugged::Tree object.

commit.tree #=> #<Rugged::Tree:0x10882c680>

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'ext/rugged/rugged_commit.c', line 211

static VALUE rb_git_commit_tree_GET(VALUE self)
{
	git_commit *commit;
	git_tree *tree;
	VALUE owner;
	int error;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);
	owner = rugged_owner(self);

	error = git_commit_tree(&tree, commit);
	rugged_exception_check(error);

	return rugged_object_new(owner, (git_object *)tree);
}

#tree_idObject

Return the tree oid pointed at by this commit. The tree is returned as a String object.

commit.tree_id #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"

236
237
238
239
240
241
242
243
244
245
246
# File 'ext/rugged/rugged_commit.c', line 236

static VALUE rb_git_commit_tree_id_GET(VALUE self)
{
	git_commit *commit;
	const git_oid *tree_id;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	tree_id = git_commit_tree_id(commit);

	return rugged_create_oid(tree_id);
}

#tree_idObject

Return the tree oid pointed at by this commit. The tree is returned as a String object.

commit.tree_id #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"

236
237
238
239
240
241
242
243
244
245
246
# File 'ext/rugged/rugged_commit.c', line 236

static VALUE rb_git_commit_tree_id_GET(VALUE self)
{
	git_commit *commit;
	const git_oid *tree_id;

	TypedData_Get_Struct(self, git_commit, &rugged_object_type, commit);

	tree_id = git_commit_tree_id(commit);

	return rugged_create_oid(tree_id);
}