Class: Rugged::Tree
- Inherits:
-
RuggedObject
- Object
- RuggedObject
- Rugged::Tree
- Includes:
- Enumerable
- Defined in:
- lib/rugged/tree.rb,
ext/rugged/rugged_tree.c
Defined Under Namespace
Classes: Builder
Instance Attribute Summary collapse
-
#owner ⇒ Object
(also: #repo)
readonly
Returns the value of attribute owner.
Class Method Summary collapse
-
.diff(repo, tree, diffable[, options]) ⇒ Object
Returns a diff between the ‘tree` and the diffable object that was given.
Instance Method Summary collapse
-
#[](entry_id) ⇒ Object
Return one of the entries from a tree as a
Hash
. -
#count ⇒ Object
Return the number of entries contained in the tree.
-
#count_recursive(limit = nil) ⇒ Object
‘limit` - The maximum number of blobs to the count in the repository.
- #diff(other = nil, options = nil) ⇒ Object
-
#diff_workdir([options]) ⇒ Object
Returns a diff between a tree and the current workdir.
-
#each ⇒ Object
Call
block
with each of the entries of the subtree as aHash
. -
#each_blob ⇒ Object
Iterate over the blobs in this tree.
-
#each_tree ⇒ Object
Iterat over the subtrees in this tree.
-
#get_entry(entry_id) ⇒ Object
Return one of the entries from a tree as a
Hash
. -
#get_entry_by_oid(rb_oid) ⇒ Object
Return one of the entries from a tree as a
Hash
, based off the oid SHA. - #inspect ⇒ Object
-
#length ⇒ Object
Return the number of entries contained in the tree.
-
#merge(*args) ⇒ Object
tree.merge(other_tree[, ancestor_tree[, options]]) -> Rugged::Index tree.merge(other_tree[, options]) -> Rugged::Index.
-
#path(path) ⇒ Object
Retrieve and return a tree entry by its relative path.
-
#walk(rb_mode) ⇒ Object
Walk
tree
with the given mode (either:preorder
or:postorder
) and yield toblock
every entry intree
and all its subtrees, as aHash
. -
#walk_blobs(mode = :postorder) ⇒ Object
Walks the tree but only yields blobs.
-
#walk_trees(mode = :postorder) ⇒ Object
Walks the tree but only yields subtrees.
Instance Attribute Details
#owner ⇒ Object (readonly) Also known as: repo
Returns the value of attribute owner.
5 6 7 |
# File 'lib/rugged/tree.rb', line 5 def owner @owner end |
Class Method Details
.diff(repo, tree, diffable[, options]) ⇒ Object
Returns a diff between the ‘tree` and the diffable object that was given. diffable
can either be a Rugged::Commit
, a Rugged::Tree
, a Rugged::Index
, or nil
.
The tree
object will be used as the “old file” side of the diff, while the parent tree or the diffable
object will be used for the “new file” side.
If tree
or diffable
are nil, they will be treated as an empty tree. Passing both as ‘nil` will raise an exception.
The following options can be passed in the options
Hash:
- :paths
-
An array of paths / fnmatch patterns to constrain the diff to a specific set of files. Also see
:disable_pathspec_match
. - :max_size
-
An integer specifying the maximum byte size of a file before a it will be treated as binary. The default value is 512MB.
- :context_lines
-
The number of unchanged lines that define the boundary of a hunk (and to display before and after the actual changes). The default is 3.
- :interhunk_lines
-
The maximum number of unchanged lines between hunk boundaries before the hunks will be merged into a one. The default is 0.
- :old_prefix
-
The virtual “directory” to prefix to old filenames in hunk headers. The default is “a”.
- :new_prefix
-
The virtual “directory” to prefix to new filenames in hunk headers. The default is “b”.
- :reverse
-
If true, the sides of the diff will be reversed.
- :force_text
-
If true, all files will be treated as text, disabling binary attributes & detection.
- :ignore_whitespace
-
If true, all whitespace will be ignored.
- :ignore_whitespace_change
-
If true, changes in amount of whitespace will be ignored.
- :ignore_whitespace_eol
-
If true, whitespace at end of line will be ignored.
- :ignore_submodules
-
if true, submodules will be excluded from the diff completely.
- :patience
-
If true, the “patience diff” algorithm will be used (currenlty unimplemented).
- :include_ignored
-
If true, ignored files will be included in the diff.
- :include_untracked
-
If true, untracked files will be included in the diff.
- :include_unmodified
-
If true, unmodified files will be included in the diff.
- :recurse_untracked_dirs
-
Even if
:include_untracked
is true, untracked directories will only be marked with a single entry in the diff. If this flag is set to true, all files under ignored directories will be included in the diff, too. - :disable_pathspec_match
-
If true, the given
:paths
will be applied as exact matches, instead of as fnmatch patterns. - :deltas_are_icase
-
If true, filename comparisons will be made with case-insensitivity.
- :include_untracked_content
-
if true, untracked content will be contained in the the diff patch text.
- :skip_binary_check
-
If true, diff deltas will be generated without spending time on binary detection. This is useful to improve performance in cases where the actual file content difference is not needed.
- :include_typechange
-
If true, type changes for files will not be interpreted as deletion of the “old file” and addition of the “new file”, but will generate typechange records.
- :include_typechange_trees
-
Even if
:include_typechange
is true, blob -> tree changes will still usually be handled as a deletion of the blob. If this flag is set to true, blob -> tree changes will be marked as typechanges. - :ignore_filemode
-
If true, file mode changes will be ignored.
- :recurse_ignored_dirs
-
Even if
:include_ignored
is true, ignored directories will only be marked with a single entry in the diff. If this flag is set to true, all files under ignored directories will be included in the diff, too.
Examples:
# Emulating `git diff <treeish>`
tree = Rugged::Tree.lookup(repo, "d70d245ed97ed2aa596dd1af6536e4bfdb047b69")
diff = tree.diff(repo.index)
diff.merge!(tree.diff)
# Tree-to-Tree Diff
tree = Rugged::Tree.lookup(repo, "d70d245ed97ed2aa596dd1af6536e4bfdb047b69")
other_tree = Rugged::Tree.lookup(repo, "7a9e0b02e63179929fed24f0a3e0f19168114d10")
diff = tree.diff(other_tree)
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 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 |
# File 'ext/rugged/rugged_tree.c', line 477
static VALUE rb_git_tree_diff_(int argc, VALUE *argv, VALUE self)
{
git_tree *tree = NULL;
git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
git_repository *repo = NULL;
git_diff *diff = NULL;
VALUE rb_self, rb_repo, rb_other, rb_options;
int error;
rb_scan_args(argc, argv, "22", &rb_repo, &rb_self, &rb_other, &rb_options);
rugged_parse_diff_options(&opts, rb_options);
Data_Get_Struct(rb_repo, git_repository, repo);
if (!NIL_P(rb_self)) {
if (!rb_obj_is_kind_of(rb_self, rb_cRuggedTree))
rb_raise(rb_eTypeError,
"At least a Rugged::Tree object is required for diffing");
Data_Get_Struct(rb_self, git_tree, tree);
}
if (NIL_P(rb_other)) {
if (tree == NULL) {
xfree(opts.pathspec.strings);
rb_raise(rb_eTypeError, "Need 'old' or 'new' for diffing");
}
error = git_diff_tree_to_tree(&diff, repo, tree, NULL, &opts);
} else {
if (TYPE(rb_other) == T_STRING)
rb_other = rugged_object_rev_parse(rb_repo, rb_other, 1);
if (rb_obj_is_kind_of(rb_other, rb_cRuggedCommit)) {
git_tree *other_tree;
git_commit *commit;
Data_Get_Struct(rb_other, git_commit, commit);
error = git_commit_tree(&other_tree, commit);
if (!error) {
error = git_diff_tree_to_tree(&diff, repo, tree, other_tree, &opts);
git_tree_free(other_tree);
}
} else if (rb_obj_is_kind_of(rb_other, rb_cRuggedTree)) {
git_tree *other_tree;
Data_Get_Struct(rb_other, git_tree, other_tree);
error = git_diff_tree_to_tree(&diff, repo, tree, other_tree, &opts);
} else if (rb_obj_is_kind_of(rb_other, rb_cRuggedIndex)) {
git_index *index;
Data_Get_Struct(rb_other, git_index, index);
error = git_diff_tree_to_index(&diff, repo, tree, index, &opts);
} else {
xfree(opts.pathspec.strings);
rb_raise(rb_eTypeError, "A Rugged::Commit, Rugged::Tree or Rugged::Index instance is required");
}
}
xfree(opts.pathspec.strings);
rugged_exception_check(error);
return rugged_diff_new(rb_cRuggedDiff, rb_repo, diff);
}
|
Instance Method Details
#[](e) ⇒ Object #get_entry(e) ⇒ Object
Return one of the entries from a tree as a Hash
. If e
is a number, the enth entry from the tree will be returned. If e
is a string, the entry with that name will be returned.
If the entry doesn’t exist, nil
will be returned.
tree[3] #=> {:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :filemode => 0}
tree['bar.txt'] #=> {:name => "bar.txt", :type => :blob, :oid => "de5ba987198bcf2518885f0fc1350e5172cded78", :filemode => 0}
tree['baz.txt'] #=> nil
174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'ext/rugged/rugged_tree.c', line 174
static VALUE rb_git_tree_get_entry(VALUE self, VALUE entry_id)
{
git_tree *tree;
Data_Get_Struct(self, git_tree, tree);
if (TYPE(entry_id) == T_FIXNUM)
return rb_git_treeentry_fromC(git_tree_entry_byindex(tree, FIX2INT(entry_id)));
else if (TYPE(entry_id) == T_STRING)
return rb_git_treeentry_fromC(git_tree_entry_byname(tree, StringValueCStr(entry_id)));
else
rb_raise(rb_eTypeError, "entry_id must be either an index or a filename");
}
|
#count ⇒ Object #length ⇒ Object
Return the number of entries contained in the tree.
Note that this only applies to entries in the root of the tree, not any other entries contained in sub-folders.
88 89 90 91 92 93 94 |
# File 'ext/rugged/rugged_tree.c', line 88
static VALUE rb_git_tree_entrycount(VALUE self)
{
git_tree *tree;
Data_Get_Struct(self, git_tree, tree);
return INT2FIX(git_tree_entrycount(tree));
}
|
#count_recursive(limit = nil) ⇒ Object
‘limit` - The maximum number of blobs to the count in the repository. Rugged will stop walking the tree after `limit` items to avoid long execution times.
Return the number of blobs (up to the limit) contained in the tree and all subtrees.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'ext/rugged/rugged_tree.c', line 127
static VALUE rb_git_tree_entrycount_recursive(int argc, VALUE* argv, VALUE self)
{
git_tree *tree;
int error;
struct rugged_treecount_cb_payload payload;
VALUE rb_limit;
Data_Get_Struct(self, git_tree, tree);
rb_scan_args(argc, argv, "01", &rb_limit);
payload.limit = -1;
payload.count = 0;
if (!NIL_P(rb_limit)) {
Check_Type(rb_limit, T_FIXNUM);
payload.limit = FIX2INT(rb_limit);
}
error = git_tree_walk(tree, GIT_TREEWALK_PRE, &rugged__treecount_cb, (void *)&payload);
if (error && giterr_last()->klass == GITERR_CALLBACK) {
giterr_clear();
error = 0;
}
rugged_exception_check(error);
return INT2FIX(payload.count);
}
|
#diff(other = nil, options = nil) ⇒ Object
8 9 10 |
# File 'lib/rugged/tree.rb', line 8 def diff(other = nil, = nil) Tree.diff(repo, self, other, ) end |
#diff_workdir([options]) ⇒ Object
Returns a diff between a tree and the current workdir.
The tree
object will be used as the “old file” side of the diff, while the content of the current workdir will be used for the “new file” side.
See Rugged::Tree#diff for a list of options that can be passed.
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'ext/rugged/rugged_tree.c', line 553
static VALUE rb_git_tree_diff_workdir(int argc, VALUE *argv, VALUE self)
{
git_tree *tree;
git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
git_repository *repo;
git_diff *diff;
VALUE owner, rb_options;
int error;
rb_scan_args(argc, argv, "00:", &rb_options);
rugged_parse_diff_options(&opts, rb_options);
Data_Get_Struct(self, git_tree, tree);
owner = rugged_owner(self);
Data_Get_Struct(owner, git_repository, repo);
error = git_diff_tree_to_workdir(&diff, repo, tree, &opts);
xfree(opts.pathspec.strings);
rugged_exception_check(error);
return rugged_diff_new(rb_cRuggedDiff, owner, diff);
}
|
#each {|entry| ... } ⇒ Object #each ⇒ Object
Call block
with each of the entries of the subtree as a Hash
. If no block
is given, an enumerator
is returned instead.
Note that only the entries in the root of the tree are yielded; if you need to list also entries in subfolders, use tree.walk
instead.
tree.each { |entry| puts entry.inspect }
generates:
{:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :filemode => 0}
{:name => "bar.txt", :type => :blob, :oid => "de5ba987198bcf2518885f0fc1350e5172cded78", :filemode => 0}
...
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'ext/rugged/rugged_tree.c', line 235
static VALUE rb_git_tree_each(VALUE self)
{
git_tree *tree;
size_t i, count;
Data_Get_Struct(self, git_tree, tree);
if (!rb_block_given_p())
return rb_funcall(self, rb_intern("to_enum"), 0);
count = git_tree_entrycount(tree);
for (i = 0; i < count; ++i) {
const git_tree_entry *entry = git_tree_entry_byindex(tree, i);
rb_yield(rb_git_treeentry_fromC(entry));
}
return Qnil;
}
|
#each_blob ⇒ Object
Iterate over the blobs in this tree
29 30 31 |
# File 'lib/rugged/tree.rb', line 29 def each_blob self.each { |e| yield e if e[:type] == :blob } end |
#each_tree ⇒ Object
Iterat over the subtrees in this tree
34 35 36 |
# File 'lib/rugged/tree.rb', line 34 def each_tree self.each { |e| yield e if e[:type] == :tree } end |
#[](e) ⇒ Object #get_entry(e) ⇒ Object
Return one of the entries from a tree as a Hash
. If e
is a number, the enth entry from the tree will be returned. If e
is a string, the entry with that name will be returned.
If the entry doesn’t exist, nil
will be returned.
tree[3] #=> {:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :filemode => 0}
tree['bar.txt'] #=> {:name => "bar.txt", :type => :blob, :oid => "de5ba987198bcf2518885f0fc1350e5172cded78", :filemode => 0}
tree['baz.txt'] #=> nil
174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'ext/rugged/rugged_tree.c', line 174
static VALUE rb_git_tree_get_entry(VALUE self, VALUE entry_id)
{
git_tree *tree;
Data_Get_Struct(self, git_tree, tree);
if (TYPE(entry_id) == T_FIXNUM)
return rb_git_treeentry_fromC(git_tree_entry_byindex(tree, FIX2INT(entry_id)));
else if (TYPE(entry_id) == T_STRING)
return rb_git_treeentry_fromC(git_tree_entry_byname(tree, StringValueCStr(entry_id)));
else
rb_raise(rb_eTypeError, "entry_id must be either an index or a filename");
}
|
#get_entry_by_oid(rb_oid) ⇒ Object
Return one of the entries from a tree as a Hash
, based off the oid SHA.
If the entry doesn’t exist, nil
will be returned.
This does a full traversal of the every element in the tree, so this method is not especially fast.
tree.get_entry_by_oid("d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f")
#=> {:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :filemode => 0}
204 205 206 207 208 209 210 211 212 213 214 |
# File 'ext/rugged/rugged_tree.c', line 204
static VALUE rb_git_tree_get_entry_by_oid(VALUE self, VALUE rb_oid)
{
git_tree *tree;
git_oid oid;
Data_Get_Struct(self, git_tree, tree);
Check_Type(rb_oid, T_STRING);
rugged_exception_check(git_oid_fromstr(&oid, StringValueCStr(rb_oid)));
return rb_git_treeentry_fromC(git_tree_entry_byid(tree, &oid));
}
|
#inspect ⇒ Object
12 13 14 15 16 |
# File 'lib/rugged/tree.rb', line 12 def inspect data = "#<Rugged::Tree:#{object_id} {oid: #{oid}}>\n" self.each { |e| data << " <\"#{e[:name]}\" #{e[:oid]}>\n" } data end |
#count ⇒ Object #length ⇒ Object
Return the number of entries contained in the tree.
Note that this only applies to entries in the root of the tree, not any other entries contained in sub-folders.
88 89 90 91 92 93 94 |
# File 'ext/rugged/rugged_tree.c', line 88
static VALUE rb_git_tree_entrycount(VALUE self)
{
git_tree *tree;
Data_Get_Struct(self, git_tree, tree);
return INT2FIX(git_tree_entrycount(tree));
}
|
#merge(*args) ⇒ Object
tree.merge(other_tree[, ancestor_tree[, options]]) -> Rugged::Index tree.merge(other_tree[, options]) -> Rugged::Index
Merges two trees and returns the a Rugged::Index object that reflects the result of the merge.
The following options can be passed in the options
Hash:
- :renames
-
If true, looking for renames will be enabled (‘–find-renames`).
- :rename_threshold
-
An integer specifying the minimum similarity of a file to be seen as an eligible rename source (default 50).
- :target_limit
-
An integer specifying the maximum byte size of a file before a it will be treated as binary. The default value is 512MB.
- :favor
-
Specifies how and if conflicts are auto-resolved by favoring a specific file output. Can be one of ‘:normal`, `:ours`, `:theirs` or `:union`.
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
# File 'ext/rugged/rugged_tree.c', line 647
static VALUE rb_git_tree_merge(int argc, VALUE *argv, VALUE self)
{
VALUE rb_other_tree, rb_ancestor_tree, rb_options;
VALUE rb_repo = rugged_owner(self);
git_tree *tree, *other_tree, *ancestor_tree;
git_repository *repo;
git_index *index;
git_merge_options opts = GIT_MERGE_OPTIONS_INIT;
int error;
if (rb_scan_args(argc, argv, "12", &rb_other_tree, &rb_ancestor_tree, &rb_options) == 2) {
if (TYPE(rb_ancestor_tree) == T_HASH) {
rb_options = rb_ancestor_tree;
rb_ancestor_tree = Qnil;
}
}
if (!NIL_P(rb_options)) {
Check_Type(rb_options, T_HASH);
rugged_parse_merge_options(&opts, rb_options);
}
if (!rb_obj_is_kind_of(rb_other_tree, rb_cRuggedTree))
rb_raise(rb_eTypeError, "Expecting a Rugged::Tree instance");
else if (!NIL_P(rb_ancestor_tree) && !rb_obj_is_kind_of(rb_ancestor_tree, rb_cRuggedTree))
rb_raise(rb_eTypeError, "Expecting a Rugged::Tree instance");
Data_Get_Struct(self, git_tree, tree);
Data_Get_Struct(rb_repo, git_repository, repo);
Data_Get_Struct(rb_other_tree, git_tree, other_tree);
if (!NIL_P(rb_ancestor_tree))
Data_Get_Struct(rb_ancestor_tree, git_tree, ancestor_tree);
else
ancestor_tree = NULL;
error = git_merge_trees(&index, repo, ancestor_tree, tree, other_tree, &opts);
rugged_exception_check(error);
return rugged_index_new(rb_cRuggedIndex, rb_repo, index);
}
|
#path(path) ⇒ Object
Retrieve and return a tree entry by its relative path.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'ext/rugged/rugged_tree.c', line 339
static VALUE rb_git_tree_path(VALUE self, VALUE rb_path)
{
int error;
git_tree *tree;
git_tree_entry *entry;
VALUE rb_entry;
Data_Get_Struct(self, git_tree, tree);
Check_Type(rb_path, T_STRING);
error = git_tree_entry_bypath(&entry, tree, StringValueCStr(rb_path));
rugged_exception_check(error);
rb_entry = rb_git_treeentry_fromC(entry);
git_tree_entry_free(entry);
return rb_entry;
}
|
#walk(mode) {|root, entry| ... } ⇒ Object #walk(mode) ⇒ Iterator
Walk tree
with the given mode (either :preorder
or :postorder
) and yield to block
every entry in tree
and all its subtrees, as a Hash
. The block
also takes a root
, the relative path in the traversal, starting from the root of the original tree.
If the block
returns a falsy value, that entry and its sub-entries (in the case of a folder) will be skipped for the iteration.
If no block
is given, an Iterator
is returned instead.
tree.walk(:postorder) { |root, entry| puts "#{root}#{entry[:name]} [#{entry[:oid]}]" }
generates:
USAGE.rb [02bae86c91f96b5fdb6b1cf06f5aa3612139e318]
ext [23f135b3c576b6ac4785821888991d7089f35db1]
ext/rugged [25c88faa9302e34e16664eb9c990deb2bcf77849]
ext/rugged/extconf.rb [40c1aa8a8cec8ca444ed5758e3f00ecff093070a]
...
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 |
# File 'ext/rugged/rugged_tree.c', line 301
static VALUE rb_git_tree_walk(VALUE self, VALUE rb_mode)
{
git_tree *tree;
int error, mode = 0, exception = 0;
ID id_mode;
Data_Get_Struct(self, git_tree, tree);
if (!rb_block_given_p())
return rb_funcall(self, rb_intern("to_enum"), 2, CSTR2SYM("walk"), rb_mode);
Check_Type(rb_mode, T_SYMBOL);
id_mode = SYM2ID(rb_mode);
if (id_mode == rb_intern("preorder"))
mode = GIT_TREEWALK_PRE;
else if (id_mode == rb_intern("postorder"))
mode = GIT_TREEWALK_POST;
else
rb_raise(rb_eTypeError,
"Invalid iteration mode. Expected `:preorder` or `:postorder`");
error = git_tree_walk(tree, mode, &rugged__treewalk_cb, (void *)&exception);
if (exception)
rb_jump_tag(exception);
rugged_exception_check(error);
return Qnil;
}
|