R/check-vector-isGitRepo.R

In acidgenomics/goalie: Assertive Check Functions

#' Does the input contain a Git repository?
#'
#' @name check-vector-isGitRepo
#' @note Updated 2023-10-02.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @examples
#' ## TRUE ====
#' isGitRepo(file.path("~", "git", "monorepo"))
#'
#' ## FALSE ====
#' isGitRepo("~")
NULL



## Vector ======================================================================

#' @describeIn check-vector-isGitRepo Vectorized.
#' @export
isGitRepo <- function(x) {
    ok <- hasLength(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- isCharacter(x)
    if (!isTRUE(ok)) {
        ko <- rep(x = FALSE, times = length(x))
        return(setCause(ko, false = "not character"))
    }
    ok <- isSystemCommand("git")
    if (!isTRUE(ok)) {
        ko <- rep(x = FALSE, times = length(x))
        return(setCause(ko, false = "no git"))
    }
    requireNamespaces("AcidBase")
    ok <- bapply(
        X = x,
        FUN = function(x) {
            ok <- isADirectory(x)
            if (!isTRUE(ok)) {
                return(FALSE)
            }
            ok <- isADirectory(file.path(x, ".git"))
            if (isTRUE(ok)) {
                return(TRUE)
            }
            ok <- tryCatch(
                expr = {
                    gitDir <- AcidBase::shell(
                        command = "git",
                        args = c("rev-parse", "--git-dir"),
                        print = FALSE,
                        wd = x,
                        returnStdout = TRUE
                    )
                    isADir(gitDir)
                },
                warning = function(w) {
                    FALSE
                },
                error = function(e) {
                    FALSE
                }
            )
            ok
        },
        USE.NAMES = FALSE
    )
    setCause(ok, false = "not git repo")
}



## Scalar ======================================================================

#' @describeIn check-vector-isGitRepo Scalar.
#' @export
isAGitRepo <- function(x) {
    ok <- isString(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- isGitRepo(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    TRUE
}



#' @describeIn check-vector-isGitRepo Scalar.
#' @export
allAreGitRepos <- function(x) {
    ok <- isGitRepo(x)
    if (!all(ok)) {
        return(falseFromVector(ok))
    }
    TRUE
}