R/cache_clear.R

In rOpenSpain/CatastRoNav: Interface to the 'INSPIRE' services of 'Catastro de Navarra'

#' Clear your \pkg{CatastRoNav} cache dir
#'
#' @family cache utilities
#'
#' @return Invisible. This function is called for its side effects.
#'
#' @description
#' **Use this function with caution**. This function would clear your cached
#' data and configuration, specifically:
#'
#' * Deletes the \pkg{CatastRoNav} config directory
#'   (`rappdirs::user_config_dir("CatastRoNav", "R")`).
#' * Deletes the `cache_dir` directory.
#' * Deletes the values on stored on `Sys.getenv("CATASTRONAV_CACHE_DIR")`.
#'
#' @param config if `TRUE`, will delete the configuration folder of
#'   \pkg{CatastRoNav}.
#' @param cached_data If this is set to `TRUE`, it will delete your
#'   `cache_dir` and all its content.
#' @inheritParams catrnav_set_cache_dir
#'
#' @details
#' This is an overkill function that is intended to reset your status
#' as it you would never have installed and/or used \pkg{CatastRoNav}.
#'
#' @examples
#'
#' # Don't run this! It would modify your current state
#' \dontrun{
#' catrnav_clear_cache(verbose = TRUE)
#' }
#'
#' Sys.getenv("CATASTRONAV_CACHE_DIR")
#' @export
catrnav_clear_cache <- function(config = FALSE,
                                cached_data = TRUE,
                                verbose = FALSE) {
  config_dir <- rappdirs::user_config_dir("CatastRoNav", "R")
  data_dir <- catrnav_hlp_detect_cache_dir()

  # nocov start
  if (config && dir.exists(config_dir)) {
    unlink(config_dir, recursive = TRUE, force = TRUE)
    if (verbose) message("CatastRoNav cache config deleted")
  }
  # nocov end

  if (cached_data && dir.exists(data_dir)) {
    unlink(data_dir, recursive = TRUE, force = TRUE)
    if (verbose) message("CatastRoNav cached data deleted: ", data_dir)
  }


  Sys.setenv(CATASTRONAV_CACHE_DIR = "")

  # Reset cache dir
  return(invisible())
}