less strict checking for 'outputs' folder. Fixes #72

reconverse · Feb 16, 2021 · b3ed129 · b3ed129
1 parent 0c256d6
commit b3ed129
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 23 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: reportfactory
 Title: Lightweight Infrastructure for Handling Multiple R Markdown Documents
-Version: 0.1.2.9
+Version: 0.1.3
 Authors@R: c(
   person("Thibaut", "Jombart", role = "aut", email = "[email protected]"),
   person("Amy", "Gimma", role = "ctb", email = "[email protected]"),

diff --git a/R/compile_reports.R b/R/compile_reports.R
@@ -64,8 +64,12 @@ compile_reports <- function(factory = ".", reports = NULL,
     }
   }
 
-  # report output folder
+  # report output folder (create if it does not already exist)
   report_output_dir <- file.path(root, outputs)
+  if (!dir.exists(report_output_dir)) {
+    dir.create(report_output_dir)
+  }
+
   params_to_print <- params
 
   # loop over all reports

diff --git a/R/validate_factory.R b/R/validate_factory.R
@@ -3,7 +3,7 @@
 #' `validate_factory()` can be used to inspect the content of a factory and make
 #' everything looks fine. This includes various sanity checks listed in details
 #' that will error if a problem is found.
-#' 
+#'
 #' @inheritParams compile_reports
 #'
 #' @details
@@ -12,7 +12,7 @@
 #'   * the factory_config file exist;
 #'   * all mandatory folders exist - by default these are 'report_sources/'
 #'     and 'outputs/';
-#' 
+#'
 #' @return A list with 4 entries:
 #'   * root - the root folder path of the factory;
 #'   * factory_name - the name of the report factory;
@@ -44,9 +44,9 @@ validate_factory <- function(factory = ".") {
     stop(
       "Have you renamed the factory?\n",
       sprintf(
-        "Expecting factory to be called '%s' not '%s'. Please rename", 
+        "Expecting factory to be called '%s' not '%s'. Please rename",
         factory_name,
-        folder      
+        folder
       ),
       call. = FALSE
     )
@@ -73,7 +73,7 @@ validate_factory <- function(factory = ".") {
       call. = FALSE
     )
   }
-  
+
   # outputs is present in factory_config
   outputs <- config$outputs
   if (is.null(outputs)) {
@@ -87,12 +87,9 @@ validate_factory <- function(factory = ".") {
   # the outputs folder matches the name from factory_config
   pth <- file.path(root, outputs)
   if (!dir.exists(pth)) {
-    stop(
-      sprintf(
-        "Folder '%s' does not exist.  Have you renamed it by mistake?",
-        outputs
-      ),
-      call. = FALSE
+    message(
+      sprintf("Folder '%s' does not exist.", outputs),
+      " It will be created the first time 'compile_reports' is run"
     )
   }
 

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,16 +1,15 @@
-Further to Brian Ripley's email on 21-01-2020 I have added a System
-Requirement on Pandoc along with additional, user facing code, that errors
-if it is not installed.  Check's requiring pandoc are now skipped on Solaris.
+## Reason for update
+* minor bugfix/workflow improvement.
+* resolves a failing test I noticed on the macos checks.
 
 ## Tested on
 * Fedora 33, local R installation, R 4.0.3 (2020-10-10)
-* Solaris via RHub (unsure of version but I believe it is the current release)
-* Fedora 33, local R installation, (unstable) (2021-01-14 r79827)
+* win-builder, R Under development (unstable) (2021-02-13 r80000)
 
 ### R CMD check results for above environments
-0 errors | 0 warnings | 1 note
+0 errors | 0 warnings | 0 note
+
+
 
-Days since last update: 0 
 
-Hopefully this is ok as at request of Brian Ripley
 
diff --git a/tests/testthat/_snaps/compile_reports/outputs_deleted_param_report_check.md b/tests/testthat/_snaps/compile_reports/outputs_deleted_param_report_check.md
@@ -0,0 +1,18 @@
+Testing parameterised reports
+================
+
+test parameter output
+
+``` r
+a <- params$test1
+a
+```
+
+    ## [1] "three"
+
+``` r
+b <- params$test2
+b
+```
+
+    ## [1] "four"
diff --git a/tests/testthat/test-compile_reports.R b/tests/testthat/test-compile_reports.R
@@ -29,6 +29,39 @@ test_that("test parameteriesed report output", {
 })
 
 
+test_that("test output folder gets recreated if not there", {
+  skip_if_pandoc_not_installed()
+  skip_on_os("windows")
+  skip_on_os("mac")
+
+  # create factory
+  f <- new_factory(path = path_temp(), move_in = FALSE)
+  on.exit(dir_delete(f))
+
+  # copy test reports over
+  file_copy(
+    path("test_reports", "parameterised.Rmd"),
+    path(f, "report_sources")
+  )
+
+  # delete outputs folder
+  file.remove(file.path(f, "outputs"))
+
+  # compile report
+  compile_reports(
+    f,
+    "parameterised",
+    params = list(test1 = "three", test2 = "four")
+  )
+
+  # check the output
+  md_file <- grep("\\.md", list_outputs(f), value = TRUE)
+  md_file <- path(f, "outputs", md_file)
+
+  expect_snapshot_file(md_file, "outputs_deleted_param_report_check.md", binary = FALSE)
+})
+
+
 test_that("parameteriesed report with missing param output but input", {
   skip_if_pandoc_not_installed()
   skip_on_os("windows")

diff --git a/tests/testthat/test-validate_factory.R b/tests/testthat/test-validate_factory.R
@@ -1,7 +1,7 @@
 library(fs)
 
 test_that("validate factory - config tests", {
-  
+
   f <- new_factory(path = path_temp(), move_in = FALSE)
   on.exit(dir_delete(f))
   config_path <- path(f, "factory_config")
@@ -49,7 +49,7 @@ test_that("validate factory - config tests", {
   tmp <- original_config
   tmp$outputs = "bob"
   write.dcf(tmp, config_path)
-  expect_error(
+  expect_message(
     validate_factory(f),
     "Folder 'bob' does not exist."
   )