setting up basic testing

Author: lorenzwalthert

tests/testthat/identify-roxygen-examples/1-one-function-example-last-proper-run.R

@@ -0,0 +1,7 @@
+#' Prettify R source code
+#'
+#' Performs various substitutions in all `.R` files in a package
+#' (code and tests).
+#' Carefully examine the results after running this function!
+#' @example style_pkg(style = tidyverse_style, strict = TRUE)
+a <- 2

tests/testthat/identify-roxygen-examples/2-one-function-examples-last-proper-run.R

@@ -0,0 +1,12 @@
+#' Prettify R source code
+#'
+#' Performs various substitutions in all `.R` files in a package
+#' (code and tests).
+#' Carefully examine the results after running this function!
+#' @examples
+#' style_pkg(style = tidyverse_style, strict = TRUE)
+#' style_pkg(
+#'   scope = "line_breaks",
+#'   math_token_spacing = specify_math_token_spacing(zero = "'+'")
+#' )
+a <- call

tests/testthat/identify-roxygen-examples/3-one-function-example-not-last-proper-run.R

@@ -0,0 +1,7 @@
+#' Prettify R source code
+#'
+#' Performs various substitutions in all `.R` files in a package...
+#' Carefully examine the results after running this function!
+#' @example style_pkg(style = tidyverse_style, strict = TRUE)
+#' @name k
+a <- 2

tests/testthat/identify-roxygen-examples/4-one-function-examples-not-last-proper-run.R

@@ -0,0 +1,12 @@
+#' The tidyverse style
+#'
+#' Style code according to the tidyverse style guide.
+#' @family style_guides
+#' @examples
+#' style_text("call( 1)", style = tidyverse_style, scope = "spaces")
+#' style_text("call( 1)", transformers = tidyverse_style(strict = TRUE))
+#' style_text(c("ab <- 3", "a  <-3"), strict = FALSE) # keeps alignment of "<-"
+#' style_text(c("ab <- 3", "a  <-3"), strict = TRUE) # drops alignment of "<-"
+#' @importFrom purrr partial
+#' @export
+a <- call

tests/testthat/test-identify-roxygen-examples.R

@@ -0,0 +1,39 @@
+context("test-identify-roxygen-examples.R")
+
+#' Things to consider:
+#' * one function declaration or many
+#' * example(s) is last tag or not?
+#' * malformatted examples
+#' * \dontrun examples
+
+test_that("one function, last tag, properly formatted, no dontrun", {
+  expect_equal(
+    identify_start_stop_ofroyxgen_examples_from_paths(testthat_file(
+    "identify-roxygen-examples/1-one-function-example-last-proper-run.R"
+    )),
+    list(c(6, 6))
+  )
+
+  expect_equal(
+    identify_start_stop_ofroyxgen_examples_from_paths(testthat_file(
+      "identify-roxygen-examples/2-one-function-examples-last-proper-run.R"
+    )),
+    list(c(6, 11))
+  )
+})
+
+test_that("one function, not last, tag, properly formatted, no dontrun", {
+  expect_equal(
+    identify_start_stop_ofroyxgen_examples_from_paths(testthat_file(
+      "identify-roxygen-examples/3-one-function-example-not-last-proper-run.R"
+    )),
+    list(c(5, 9))
+  )
+
+  expect_equal(
+    identify_start_stop_ofroyxgen_examples_from_paths(testthat_file(
+      "identify-roxygen-examples/4-one-function-examples-not-last-proper-run.R"
+    )),
+    list(c(5, 5))
+  )
+})