Use doctest: add doctests for utility functions

hughjonesd · Dec 13, 2022 · cec1949 · cec1949
1 parent a870ede
commit cec1949
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 4 deletions.
diff --git a/R/utils.R b/R/utils.R
@@ -13,9 +13,12 @@
 #' oo <- options(onetime.dir = tempdir(check = TRUE))
 #' id <- sample(10000L, 1)
 #'
+#' @expect message("will")
 #' onetime_message("will be shown",  id = id)
+#' @expect silent()
 #' onetime_message("won't be shown", id = id)
 #' onetime_reset(id = id)
+#' @expect message("will")
 #' onetime_message("will be shown",  id = id)
 #'
 #' onetime_reset(id = id)
@@ -58,7 +61,9 @@ onetime_reset <- function (
 #' oo <- options(onetime.dir = tempdir(check = TRUE))
 #' id <- sample(10000L, 1)
 #'
+#' @expect true()
 #' onetime_mark_as_done(id = id)
+#' @expect silent()
 #' onetime_message("Won't be shown", id = id)
 #'
 #' onetime_reset(id = id)
@@ -86,8 +91,10 @@ onetime_mark_as_done <- function (
 #' oo <- options(onetime.dir = tempdir(check = TRUE))
 #' id <- sample(10000L, 1)
 #'
+#' @expect false()
 #' onetime_been_done(id = id)
 #' onetime_message("Creating an ID",  id = id)
+#' @expect true()
 #' onetime_been_done(id = id)
 #'
 #' onetime_reset(id = id)
@@ -129,8 +136,11 @@ onetime_been_done <- function (
 #' @export
 #'
 #' @doctest
+#'
+#' @expect match("my-folder$")
 #' onetime_dir("my-folder")
 #'
+#' @omit
 #' oo <- options(onetime.dir = tempdir(check = TRUE))
 #' onetime_dir("my-folder")
 #' options(oo)

diff --git a/man/onetime_been_done.Rd b/man/onetime_been_done.Rd
diff --git a/man/onetime_dir.Rd b/man/onetime_dir.Rd
diff --git a/man/onetime_mark_as_done.Rd b/man/onetime_mark_as_done.Rd
diff --git a/man/onetime_reset.Rd b/man/onetime_reset.Rd
diff --git a/tests/testthat/test-doctest-onetime_been_done.R b/tests/testthat/test-doctest-onetime_been_done.R
@@ -0,0 +1,16 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/utils.R
+
+test_that("Doctest: onetime_been_done", {
+  # Created from @doctest for `onetime_been_done`
+  # Source file: R/utils.R
+  # Source line: 90
+  oo <- options(onetime.dir = tempdir(check = TRUE))
+  id <- sample(10000L, 1)
+  expect_false(onetime_been_done(id = id))
+  onetime_message("Creating an ID", id = id)
+  expect_true(onetime_been_done(id = id))
+  onetime_reset(id = id)
+  options(oo)
+})
+
diff --git a/tests/testthat/test-doctest-onetime_dir.R b/tests/testthat/test-doctest-onetime_dir.R
@@ -0,0 +1,10 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/utils.R
+
+test_that("Doctest: onetime_dir", {
+  # Created from @doctest for `onetime_dir`
+  # Source file: R/utils.R
+  # Source line: 138
+  expect_match(onetime_dir("my-folder"), "my-folder$")
+})
+
diff --git a/tests/testthat/test-doctest-onetime_mark_as_done.R b/tests/testthat/test-doctest-onetime_mark_as_done.R
@@ -0,0 +1,15 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/utils.R
+
+test_that("Doctest: onetime_mark_as_done", {
+  # Created from @doctest for `onetime_mark_as_done`
+  # Source file: R/utils.R
+  # Source line: 60
+  oo <- options(onetime.dir = tempdir(check = TRUE))
+  id <- sample(10000L, 1)
+  expect_true(onetime_mark_as_done(id = id))
+  expect_silent(onetime_message("Won't be shown", id = id))
+  onetime_reset(id = id)
+  options(oo)
+})
+
diff --git a/tests/testthat/test-doctest-onetime_reset.R b/tests/testthat/test-doctest-onetime_reset.R
@@ -0,0 +1,17 @@
+# Generated by doctest: do not edit by hand
+# Please edit file in R/utils.R
+
+test_that("Doctest: onetime_reset", {
+  # Created from @doctest for `onetime_reset`
+  # Source file: R/utils.R
+  # Source line: 12
+  oo <- options(onetime.dir = tempdir(check = TRUE))
+  id <- sample(10000L, 1)
+  expect_message(onetime_message("will be shown", id = id), "will")
+  expect_silent(onetime_message("won't be shown", id = id))
+  onetime_reset(id = id)
+  expect_message(onetime_message("will be shown", id = id), "will")
+  onetime_reset(id = id)
+  options(oo)
+})
+