Add function to return details of report script from parsed exprs

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: orderly2
 Title: Orderly Next Generation
-Version: 1.99.12
+Version: 1.99.13
 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
                     email = "[email protected]"),
              person("Robert", "Ashton", role = "aut"),
@@ -11,7 +11,7 @@ Description: Reimplementation of orderly based on outpack.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 URL: https://github.com/mrc-ide/orderly2
 BugReports: https://github.com/mrc-ide/orderly2/issues
 Imports:

NAMESPACE

@@ -30,6 +30,7 @@ export(orderly_metadata_extract)
 export(orderly_metadata_read)
 export(orderly_new)
 export(orderly_parameters)
+export(orderly_parse)
 export(orderly_plugin_add_metadata)
 export(orderly_plugin_context)
 export(orderly_plugin_register)

R/read.R

@@ -1,11 +1,30 @@
 orderly_read <- function(path, call = NULL) {
   entrypoint_filename <- find_entrypoint_filename(path)
-  orderly_read_r(file.path(path, entrypoint_filename), entrypoint_filename)
+  orderly_parse(file.path(path, entrypoint_filename), entrypoint_filename)
 }
 
 
-orderly_read_r <- function(path, entrypoint_filename) {
-  exprs <- parse(file = path)
+#' Parse the orderly entrypoint script
+#'
+#' For expert use only.
+#'
+#' Takes either a path to the orderly entrypoint script or
+#' the parsed AST from an orderly script, parses details
+#' of any calls to the orderly_ in-script functions into intermediate
+#' representation for downstream use. Also validates that any calls to
+#' orderly_ in-script functions are well-formed.
+#'
+#' @param entrypoint_script Path to script or parsed AST from orderly script
+#' @param entrypoint_filename Name of entrypoint file to include in metadata
+#'
+#' @return Parsed orderly entrypoint script
+#' @export
+orderly_parse <- function(entrypoint_script, entrypoint_filename) {
+  if (!is.expression(entrypoint_script)) {
+    exprs <- parse(file = entrypoint_script)
+  } else {
+    exprs <- entrypoint_script
+  }
 
   inputs <- list()
   artefacts <- list()

_pkgdown.yml

@@ -86,3 +86,4 @@ reference:
       - orderly_validate_archive
       - orderly_hash_data
       - orderly_hash_file
+      - orderly_parse

tests/testthat/test-read.R

@@ -1,12 +1,12 @@
-test_that("can read file with no helpers", {
-  expect_equal(orderly_read_r("examples/implicit/implicit.R", "implicit.R"),
+test_that("can parse file with no helpers", {
+  expect_equal(orderly_parse("examples/implicit/implicit.R", "implicit.R"),
                list(entrypoint_filename = "implicit.R",
                     strict = list(enabled = FALSE)))
 })
 
 
-test_that("can read file with helpers", {
-  dat <- orderly_read_r("examples/explicit/explicit.R", "explicit.R")
+test_that("can parse file with helpers", {
+  dat <- orderly_parse("examples/explicit/explicit.R", "explicit.R")
   expect_setequal(names(dat),
                   c("entrypoint_filename", "strict", "resources", "artefacts"))
   expect_equal(dat$strict, list(enabled = FALSE))
@@ -17,8 +17,15 @@ test_that("can read file with helpers", {
 })
 
 
+test_that("can parse file from expression", {
+  exprs <- parse(file = "examples/explicit/explicit.R")
+  dat <- orderly_parse(exprs, "explicit.R")
+  expect_equal(dat, orderly_parse("examples/explicit/explicit.R", "explicit.R"))
+})
+
+
 test_that("Skip over computed resources", {
-  dat <- orderly_read_r("examples/computed-resource/computed-resource.R",
+  dat <- orderly_parse("examples/computed-resource/computed-resource.R",
                         "computed-resource.R")
   expect_null(dat$resources)
 })