Merge pull request #649 from lorenzwalthert/issue-641

- Global base indention (#649).

Author: lorenzwalthert

API

@@ -10,10 +10,10 @@ create_style_guide(initialize = default_style_guide_attributes, line_break = NUL
 default_style_guide_attributes(pd_flat)
 specify_math_token_spacing(zero = "'^'", one = c("'+'", "'-'", "'*'", "'/'"))
 specify_reindention(regex_pattern = NULL, indention = 0, comments_only = TRUE)
-style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), filetype = c("R", "Rprofile"), recursive = TRUE, exclude_files = NULL, exclude_dirs = c("packrat", "renv"), include_roxygen_examples = TRUE, dry = "off")
-style_file(path, ..., style = tidyverse_style, transformers = style(...), include_roxygen_examples = TRUE, dry = "off")
-style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...), filetype = c("R", "Rprofile"), exclude_files = "R/RcppExports.R", exclude_dirs = c("packrat", "renv"), include_roxygen_examples = TRUE, dry = "off")
-style_text(text, ..., style = tidyverse_style, transformers = style(...), include_roxygen_examples = TRUE)
+style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), filetype = c("R", "Rprofile"), recursive = TRUE, exclude_files = NULL, exclude_dirs = c("packrat", "renv"), include_roxygen_examples = TRUE, base_indention = 0, dry = "off")
+style_file(path, ..., style = tidyverse_style, transformers = style(...), include_roxygen_examples = TRUE, base_indention = 0, dry = "off")
+style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...), filetype = c("R", "Rprofile"), exclude_files = "R/RcppExports.R", exclude_dirs = c("packrat", "renv"), include_roxygen_examples = TRUE, base_indention = 0, dry = "off")
+style_text(text, ..., style = tidyverse_style, transformers = style(...), include_roxygen_examples = TRUE, base_indention = 0)
 tidyverse_math_token_spacing()
 tidyverse_reindention()
 tidyverse_style(scope = "tokens", strict = TRUE, indent_by = 2, start_comments_with_one_space = FALSE, reindention = tidyverse_reindention(), math_token_spacing = tidyverse_math_token_spacing())

DESCRIPTION

@@ -45,7 +45,7 @@ Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace",
     "collate", "pkgapi::api_roclet"))
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 Collate: 
     'addins.R'
     'communicate.R'

R/addins.R

@@ -50,7 +50,9 @@ style_active_file <- function() {
   communicate_addins_style_transformers()
   context <- get_rstudio_context()
   transformer <- make_transformer(get_addins_style_transformer(),
-    include_roxygen_examples = TRUE, warn_empty = is_plain_r_file(context$path)
+    include_roxygen_examples = TRUE,
+    base_indention = 0,
+    warn_empty = is_plain_r_file(context$path)
   )
   is_r_file <- any(
     is_plain_r_file(context$path),

R/roxygen-examples.R

@@ -8,10 +8,13 @@
 #' @inheritSection parse_transform_serialize_roxygen Hierarchy
 #' @importFrom purrr map flatten_chr
 #' @keywords internal
-style_roxygen_code_example <- function(example, transformers) {
+style_roxygen_code_example <- function(example, transformers, base_indention) {
   bare <- parse_roxygen(example)
   one_dont <- split(bare, factor(cumsum(bare %in% dont_keywords())))
-  map(one_dont, style_roxygen_code_example_segment, transformers) %>%
+  map(one_dont, style_roxygen_code_example_segment,
+    transformers = transformers,
+    base_indention = base_indention
+  ) %>%
     flatten_chr() %>%
     add_roxygen_mask()
 }
@@ -35,7 +38,9 @@ style_roxygen_code_example <- function(example, transformers) {
 #' @importFrom rlang seq2
 #' @importFrom purrr map2 flatten_chr
 #' @keywords internal
-style_roxygen_code_example_segment <- function(one_dont, transformers) {
+style_roxygen_code_example_segment <- function(one_dont,
+                                               transformers,
+                                               base_indention) {
   if (length(one_dont) < 1L) {
     return(character())
   }
@@ -46,7 +51,8 @@ style_roxygen_code_example_segment <- function(one_dont, transformers) {
 
   map2(split_segments$separated, is_dont,
     style_roxygen_example_snippet,
-    transformers = transformers
+    transformers = transformers,
+    base_indention = base_indention
   ) %>%
     flatten_chr()
 }
@@ -61,7 +67,8 @@ style_roxygen_code_example_segment <- function(one_dont, transformers) {
 #' @keywords internal
 style_roxygen_example_snippet <- function(code_snippet,
                                           transformers,
-                                          is_dont) {
+                                          is_dont,
+                                          base_indention) {
   if (is_dont) {
     decomposed <- remove_dont_mask(code_snippet)
     code_snippet <- decomposed$code
@@ -73,7 +80,9 @@ style_roxygen_example_snippet <- function(code_snippet,
   is_cached <- is_cached(code_snippet, transformers)
   if (!is_cached || !cache_is_active) {
     code_snippet <- code_snippet %>%
-      parse_transform_serialize_r(transformers, warn_empty = FALSE)
+      parse_transform_serialize_r(transformers,
+        base_indention = base_indention, warn_empty = FALSE
+      )
   } else {
     code_snippet <- ensure_last_n_empty(code_snippet, n = 0)
   }

R/testing.R

@@ -113,7 +113,8 @@ transform_and_check <- function(in_item, out_item,
   read_in <- xfun::read_utf8(in_item)
   if (write_tree) {
     create_tree(read_in) %>%
-      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE,
+      write.table(out_tree,
+        col.names = FALSE, row.names = FALSE, quote = FALSE,
         fileEncoding = "UTF-8"
       )
   }
@@ -160,7 +161,7 @@ NULL
 #'   transformations but remove EOL spaces and indention due to the way the
 #'   serialization is set up.
 #' @keywords internal
-style_empty <- function(text) {
+style_empty <- function(text, base_indention = 0) {
   transformers <- list(
     # transformer functions
     initialize = default_style_guide_attributes,
@@ -172,13 +173,16 @@ style_empty <- function(text) {
     reindention       = specify_reindention(),
     NULL
   )
-  transformed_text <- parse_transform_serialize_r(text, transformers)
+  transformed_text <- parse_transform_serialize_r(text,
+    transformers = transformers,
+    base_indention = base_indention
+  )
   transformed_text
 }
 
 #' @describeIn test_transformer Transformations for indention based on operators
 #' @keywords internal
-style_op <- function(text) {
+style_op <- function(text, base_indention = 0) {
   transformers <- list(
     # transformer functions
     initialize        = default_style_guide_attributes,
@@ -191,7 +195,10 @@ style_op <- function(text) {
     NULL
   )
 
-  transformed_text <- parse_transform_serialize_r(text, transformers)
+  transformed_text <- parse_transform_serialize_r(text,
+    transformers = transformers,
+    base_indention = base_indention
+  )
   transformed_text
 }
 
@@ -246,16 +253,16 @@ n_times_faster_with_cache <- function(x1, x2 = x1, ...,
                                       n = 3,
                                       clear = "always") {
   rlang::arg_match(clear, c("always", "final", "never", "all but last"))
-  capture.output(
-    out <- purrr::map(1:n, n_times_faster_bench,
-      x1 = x1, x2 = x2, fun = fun,
-      ..., n = n, clear = clear
+
+  out <- purrr::map(1:n, n_times_faster_bench,
+    x1 = x1, x2 = x2, fun = fun,
+    ..., n = n, clear = clear
+  ) %>%
+    purrr::map_dbl(
+      ~ unname(.x$first["elapsed"] / .x$second["elapsed"])
     ) %>%
-      purrr::map_dbl(
-        ~ unname(.x$first["elapsed"] / .x$second["elapsed"])
-      ) %>%
-      mean()
-  )
+    mean()
+
   if (clear %in% c("always", "final")) {
     clear_testthat_cache()
   }

R/transform-block.R

@@ -4,11 +4,26 @@
 #' for details on how a top level nest is split into blocks.
 #' @param pd_nested A block of the nested parse table.
 #' @param start_line The line number on which the code starts.
+#' @param base_indention Integer scalar indicating by how many spaces the whole
+#'   output text should be indented. Note that this is not the same as splitting
+#'   by line and add a `base_indention` spaces before the code in the case
+#'   multi-line strings are present. See 'Examples'.
 #' @inheritParams apply_transformers
+#' @examples
+#' text_in <- 'x<- function()
+#' "here
+#' is"
+#' NULL
+#' 1+ 1
+#' '
+#' style_text(text_in, base_indention = 3)
+#' # not equal to the naive approach
+#' styler:::construct_vertical(paste0(styler:::add_spaces(3), style_text(text_in), sep = ""))
 #' @keywords internal
 parse_transform_serialize_r_block <- function(pd_nested,
                                               start_line,
-                                              transformers) {
+                                              transformers,
+                                              base_indention) {
   if (!all(pd_nested$is_cached, na.rm = TRUE) || !cache_is_activated()) {
     transformed_pd <- apply_transformers(pd_nested, transformers)
     flattened_pd <- post_visit(transformed_pd, list(extract_terminals)) %>%
@@ -19,6 +34,9 @@ parse_transform_serialize_r_block <- function(pd_nested,
         target_indention = transformers$reindention$indention,
         comments_only = transformers$reindention$comments_only
       )
+    is_on_newline <- flattened_pd$lag_newlines > 0
+    is_on_newline[1] <- TRUE
+    flattened_pd$lag_spaces[is_on_newline] <- flattened_pd$lag_spaces[is_on_newline] + base_indention
     serialized_transformed_text <- serialize_parse_data_flattened(flattened_pd)
   } else {
     serialized_transformed_text <- map2(

R/transform-files.R

@@ -11,8 +11,8 @@
 #' styling whether or not it was actually changed (or would be changed when
 #' `dry` is not "off").
 #' @keywords internal
-transform_files <- function(files, transformers, include_roxygen_examples, dry) {
-  transformer <- make_transformer(transformers, include_roxygen_examples)
+transform_files <- function(files, transformers, include_roxygen_examples, base_indention, dry) {
+  transformer <- make_transformer(transformers, include_roxygen_examples, base_indention)
   max_char <- min(max(nchar(files), 0), getOption("width"))
   len_files <- length(files)
   if (len_files > 0L && !getOption("styler.quiet", FALSE)) {
@@ -52,12 +52,12 @@ transform_file <- function(path,
   n_spaces_before_message_after <-
     max_char_after_message_path - char_after_path
   if (!getOption("styler.quiet", FALSE)) {
-      cat(
-        message_before, path,
-        rep_char(" ", max(0L, n_spaces_before_message_after)),
-        append = FALSE
-      )
-    }
+    cat(
+      message_before, path,
+      rep_char(" ", max(0L, n_spaces_before_message_after)),
+      append = FALSE
+    )
+  }
   changed <- transform_code(path, fun = fun, ..., dry = dry)
 
   bullet <- ifelse(is.na(changed), "warning", ifelse(changed, "info", "tick"))
@@ -82,6 +82,7 @@ transform_file <- function(path,
 #' @importFrom purrr when
 make_transformer <- function(transformers,
                              include_roxygen_examples,
+                             base_indention,
                              warn_empty = TRUE) {
   force(transformers)
   assert_transformers(transformers)
@@ -98,10 +99,15 @@ make_transformer <- function(transformers,
 
     if (!use_cache) {
       transformed_code <- text %>%
-        parse_transform_serialize_r(transformers, warn_empty = warn_empty) %>%
+        parse_transform_serialize_r(transformers,
+          base_indention = base_indention,
+          warn_empty = warn_empty
+        ) %>%
         when(
           include_roxygen_examples ~
-          parse_transform_serialize_roxygen(., transformers),
+          parse_transform_serialize_roxygen(.,
+            transformers = transformers, base_indention = base_indention
+          ),
           ~.
         )
       if (should_use_cache) {
@@ -140,15 +146,16 @@ make_transformer <- function(transformers,
 #' [parse_transform_serialize_r()].
 #' @importFrom purrr map_at flatten_chr
 #' @keywords internal
-parse_transform_serialize_roxygen <- function(text, transformers) {
+parse_transform_serialize_roxygen <- function(text, transformers, base_indention) {
   roxygen_seqs <- identify_start_to_stop_of_roxygen_examples_from_text(text)
   if (length(roxygen_seqs) < 1L) {
     return(text)
   }
   split_segments <- split_roxygen_segments(text, unlist(roxygen_seqs))
   map_at(split_segments$separated, split_segments$selectors,
     style_roxygen_code_example,
-    transformers = transformers
+    transformers = transformers,
+    base_indention = base_indention
   ) %>%
     flatten_chr()
 }
@@ -187,12 +194,13 @@ split_roxygen_segments <- function(text, roxygen_examples) {
 #' @param warn_empty Whether or not a warning should be displayed when `text`
 #'   does not contain any tokens.
 #' @inheritParams compute_parse_data_nested
-#' @inheritParams apply_transformers
+#' @inheritParams parse_transform_serialize_r_block
 #' @seealso [parse_transform_serialize_roxygen()]
 #' @importFrom rlang abort
 #' @keywords internal
 parse_transform_serialize_r <- function(text,
                                         transformers,
+                                        base_indention,
                                         warn_empty = TRUE) {
   text <- assert_text(text)
   pd_nested <- compute_parse_data_nested(text, transformers)
@@ -210,7 +218,8 @@ parse_transform_serialize_r <- function(text,
     unname() %>%
     map2(blank_lines_to_next_expr,
       parse_transform_serialize_r_block,
-      transformers = transformers
+      transformers = transformers,
+      base_indention = base_indention
     ) %>%
     unlist()