R/assert.R

In Tutuchan/vacancesscolr: Find school holidays in France

#' assert a value can be cast to Date
#'
#' @param x the value to test
#'
#' @keywords internal
assert_date <- function(x) {
  if (!inherits(x, c("Date", "POSIXt"))) {
    res <- tryCatch({
      strftime(x)
    }, error = I)

    if (inherits(res, "error")) {
      stop(x, " can't be cast to a Date object!")
    }
  }
  TRUE
}

#' assert a value can be considered as a year
#'
#' @param x the value to test
#'
#' @keywords internal
assert_year <- function(x) {
  res <- tryCatch({
    suppressWarnings(as.numeric(x))
  }, error = I)

  if (inherits(res, "error") | any(is.na(res))) {
    stop(x, " is not a year!")
  }

  min_year <- as.numeric(substring(min(vacances$date), 1, 4))
  max_year <- as.numeric(substring(max(vacances$date), 1, 4))

  if (any(res < min_year) | any(res > max_year)) {
    stop("All elements of '", toString(x), "' should be between ", min_year, " and ", max_year, "!")
  }

  TRUE
}

#' assert a value is a valid school holiday name
#'
#' @param x the value to test
#'
#' @keywords internal
assert_name <- function(x) {
  if (!x %in% c(.holidays_names, .holidays_names_short)) {
    stop("Valid holiday names are: ", toString(.holidays_names), " or ", toString(.holidays_names_short))
  }

  if (tolower(x) %in% .holidays_names_short) {
    idx <- which(.holidays_names_short == tolower(x))
    x   <- .holidays_names[idx]
  }
  x
}