R/config.R

In orderly: Lightweight Reproducible Reporting

orderly_config_read <- function(filename, call = NULL) {
  path <- dirname(filename)
  assert_file_exists_relative(basename(filename), workdir = path,
                              name = "Orderly configuration", call = call)
  raw <- read_config_data(filename)
  if (!is.null(raw)) {
    assert_named(raw, call = call)
  }

  raw <- resolve_envvar(raw, orderly_envir_read(path, call), basename(filename))

  check <- list(
    minimum_orderly_version = orderly_config_validate_minimum_orderly_version,
    plugins = orderly_config_validate_plugins)

  required <- "minimum_orderly_version"
  optional <- setdiff(names(check), required)
  check_fields(raw, filename, required, optional)

  ## This simplifies the validation
  owd <- setwd(path)
  on.exit(setwd(owd))
  dat <- list()
  for (x in names(check)) {
    dat[[x]] <- check[[x]](raw[[x]], filename, call = call)
  }

  attr(dat, "filename") <- filename

  dat
}


orderly_config_validate_minimum_orderly_version <- function(value, filename,
                                                            call = NULL) {
  assert_not_orderly1_project(value, call = call)
  version <- numeric_version(value)
  if (version > current_orderly_version()) {
    cli::cli_abort(sprintf(
      "orderly version '%s' is required, but only '%s' installed",
      version, current_orderly_version()),
      call = call)
  }
  version
}


assert_not_orderly1_project <- function(value, call = NULL) {
  assert_scalar_character(value, call = call)
  if (numeric_version(value) < numeric_version("1.99.0")) {
    cli::cli_abort(
      c("Detected old orderly project, you need to migrate to orderly 2",
        i = 'Please see documentation at vignette("migrating")',
        i = paste(
          "You can also use this project with the 'orderly1' package,",
          "which can safely be installed alongside the new version")),
      call = call)
  }
}


orderly_config_validate_plugins <- function(plugins, filename, call = NULL) {
  if (is.null(plugins)) {
    return(NULL)
  }
  assert_named(plugins, unique = TRUE, name = sprintf("%s:plugins", filename),
               call = call)

  ret <- list()
  for (nm in names(plugins)) {
    dat <- load_orderly_plugin(nm)
    dat$config <- dat$config(plugins[[nm]], filename)
    ret[[nm]] <- dat
  }
  ret
}


orderly_envir_read <- function(path, call = NULL) {
  ## TODO: we might prefer json here too, fairly easily really
  filename <- file.path(path, "orderly_envir.yml")
  if (!file.exists(filename)) {
    return(NULL)
  }

  dat <- yaml_read(filename)
  if (length(dat) == 0) {
    return(NULL)
  }

  assert_named(dat, TRUE, basename(filename), call = call)
  n <- lengths(dat)
  nok <- n != 1L
  if (any(nok)) {
    err <- sprintf("Expected '%s' to be scalar, but had length %d",
                   names(dat)[nok], n[nok])
    cli::cli_abort(
      c("All elements of '{basename(filename)}' must be scalar",
        set_names(err, rep("x", length(err))),
        i = "Working directory was '{dirname(filename)}'"),
      call = call)
  }
  vcapply(dat[n == 1], as.character)
}