R/gitconnection_class.R

In inbo/n2khelper: Auxiliary Functions for the Analysis and Reporting of the Natura 2000 Monitoring

#' @importFrom methods setOldClass setClassUnion
setOldClass(c("cred_user_pass", "cred_ssh_key", "git_repository"))
setClassUnion("gitCredentials", c("NULL", "cred_user_pass", "cred_ssh_key"))

#' The gitConnection class
#'
#' @section Slots:
#'   \describe{
#'    \item{\code{Repository}}{a git repository}
#'    \item{\code{Credentials}}{the credentials for the repository}
#'    \item{\code{CommitUser}}{the name of the user how will commit}
#'    \item{\code{CommitEmail}}{the email of the user how will commit}
#'   }
#' @name gitConnection-class
#' @rdname gitConnection-class
#' @exportClass gitConnection
#' @aliases gitConnection-class
#' @importFrom methods setClass
#' @docType class
setClass(
  Class = "gitConnection",
  representation = representation(
    Repository = "git_repository",
    Credentials = "gitCredentials",
    CommitUser = "character",
    CommitEmail = "character"
  )
)

#' @importFrom methods setValidity
#' @importFrom git2r repository config
#' @importFrom assertthat assert_that is.string has_name
setValidity(
  "gitConnection",
  function(object) {
    assert_that(is.string(object@CommitUser))
    assert_that(is.string(object@CommitEmail))
    repo_config <- config(object@Repository)
    assert_that(has_name(repo_config$local, "user.name"))
    assert_that(has_name(repo_config$local, "user.email"))
    assert_that(repo_config$local$user.name == object@CommitUser)
    assert_that(repo_config$local$user.email == object@CommitEmail)
    return(TRUE)
  }
)