class Rugged::Index
Index
Entries¶ ↑
Index
entries are represented as Hash instances with the following key/value pairs:
- path:
-
The entry’s path in the index.
- oid:
-
The oid of the entry’s git object (blob / tree).
- dev:
-
The device for the index entry.
- ino:
-
The inode for the index entry.
- mode:
-
The current permissions of the index entry.
- gid:
-
Group ID of the index entry’s owner.
- uid:
-
User ID of the index entry’s owner.
- file_size:
-
The index entry’s size, in bytes.
- valid:
-
true
if the index entry is valid,false
otherwise. - stage:
-
The current stage of the index entry.
- mtime:
-
A Time instance representing the index entry’s time of last modification.
- mtime:
-
A Time instance representing the index entry’s time of last status change (ie. change of owner, group, mode, etc.).
Public Class Methods
Create a bare index object based on the index file at path
.
Any index methods that rely on the ODB or a working directory (e.g. add
) will raise a Rugged::IndexError.
static VALUE rb_git_index_new(int argc, VALUE *argv, VALUE klass) { git_index *index; int error; VALUE rb_path; const char *path = NULL; if (rb_scan_args(argc, argv, "01", &rb_path) == 1) { Check_Type(rb_path, T_STRING); path = StringValueCStr(rb_path); } error = git_index_open(&index, path); rugged_exception_check(error); return rugged_index_new(klass, Qnil, index); }
Public Instance Methods
Add a new entry to the index or update an existing entry in the index.
If passed a path
to an existing, readable file relative to the workdir, creates a new index entry based on this file.
Alternatively, a new index entry can be created by passing a Hash containing all key/value pairs of an index entry.
Any gitignore rules that might match path
(or the :path
value of the entry hash) are ignored.
If the index entry at path
(or :path
) currently contains a merge conflict, it will no longer be marked as conflicting and the data about the conflict will be moved into the “resolve undo” (REUC) section of the index.
Add a new entry to the index or update an existing entry in the index.
If passed a path
to an existing, readable file relative to the workdir, creates a new index entry based on this file.
Alternatively, a new index entry can be created by passing a Hash containing all key/value pairs of an index entry.
Any gitignore rules that might match path
(or the :path
value of the entry hash) are ignored.
If the index entry at path
(or :path
) currently contains a merge conflict, it will no longer be marked as conflicting and the data about the conflict will be moved into the “resolve undo” (REUC) section of the index.
static VALUE rb_git_index_add(VALUE self, VALUE rb_entry) { git_index *index; int error = 0; Data_Get_Struct(self, git_index, index); if (TYPE(rb_entry) == T_HASH) { git_index_entry entry; rb_git_indexentry_toC(&entry, rb_entry); error = git_index_add(index, &entry); } else if (TYPE(rb_entry) == T_STRING) { error = git_index_add_bypath(index, StringValueCStr(rb_entry)); } else { rb_raise(rb_eTypeError, "Expecting a hash defining an Index Entry or a path to a file in the repository"); } rugged_exception_check(error); return Qnil; }
Add or update index entries matching files in the working directory.
Searches the working directory for files that pathspec
and adds them to index
(by updating an existing entry or adding a new entry).
pathspec
can either be a String, or an Array of Strings. If pathspec
is empty, all entries in the index will be matched.
Files that are ignored due to .gitignore
rules will be skipped, unless they’re already have an entry in index
.
Files that are marked as the result of a merge request, will have this marking removed and the merge conflict information will be moved into the “resolve undo” (REUC) section of index
.
If a block is given, each matched path
and the pathspec
that matched it will be passed to the block. If the return value of block
is falsy, the matching item will not be added to the index.
This method will fail in bare index instances.
The following options can be passed in the options
Hash:
- :force
-
If
true
, any.gitignore
rules will be ignored. - :disable_pathspec_match
-
If
true
, glob expansion will be disabled and exact matching will be forced. - :check_pathspec
-
If
true
, and the:force
options isfalse
or not given, exact matches of ignored files or files that are not already inindex
will raise a Rugged::InvalidError. This emulatesgit add -A
.
static VALUE rb_git_index_add_all(int argc, VALUE *argv, VALUE self) { VALUE rb_pathspecs, rb_options; git_index *index; git_strarray pathspecs; int error, exception = 0; unsigned int flags = GIT_INDEX_ADD_DEFAULT; Data_Get_Struct(self, git_index, index); if (rb_scan_args(argc, argv, "02", &rb_pathspecs, &rb_options) > 1) { Check_Type(rb_options, T_HASH); if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("force")))) flags |= GIT_INDEX_ADD_FORCE; if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("disable_pathspec_match")))) flags |= GIT_INDEX_ADD_DISABLE_PATHSPEC_MATCH; if (RTEST(rb_hash_aref(rb_options, CSTR2SYM("check_pathspec")))) flags |= GIT_INDEX_ADD_CHECK_PATHSPEC; } rugged_rb_ary_to_strarray(rb_pathspecs, &pathspecs); error = git_index_add_all(index, &pathspecs, flags, rb_block_given_p() ? rugged__index_matched_path_cb : NULL, &exception); xfree(pathspecs.strings); if (exception) rb_jump_tag(exception); rugged_exception_check(error); return Qnil; }
Clear the contents (remove all entries) of the index object. Changes are in-memory only and can be saved by calling write
.
static VALUE rb_git_index_clear(VALUE self) { git_index *index; Data_Get_Struct(self, git_index, index); git_index_clear(index); return Qnil; }
Add or update index entries that represent a conflict.
conflict
has to be a hash containing :ancestor
, :ours
and :theirs
key/value pairs. Any of those paris can be nil
(or left out) to indicate that the file was not present in the respective tree during the merge.
static VALUE rb_git_conflict_add(VALUE self, VALUE rb_conflict) { VALUE rb_ancestor, rb_ours, rb_theirs; git_index *index; git_index_entry ancestor, ours, theirs; int error; Check_Type(rb_conflict, T_HASH); rb_ancestor = rb_hash_aref(rb_conflict, CSTR2SYM("ancestor")); rb_ours = rb_hash_aref(rb_conflict, CSTR2SYM("ours")); rb_theirs = rb_hash_aref(rb_conflict, CSTR2SYM("theirs")); if (!NIL_P(rb_ancestor)) rb_git_indexentry_toC(&ancestor, rb_ancestor); if (!NIL_P(rb_ours)) rb_git_indexentry_toC(&ours, rb_ours); if (!NIL_P(rb_theirs)) rb_git_indexentry_toC(&theirs, rb_theirs); Data_Get_Struct(self, git_index, index); error = git_index_conflict_add(index, NIL_P(rb_ancestor) ? NULL : &ancestor, NIL_P(rb_theirs) ? NULL : &ours, NIL_P(rb_ours) ? NULL : &theirs); rugged_exception_check(error); return Qnil; }
Remove all conflicting entries (entries with a stage greater than 0) from the index.
static VALUE rb_git_conflict_cleanup(VALUE self) { git_index *index; Data_Get_Struct(self, git_index, index); git_index_conflict_cleanup(index); return Qnil; }
Return index entries from the ancestor, our side and their side of the conflict at path
.
If :ancestor
, :ours
or :theirs
is nil
, that indicates that path
did not exist in the respective tree.
Returns nil if no conflict is present at path
.
static VALUE rb_git_conflict_get(VALUE self, VALUE rb_path) { VALUE rb_result = rb_hash_new(); git_index *index; const git_index_entry *ancestor, *ours, *theirs; int error; Check_Type(rb_path, T_STRING); Data_Get_Struct(self, git_index, index); error = git_index_conflict_get(&ancestor, &ours, &theirs, index, StringValueCStr(rb_path)); if (error == GIT_ENOTFOUND) return Qnil; else rugged_exception_check(error); rb_hash_aset(rb_result, CSTR2SYM("ancestor"), rb_git_indexentry_fromC(ancestor)); rb_hash_aset(rb_result, CSTR2SYM("ours"), rb_git_indexentry_fromC(ours)); rb_hash_aset(rb_result, CSTR2SYM("theirs"), rb_git_indexentry_fromC(theirs)); return rb_result; }
Removes the index entries that represent the conflict at path
.
static VALUE rb_git_conflict_remove(VALUE self, VALUE rb_path) { git_index *index; int error; Check_Type(rb_path, T_STRING); Data_Get_Struct(self, git_index, index); error = git_index_conflict_remove(index, StringValueCStr(rb_path)); rugged_exception_check(error); return Qnil; }
Return all conflicts in index
.
Each conflict is represented as a Hash with :ancestor
, :ours
or :theirs
key-value pairs, each containing index entry data.
If the value of the :ancestor
, :ours
or :theirs
key is nil
, that indicates that file in conflict did not exists in the respective tree.
static VALUE rb_git_index_conflicts(VALUE self) { VALUE rb_conflicts = rb_ary_new(); git_index *index; git_index_conflict_iterator *iter; const git_index_entry *ancestor, *ours, *theirs; int error; Data_Get_Struct(self, git_index, index); error = git_index_conflict_iterator_new(&iter, index); rugged_exception_check(error); while ((error = git_index_conflict_next(&ancestor, &ours, &theirs, iter)) == GIT_OK) { VALUE rb_conflict = rb_hash_new(); rb_hash_aset(rb_conflict, CSTR2SYM("ancestor"), rb_git_indexentry_fromC(ancestor)); rb_hash_aset(rb_conflict, CSTR2SYM("ours"), rb_git_indexentry_fromC(ours)); rb_hash_aset(rb_conflict, CSTR2SYM("theirs"), rb_git_indexentry_fromC(theirs)); rb_ary_push(rb_conflicts, rb_conflict); } git_index_conflict_iterator_free(iter); if (error != GIT_ITEROVER) rugged_exception_check(error); return rb_conflicts; }
Determines if the index contains entries representing conflicts.
static VALUE rb_git_index_conflicts_p(VALUE self) { git_index *index; Data_Get_Struct(self, git_index, index); return git_index_has_conflicts(index) ? Qtrue : Qfalse; }
Returns the number of entries currently in the index.
static VALUE rb_git_index_count(VALUE self) { git_index *index; Data_Get_Struct(self, git_index, index); return INT2FIX(git_index_entrycount(index)); }
The first form returns a diff between the index and the current working directory.
The second form returns a diff between the index and the given diffable object. diffable
can either be a Rugged::Commit
or a Rugged::Tree
.
The index will be used as the “old file” side of the diff, while the working directory or the diffable
will be used for the “new file” side.
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.
- :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.
- :show_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.
# File lib/rugged/index.rb, line 109 def diff(*args) options = args.last.is_a?(Hash) ? args.pop : {} other = args.shift case other when nil diff_index_to_workdir options when ::Rugged::Commit diff_tree_to_index other.tree, options when ::Rugged::Tree diff_tree_to_index other, options else raise TypeError, "A Rugged::Commit or Rugged::Tree instance is required" end end
Passes each entry of the index to the given block.
If no block is given, an enumerator is returned instead.
static VALUE rb_git_index_each(VALUE self) { git_index *index; unsigned int i, count; RETURN_ENUMERATOR(self, 0, 0); Data_Get_Struct(self, git_index, index); count = (unsigned int)git_index_entrycount(index); for (i = 0; i < count; ++i) { const git_index_entry *entry = git_index_get_byindex(index, i); if (entry) rb_yield(rb_git_indexentry_fromC(entry)); } return Qnil; }
Return a specific entry in the index.
The first two forms returns entries based on their path
in the index and an optional stage
, while the last two forms return entries based on their position in the index.
static VALUE rb_git_index_get(int argc, VALUE *argv, VALUE self) { git_index *index; const git_index_entry *entry = NULL; VALUE rb_entry, rb_stage; Data_Get_Struct(self, git_index, index); rb_scan_args(argc, argv, "11", &rb_entry, &rb_stage); if (TYPE(rb_entry) == T_STRING) { int stage = 0; if (!NIL_P(rb_stage)) { Check_Type(rb_stage, T_FIXNUM); stage = FIX2INT(rb_stage); } entry = git_index_get_bypath(index, StringValueCStr(rb_entry), stage); } else if (TYPE(rb_entry) == T_FIXNUM) { if (argc > 1) { rb_raise(rb_eArgError, "Too many arguments when trying to lookup entry by index"); } entry = git_index_get_byindex(index, FIX2INT(rb_entry)); } else { rb_raise(rb_eArgError, "Invalid type for `entry`: expected String or Fixnum"); } return entry ? rb_git_indexentry_fromC(entry) : Qnil; }
Return merge_file
(in memory) from the ancestor, our side and their side of the conflict at path
.
If :ancestor
, :ours
or :theirs
is nil
, that indicates that path
did not exist in the respective tree.
Returns nil if no conflict is present at path
.
The following options can be passed in the options
Hash:
- :ancestor_label
-
The name of the ancestor branch used to decorate conflict markers.
- :our_label
-
The name of our branch used to decorate conflict markers.
- :their_label
-
The name of their branch used to decorate conflict markers.
- :favor
-
Specifies how and if conflicts are auto-resolved by favoring a specific file output. Can be one of ‘:normal`, `:ours`, `:theirs` or `:union`. Defaults to `:normal`.
- :style
-
Specifies the type of merge file to produce. Can be one of ‘:standard`, `:diff3`. Defaults to `:standard`
- :simplify
-
If true, the merge file is simplified by condensing non-alphanumeric regions.
static VALUE rb_git_merge_file(int argc, VALUE *argv, VALUE self) { VALUE rb_path, rb_options, rb_result; VALUE rb_repo = rugged_owner(self); git_repository *repo; git_index *index; const git_index_entry *ancestor, *ours, *theirs; git_merge_file_result merge_file_result = {0}; git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT; int error; rb_scan_args(argc, argv, "1:", &rb_path, &rb_options); if (!NIL_P(rb_options)) rugged_parse_merge_file_options(&opts, rb_options); Check_Type(rb_path, T_STRING); Data_Get_Struct(self, git_index, index); rugged_check_repo(rb_repo); Data_Get_Struct(rb_repo, git_repository, repo); error = git_index_conflict_get(&ancestor, &ours, &theirs, index, StringValueCStr(rb_path)); if (error == GIT_ENOTFOUND) return Qnil; else rugged_exception_check(error); if (ours == NULL) rb_raise(rb_eRuntimeError, "The conflict does not have a stage 2 entry"); else if (theirs == NULL) rb_raise(rb_eRuntimeError, "The conflict does not have a stage 3 entry"); error = git_merge_file_from_index(&merge_file_result, repo, ancestor, ours, theirs, &opts); rugged_exception_check(error); rb_result = rb_merge_file_result_fromC(&merge_file_result); git_merge_file_result_free(&merge_file_result); return rb_result; }
Clear the current index and start the index again on top of tree
Further index operations (add
, update
, remove
, etc) will be considered changes on top of tree
.
static VALUE rb_git_index_readtree(VALUE self, VALUE rb_tree) { git_index *index; git_tree *tree; int error; Data_Get_Struct(self, git_index, index); TypedData_Get_Struct(rb_tree, git_tree, &rugged_object_type, tree); if (!rb_obj_is_kind_of(rb_tree, rb_cRuggedTree)) { rb_raise(rb_eTypeError, "A Rugged::Tree instance is required"); } error = git_index_read_tree(index, tree); rugged_exception_check(error); return Qnil; }
Reloads the index contents from the disk, discarding any changes that have not been saved through write
.
static VALUE rb_git_index_read(VALUE self) { git_index *index; int error; Data_Get_Struct(self, git_index, index); error = git_index_read(index, 0); rugged_exception_check(error); return Qnil; }
Removes the entry at the given path
with the given stage
from the index.
static VALUE rb_git_index_remove(int argc, VALUE *argv, VALUE self) { git_index *index; int error, stage = 0; VALUE rb_entry, rb_stage; Data_Get_Struct(self, git_index, index); if (rb_scan_args(argc, argv, "11", &rb_entry, &rb_stage) > 1) { Check_Type(rb_stage, T_FIXNUM); stage = FIX2INT(rb_stage); } Check_Type(rb_entry, T_STRING); error = git_index_remove(index, StringValueCStr(rb_entry), stage); rugged_exception_check(error); return Qnil; }
Remove all matching index entries.
Searches index
for entries that match pathspec
and removes them from the index.
pathspec
can either be a String, or an Array of Strings. If pathspec
is empty, all entries in the index will be matched.
If a block is given, each matched path
and the pathspec
that matched it will be passed to the block. If the return value of block
is falsy, the matching item will not be removed from the index.
static VALUE rb_git_index_remove_all(int argc, VALUE *argv, VALUE self) { VALUE rb_pathspecs = rb_ary_new(); git_index *index; git_strarray pathspecs; int error, exception = 0; Data_Get_Struct(self, git_index, index); rb_scan_args(argc, argv, "01", &rb_pathspecs); if (NIL_P(rb_pathspecs)) rb_pathspecs = rb_ary_new(); rugged_rb_ary_to_strarray(rb_ary_to_ary(rb_pathspecs), &pathspecs); error = git_index_remove_all(index, &pathspecs, rb_block_given_p() ? rugged__index_matched_path_cb : NULL, &exception); xfree(pathspecs.strings); if (exception) rb_jump_tag(exception); rugged_exception_check(error); return Qnil; }
Removes all entries under the given dir
with the given stage
from the index.
static VALUE rb_git_index_remove_directory(int argc, VALUE *argv, VALUE self) { git_index *index; int error, stage = 0; VALUE rb_dir, rb_stage; Data_Get_Struct(self, git_index, index); if (rb_scan_args(argc, argv, "11", &rb_dir, &rb_stage) > 1) { Check_Type(rb_stage, T_FIXNUM); stage = FIX2INT(rb_stage); } Check_Type(rb_dir, T_STRING); error = git_index_remove_directory(index, StringValueCStr(rb_dir), stage); rugged_exception_check(error); return Qnil; }
# File lib/rugged/index.rb, line 125 def to_s s = "#<Rugged::Index\n" self.each do |entry| s << " [#{entry[:stage]}] '#{entry[:path]}'\n" end s + '>' end
Add a new entry to the index or update an existing entry in the index.
If passed a path
to an existing, readable file relative to the workdir, creates a new index entry based on this file.
Alternatively, a new index entry can be created by passing a Hash containing all key/value pairs of an index entry.
Any gitignore rules that might match path
(or the :path
value of the entry hash) are ignored.
If the index entry at path
(or :path
) currently contains a merge conflict, it will no longer be marked as conflicting and the data about the conflict will be moved into the “resolve undo” (REUC) section of the index.
Update all index entries to match the working directory.
Searches index
for entries that match pathspec
and synchronizes them with the content of the working directory.
pathspec
can either be a String, or an Array of Strings. If pathspec
is empty, all entries in the index will be matched.
Entries where the corresponding working directory file no longer exists get deleted, all other matched entries will get updated to reflect their working directory state (the latest version of the a file’s content will automatically be added to the ODB).
If a block is given, each matched path
and the pathspec
that matched it will be passed to the block. If the return value of block
is falsy, the matching item will not be updated in the index.
This method will fail in bare index instances.
static VALUE rb_git_index_update_all(int argc, VALUE *argv, VALUE self) { VALUE rb_pathspecs = rb_ary_new(); git_index *index; git_strarray pathspecs; int error, exception = 0; Data_Get_Struct(self, git_index, index); rb_scan_args(argc, argv, "01", &rb_pathspecs); rugged_rb_ary_to_strarray(rb_pathspecs, &pathspecs); error = git_index_update_all(index, &pathspecs, rb_block_given_p() ? rugged__index_matched_path_cb : NULL, &exception); xfree(pathspecs.strings); if (exception) rb_jump_tag(exception); rugged_exception_check(error); return Qnil; }
Writes the index object from memory back to the disk, persisting all changes.
static VALUE rb_git_index_write(VALUE self) { git_index *index; int error; Data_Get_Struct(self, git_index, index); error = git_index_write(index); rugged_exception_check(error); return Qnil; }
Write the index to a tree, either in the index’s repository, or in the given repo
.
If the index contains any files in conflict, writing the tree will fail.
Returns the OID string of the written tree object.
static VALUE rb_git_index_writetree(int argc, VALUE *argv, VALUE self) { git_index *index; git_oid tree_oid; int error; VALUE rb_repo; Data_Get_Struct(self, git_index, index); if (rb_scan_args(argc, argv, "01", &rb_repo) == 1) { git_repository *repo = NULL; rugged_check_repo(rb_repo); Data_Get_Struct(rb_repo, git_repository, repo); error = git_index_write_tree_to(&tree_oid, index, repo); } else { error = git_index_write_tree(&tree_oid, index); } rugged_exception_check(error); return rugged_create_oid(&tree_oid); }
Private Instance Methods
static VALUE rb_git_diff_index_to_workdir(VALUE self, VALUE rb_options) { git_index *index; git_diff_options opts = GIT_DIFF_OPTIONS_INIT; git_repository *repo; git_diff *diff = NULL; VALUE owner; int error; rugged_parse_diff_options(&opts, rb_options); Data_Get_Struct(self, git_index, index); owner = rugged_owner(self); Data_Get_Struct(owner, git_repository, repo); error = git_diff_index_to_workdir(&diff, repo, index, &opts); xfree(opts.pathspec.strings); rugged_exception_check(error); return rugged_diff_new(rb_cRuggedDiff, owner, diff); }
static VALUE rb_git_diff_tree_to_index(VALUE self, VALUE rb_other, VALUE rb_options) { git_index *index; git_diff_options opts = GIT_DIFF_OPTIONS_INIT; git_repository *repo; git_diff *diff = NULL; VALUE owner; int error; git_tree *other_tree; rugged_parse_diff_options(&opts, rb_options); Data_Get_Struct(self, git_index, index); owner = rugged_owner(self); Data_Get_Struct(owner, git_repository, repo); // Need to flip the reverse option, so that the index is by default // the "old file" side of the diff. opts.flags ^= GIT_DIFF_REVERSE; TypedData_Get_Struct(rb_other, git_tree, &rugged_object_type, other_tree); error = git_diff_tree_to_index(&diff, repo, other_tree, index, &opts); xfree(opts.pathspec.strings); rugged_exception_check(error); return rugged_diff_new(rb_cRuggedDiff, owner, diff); }