R/branch.R

In gert: Simple Git Client for R

#' Git Branch
#'
#' Create, list, and checkout branches.
#'
#' @export
#' @rdname git_branch
#' @name git_branch
#' @family git
#' @inheritParams git_open
#' @useDynLib gert R_git_branch_current
#' @git branch
git_branch <- function(repo = '.') {
  repo <- git_open(repo)
  .Call(R_git_branch_current, repo)
}

#' @export
#' @rdname git_branch
#' @useDynLib gert R_git_branch_list
git_branch_list <- function(local = NULL, repo = '.') {
  repo <- git_open(repo)
  local <- as.logical(local)
  .Call(R_git_branch_list, repo, local)
}

#' @export
#' @rdname git_branch
#' @param branch name of branch to check out
#' @param force ignore conflicts and overwrite modified files
#' @param orphan if branch does not exist, checkout unborn branch
#' @useDynLib gert R_git_checkout_branch R_git_checkout_unborn
#' @git checkout
#' @param force overwrite existing branch
#' @examplesIf interactive()
#' # Creating a branch
#' repo <- file.path(tempdir(), "myrepo")
#' git_init(repo)
#' writeLines("hello", file.path(repo, "hello.txt"))
#' git_add("hello.txt", repo = repo)
#' first_commit <- git_commit("First commit", repo = repo)
#'
#' git_branch_create("new-feat", repo = repo)
#' writeLines("world", file.path(repo, "hello.txt"))
#' git_add("hello.txt", repo = repo)
#' second_commit <- git_commit("Second commit", repo = repo)
#'
#' # Changing branches
#' git_branch(repo = repo)
#' git_branch_switch("main", repo = repo)
#' git_branch(repo = repo)
#'
#' git_branch_exists("new-feat", repo = repo)
#'
#' # Listing branches
#' git_branch_list(repo = repo)
#'
#' # Renaming a branch
#' git_branch_move("new-feat", "better-name", repo = repo)
#' git_branch_exists("new-feat", repo = repo)
#' git_branch_list(repo = repo)
#'
#' # Deleting a branch
#' git_branch_delete("better-name", repo = repo)
#' git_branch_exists("better-name", repo = repo)
#'
#' # clean up
#' unlink(repo, recursive = TRUE)
#' # ------------------------
#' # Creating an orphan branch
#' 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)
#' first_commit <- git_commit("First commit", repo = repo)
#'
#' writeLines("world", file.path(repo, "hello.txt"))
#' git_add("hello.txt", repo = repo)
#' second_commit <- git_commit("Second commit", repo = repo)
#'
#' # Check out first commit
#' git_branch_checkout(first_commit, orphan = TRUE, repo = repo)
#' git_status(repo)
#' # clean up
#' unlink(repo, recursive = TRUE)
#'
git_branch_checkout <- function(
  branch,
  force = FALSE,
  orphan = FALSE,
  repo = '.'
) {
  repo <- git_open(repo)
  branch <- as.character(branch)
  force <- as.logical(force)
  if (!git_branch_exists(branch, repo = repo)) {
    if (isTRUE(orphan)) {
      ref <- paste0('refs/heads/', branch)
      .Call(R_git_checkout_unborn, repo, ref)
      return(ref)
    }
    all_branches <- subset(git_branch_list(repo = repo), local == FALSE)$name
    candidate <- sub("^[^/]+/", "", all_branches) == branch
    if (sum(candidate) > 1) {
      stop(sprintf(
        "Local branch '%s' does not exist and multiple remote candidates found.",
        branch
      ))
    } else if (sum(candidate) == 0) {
      stop(sprintf("No local or remote branch '%s' found.", branch))
    } else {
      remote_branch <- unname(all_branches[candidate])
      inform("Creating local branch %s from %s", branch, remote_branch)
      git_branch_create(branch, remote_branch, checkout = FALSE, repo = repo)
    }
  }
  .Call(R_git_checkout_branch, repo, branch, force)
}

#' @rdname git_branch
#' @export
git_branch_switch <- git_branch_checkout

#' @export
#' @rdname git_branch
#' @useDynLib gert R_git_create_branch
#' @param ref string with a branch/tag/commit
#' @param checkout move HEAD to the newly created branch
#' @param force overwrite existing branch
git_branch_create <- function(
  branch,
  ref = "HEAD",
  checkout = TRUE,
  force = FALSE,
  repo = '.'
) {
  repo <- git_open(repo)
  branch <- as.character(branch)
  ref <- as.character(ref)
  checkout <- as.logical(checkout)
  force <- as.logical(force)
  invisible(.Call(R_git_create_branch, repo, branch, ref, checkout, force))
}

#' @export
#' @rdname git_branch
#' @useDynLib gert R_git_delete_branch
git_branch_delete <- function(branch, repo = '.') {
  repo <- git_open(repo)
  branch <- as.character(branch)
  .Call(R_git_delete_branch, repo, branch)
  git_repo_path(repo)
}

#' @export
#' @rdname git_branch
#' @useDynLib gert R_git_branch_move
#' @param new_branch target name of the branch once the move is performed; this name is validated for consistency.
git_branch_move <- function(branch, new_branch, force = FALSE, repo = '.') {
  repo <- git_open(repo)
  branch <- as.character(branch)
  new_branch <- as.character(new_branch)
  .Call(R_git_branch_move, repo, branch, new_branch, as.logical(force))
  git_repo_path(repo)
}

#' @export
#' @rdname git_branch
git_branch_fast_forward <- function(ref, repo = '.') {
  analysis <- git_merge_analysis(ref = ref, repo = repo)
  if (analysis != "fastforward") {
    stop("Branch cannot be fast-forwarded. Use git_merge() instead")
  }
  git_branch_set_target(ref = ref, repo = repo)
}

#' @export
#' @rdname git_branch
#' @param upstream remote branch from [git_branch_list], for example `"origin/master"`
#' @useDynLib gert R_git_branch_set_upstream
git_branch_set_upstream <- function(
  upstream,
  branch = git_branch(repo),
  repo = '.'
) {
  repo <- git_open(repo)
  stopifnot(is.character(upstream))
  if (!git_branch_exists(upstream, local = FALSE, repo = repo)) {
    stop(sprintf("No remote branch found: %s, maybe fetch first?", upstream))
  }
  .Call(R_git_branch_set_upstream, repo, upstream, branch)
  git_repo_path(repo)
}

#' @export
#' @rdname git_branch
#' @param local set TRUE to only check for local branches, FALSE to check for remote
#' branches. Use NULL to return all branches.
#' @useDynLib gert R_git_branch_exists
git_branch_exists <- function(branch, local = TRUE, repo = '.') {
  repo <- git_open(repo)
  branch <- as.character(branch)
  local <- as.logical(local)
  .Call(R_git_branch_exists, repo, branch, local)
}

#' @useDynLib gert R_git_branch_set_target
git_branch_set_target <- function(ref, branch, repo) {
  repo <- git_open(repo)
  ref <- as.character(ref)
  .Call(R_git_branch_set_target, repo, ref)
  git_repo_path(repo)
}