Replacing create_filler

Replacing create_filler with initialize_attributes() and split it up further

Author: lorenzwalthert

DESCRIPTION

@@ -35,10 +35,10 @@ RoxygenNote: 6.0.1.9000
 VignetteBuilder: knitr
 Collate: 
     'addins.R'
+    'initialize.R'
     'modify_pd.R'
     'nested.R'
     'nested_to_tree.R'
-    'parsed.R'
     'reindent.R'
     'token.R'
     'relevel.R'

R/initialize.R

@@ -0,0 +1,64 @@
+#' Enrich parse table with space and line break information
+#'
+#' This function computes difference (as column and line difference) between two
+#'   entries in the parse table and adds this information to the table.
+#' @param pd_flat A parse table.
+#' @importFrom utils tail
+initialize_attributes <- function(pd_flat) {
+
+  init_pd <-
+    initialize_newlines(pd_flat) %>%
+    initialize_spaces() %>%
+    initialize_multi_line() %>%
+    initialize_indention_ref_id() %>%
+    initialize_indent() %>%
+    validate_parse_data()
+  init_pd
+}
+
+#' @describeIn initialize_attributes Initializes `newlines` and `lag_newlines`.
+initialize_newlines <- function(pd_flat) {
+  pd_flat$line3 <- lead(pd_flat$line1, default = tail(pd_flat$line2, 1))
+  pd_flat$newlines <- pd_flat$line3 - pd_flat$line2
+  pd_flat$lag_newlines <- lag(pd_flat$newlines, default = 0L)
+  pd_flat$line3 <- NULL
+  pd_flat
+}
+
+#' @describeIn initialize_attributes Initializes `spaces`.
+initialize_spaces <- function(pd_flat) {
+  pd_flat$col3 <- lead(pd_flat$col1, default = tail(pd_flat$col2, 1) + 1L)
+  pd_flat$col2_nl <- if_else(pd_flat$newlines > 0L, 0L, pd_flat$col2)
+  pd_flat$spaces <- pd_flat$col3 - pd_flat$col2_nl - 1L
+  pd_flat$col3 <- NULL
+  pd_flat$col2_nl <- NULL
+  pd_flat
+}
+
+#' @describeIn initialize_attributes Initializes `multi_line`.
+initialize_multi_line <- function(pd_flat) {
+  pd_flat$multi_line <- ifelse(pd_flat$terminal, FALSE, NA)
+  pd_flat
+}
+
+#' @describeIn initialize_attributes Initializes `indention_ref_ind`.
+initialize_indention_ref_id <- function(pd_flat) {
+  pd_flat$indention_ref_id <- NA
+  pd_flat
+}
+
+#' @describeIn initialize_attributes Initializes `indent`.
+initialize_indent <- function(pd_flat) {
+  if (!("indent" %in% names(pd_flat))) {
+    pd_flat$indent <- 0
+  }
+  pd_flat
+}
+
+#' @describeIn initialize_attributes validates the parse data.
+validate_parse_data <- function(pd_flat) {
+  if (any(pd_flat$spaces < 0L)) {
+    stop("Invalid parse data")
+  }
+  pd_flat
+}

R/modify_pd.R

@@ -1,7 +1,7 @@
 #' Update indention information of parse data
 #'
 #' @param pd A nested or flat parse table that is already enhanced with
-#'   line break and space information via [create_filler()].
+#'   line break and space information via [initialize_attributes()].
 #' @param indent_by How many spaces should be added after the token of interest.
 #' @param token The token the indention should be based on.
 #' @name update_indention

R/nested_to_tree.R

@@ -6,7 +6,7 @@
 #' @importFrom purrr when
 create_tree <- function(text) {
   compute_parse_data_nested(text) %>%
-    pre_visit(c(create_filler)) %>%
+    pre_visit(c(initialize_attributes)) %>%
     create_node_from_nested_root() %>%
     as.data.frame()
 }
@@ -19,7 +19,7 @@ create_tree <- function(text) {
 #' @examples
 #' code <- "a <- function(x) { if(x > 1) { 1+1 } else {x} }"
 #' nested_pd <- styler:::compute_parse_data_nested(code)
-#' initialized <- styler:::pre_visit(nested_pd, c(styler:::create_filler))
+#' initialized <- styler:::pre_visit(nested_pd, c(styler:::initialize_attributes))
 #' styler:::create_node_from_nested_root(initialized)
 create_node_from_nested_root <- function(pd_nested) {
   n <- data.tree::Node$new("ROOT (token: short_text [lag_newlines/spaces] {id})")

R/parsed.R

@@ -137,7 +137,7 @@ NULL
 style_empty <- function(text) {
   transformers <- list(
     # transformer functions
-    filler     = create_filler,
+    initialize = initialize_attributes,
     line_break = NULL,
     space      = NULL,
     token      = NULL,
@@ -156,7 +156,7 @@ style_indent_curly <- function(text) {
 
   transformers <- list(
     # transformer functions
-    filler     = create_filler,
+    initialize = initialize_attributes,
     line_break = NULL,
     space      =  partial(indent_curly, indent_by = 2),
     token      = NULL,
@@ -175,7 +175,7 @@ style_indent_curly <- function(text) {
 style_indent_curly_round <- function(text) {
   transformers <- list(
     # transformer functions
-    filler     = create_filler,
+    initialize = initialize_attributes,
     line_break = NULL,
     space      = c(partial(indent_curly, indent_by = 2),
                     partial(indent_round, indent_by = 2)),
@@ -195,7 +195,7 @@ style_op <- function(text) {
 
   transformers <- list(
     # transformer functions
-    filler     = create_filler,
+    initialize = initialize_attributes,
     line_break = NULL,
     space      = partial(indent_op, indent_by = 2),
     token      = NULL,

R/serialized_tests.R

@@ -124,7 +124,7 @@ tidyverse_style <- function(scope = "tokens",
 
   create_style_guide(
     # transformer functions
-    filler            = create_filler,
+    initialize        = initialize_attributes,
     line_break        = line_break_manipulators,
     space             = space_manipulators,
     token             = token_manipulators,
@@ -141,7 +141,7 @@ tidyverse_style <- function(scope = "tokens",
 #' transformer function corresponds to one styling rule. The output of this
 #' function can be used as an argument for \code{style} in top level functions
 #' like [style_text()] and friends.
-#' @param filler A filler function that initializes various variables on each
+#' @param initialize A function that initializes various variables on each
 #'   level of nesting.
 #' @param line_break A list of transformer functions that manipulate line_break
 #'   information.
@@ -152,15 +152,15 @@ tidyverse_style <- function(scope = "tokens",
 #' @param use_raw_indention Boolean indicating whether or not the raw indention
 #'   should be used.
 #' @export
-create_style_guide <- function(filler = create_filler,
+create_style_guide <- function(initialize = initialize_attributes,
                                line_break = NULL,
                                space = NULL,
                                token = NULL,
                                indention = NULL,
                                use_raw_indention = FALSE) {
   lst(
     # transformer functions
-    filler,
+    initialize,
     line_break,
     space,
     token,

R/style_guides.R

@@ -110,7 +110,7 @@ parse_transform_serialize <- function(text, transformers) {
 apply_transformers <- function(pd_nested, transformers) {
   transformed_line_breaks <- pre_visit(
     pd_nested,
-    c(transformers$filler,
+    c(transformers$initialize,
     transformers$line_break)
   )