Initial update to handle Rnw styling

Author: jonmcalder

R/testing.R

@@ -27,7 +27,7 @@ test_collection <- function(test, sub_test = NULL,
 
   pattern <- paste0(
     if (!is.null(sub_test)) paste0("^", sub_test, ".*"),
-    "in\\.R(?:|md)$"
+    "in\\.R(?:|md|nw)$"
   )
 
   in_names <- list.files(
@@ -66,7 +66,7 @@ test_collection <- function(test, sub_test = NULL,
 #' ))
 #' @keywords internal
 construct_out <- function(in_paths) {
-  gsub("\\-in([.]R(?:|md))$", "\\-out\\1", in_paths)
+  gsub("\\-in([.]R(?:|md|nw))$", "\\-out\\1", in_paths)
 }
 
 #' Construct paths of a tree object given the paths of *-in.R files

R/transform-code.R

@@ -1,7 +1,7 @@
-#' Transform code from R or Rmd files
+#' Transform code from R, Rmd or Rnw files
 #'
 #' A wrapper for [enc::transform_lines_enc()] which initiates the styling of
-#' either R or Rmd files by passing the relevant transformer function for each
+#' either R, Rmd or Rnw files by passing the relevant transformer function for each
 #' case.
 #'
 #' @inheritParams enc::transform_lines_enc
@@ -15,40 +15,78 @@ transform_code <- function(path, fun, verbose = FALSE, ...) {
       fun = partial(transform_rmd, transformer_fun = fun), ...,
       verbose = verbose
     )
+  } else if (is_rnw_file(path)) {
+    enc::transform_lines_enc(path,
+      fun = partial(transform_rnw, transformer_fun = fun), ...,
+      verbose = verbose
+    )
   } else {
-    stop(path, " is not an R or Rmd file")
+    stop(path, " is not an R, Rmd or Rnw file")
   }
 }
 
-#' Transform Rmd contents
+#' Transform mixed contents
 #'
 #' Applies the supplied transformer function to code chunks identified within
-#' an Rmd file and recombines the resulting (styled) code chunks with the text
+#' an Rmd or Rnw file and recombines the resulting (styled) code chunks with the text
 #' chunks.
 #'
-#' @param lines A character vector of lines from an Rmd file
+#' @param lines A character vector of lines from an Rmd or Rnw file
 #' @param transformer_fun A styler transformer function
+#' @param filetype A string indicating the filetype (Rmd or Rnw)
 #' @importFrom purrr flatten_chr
 #' @keywords internal
-transform_rmd <- function(lines, transformer_fun) {
-  chunks <- separate_chunks(lines)
+transform_mixed <- function(lines, transformer_fun, filetype = "Rmd") {
+  chunks <- separate_chunks(lines, filetype)
   chunks$r_chunks <- map(chunks$r_chunks, transformer_fun)
 
   map2(chunks$text_chunks, c(chunks$r_chunks, list(character(0))), c) %>%
     flatten_chr()
 }
 
+#' Transform Rmd contents
+#'
+#' Applies the supplied transformer function to code chunks identified within
+#' an Rmd file and recombines the resulting (styled) code chunks with the text
+#' chunks.
+#'
+#' @param lines A character vector of lines from an Rmd file
+#' @param transformer_fun A styler transformer function
+#' @importFrom purrr flatten_chr
+#' @keywords internal
+transform_rmd <- function(lines, transformer_fun) {
+  transform_mixed(lines, transformer_fun, filetype = "Rmd")
+}
 
-#' Separate chunks within Rmd contents
+#' Transform Rnw contents
+#'
+#' Applies the supplied transformer function to code chunks identified within
+#' an Rnw file and recombines the resulting (styled) code chunks with the text
+#' chunks.
+#'
+#' @param lines A character vector of lines from an Rnw file
+#' @param transformer_fun A styler transformer function
+#' @importFrom purrr flatten_chr
+#' @keywords internal
+transform_rnw <- function(lines, transformer_fun) {
+  transform_mixed(lines, transformer_fun, filetype = "Rnw")
+}
+
+#' Separate chunks within Rmd and Rnw contents
 #'
 #' Identifies and separates the code and text chunks (the latter includes non-R
-#' code) within an Rmd file, and returns these separately.
+#' code) within an Rmd or Rnw file, and returns these separately.
 #' @param lines a character vector of lines from an Rmd file
 #' @importFrom purrr map2
 #' @importFrom rlang seq2
 #' @keywords internal
-separate_chunks <- function(lines) {
-  r_raw_chunks <- identify_r_raw_chunks(lines)
+separate_chunks <- function(lines, filetype = "Rmd") {
+  if(filetype == "Rmd") {
+    r_raw_chunks <- identify_rmd_raw_chunks(lines)
+  } else {
+    r_raw_chunks <- identify_rnw_raw_chunks(lines)
+  }
+
   r_chunks <- map2(
     r_raw_chunks$starts, r_raw_chunks$ends, ~lines[seq2(.x + 1, .y - 1)]
   )
@@ -60,16 +98,16 @@ separate_chunks <- function(lines) {
   lst(r_chunks, text_chunks)
 }
 
-#' Identifies raw R code chunks
+#' Identifies raw Rmd code chunks
 #'
 #' Raw in the sense that these chunks don't contain pure R code, but they
 #' contain a header and footer of markdown. Only code chunks that have an engine
 #' whose name matches `engine-pattern` are considered as R code.
 #' @inheritParams separate_chunks
 #' @param engine_pattern A regular expression that must match the engine name.
 #' @keywords internal
-identify_r_raw_chunks <- function(lines, engine_pattern = get_engine_pattern()) {
-  pattern <- get_knitr_pattern(lines)
+identify_rmd_raw_chunks <- function(lines, engine_pattern = get_engine_pattern()) {
+  pattern <- get_knitr_pattern(lines, filetype = "Rmd")
   if (is.null(pattern$chunk.begin) || is.null(pattern$chunk.end)) {
     stop("Unrecognized chunk pattern!", call. = FALSE)
   }
@@ -89,6 +127,28 @@ identify_r_raw_chunks <- function(lines, engine_pattern = get_engine_pattern())
   list(starts = starts[is_r_code], ends = ends[is_r_code])
 }
 
+#' Identifies raw Rnw code chunks
+#'
+#' Raw in the sense that these chunks don't contain pure R code, but they
+#' contain the Rnw chunk header and footer. All Rnw code chunks are assumed
+#' to contain R code.
+#' @inheritParams separate_chunks
+#' @keywords internal
+identify_rnw_raw_chunks <- function(lines) {
+  pattern <- get_knitr_pattern(lines, filetype = "Rnw")
+  if (is.null(pattern$chunk.begin) || is.null(pattern$chunk.end)) {
+    stop("Unrecognized chunk pattern!", call. = FALSE)
+  }
+  starts <- grep(pattern$chunk.begin, lines, perl = TRUE)
+  ends <- grep(pattern$chunk.end, lines, perl = TRUE)
+
+  if (length(starts) != length(ends)) {
+    stop("Malformed file!", call. = FALSE)
+  }
+
+  list(starts = starts, ends = ends)
+}
+
 #' What's the engine pattern for rmd code chunks?
 #'
 #' The function returns the regular expression pattern that identifies
@@ -110,6 +170,10 @@ get_engine_pattern <- function() {
 #'
 #' @inheritParams separate_chunks
 #' @keywords internal
-get_knitr_pattern <- function(lines) {
-  knitr::all_patterns[["md"]]
+get_knitr_pattern <- function(lines, filetype = "Rmd") {
+  if(filetype == "Rnw") {
+    knitr::all_patterns[["rnw"]]
+  } else {
+    knitr::all_patterns[["md"]]
+  }
 }

R/ui.R

@@ -58,7 +58,7 @@ NULL
 #' @family stylers
 #' @examples
 #' \dontrun{
-#' 
+#'
 #' style_pkg(style = tidyverse_style, strict = TRUE)
 #' style_pkg(
 #'   scope = "line_breaks",
@@ -188,7 +188,7 @@ prettify_any <- function(transformers,
   )
 }
 
-#' Style `.R` and/or `.Rmd` files
+#' Style `.R` and/or `.Rmd` and.or `.Rnw` files
 #'
 #' Performs various substitutions in the files specified.
 #' Carefully examine the results after running this function!