R/fail_fast.R

Defines functions .check_package_provided .check_build_path_exists .check_arch .ping_url .check_repo_set

Documented in .check_arch .check_build_path_exists .check_package_provided .check_repo_set .ping_url

#' Check that a repo for packages/R was set
#'
#' @param cran_like_url cran_like_url
#' @param mran_date mran_date
#'
.check_repo_set <- function(cran_like_url = NULL, 
                            mran_date = NULL) {
  
  # Either 'cran_like_url' or 'local_package_path_path' must be set
  if (is.null(c(cran_like_url, mran_date))) {
    base::stop("electricShine requires you to specify either a 'cran_like_url' or 'mran_date' argument specifying
         the shiny app/package to be turned into an Electron app. The url for CRAN is: 'https://cran.r-project.org'") 
  }
  
  # Ensure that 'cran_like_url' and 'mran_date' aren't set at the same time.
  if (!is.null(cran_like_url) && !is.null(mran_date)) {
    stop("Values provided for both 'cran_like_url' and 'mran_date'; electricShine requires that only one of these is not NULL.") 
  }
  
}





#' Check internet connection
#'
#' @param url url to check
#'
.ping_url <- function(url){
  
  if(capabilities("libcurl")) {
    
    a <- base::curlGetHeaders(url)
    
    if (attributes(a)$status != 200L) {
      message(a)
      stop("provided url was unable to resolve host ")
      
    }
    message("----------")
    message(paste0("Connection to: ", url, "\n"))
    message(a[1:10])
    message("----------")
  } else {
    warning("libcurl unavailable to check internet.")
  }
  
}


#' Check if compatible architecture
#'
#' @param arch only used for unit testing
#'
#' @return Stops if unsupported architecture
.check_arch <- function(arch = base::version$arch[[1]]){
  
  if (arch != "x86_64") {
    base::stop("Unfortunately 32 bit operating system builds are unsupported, if you would like to contribute to support this, that would be cool")
  }
  
}


#' Check whether build path exists
#'
#' @param build_path build_path
#'
#' @return stops 
.check_build_path_exists <- function(build_path){
  
  if (is.null(build_path)) {
    base::stop("'build_path' not provided")
  }
  
  if (!is.character(build_path)) {
    base::stop("'build_path' should be character type.")
  }
  
  if (!dir.exists(build_path)) {
    base::stop("'build_path' provided, but path wasn't found.")
  }
}



#' Check package paths
#'
#'    Doesn't check whether it works, only for conflicts in arguments
#'
#' @param git_host git_host 
#' @param git_repo git_repo 
#' @param local_package_path local_package_path 
#'
#' @return stops 
.check_package_provided <- function(git_host,
                                    git_repo,
                                    local_package_path){
  
  # Either 'git_repo' or 'local_package_path' must be set
  if (is.null(c(git_repo, local_package_path))) {
    base::stop("electricShine requires you to specify either a 'git_repo' or 'local_package_path' argument specifying
         the shiny app/package to be turned into an Electron app") 
  }
  
  # Ensure that 'git_repo' and 'local_package_path' aren't set at the same time.
  if (!is.null(git_repo) && !is.null(local_package_path)) {
    stop("Values provided for both 'git_repo' and 'local_package_path'; electricShine requires that only one of these is not NULL.") 
  }
  
  # Ensure that 'git_host' and 'local_package_path' aren't set at the same time.
  if (!is.null(git_host) && !is.null(local_package_path)) {
    stop("Values provided for both 'git_host' and 'local_package_path'; electricShine requires that only one of these is not NULL.") 
  }
  
  if (sum(is.null(git_host), is.null(git_repo)) == 1) {
    stop("Must provide both 'git_host' and 'git_repo', or just 'local_package_path'.") 
  }
  
}
chasemc/electricShine documentation built on Oct. 12, 2022, 8:50 a.m.