Merge pull request #512 from lorenzwalthert/fix-roxygen-code-examples

- Deparse Rd to correctly escape characters (#512).

Author: lorenzwalthert

DESCRIPTION

@@ -36,7 +36,7 @@ Suggests:
     prettycode,
     rmarkdown,
     rstudioapi (>= 0.7),
-    testthat
+    testthat (>= 2.1.0)
 VignetteBuilder: knitr
 Encoding: UTF-8
 LazyData: true

R/roxygen-examples-parse.R

@@ -19,7 +19,7 @@ parse_roxygen <- function(roxygen) {
     textConnection()
   parsed <- connection %>%
     tools::parse_Rd(fragment = TRUE) %>%
-    as.character()
+    as.character(deparse = TRUE)
   is_line_break <- parsed[1] == "\n"
   close(connection)
   c(parsed[1][!is_line_break], parsed[-1])

tests/testthat/escaping/basic-escape-in.R

@@ -0,0 +1,27 @@
+#' things
+#'
+#' @examples
+#' call("\\.")
+NULL
+
+
+#' things
+#'
+#' @examples
+#' call("\n")
+NULL
+
+#' things
+#'
+#' @examples
+#' call("\n")
+#' ano("\\.", further = X)
+NULL
+
+
+#' things
+#'
+#' @examples
+#' call('\n') # FIXME when single quotes are used, the newline is evaluated
+#' ano("\\.", further = X)
+NULL

tests/testthat/escaping/basic-escape-in_tree

@@ -0,0 +1,28 @@
+#' things
+#'
+#' @examples
+#' call("\\.")
+NULL
+
+
+#' things
+#'
+#' @examples
+#' call("\n")
+NULL
+
+#' things
+#'
+#' @examples
+#' call("\n")
+#' ano("\\.", further = X)
+NULL
+
+
+#' things
+#'
+#' @examples
+#' call("
+#' ") # FIXME when single quotes are used, the newline is evaluated
+#' ano("\\.", further = X)
+NULL

tests/testthat/escaping/basic-escape-out.R

@@ -12,6 +12,6 @@
 #' ) %>%
 #'   there()
 #' }
-#' call("\n", x = 3)
+#' call("\\n", x = 3)
 #' @export
 NULL

tests/testthat/roxygen-examples-complete/14-pipe-dontrun-out.R

@@ -0,0 +1,6 @@
+test_that("escaping of characters works", {
+  expect_warning(test_collection("escaping",
+    transformer = style_text,
+    write_back = TRUE
+  ), "macro '")
+})