Imrpove handling of verbatim blocks

Closes #951.
r-lib · Jul 2, 2019 · f1127c0 · f1127c0
1 parent 0ac6c78
commit f1127c0
Show file tree

Hide file tree

Showing 13 changed files with 85 additions and 9 deletions.
diff --git a/R/rd-data.R b/R/rd-data.R
@@ -39,11 +39,10 @@ as_data.tag_item <- function(x, ...) {
 
 parse_section <- function(x, title, ...) {
   text <- flatten_para(x, ...)
-  paras <- split_at_linebreaks(text)
 
   list(
     title = title,
-    contents = paras
+    contents = text
   )
 }
 

diff --git a/R/rd-html.R b/R/rd-html.R
@@ -29,6 +29,12 @@ flatten_para <- function(x, ...) {
   groups <- cumsum(before_break | after_break)
 
   html <- purrr::map_chr(x, as_html, ...)
+
+  # split at line breaks for everything except blocks
+  empty <- purrr::map_lgl(x, purrr::is_empty)
+  needs_split <- !is_block & !empty
+  html[needs_split] <- purrr::map(html[needs_split], split_at_linebreaks)
+
   blocks <- html %>%
     split(groups) %>%
     purrr::map_chr(paste, collapse = "")

diff --git a/R/test.R b/R/test.R
@@ -144,3 +144,29 @@ NULL
 #'
 #' warning(crayon::bold("This is bold"))
 NULL
+
+#' Test case: verbatim blocks
+#'
+#' This description block is required so that verbatim blocks are recognized
+#' and rendered correctly.
+#'
+#' ```
+#' foo
+#'
+#' bar
+#' ```
+#'
+#' ```
+#' yaml:
+#'   this
+#'
+#' OR:
+#'
+#' yaml:
+#'   that
+#' ```
+#'
+#' @name test-verbatim
+#' @keywords internal
+#' @family tests
+NULL
diff --git a/R/utils.r b/R/utils.r
@@ -1,6 +1,7 @@
 set_contains <- function(haystack, needles) {
   all(needles %in% haystack)
 }
+
 split_at_linebreaks <- function(text) {
   if (length(text) < 1)
     return(character())

diff --git a/man/test-crayon.Rd b/man/test-crayon.Rd
diff --git a/man/test-dont.Rd b/man/test-dont.Rd
diff --git a/man/test-figures.Rd b/man/test-figures.Rd
diff --git a/man/test-links.Rd b/man/test-links.Rd
diff --git a/man/test-lists.Rd b/man/test-lists.Rd
diff --git a/man/test-output-styles.Rd b/man/test-output-styles.Rd
diff --git a/man/test-params.Rd b/man/test-params.Rd
diff --git a/man/test-verbatim.Rd b/man/test-verbatim.Rd
diff --git a/tests/testthat/test-rd-html.R b/tests/testthat/test-rd-html.R
@@ -301,6 +301,18 @@ test_that("cr generates line break", {
   expect_equal(out, "<p>a <br /> b</p>")
 })
 
+# Verbatim ----------------------------------------------------------------
+
+test_that("newlines are preserved in preformatted blocks", {
+  out <- flatten_para(rd_text("\\preformatted{a\n\nb\n\nc}"))
+  expect_equal(out, "<pre>a\n\nb\n\nc</pre>")
+})
+
+test_that("spaces are preserved in preformatted blocks", {
+  out <- flatten_para(rd_text("\\preformatted{a\n\n  b\n\n  c}"))
+  expect_equal(out, "<pre>a\n\n  b\n\n  c</pre>")
+})
+
 # Usage -------------------------------------------------------------------
 
 test_that("S4 methods gets comment", {