R/remote_path.R

In vimc/orderly: Lightweight Reproducible Reporting

##' Create a "handle" for interacting with orderly repositories that
##' are hosted at a different path.  This might be useful in cases
##' where you have access to an orderly repository via a network mount
##' or a synchronised folder (e.g., Dropbox, Box, etc).  More
##' generally, `orderly_remote_path` implements an interface
##' used by orderly to abstract over different ways that orderly
##' repositories might be hosted remotely, including over HTTP APIs.
##'
##' @title Orderly remote at a different path
##'
##' @param path Path to the orderly store
##'
##' @param name Name of the remote
##'
##' @return An `orderly_remote_path` object, with methods that
##'   orderly will use in order to control this remote
##'
##' @export
##' @seealso [orderly::orderly_pull_dependencies()] and
##'   [orderly::orderly_pull_archive()], which are the primary ways
##'   these remote objects are used.  See also
##'   [OrderlyWeb](https://github.com/vimc/orderly-web) for a
##'   system for hosting orderly repositories over an HTTP API.
##'
##' @example man-roxygen/example-remote.R
orderly_remote_path <- function(path, name = NULL) {
  orderly_remote_path_$new(path, name)
}


orderly_remote_path_ <- R6::R6Class(
  "orderly_remote_path",

  public = list(
    config = NULL,
    name = NULL,

    initialize = function(path, name) {
      assert_file_exists(path, FALSE)
      path <- normalizePath(path, "/", mustWork = TRUE)
      if (!file.exists(path_orderly_config_yml(path))) {
        stop("Does not look like an orderly repository: ", squote(path))
      }
      self$config <- orderly_config_$new(path)
      self$name <- name %||% self$config$root
      lockBinding(quote(config), self)
      lockBinding(quote(name), self)
    },

    list_reports = function() {
      orderly_list(self$config)
    },

    list_versions = function(name) {
      d <- orderly_list_archive(self$config)
      d$id[d$name == name]
    },

    metadata = function(name, id) {
      path_orderly_run_rds(file.path(path_archive(self$config$root), name, id))
    },

    pull = function(name, id) {
      src <- file.path(path_archive(self$config$root), name, id)
      dest <- tempfile()
      copy_directory(src, dest, TRUE)
      dest
    },

    push = function(path) {
      path_meta <- file.path(path, "orderly_run.rds")
      stopifnot(file.exists(path_meta))

      dat <- readRDS(path_meta)
      name <- dat$meta$name
      id <- dat$meta$id

      dest <- file.path(path_archive(self$config$root), name, id)
      copy_directory(path, dest, rollback_on_error = TRUE)
    },

    run = function(...) {
      stop("'orderly_remote_path' remotes do not run")
    },

    url_report = function(name, id) {
      file.path(self$config$root, name, id, fsep = "/")
    },

    bundle_pack = function(name, parameters = NULL, instance = NULL) {
      res <- orderly_bundle_pack(tempdir(), name, parameters = parameters,
                                 instance = instance,
                                 root = self$config, locate = FALSE)
      res$path
    },

    bundle_import = function(path) {
      orderly_bundle_import(path, root = self$config, locate = FALSE)
    },

    kill = function(...) {
      stop("'orderly_remote_path' remotes do not kill")
    }
  ))