Merge pull request #588 from lorenzwalthert/issue-587

- Styling with styler (#588).

Author: lorenzwalthert

R/addins.R

@@ -120,16 +120,17 @@ set_style_transformers <- function() {
       current_style
     )
   if (!is.null(new_style)) {
-    parsed_new_style <- with_handlers({
-      transformers <- eval(parse(text = new_style))
-      style_text(c("a = 2", "function() {", "NULL", "}"))
-    },
-    error = function(e) {
-      abort(paste0(
-        "The selected style transformers \"",
-        new_style, "\" is not valid: ", e$message
-      ))
-    }
+    parsed_new_style <- with_handlers(
+      {
+        transformers <- eval(parse(text = new_style))
+        style_text(c("a = 2", "function() {", "NULL", "}"))
+      },
+      error = function(e) {
+        abort(paste0(
+          "The selected style transformers \"",
+          new_style, "\" is not valid: ", e$message
+        ))
+      }
     )
     options(styler.addins_style_transformer = new_style)
   }

R/detect-alignment.R

@@ -34,11 +34,10 @@
 #'   "  a  = 2",
 #'   ")"
 #' )) %>%
-#' styler:::post_visit(transformers$initialize)
+#'   styler:::post_visit(transformers$initialize)
 #' nest <- pd_nested$child[[1]]
 #' styler:::token_is_on_aligned_line(nest)
 token_is_on_aligned_line <- function(pd_flat) {
-
   line_idx <- 1 + cumsum(pd_flat$lag_newlines)
   pd_flat$.lag_spaces <- lag(pd_flat$spaces)
   pd_by_line <- split(pd_flat, line_idx)

R/initialize.R

@@ -11,7 +11,7 @@
 #' @export
 #' @keywords internal
 default_style_guide_attributes <- function(pd_flat) {
-    initialize_newlines(pd_flat) %>%
+  initialize_newlines(pd_flat) %>%
     initialize_spaces() %>%
     remove_attributes(c("line1", "line2", "col1", "col2", "parent", "id")) %>%
     initialize_multi_line() %>%

R/io.R

@@ -15,20 +15,23 @@ transform_utf8 <- function(path, fun, write_back = TRUE) {
 
 #' @importFrom rlang with_handlers warn
 transform_utf8_one <- function(path, fun, write_back) {
-  with_handlers({
-    file_with_info <- read_utf8(path)
-    # only write back when changed OR when there was a missing newline
-    new <- fun(file_with_info$text)
-    identical_content <- identical(unclass(file_with_info$text), unclass(new))
-    identical <- identical_content && !file_with_info$missing_EOF_line_break
-    if (!identical && write_back) {
-      xfun::write_utf8(new, path)
+  with_handlers(
+    {
+      file_with_info <- read_utf8(path)
+      # only write back when changed OR when there was a missing newline
+      new <- fun(file_with_info$text)
+      identical_content <- identical(unclass(file_with_info$text), unclass(new))
+      identical <- identical_content && !file_with_info$missing_EOF_line_break
+      if (!identical && write_back) {
+        xfun::write_utf8(new, path)
+      }
+      !identical
+    },
+    error = function(e) {
+      warn(paste0("When processing ", path, ": ", conditionMessage(e)))
+      NA
     }
-    !identical
-  }, error = function(e) {
-    warn(paste0("When processing ", path, ": ", conditionMessage(e)))
-    NA
-  })
+  )
 }
 
 #' Read UTF-8

R/nest.R

@@ -88,16 +88,14 @@ add_cache_block <- function(pd_nested) {
 #' it is shallow in the right places.
 #' @keywords internal
 drop_cached_children <- function(pd) {
-
   if (cache_is_activated()) {
-
-    pd_parent_first <- pd[order(pd$line1, pd$col1, -pd$line2, -pd$col2, as.integer(pd$terminal)),]
+    pd_parent_first <- pd[order(pd$line1, pd$col1, -pd$line2, -pd$col2, as.integer(pd$terminal)), ]
     pos_ids_to_keep <- pd_parent_first %>%
       split(cumsum(pd_parent_first$parent == 0)) %>%
       map(find_pos_id_to_keep) %>%
       unlist() %>%
       unname()
-    pd[pd$pos_id %in% pos_ids_to_keep,]
+    pd[pd$pos_id %in% pos_ids_to_keep, ]
   } else {
     pd
   }
@@ -155,7 +153,7 @@ find_pos_id_to_keep <- function(pd) {
 #'   # styler: on
 #'   1+1
 #'   "
-#')
+#' )
 #'
 #' # if there is a stop marker before a start marker, styler won't be able
 #' # to figure out which lines you want to ignore and won't ignore anything,
@@ -169,8 +167,8 @@ find_pos_id_to_keep <- function(pd) {
 #'   # styler: off
 #'   1+1
 #'   "
-#')
-#'}
+#' )
+#' }
 #'
 NULL
 
@@ -214,8 +212,9 @@ add_terminal_token_after <- function(pd_flat) {
 
   new_tibble(list(
     pos_id = terminals$pos_id,
-    token_after = lead(terminals$token, default = "")),
-    nrow = nrow(terminals)
+    token_after = lead(terminals$token, default = "")
+  ),
+  nrow = nrow(terminals)
   ) %>%
     left_join(pd_flat, ., by = "pos_id")
 }

R/parse.R

@@ -97,7 +97,8 @@ get_parse_data <- function(text, include_text = TRUE, ...) {
   parsed <- parse_safely(text, keep.source = TRUE)
   pd <- as_tibble(
     utils::getParseData(parsed, includeText = include_text),
-    .name_repair = "minimal") %>%
+    .name_repair = "minimal"
+  ) %>%
     add_id_and_short()
 
   parser_version_set(parser_version_find(pd))

R/rules-line-break.R

@@ -207,8 +207,8 @@ NULL
 #' @keywords internal
 set_line_break_after_opening_if_call_is_multi_line <-
   function(pd,
-             except_token_after = NULL,
-             except_text_before = NULL) {
+           except_token_after = NULL,
+           except_text_before = NULL) {
     if (!is_function_call(pd) && !is_subset_expr(pd)) {
       return(pd)
     }
@@ -282,19 +282,18 @@ set_linebreak_after_ggplot2_plus <- function(pd) {
     next_non_comment <- next_non_comment(pd, first_plus)
     is_plus_or_comment_after_plus_before_fun_call <-
       lag(is_plus_raw, next_non_comment - first_plus - 1, default = FALSE) &
-      (pd$token_after == "SYMBOL_FUNCTION_CALL" | pd$token_after == "SYMBOL_PACKAGE")
+        (pd$token_after == "SYMBOL_FUNCTION_CALL" | pd$token_after == "SYMBOL_PACKAGE")
     if (any(is_plus_or_comment_after_plus_before_fun_call)) {
       gg_call <- pd$child[[previous_non_comment(pd, first_plus)]]$child[[1]]
       if (!is.null(gg_call) && isTRUE(gg_call$text[gg_call$token == "SYMBOL_FUNCTION_CALL"] == "ggplot")) {
         plus_without_comment_after <- setdiff(
           which(is_plus_raw),
           which(lead(pd$token == "COMMENT"))
-          )
+        )
 
         pd$lag_newlines[plus_without_comment_after + 1] <- 1L
       }
     }
-
   }
   pd
 }

R/rules-spacing.R

@@ -58,7 +58,7 @@ style_space_around_math_token <- function(strict, zero, one, pd_flat) {
       )
   }
   if (any(pd_flat$token %in% one)) {
-    pd_flat <-  pd_flat %>%
+    pd_flat <- pd_flat %>%
       style_space_around_token(
         strict = strict, tokens = one, level_before = 1L, level_after = 1L
       )

R/style-guides.R

@@ -119,21 +119,24 @@ tidyverse_style <- function(scope = "tokens",
         if (strict) remove_line_break_before_round_closing_after_curly,
       remove_line_break_before_round_closing_fun_dec =
         if (strict) remove_line_break_before_round_closing_fun_dec,
-      style_line_break_around_curly = partial(style_line_break_around_curly,
+      style_line_break_around_curly = partial(
+        style_line_break_around_curly,
         strict
       ),
       # must be after style_line_break_around_curly as it remove line
       # breaks again for {{.
       set_line_break_around_curly_curly,
-      set_line_break_after_opening_if_call_is_multi_line = if (strict)
+      set_line_break_after_opening_if_call_is_multi_line = if (strict) {
         partial(
           set_line_break_after_opening_if_call_is_multi_line,
           except_token_after = "COMMENT",
           except_text_before = c("switch", "ifelse", "if_else")
-        ),
+        )
+      },
       set_line_break_before_closing_call = if (strict) {
         partial(
-          set_line_break_before_closing_call, except_token_before = "COMMENT"
+          set_line_break_before_closing_call,
+          except_token_before = "COMMENT"
         )
       },
       remove_line_break_in_empty_fun_call,
@@ -160,19 +163,19 @@ tidyverse_style <- function(scope = "tokens",
       update_indention_ref_fun_dec =
         if (scope >= "indention") update_indention_ref_fun_dec
     )
-
+  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,
+    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    = "styler::tidyverse_style@https://github.com/r-lib",
-    style_guide_version = styler_version
+    use_raw_indention   =              use_raw_indention,
+    reindention         =                    reindention,
+    style_guide_name    =               style_guide_name,
+    style_guide_version =                 styler_version
   )
 }
 
@@ -211,9 +214,14 @@ tidyverse_style <- function(scope = "tokens",
 #'   pd_flat
 #' }
 #' set_line_break_before_curly_opening_style <- function() {
-#'   create_style_guide(line_break = tibble::lst(set_line_break_before_curly_opening))
+#'   create_style_guide(
+#'     line_break = tibble::lst(set_line_break_before_curly_opening)
+#'   )
 #' }
-#' style_text("a <- function(x) { x }", style = set_line_break_before_curly_opening_style)
+#' style_text(
+#'   "a <- function(x) { x }",
+#'   style = set_line_break_before_curly_opening_style
+#' )
 #' @importFrom purrr compact
 #' @export
 create_style_guide <- function(initialize = default_style_guide_attributes,
@@ -267,12 +275,13 @@ NULL
 #' @export
 specify_reindention <- function(regex_pattern = NULL,
                                 indention = 0,
-                                comments_only = TRUE)
+                                comments_only = TRUE) {
   lst(
     regex_pattern,
     indention,
     comments_only
   )
+}
 
 #' @describeIn reindention Simple forwarder to
 #' `specify_reindention` with reindention according to the tidyverse style
@@ -330,7 +339,7 @@ NULL
 #' @export
 specify_math_token_spacing <-
   function(zero = "'^'",
-             one = c("'+'", "'-'", "'*'", "'/'")) {
+           one = c("'+'", "'-'", "'*'", "'/'")) {
     assert_tokens(c(one, zero))
     lst(
       one = setdiff(c(math_token, one), zero),

R/token-create.R

@@ -41,25 +41,25 @@ create_tokens <- function(tokens,
   len_text <- length(texts)
   new_tibble(
     list(
-    token = tokens,
-    text = texts,
-    short = substr(texts, 1, 5),
-    lag_newlines = lag_newlines,
-    newlines = lead(lag_newlines),
-    pos_id = pos_ids,
-    token_before = token_before,
-    token_after = token_after,
-    terminal = rep(terminal, len_text),
-    internal = rep(FALSE, len_text),
-    spaces = spaces,
-    multi_line = rep(FALSE, len_text),
-    indention_ref_pos_id = indention_ref_pos_ids,
-    indent = indents,
-    child = rep(list(child), len_text),
-    stylerignore = stylerignore,
-    block = block,
-    is_cached = is_cached
-  ),
+      token = tokens,
+      text = texts,
+      short = substr(texts, 1, 5),
+      lag_newlines = lag_newlines,
+      newlines = lead(lag_newlines),
+      pos_id = pos_ids,
+      token_before = token_before,
+      token_after = token_after,
+      terminal = rep(terminal, len_text),
+      internal = rep(FALSE, len_text),
+      spaces = spaces,
+      multi_line = rep(FALSE, len_text),
+      indention_ref_pos_id = indention_ref_pos_ids,
+      indent = indents,
+      child = rep(list(child), len_text),
+      stylerignore = stylerignore,
+      block = block,
+      is_cached = is_cached
+    ),
     nrow = len_text
   )
 }