R/pkg.R

In anthonynorth/using: Add version constraints to library() calls

##' Optionally add version constraints to library calls
##'
##' This function is intended to always be called with the `using::` prefix. A
##' call without this prefix will throw a warning. This simplifies detecting
##' dependencies declared by using::pkg for use with `{renv}` and `{capsule}`
#'
#' @title using::pkg
#' @param package `{character | name}` package name
#' @param min_version `{package_version | character}` min package version
#' @param repo `{character}` repo url
#' @param ... additional arguments to pass to [base::library()]
#'
#' @return `{character | logical}`
#' attached packages, or boolean if `logical.return is TRUE`
#'
#' @examples
#' \dontrun{
#' using::pkg(capsule)
#' using::pkg(dplyr, min_version = "0.8.0")
#' using::pkg(h3jsr, min_version = "1.0.0", repo = "https://github.com/obrl-soil/h3jsr")
#' }
#'
#' @export
pkg <- function(package, min_version = NULL, repo = NULL, ...) {

package <- deparse(substitute(package))
  package_installed <- requireNamespace(package, quietly = TRUE)
  version_satisfied <- TRUE

  stopifnot(
    is.null(min_version) || inherits(
      min_version,
      c("character", "package_version")
    ),
    is.null(repo) || inherits(repo, "character")
  )

  if (package_installed && !is.null(min_version)) {
    version_satisfied <-
      utils::compareVersion(
        as.character(utils::packageVersion(package)),
        min_version
      ) >= 0
  }

  if ((!package_installed || !version_satisfied) && interactive() &&
    prompt_install(package)) {
    using_install_package(package, min_version, repo)
    version_satisfied <- TRUE
    package_installed <- TRUE
  }


  if (!version_satisfied || !package_installed) {
    error_message <- paste0(
      "Could not satisfy dependency '",
      package,
      if (!is.null(version)) paste0("' with version >= ", min_version),
      if (!is.null(repo)) paste0(" from repo ", repo)
    )
    stop(error_message)
  }

  params <- c(
    list(
      package = package,
      character.only = TRUE
    ),
    list(...)
  )

  do.call(library, params, envir = .GlobalEnv)
}