Merge pull request #916 from lorenzwalthert/iussue-874

lorenzwalthert · web-flow · commit 004783a6c5b4 · 2022-02-18T23:42:44.000+01:00
Allow arbitrary indent characters for developers
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -57,7 +57,9 @@ repos:
           tests/testthat/escaping/basic-escape-out\.R|
           tests/testthat/indention_operators/.*pipe.*|
           tests/testthat/line_breaks_and_other/.*pipe.*|
-          tests/testthat/exception_handling/parser-error.R|
+          tests/testthat/exception_handling/parser-error\.R|
+          tests/testthat/public-api/xyzfile_rmd/random4\.Rmd|
+          tests/testthat/rmd/no-tidy-(in|out)\.Rmd|
           )$
     -   id: no-browser-statement
         exclude: >
@@ -68,6 +70,7 @@ repos:
           tests/testthat/indention_operators/.*pipe.*|
           tests/testthat/line_breaks_and_other/.*pipe.*|
           tests/testthat/exception_handling/parser-error.R|
+          tests/testmanual/|
           )$
     -   id: deps-in-desc
         exclude: >
diff --git a/API b/API
@@ -6,7 +6,7 @@ cache_activate(cache_name = NULL, verbose = !getOption("styler.quiet", FALSE))
 cache_clear(cache_name = NULL, ask = TRUE)
 cache_deactivate(verbose = !getOption("styler.quiet", FALSE))
 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_style_guide = NULL, transformers_drop = specify_transformers_drop())
+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, transformers_drop = specify_transformers_drop(), indent_character = " ")
 default_style_guide_attributes(pd_flat)
 specify_math_token_spacing(zero = "'^'", one = c("'+'", "'-'", "'*'", "'/'"))
 specify_reindention(regex_pattern = NULL, indention = 0, comments_only = TRUE)
diff --git a/NEWS.md b/NEWS.md
@@ -51,6 +51,8 @@
   statement by {styler} (#915).
 * An error is now thrown on styling if input unicode characters can't be 
   correctly parsed for Windows and R < 4.2 (#883).
+* Developers can now create style guides with indention characters other than 
+  spaces (#916).
 * styling of text does not error anymore when the R option `OutDec` is set to 
   a non-default value (#912).
 * Fix argument name `filetype` in Example for `style_dir()` (#855).
diff --git a/R/serialize.R b/R/serialize.R
@@ -2,15 +2,23 @@
 #'
 #' Collapses a flattened parse table into character vector representation.
 #' @inheritParams apply_stylerignore
+#' @param indent_character The character that is used for indention. We strongly
+#'   advise for using spaces as indention characters.
 #' @keywords internal
-serialize_parse_data_flattened <- function(flattened_pd) {
+serialize_parse_data_flattened <- function(flattened_pd, indent_character = "") {
   flattened_pd <- apply_stylerignore(flattened_pd)
   flattened_pd$lag_newlines[1] <- 0L # resolve start_line elsewhere
   with(
     flattened_pd,
     paste0(
       collapse = "",
-      map(lag_newlines, add_newlines), map(lag_spaces, add_spaces), text
+      map(lag_newlines, add_newlines),
+      map2(
+        ifelse(lag_newlines > 0, indent_character, " "),
+        lag_spaces,
+        rep_char
+      ),
+      text
     )
   )
 }
diff --git a/R/style-guides.R b/R/style-guides.R
@@ -71,6 +71,7 @@ tidyverse_style <- function(scope = "tokens",
                             math_token_spacing = tidyverse_math_token_spacing()) {
   args <- as.list(environment())
   scope <- scope_normalize(scope)
+  indent_character <- " "
 
 
   indention_manipulators <- if ("indention" %in% scope) {
@@ -245,7 +246,8 @@ tidyverse_style <- function(scope = "tokens",
     style_guide_name       =               style_guide_name,
     style_guide_version    =                 styler_version,
     more_specs_style_guide =                           args,
-    transformers_drop      =              transformers_drop
+    transformers_drop      =              transformers_drop,
+    indent_character       =               indent_character
   )
 }
 
@@ -294,6 +296,7 @@ tidyverse_style <- function(scope = "tokens",
 #'   introduced to improve speed. Listing transformers here that occur almost
 #'   always in code does not make sense because the process of excluding them
 #'   also takes some time.
+#' @inheritParams serialize_parse_data_flattened
 #' @examples
 #' set_line_break_before_curly_opening <- function(pd_flat) {
 #'   op <- pd_flat$token %in% "'{'"
@@ -323,7 +326,8 @@ create_style_guide <- function(initialize = default_style_guide_attributes,
                                style_guide_name = NULL,
                                style_guide_version = NULL,
                                more_specs_style_guide = NULL,
-                               transformers_drop = specify_transformers_drop()) {
+                               transformers_drop = specify_transformers_drop(),
+                               indent_character = " ") {
   list(
     # transformer functions
     initialize = list(initialize = initialize),
@@ -337,7 +341,8 @@ create_style_guide <- function(initialize = default_style_guide_attributes,
     style_guide_name = style_guide_name,
     style_guide_version = style_guide_version,
     more_specs_style_guide = more_specs_style_guide,
-    transformers_drop = transformers_drop
+    transformers_drop = transformers_drop,
+    indent_character = indent_character
   ) %>%
     map(compact)
 }
diff --git a/R/testing.R b/R/testing.R
@@ -171,6 +171,7 @@ style_empty <- function(text, base_indention = 0) {
     # transformer options
     use_raw_indention = FALSE,
     reindention       = specify_reindention(),
+    indent_character  = " ",
     NULL
   )
   transformed_text <- parse_transform_serialize_r(text,
@@ -192,6 +193,7 @@ style_op <- function(text, base_indention = 0) {
     # transformer options
     use_raw_indention = FALSE,
     reindention       = specify_reindention(),
+    indent_character  = " ",
     NULL
   )
 
diff --git a/R/transform-block.R b/R/transform-block.R
@@ -37,7 +37,10 @@ parse_transform_serialize_r_block <- function(pd_nested,
     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)
+    serialized_transformed_text <- serialize_parse_data_flattened(
+      flattened_pd,
+      indent_character = transformers$indent_character
+    )
   } else {
     serialized_transformed_text <- map2(
       c(0, find_blank_lines_to_next_expr(pd_nested)[-1] - 1L),
diff --git a/man/create_style_guide.Rd b/man/create_style_guide.Rd
diff --git a/man/serialize_parse_data_flattened.Rd b/man/serialize_parse_data_flattened.Rd
diff --git a/tests/testthat/test-cache-high-level-api.R b/tests/testthat/test-cache-high-level-api.R
@@ -116,7 +116,7 @@ test_that("speedup higher when cached roxygen example code is multiple expressio
   )
   # the speed gain for longer expression is 1.1x higher
   expect_true(
-    speedup_multiple_roygen_example / speedup_many_roygen_examples > 1.05
+    speedup_multiple_roygen_example / speedup_many_roygen_examples > 1.03
   )
 })
 
diff --git a/tests/testthat/test-indent-character.R b/tests/testthat/test-indent-character.R
@@ -0,0 +1,15 @@
+test_that("indention character can be arbitrary", {
+  sg <- function(indent_by = 1) {
+    create_style_guide(
+      indention = list(purrr::partial(indent_braces, indent_by = indent_by)),
+      indent_character = "\t",
+      style_guide_name = "test",
+      style_guide_version = 1
+    )
+  }
+  expect_equal(
+    style_text("{\n1\n}", style = sg) %>%
+      as.character(),
+    c("{", "\t1", "}")
+  )
+})

Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,7 @@ style_empty <- function(text, base_indention = 0) {`
`171`	`171`	`# transformer options`
`172`	`172`	`use_raw_indention = FALSE,`
`173`	`173`	`reindention = specify_reindention(),`
	`174`	`+ indent_character = " ",`
`174`	`175`	`NULL`
`175`	`176`	`)`
`176`	`177`	`transformed_text <- parse_transform_serialize_r(text,`
`@@ -192,6 +193,7 @@ style_op <- function(text, base_indention = 0) {`
`192`	`193`	`# transformer options`
`193`	`194`	`use_raw_indention = FALSE,`
`194`	`195`	`reindention = specify_reindention(),`
	`196`	`+ indent_character = " ",`
`195`	`197`	`NULL`
`196`	`198`	`)`
`197`	`199`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ test_that("speedup higher when cached roxygen example code is multiple expressio`
`116`	`116`	`)`
`117`	`117`	`# the speed gain for longer expression is 1.1x higher`
`118`	`118`	`expect_true(`
`119`		`- speedup_multiple_roygen_example / speedup_many_roygen_examples > 1.05`
	`119`	`+ speedup_multiple_roygen_example / speedup_many_roygen_examples > 1.03`
`120`	`120`	`)`
`121`	`121`	`})`
`122`	`122`