Merge pull request #655 from lorenzwalthert/issue-641

- correct cache invalidation for include_roxygen_examples and base_indention (#655).

Author: lorenzwalthert

API

@@ -6,7 +6,7 @@ cache_activate(cache_name = NULL, verbose = TRUE)
 cache_clear(cache_name = NULL, ask = TRUE)
 cache_deactivate(verbose = TRUE)
 cache_info(cache_name = NULL, format = "both")
-create_style_guide(initialize = default_style_guide_attributes, line_break = NULL, space = NULL, token = NULL, indention = NULL, use_raw_indention = FALSE, reindention = tidyverse_reindention(), style_guide_name = NULL, style_guide_version = NULL, more_specs = NULL)
+create_style_guide(initialize = default_style_guide_attributes, line_break = NULL, space = NULL, token = NULL, indention = NULL, use_raw_indention = FALSE, reindention = tidyverse_reindention(), style_guide_name = NULL, style_guide_version = NULL, more_specs_style_guide = NULL)
 default_style_guide_attributes(pd_flat)
 specify_math_token_spacing(zero = "'^'", one = c("'+'", "'-'", "'*'", "'/'"))
 specify_reindention(regex_pattern = NULL, indention = 0, comments_only = TRUE)

R/nest.R

@@ -2,14 +2,15 @@
 #'
 #' Parses `text` to a flat parse table and subsequently changes its
 #' representation into a nested parse table with [nest_parse_data()].
-#' @param text A character vector to parse.
+#' @inheritParams text_to_flat_pd
 #' @return A nested parse table. See [tokenize()] for details on the columns
 #'   of the parse table.
 #' @importFrom purrr when
 #' @keywords internal
 compute_parse_data_nested <- function(text,
-                                      transformers) {
-  parse_data <- text_to_flat_pd(text, transformers)
+                                      transformers,
+                                      more_specs) {
+  parse_data <- text_to_flat_pd(text, transformers, more_specs = more_specs)
   env_add_stylerignore(parse_data)
   parse_data$child <- rep(list(NULL), length(parse_data$text))
   pd_nested <- parse_data %>%
@@ -37,12 +38,12 @@ compute_parse_data_nested <- function(text,
 #' Note that the parse table might be shallow if caching is enabled and some
 #' values are cached.
 #' @keywords internal
-text_to_flat_pd <- function(text, transformers) {
+text_to_flat_pd <- function(text, transformers, more_specs) {
   tokenize(text) %>%
     add_terminal_token_before() %>%
     add_terminal_token_after() %>%
     add_stylerignore() %>%
-    add_attributes_caching(transformers) %>%
+    add_attributes_caching(transformers, more_specs = more_specs) %>%
     drop_cached_children()
 }
 
@@ -274,18 +275,18 @@ add_terminal_token_before <- function(pd_flat) {
 #' [default_style_guide_attributes()] (when using [tidyverse_style()]) because
 #' for cached code, we don't build up the nested structure and leave it shallow
 #' (to speed up things), see also [drop_cached_children()].
-#' @param transformers A list with transformer functions, used to check if
-#'   the code is cached.
+#' @inheritParams is_cached
 #' @describeIn add_token_terminal Initializes `newlines` and `lag_newlines`.
 #' @keywords internal
-add_attributes_caching <- function(pd_flat, transformers) {
+add_attributes_caching <- function(pd_flat, transformers, more_specs) {
   pd_flat$block <- rep(NA, nrow(pd_flat))
   pd_flat$is_cached <- rep(FALSE, nrow(pd_flat))
   if (cache_is_activated()) {
     is_parent <- pd_flat$parent == 0
     pd_flat$is_cached[is_parent] <- map_lgl(
       pd_flat$text[pd_flat$parent == 0],
-      is_cached, transformers
+      is_cached, transformers,
+      more_specs = more_specs
     )
     is_comment <- pd_flat$token == "COMMENT"
     pd_flat$is_cached[is_comment] <- rep(FALSE, sum(is_comment))

R/roxygen-examples.R

@@ -77,7 +77,13 @@ style_roxygen_example_snippet <- function(code_snippet,
   code_snippet <- post_parse_roxygen(code_snippet)
 
   cache_is_active <- cache_is_activated()
-  is_cached <- is_cached(code_snippet, transformers)
+  is_cached <- is_cached(
+    code_snippet, transformers,
+    cache_more_specs(
+      include_roxygen_examples = TRUE,
+      base_indention = base_indention
+    )
+  )
   if (!is_cached || !cache_is_active) {
     code_snippet <- code_snippet %>%
       parse_transform_serialize_r(transformers,
@@ -88,7 +94,12 @@ style_roxygen_example_snippet <- function(code_snippet,
   }
 
   if (!is_cached && cache_is_active) {
-    cache_write(code_snippet, transformers)
+    cache_write(
+      code_snippet, transformers,
+      cache_more_specs(
+        include_roxygen_examples = TRUE, base_indention = base_indention
+      )
+    )
   }
 
   if (is_dont) {

R/style-guides.R

@@ -167,17 +167,17 @@ tidyverse_style <- function(scope = "tokens",
   style_guide_name <- "styler::tidyverse_style@https://github.com/r-lib"
   create_style_guide(
     # transformer functions
-    initialize          = default_style_guide_attributes,
-    line_break          =        line_break_manipulators,
-    space               =             space_manipulators,
-    token               =             token_manipulators,
-    indention           =             indention_modifier,
+    initialize             = default_style_guide_attributes,
+    line_break             =        line_break_manipulators,
+    space                  =             space_manipulators,
+    token                  =             token_manipulators,
+    indention              =             indention_modifier,
     # transformer options
-    use_raw_indention   =              use_raw_indention,
-    reindention         =                    reindention,
-    style_guide_name    =               style_guide_name,
-    style_guide_version =                 styler_version,
-    more_specs          =                           args
+    use_raw_indention      =              use_raw_indention,
+    reindention            =                    reindention,
+    style_guide_name       =               style_guide_name,
+    style_guide_version    =                 styler_version,
+    more_specs_style_guide =                            args
   )
 }
 
@@ -213,8 +213,9 @@ tidyverse_style <- function(scope = "tokens",
 #'   attribute inside the created style guide, for example for caching. This
 #'   should correspond to the version of the R package that exports the
 #'   style guide.
-#' @param more_specs Named vector (coercible to character) specifying arguments
-#'   `args` in `transformer <- list(t1 = purrr::partial(f, arg)` because when
+#' @param more_specs_style_guide Named vector (coercible to character)
+#'   specifying arguments `args` in
+#'   `transformer <- list(t1 = purrr::partial(f, arg)` because when
 #'   such functions are converted to characters in [styler::cache_make_key()],
 #'   they will yield generic code and we loose the specific value of `arg` (see
 #'   [styler::cache_make_key()]), even when unquoting these inputs with `!!`
@@ -245,7 +246,7 @@ create_style_guide <- function(initialize = default_style_guide_attributes,
                                reindention = tidyverse_reindention(),
                                style_guide_name = NULL,
                                style_guide_version = NULL,
-                               more_specs = NULL) {
+                               more_specs_style_guide = NULL) {
   lst(
     # transformer functions
     initialize = lst(initialize),
@@ -258,7 +259,7 @@ create_style_guide <- function(initialize = default_style_guide_attributes,
     reindention,
     style_guide_name,
     style_guide_version,
-    more_specs
+    more_specs_style_guide
   ) %>%
     map(compact)
 }

R/testing.R

@@ -337,3 +337,7 @@ fresh_testthat_cache <- function() {
   clear_testthat_cache()
   activate_testthat_cache()
 }
+
+cache_more_specs_default <- function() {
+  cache_more_specs(include_roxygen_examples = TRUE, base_indention = 0)
+}

R/transform-files.R

@@ -92,7 +92,13 @@ make_transformer <- function(transformers,
     should_use_cache <- cache_is_activated()
 
     if (should_use_cache) {
-      use_cache <- is_cached(text, transformers)
+      use_cache <- is_cached(
+        text, transformers,
+        cache_more_specs(
+          include_roxygen_examples = include_roxygen_examples,
+          base_indention = base_indention
+        )
+      )
     } else {
       use_cache <- FALSE
     }
@@ -111,7 +117,10 @@ make_transformer <- function(transformers,
           ~.
         )
       if (should_use_cache) {
-        cache_write(transformed_code, transformers)
+        cache_write(
+          transformed_code, transformers,
+          cache_more_specs(include_roxygen_examples, base_indention)
+        )
       }
       transformed_code
     } else {
@@ -202,9 +211,12 @@ parse_transform_serialize_r <- function(text,
                                         transformers,
                                         base_indention,
                                         warn_empty = TRUE) {
-  text <- assert_text(text)
-  pd_nested <- compute_parse_data_nested(text, transformers)
+  more_specs <- cache_more_specs(
+    include_roxygen_examples = TRUE, base_indention = base_indention
+  )
 
+  text <- assert_text(text)
+  pd_nested <- compute_parse_data_nested(text, transformers, more_specs)
   blank_lines_to_next_expr <- find_blank_lines_to_next_block(pd_nested)
   if (nrow(pd_nested) == 0) {
     if (warn_empty) {
@@ -228,7 +240,7 @@ parse_transform_serialize_r <- function(text,
   }
   text_out <- convert_newlines_to_linebreaks(text_out)
   if (cache_is_activated()) {
-    cache_by_expression(text_out, transformers)
+    cache_by_expression(text_out, transformers, more_specs = more_specs)
   }
   text_out
 }

R/utils-cache.R

@@ -16,13 +16,17 @@ hash_standardize <- function(text) {
 #' Check if text is cached
 #'
 #' This boils down to check if the hash exists at the caching dir as a file.
-#' @param text,transformers Passed to [cache_make_key()] to generate a key.
+#' @param text,transformers,more_specs Passed to [cache_make_key()] to generate
+#'   a key.
 #' @param cache_dir The caching directory relative to the `.Rcache` root to
 #'   look for a cached value.
 #' @keywords internal
-is_cached <- function(text, transformers, cache_dir = cache_dir_default()) {
+is_cached <- function(text,
+                      transformers,
+                      more_specs,
+                      cache_dir = cache_dir_default()) {
   R.cache::generateCache(
-    key = cache_make_key(text, transformers),
+    key = cache_make_key(text, transformers, more_specs),
     dirs = cache_dir
   ) %>%
     file.exists()
@@ -37,6 +41,9 @@ is_cached <- function(text, transformers, cache_dir = cache_dir_default()) {
 #' @param transformers A list of transformer functions, because we can only
 #'   know if text is already correct if we know which transformer function it
 #'   should be styled with.
+#' @param more_args A named vector coercible to it character that determine the
+#'   styling but are style guide independent, such as `include_roxygen_examples`
+#'   or `base_indention`.
 #' @details
 #' We need to compare:
 #'
@@ -55,7 +62,7 @@ is_cached <- function(text, transformers, cache_dir = cache_dir_default()) {
 #'   Remaining problem: `purrr::partial()` calls will render generic code, e.g.
 #'   see `as.character(list(purrr::partial(sum, x = 4)))`. For that reason,
 #'   all arguments passed to a `purrr::partial()` call must be put in the
-#'   style guide under `more_specs`.
+#'   style guide under `more_specs_style_guide`.
 #' @section Experiments:
 #'
 #' There is unexplainable behavior in conjunction with hashing and
@@ -86,13 +93,14 @@ is_cached <- function(text, transformers, cache_dir = cache_dir_default()) {
 #' identical(digest::digest(add1), digest::digest(add2))
 #' identical(digest::digest(styler::tidyverse_style()), digest::digest(styler::tidyverse_style()))
 #' @keywords internal
-cache_make_key <- function(text, transformers) {
+cache_make_key <- function(text, transformers, more_specs) {
   list(
     text = hash_standardize(text),
     style_guide_name = transformers$style_guide_name,
     style_guide_version = transformers$style_guide_version,
-    more_specs = as.character(transformers$more_specs) %>%
-      set_names(names(transformers$more_specs))
+    more_specs_style_guide = as.character(transformers$more_specs_style_guide) %>%
+      set_names(names(transformers$more_specs_style_guide)),
+    more_specs = more_specs
   )
 }
 
@@ -134,9 +142,11 @@ cache_is_activated <- function(cache_name = NULL) {
 #' 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.
+#' @inheritParams cache_write
 #' @keywords internal
-cache_by_expression <- function(text, transformers) {
+cache_by_expression <- function(text,
+                                transformers,
+                                more_specs) {
   expressions <- parse(text = text, keep.source = TRUE) %>%
     utils::getParseData(includeText = TRUE)
   if (env_current$any_stylerignore) {
@@ -146,13 +156,17 @@ cache_by_expression <- function(text, transformers) {
     expressions$stylerignore <- rep(FALSE, length(expressions$text))
   }
   expressions[expressions$parent == 0 & expressions$token != "COMMENT" & !expressions$stylerignore, "text"] %>%
-    map(~ cache_write(.x, transformers = transformers))
+    map(~ cache_write(.x, transformers = transformers, more_specs))
 }
 
 
-cache_write <- function(text, transformers) {
+#' Write to the cache
+#'
+#' @inheritParams cache_make_key
+#' @keywords internal
+cache_write <- function(text, transformers, more_specs) {
   R.cache::generateCache(
-    key = cache_make_key(text, transformers),
+    key = cache_make_key(text, transformers, more_specs),
     dirs = cache_dir_default()
   ) %>%
     file.create()
@@ -177,3 +191,16 @@ cache_get_or_derive_name <- function(cache_name) {
 cache_dir_default <- function() {
   c("styler", cache_get_name())
 }
+
+
+#' Create more specs
+#'
+#' Syntactic suggar for creating more specs. This is useful when we want to add
+#' more arguments (because we can search for this function in the source code).
+#' @keywords internal
+cache_more_specs <- function(include_roxygen_examples, base_indention) {
+  list(
+    include_roxygen_examples = include_roxygen_examples,
+    base_indention = base_indention
+  )
+}