Merge pull request #496 from niamster/master

repo: support for checkout_index

Author: arthurschreiber

CHANGELOG.md

@@ -1,3 +1,10 @@
+*   Add `Rugged::Repository#checkout_index`.
+
+    This allows to perform checkout from a given GIT index.
+    It might be handy in case of manual merge conflicts resolution with user intervention.
+
+    *Dmytro Milinevskyy*
+
 *   Add accessors for the Repository ident.
 
     Added `Repository#ident` and `Repository#ident=` to read and set the

ext/rugged/rugged_repo.c

@@ -2181,6 +2181,54 @@ static VALUE rb_git_checkout_tree(int argc, VALUE *argv, VALUE self)
 	return Qnil;
 }
 
+/**
+ *  call-seq: repo.checkout_index(index[,options]) -> nil
+ *
+ *  Updates files in the index and the working tree to match the content of the
+ *  commit pointed at by +index+.
+ *
+ *  See Repository#checkout_tree for a list of supported +options+.
+ */
+static VALUE rb_git_checkout_index(int argc, VALUE *argv, VALUE self)
+{
+	VALUE rb_index, rb_options;
+	git_repository *repo;
+	git_index *index;
+	git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
+	struct rugged_cb_payload *payload;
+	int error, exception = 0;
+
+	rb_scan_args(argc, argv, "10:", &rb_index, &rb_options);
+
+	if (!rb_obj_is_kind_of(rb_index, rb_cRuggedIndex))
+		rb_raise(rb_eTypeError, "Expected Rugged::Index");
+
+	Data_Get_Struct(self, git_repository, repo);
+	Data_Get_Struct(rb_index, git_index, index);
+
+	rugged_parse_checkout_options(&opts, rb_options);
+
+	error = git_checkout_index(repo, index, &opts);
+	xfree(opts.paths.strings);
+
+	if ((payload = opts.notify_payload) != NULL) {
+		exception = payload->exception;
+		xfree(opts.notify_payload);
+	}
+
+	if ((payload = opts.progress_payload) != NULL) {
+		exception = payload->exception;
+		xfree(opts.progress_payload);
+	}
+
+	if (exception)
+		rb_jump_tag(exception);
+
+	rugged_exception_check(error);
+
+	return Qnil;
+}
+
 /**
  *  call-seq: repo.checkout_head([options]) -> nil
  *
@@ -2483,6 +2531,7 @@ void Init_rugged_repo(void)
 	rb_define_method(rb_cRuggedRepo, "default_signature", rb_git_repo_default_signature, 0);
 
 	rb_define_method(rb_cRuggedRepo, "checkout_tree", rb_git_checkout_tree, -1);
+    rb_define_method(rb_cRuggedRepo, "checkout_index", rb_git_checkout_index, -1);
 	rb_define_method(rb_cRuggedRepo, "checkout_head", rb_git_checkout_head, -1);
 
 	rb_define_method(rb_cRuggedRepo, "cherrypick", rb_git_repo_cherrypick, -1);

test/repo_test.rb

@@ -811,20 +811,16 @@ def teardown
     super
   end
 
-  def test_checkout_tree_with_commit
-    @repo.checkout_tree(@repo.rev_parse("refs/heads/dir"), :strategy => :force)
-    @repo.head = "refs/heads/dir"
-
+  def verify_dir
     assert File.exist?(File.join(@repo.workdir, "README"))
     assert File.exist?(File.join(@repo.workdir, "branch_file.txt"))
     assert File.exist?(File.join(@repo.workdir, "new.txt"))
     assert File.exist?(File.join(@repo.workdir, "a/b.txt"))
 
     refute File.exist?(File.join(@repo.workdir, "ab"))
+  end
 
-    @repo.checkout_tree(@repo.rev_parse("refs/heads/subtrees"), :strategy => :safe)
-    @repo.head = "refs/heads/subtrees"
-
+  def verify_subtrees
     assert File.exist?(File.join(@repo.workdir, "README"))
     assert File.exist?(File.join(@repo.workdir, "branch_file.txt"))
     assert File.exist?(File.join(@repo.workdir, "new.txt"))
@@ -836,16 +832,29 @@ def test_checkout_tree_with_commit
     refute File.exist?(File.join(@repo.workdir, "a"))
   end
 
+  def test_checkout_tree_with_commit
+    @repo.checkout_tree(@repo.rev_parse("refs/heads/dir"), :strategy => :force)
+    @repo.head = "refs/heads/dir"
+    verify_dir
+
+    @repo.checkout_tree(@repo.rev_parse("refs/heads/subtrees"), :strategy => :safe)
+    @repo.head = "refs/heads/subtrees"
+    verify_subtrees
+  end
+
   def test_checkout_with_revspec_string
     @repo.checkout_tree("refs/heads/dir", :strategy => :force)
     @repo.head = "refs/heads/dir"
+    verify_dir
+  end
 
-    assert File.exist?(File.join(@repo.workdir, "README"))
-    assert File.exist?(File.join(@repo.workdir, "branch_file.txt"))
-    assert File.exist?(File.join(@repo.workdir, "new.txt"))
-    assert File.exist?(File.join(@repo.workdir, "a/b.txt"))
-
-    refute File.exist?(File.join(@repo.workdir, "ab"))
+  def test_checkout_tree_with_index
+    index = @repo.index
+    head = @repo.references["refs/heads/dir"]
+    index.read_tree head.target.tree
+    @repo.checkout_index(index, :strategy => :force)
+    @repo.head = "refs/heads/dir"
+    verify_dir
   end
 
   def test_checkout_tree_raises_errors_in_notify_cb