Address PR review comments & refactor Rmd & Rnw styling

Author: jonmcalder

R/addins.R

@@ -25,11 +25,13 @@ style_active_file <- function() {
   )
   context <- get_rstudio_context()
   if (is_rmd_file(context$path)) {
-    out <- transform_rmd(context$contents, transformer)
+    out <- transform_mixed(context$contents, transformer, filetype = "Rmd")
+  } else if (is_rnw_file(context$path)) {
+    out <- transform_mixed(context$contents, transformer, filetype = "Rnw")
   } else if (is_plain_r_file(context$path) | is_unsaved_file(context$path)) {
     out <- try_transform_as_r_file(context, transformer)
   } else {
-    stop("Can only style .R and .Rmd files.", call. = FALSE)
+    stop("Can only style .R, .Rmd and .Rnw files.", call. = FALSE)
   }
   rstudioapi::modifyRange(
     c(1, 1, length(context$contents) + 1, 1),

R/transform-code.R

@@ -12,12 +12,12 @@ transform_code <- function(path, fun, verbose = FALSE, ...) {
     enc::transform_lines_enc(path, fun = fun, ..., verbose = verbose)
   } else if (is_rmd_file(path)) {
     enc::transform_lines_enc(path,
-      fun = partial(transform_rmd, transformer_fun = fun), ...,
+      fun = partial(transform_mixed, transformer_fun = fun, filetype = "Rmd"), ...,
       verbose = verbose
     )
   } else if (is_rnw_file(path)) {
     enc::transform_lines_enc(path,
-      fun = partial(transform_rnw, transformer_fun = fun), ...,
+      fun = partial(transform_mixed, transformer_fun = fun, filetype = "Rnw"), ...,
       verbose = verbose
     )
   } else {
@@ -31,61 +31,30 @@ transform_code <- function(path, fun, verbose = FALSE, ...) {
 #' 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 or Rnw file
-#' @param transformer_fun A styler transformer function
-#' @param filetype A string indicating the filetype (Rmd or Rnw)
+#' @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_mixed <- function(lines, transformer_fun, filetype = "Rmd") {
+transform_mixed <- function(lines, transformer_fun, filetype) {
   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")
-}
-
-#' 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 or Rnw file, and returns these separately.
-#' @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 filetype A string indicating the filetype - either 'Rmd' or 'Rnw'.
 #' @importFrom purrr map2
 #' @importFrom rlang seq2
 #' @keywords internal
-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)
-  }
+separate_chunks <- function(lines, filetype) {
+  r_raw_chunks <- identify_raw_chunks(lines, filetype = filetype)
 
   r_chunks <- map2(
     r_raw_chunks$starts, r_raw_chunks$ends, ~lines[seq2(.x + 1, .y - 1)]
@@ -98,55 +67,40 @@ separate_chunks <- function(lines, filetype = "Rmd") {
   lst(r_chunks, text_chunks)
 }
 
-#' Identifies raw Rmd code chunks
+#' Identifies raw Rmd or Rnw 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_rmd_raw_chunks <- function(lines, engine_pattern = get_engine_pattern()) {
-  pattern <- get_knitr_pattern(lines, filetype = "Rmd")
+identify_raw_chunks <- function(lines, filetype, engine_pattern = get_engine_pattern()) {
+  pattern <- get_knitr_pattern(filetype)
   if (is.null(pattern$chunk.begin) || is.null(pattern$chunk.end)) {
     stop("Unrecognized chunk pattern!", call. = FALSE)
   }
-  chunks <- grep("^[\t >]*```+\\s*", lines, perl = TRUE)
-  starts <- odd(chunks)
-  ends <- even(chunks)
 
-  if (length(starts) != length(ends)) {
-    stop("Malformed file!", call. = FALSE)
-  }
-
-  is_r_code <- grepl(
-    paste0("^[\t >]*```+\\s*\\{\\s*", engine_pattern, "[\\s\\},]"),
-    lines[starts],
-    perl = TRUE
-  )
-  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)
+  if (filetype == "Rmd") {
+    chunks <- grep("^[\t >]*```+\\s*", lines, perl = TRUE)
+    starts <- odd(chunks)
+    ends <- even(chunks)
+    is_r_code <- grepl(
+      paste0("^[\t >]*```+\\s*\\{\\s*", engine_pattern, "[\\s\\},]"),
+      lines[starts],
+      perl = TRUE
+    )
+  } else if (filetype == "Rnw") {
+    starts <- grep(pattern$chunk.begin, lines, perl = TRUE)
+    ends <- grep(pattern$chunk.end, lines, perl = TRUE)
+    is_r_code <- rep(TRUE, length(start))
   }
-  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)
+  list(starts = starts[is_r_code], ends = ends[is_r_code])
 }
 
 #' What's the engine pattern for rmd code chunks?
@@ -170,10 +124,10 @@ get_engine_pattern <- function() {
 #'
 #' @inheritParams separate_chunks
 #' @keywords internal
-get_knitr_pattern <- function(lines, filetype = "Rmd") {
+get_knitr_pattern <- function(filetype) {
   if(filetype == "Rnw") {
     knitr::all_patterns[["rnw"]]
-  } else {
+  } else if (filetype == "Rmd") {
     knitr::all_patterns[["md"]]
   }
 }

R/ui.R

@@ -188,7 +188,7 @@ prettify_any <- function(transformers,
   )
 }
 
-#' Style `.R` and/or `.Rmd` and.or `.Rnw` files
+#' Style `.R`, `.Rmd` or `.Rnw` files
 #'
 #' Performs various substitutions in the files specified.
 #' Carefully examine the results after running this function!