Use doctest: add doctests for onetime_do() and onetime_only()

R/onetime.R

@@ -41,6 +41,7 @@
 #' id <- sample(10000L, 1L)
 #'
 #' for (n in 1:3) {
+#' @expect output(regexp = if (n == 1L) "once" else NA)
 #'   onetime_do(print("printed once"), id = id)
 #' }
 #'
@@ -49,7 +50,9 @@
 #' expiry <- as.difftime(1, units = "secs")
 #' onetime_do(print("Expires quickly, right?"), id = id2, expiry = expiry)
 #' Sys.sleep(2)
+#' @expect silent()
 #' onetime_do(print("This won't be shown..."), id = id2)
+#' @expect output("but this will")
 #' onetime_do(print("... but this will"), id = id2, expiry = expiry)
 #'
 #'
@@ -94,16 +97,18 @@ onetime_do <- function(
 #' id <- sample(10000L, 1)
 #'
 #' sample_once <- onetime_only(sample, id = id)
+#' @expect length(10)
 #' sample_once(1:10)
+#' @expect null()
 #' sample_once(1:10)
 #'
 #' onetime_reset(id)
 #' options(oo)
 onetime_only <- function (
         .f,
-        id   = deprecate_calling_package(),
+        id = deprecate_calling_package(),
         path = default_lockfile_dir(),
-	default = NULL,
+	      default = NULL,
         without_permission = "warn"
       ) {
   force(id)

tests/testthat/test-doctest-onetime_do.R

@@ -0,0 +1,25 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/onetime.R
+
+test_that("Doctest: onetime_do", {
+  # Created from @doctest for `onetime_do`
+  # Source file: R/onetime.R
+  # Source line: 39
+  oo <- options(onetime.dir = tempdir(check = TRUE))
+  id <- sample(10000L, 1L)
+  for (n in 1:3) {
+    expect_output(onetime_do(print("printed once"), id = id), regexp = if (n ==
+    1L) "once" else NA)
+  }
+  id2 <- sample(10000L, 1L)
+  expiry <- as.difftime(1, units = "secs")
+  onetime_do(print("Expires quickly, right?"), id = id2, expiry = expiry)
+  Sys.sleep(2)
+  expect_silent(onetime_do(print("This won't be shown..."), id = id2))
+  expect_output(onetime_do(print("... but this will"), id = id2, expiry = expiry),
+  "but this will")
+  onetime_reset(id = id)
+  onetime_reset(id = id2)
+  options(oo)
+})
+

tests/testthat/test-doctest-onetime_only.R

@@ -0,0 +1,16 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/onetime.R
+
+test_that("Doctest: onetime_only", {
+  # Created from @doctest for `onetime_only`
+  # Source file: R/onetime.R
+  # Source line: 95
+  oo <- options(onetime.dir = tempdir(check = TRUE))
+  id <- sample(10000L, 1)
+  sample_once <- onetime_only(sample, id = id)
+  expect_length(sample_once(1:10), 10)
+  expect_null(sample_once(1:10))
+  onetime_reset(id)
+  options(oo)
+})
+