Merge pull request #609 from lorenzwalthert/issue-608

- Don't cache stylerignore sequences (#609).

R/utils-cache.R

@@ -121,17 +121,27 @@ cache_is_activated <- function(cache_name = NULL) {
 #' Cache text
 #'
 #' Splits `text` into expressions and adds these to the cache. Note that
-#' comments are **not** cached because caching them is too expensive.
+#' comments are **not** cached because caching them is too expensive. Also, we
+#' must not cache stylerignore sequence, because we might see the same
+#' expression that does not comply with the style guide outside a stylerignore
+#' sequence and wrongly think we should leave it as is.
 #' @param text A character vector with one or more expressions.
 #' @param transformers The transformers.
 #' @keywords internal
 cache_by_expression <- function(text, transformers) {
   expressions <- parse(text = text, keep.source = TRUE) %>%
     utils::getParseData(includeText = TRUE)
-  expressions[expressions$parent == 0 & expressions$token != "COMMENT", "text"] %>%
+  if (env_current$any_stylerignore) {
+    expressions <- expressions %>%
+      add_stylerignore()
+  } else {
+    expressions$stylerignore <- rep(FALSE, length(expressions$text))
+  }
+  expressions[expressions$parent == 0 & expressions$token != "COMMENT" & !expressions$stylerignore, "text"] %>%
     map(~ cache_write(.x, transformers = transformers))
 }
 
+
 cache_write <- function(text, transformers) {
   R.cache::generateCache(
     key = cache_make_key(text, transformers),

tests/testthat/test-interaction-caching-stylerignore.R

@@ -134,3 +134,23 @@ test_that("caching works for non-top-level expressions", {
   )
 })
 
+test_that("does not cache stylerignore sequences", {
+  on.exit(clear_testthat_cache())
+  fresh_testthat_cache()
+  text <- c(
+    "1+1# styler: off"
+  )
+  style_text(text)
+  expect_false(
+    is_cached("1+1", tidyverse_style())
+  )
+  fresh_testthat_cache()
+  text <- c(
+    "# styler: off",
+    "1+1"
+  )
+  style_text(text)
+  expect_false(
+    is_cached("1+1", tidyverse_style())
+  )
+})