Class: Rugged::Commit
- Inherits:
-
RuggedObject
- Object
- RuggedObject
- Rugged::Commit
- Defined in:
- lib/rugged/commit.rb,
ext/rugged/rugged_commit.c
Class Method Summary collapse
-
.create(repository, data = {}) ⇒ Object
Write a new
Commit
object torepository
, with the givendata
arguments, passed as aHash
:. - .prettify_message(msg, strip_comments = true) ⇒ Object
Instance Method Summary collapse
-
#amend(data = {}) ⇒ Object
Amend a commit object, with the given
data
arguments, passed as aHash
:. -
#author ⇒ Object
Return the signature for the author of this
commit
. -
#committer ⇒ Object
Return the signature for the committer of this
commit
. -
#diff(*args) ⇒ Object
Return a diff between this commit and its first parent or another commit or tree.
-
#diff_workdir(options = {}) ⇒ Object
Return a diff between this commit and the workdir.
-
#epoch_time ⇒ Integer
Return the time when this commit was made effective.
- #inspect ⇒ Object
-
#message ⇒ Object
Return the message of this commit.
- #modify(new_args, update_ref = nil) ⇒ Object
-
#parent_ids ⇒ Array
Return the parent oid(s) of this commit as an array of oid String objects.
-
#parent_ids ⇒ Array
Return the parent oid(s) of this commit as an array of oid String objects.
-
#parents ⇒ Array
Return the parent(s) of this commit as an array of
Rugged::Commit
objects. -
#time ⇒ Object
The time when this commit was made effective.
- #to_hash ⇒ Object
-
#to_mbox(options = {}) ⇒ String
Returns
commit
‘s contents formatted to resemble UNIX mailbox format. -
#tree ⇒ Object
Return the tree pointed at by this
commit
. -
#tree_id ⇒ Object
Return the tree oid pointed at by this
commit
. -
#tree_id ⇒ Object
Return the tree oid pointed at by this
commit
.
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
: anArray
with zero or more parents for this commit, represented asRugged::Commit
instances, or OIDString
. -
:tree
: the tree for this commit, represented as aRugged::Tree
instance or an OIDString
. -
:update_ref
(optional): aString
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
.
= {:email=>"[email protected]", :time=>Time.now, :name=>"Vicent Mart\303\255"}
Rugged::Commit.create(r,
:author => ,
:message => "Hello world\n\n",
:committer => ,
:parents => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1"],
:tree => some_tree) #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"
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 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'ext/rugged/rugged_commit.c', line 371
static VALUE rb_git_commit_create(VALUE self, VALUE rb_repo, VALUE rb_data)
{
VALUE rb_message, rb_tree, rb_parents, rb_ref;
VALUE rb_err_obj = Qnil;
int parent_count, i, error = 0;
const git_commit **parents = NULL;
git_commit **free_list = NULL;
git_tree *tree;
git_signature *author, *committer;
git_oid commit_oid;
git_repository *repo;
const char *update_ref = NULL;
Check_Type(rb_data, T_HASH);
rugged_check_repo(rb_repo);
Data_Get_Struct(rb_repo, 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"));
Check_Type(rb_message, T_STRING);
committer = rugged_signature_get(
rb_hash_aref(rb_data, CSTR2SYM("committer")), repo
);
author = rugged_signature_get(
rb_hash_aref(rb_data, CSTR2SYM("author")), repo
);
rb_parents = rb_hash_aref(rb_data, CSTR2SYM("parents"));
Check_Type(rb_parents, T_ARRAY);
rb_tree = rb_hash_aref(rb_data, CSTR2SYM("tree"));
tree = (git_tree *)rugged_object_get(repo, rb_tree, GIT_OBJ_TREE);
parents = alloca(RARRAY_LEN(rb_parents) * sizeof(void *));
free_list = alloca(RARRAY_LEN(rb_parents) * sizeof(void *));
parent_count = 0;
for (i = 0; i < (int)RARRAY_LEN(rb_parents); ++i) {
VALUE p = rb_ary_entry(rb_parents, i);
git_commit *parent = NULL;
git_commit *free_ptr = NULL;
if (NIL_P(p))
continue;
if (TYPE(p) == T_STRING) {
git_oid oid;
error = git_oid_fromstr(&oid, StringValueCStr(p));
if (error < GIT_OK)
goto cleanup;
error = git_commit_lookup(&parent, repo, &oid);
if (error < GIT_OK)
goto cleanup;
free_ptr = parent;
} else if (rb_obj_is_kind_of(p, rb_cRuggedCommit)) {
Data_Get_Struct(p, git_commit, parent);
} else {
rb_err_obj = rb_exc_new2(rb_eTypeError, "Invalid type for parent object");
goto cleanup;
}
parents[parent_count] = parent;
free_list[parent_count] = free_ptr;
parent_count++;
}
error = git_commit_create(
&commit_oid,
repo,
update_ref,
author,
committer,
NULL,
StringValueCStr(rb_message),
tree,
parent_count,
parents);
cleanup:
git_signature_free(author);
git_signature_free(committer);
git_object_free((git_object *)tree);
for (i = 0; i < parent_count; ++i)
git_object_free((git_object *)free_list[i]);
if (!NIL_P(rb_err_obj))
rb_exc_raise(rb_err_obj);
rugged_exception_check(error);
return rugged_create_oid(&commit_oid);
}
|
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 aRugged::Tree
instance or an OIDString
. -
:update_ref
(optional): aString
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
.
= {:email=>"[email protected]", :time=>Time.now, :name=>"Vicent Mart\303\255"}
commit.amend(
:author => ,
:message => "Updated Hello world\n\n",
:committer => ,
:tree => some_tree) #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'ext/rugged/rugged_commit.c', line 273
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);
Data_Get_Struct(self, git_commit, 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);
}
|
#author ⇒ Object
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. #=> {:email=>"[email protected]", :time=>Tue Jan 24 05:42:45 UTC 2012, :name=>"Vicent Mart\303\255"}
104 105 106 107 108 109 110 111 112 |
# File 'ext/rugged/rugged_commit.c', line 104
static VALUE rb_git_commit_author_GET(VALUE self)
{
git_commit *commit;
Data_Get_Struct(self, git_commit, commit);
return rugged_signature_new(
git_commit_author(commit),
git_commit_message_encoding(commit));
}
|
#committer ⇒ Object
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"}
79 80 81 82 83 84 85 86 87 |
# File 'ext/rugged/rugged_commit.c', line 79
static VALUE rb_git_commit_committer_GET(VALUE self)
{
git_commit *commit;
Data_Get_Struct(self, git_commit, 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.
See Rugged::Tree#diff for more details.
15 16 17 18 |
# File 'lib/rugged/commit.rb', line 15 def diff(*args) args.unshift(parents.first) if args.size == 1 && args.first.is_a?(Hash) self.tree.diff(*args) end |
#diff_workdir(options = {}) ⇒ Object
Return a diff between this commit and the workdir.
See Rugged::Tree#diff_workdir for more details.
23 24 25 |
# File 'lib/rugged/commit.rb', line 23 def diff_workdir( = {}) self.tree.diff_workdir() end |
#epoch_time ⇒ Integer
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
124 125 126 127 128 129 130 |
# File 'ext/rugged/rugged_commit.c', line 124
static VALUE rb_git_commit_epoch_time_GET(VALUE self)
{
git_commit *commit;
Data_Get_Struct(self, git_commit, commit);
return ULONG2NUM(git_commit_time(commit));
}
|
#inspect ⇒ Object
8 9 10 |
# File 'lib/rugged/commit.rb', line 8 def inspect "#<Rugged::Commit:#{object_id} {message: #{.inspect}, tree: #{tree.inspect}, parents: #{parent_oids}}>" end |
#message ⇒ Object
Return the message of this commit. This includes the full body of the message, with the short description, detailed descritpion, 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. #=> "add a lot of RDoc docs\n\nthis includes docs for commit and blob"
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'ext/rugged/rugged_commit.c', line 46
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;
Data_Get_Struct(self, git_commit, 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
45 46 47 48 |
# File 'lib/rugged/commit.rb', line 45 def modify(new_args, update_ref=nil) args = self.to_hash.merge(new_args) Commit.create(args, update_ref) end |
#parent_ids ⇒ Array
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 #=> []
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'ext/rugged/rugged_commit.c', line 223
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;
Data_Get_Struct(self, git_commit, 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_ids ⇒ Array
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 #=> []
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'ext/rugged/rugged_commit.c', line 223
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;
Data_Get_Struct(self, git_commit, 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;
}
|
#parents ⇒ Array
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 #=> []
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'ext/rugged/rugged_commit.c', line 189
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;
Data_Get_Struct(self, git_commit, 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;
}
|
#time ⇒ Object
The time when this commit was made effective. This is the same value as the :time
attribute for commit.committer
.
Returns a Time object
31 32 33 |
# File 'lib/rugged/commit.rb', line 31 def time @time ||= Time.at(self.epoch_time) end |
#to_hash ⇒ Object
35 36 37 38 39 40 41 42 43 |
# File 'lib/rugged/commit.rb', line 35 def to_hash { :message => , :committer => committer, :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.
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'ext/rugged/rugged_commit.c', line 500
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);
Data_Get_Struct(self, git_commit, 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_free(&email_patch);
rugged_exception_check(error);
return rb_email_patch;
}
|
#tree ⇒ Object
Return the tree pointed at by this commit
. The tree is returned as a Rugged::Tree
object.
commit.tree #=> #<Rugged::Tree:0x10882c680>
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'ext/rugged/rugged_commit.c', line 141
static VALUE rb_git_commit_tree_GET(VALUE self)
{
git_commit *commit;
git_tree *tree;
VALUE owner;
int error;
Data_Get_Struct(self, git_commit, commit);
owner = rugged_owner(self);
error = git_commit_tree(&tree, commit);
rugged_exception_check(error);
return rugged_object_new(owner, (git_object *)tree);
}
|
#tree_id ⇒ Object
Return the tree oid pointed at by this commit
. The tree is returned as a String object.
commit.tree_id #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"
166 167 168 169 170 171 172 173 174 175 176 |
# File 'ext/rugged/rugged_commit.c', line 166
static VALUE rb_git_commit_tree_id_GET(VALUE self)
{
git_commit *commit;
const git_oid *tree_id;
Data_Get_Struct(self, git_commit, commit);
tree_id = git_commit_tree_id(commit);
return rugged_create_oid(tree_id);
}
|
#tree_id ⇒ Object
Return the tree oid pointed at by this commit
. The tree is returned as a String object.
commit.tree_id #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"
166 167 168 169 170 171 172 173 174 175 176 |
# File 'ext/rugged/rugged_commit.c', line 166
static VALUE rb_git_commit_tree_id_GET(VALUE self)
{
git_commit *commit;
const git_oid *tree_id;
Data_Get_Struct(self, git_commit, commit);
tree_id = git_commit_tree_id(commit);
return rugged_create_oid(tree_id);
}
|