feat: git_restore()

Author: maelle

NAMESPACE

@@ -60,6 +60,7 @@ export(git_remote_set_url)
 export(git_reset_hard)
 export(git_reset_mixed)
 export(git_reset_soft)
+export(git_restore)
 export(git_revert)
 export(git_rm)
 export(git_signature)
@@ -153,6 +154,7 @@ useDynLib(gert,R_git_repository_open)
 useDynLib(gert,R_git_repository_path)
 useDynLib(gert,R_git_repository_rm)
 useDynLib(gert,R_git_reset)
+useDynLib(gert,R_git_restore)
 useDynLib(gert,R_git_revert)
 useDynLib(gert,R_git_signature_create)
 useDynLib(gert,R_git_signature_default)

NEWS

@@ -1,4 +1,5 @@
 2.3.1
+  - Add git_restore() function
   - Add git_revert() function
   - git_stat_files() gains a 'max' parameter
   - Fix function declaration error

R/commit.R

@@ -307,22 +307,7 @@ git_revert <- function(
   assert_string(ref)
   stopifnot(is.logical(commit), length(commit) == 1)
 
-  sha <- tryCatch(git_commit_id(ref, repo = repo), error = function(e){
-    stop(sprintf(
-      "Can't find reference/commit '%s' in the current branch history",
-      ref
-    ))
-  })
-
-  head_sha <- git_commit_id("HEAD", repo = repo)
-  sha_descends_from_head <- git_commit_descendant_of(
-    ancestor = sha,
-    ref = "HEAD",
-    repo = repo
-  )
-  if (sha != head_sha && !sha_descends_from_head) {
-    stop(sprintf("commit '%s' is not in the current branch history", ref))
-  }
+  sha <- check_ref_in_history(ref, repo)
 
   .Call(R_git_revert, repo, sha)
 
@@ -331,7 +316,12 @@ git_revert <- function(
   }
 }
 
-git_revert_commit <- function(sha, message = revert_message(sha, repo), ..., repo){
+git_revert_commit <- function(
+  sha,
+  message = revert_message(sha, repo),
+  ...,
+  repo
+) {
   git_commit(message, ..., repo = repo)
 }
 

R/restore.R

@@ -0,0 +1,58 @@
+#' Restore working tree files
+#'
+#' Restores specified paths in the working tree from a given ref, equivalent
+#' to `git restore --source=<ref> <path>` (or the older
+#' `git checkout <ref> -- <path>`). The ref must be reachable from the
+#' current HEAD. By default restores from HEAD, discarding any local
+#' modifications.
+#'
+#' @export
+#' @name git_restore
+#' @rdname git_restore
+#' @family git
+#' @inheritParams git_open
+#' @param path character vector with file paths to restore, relative to the
+#'   repository root. Use `"."` to restore all tracked files.
+#' @param ref revision string with a branch/tag/commit to restore from.
+#'   Defaults to `"HEAD"`.
+#' @return Invisibly, the [git_status()] after restoring.
+#' @examplesIf interactive()
+#' repo <- file.path(tempdir(), "myrepo")
+#' git_init(repo)
+#'
+#' # Set a user if no default
+#' if (!user_is_configured()) {
+#'   git_config_set("user.name", "Jerry")
+#'   git_config_set("user.email", "jerry@gmail.com")
+#' }
+#'
+#' writeLines("hello", file.path(repo, "hello.txt"))
+#' git_add("hello.txt", repo = repo)
+#' git_commit("First commit", repo = repo)
+#'
+#' # Modify the file, then restore it from HEAD
+#' writeLines("oops", file.path(repo, "hello.txt"))
+#' git_restore("hello.txt", repo = repo)
+#' readLines(file.path(repo, "hello.txt"))  # "hello"
+#'
+#' unlink(repo, recursive = TRUE)
+#' @useDynLib gert R_git_restore
+git_restore <- function(path, ref = "HEAD", repo = ".") {
+  repo <- git_open(repo)
+  path <- check_path_tracked(as.character(path), repo)
+  check_ref_in_history(ref, repo)
+  .Call(R_git_restore, repo, path, ref)
+  invisible(git_status(repo = repo))
+}
+
+check_path_tracked <- function(path, repo) {
+  if (identical(path, ".")) {
+    return(character(0))
+  }
+  tracked <- git_ls(repo = repo)$path
+  untracked <- setdiff(path, tracked)
+  if (length(untracked) > 0) {
+    stop("Path(s) not tracked by git: ", toString(untracked))
+  }
+  path
+}

R/utils-sha.R

@@ -0,0 +1,17 @@
+check_ref_in_history <- function(ref, repo) {
+  sha <- tryCatch(git_commit_id(ref, repo = repo), error = function(e) {
+    stop(sprintf("Cannot resolve '%s' to a commit", ref))
+  })
+
+  head_sha <- git_commit_id("HEAD", repo = repo)
+  sha_descends_from_head <- git_commit_descendant_of(
+    ancestor = sha,
+    ref = "HEAD",
+    repo = repo
+  )
+  if (sha != head_sha && !sha_descends_from_head) {
+    stop(sprintf("'%s' is not in the current branch history", ref))
+  }
+
+  sha
+}