Merge pull request #49 from lorenzwalthert/indent_curly

* Indention based on curly brackets
* spacing across different levels of nesting (e.g. a space after `)` in `function(x) {...}`)

Author: lorenzwalthert

NAMESPACE

@@ -16,4 +16,4 @@ importFrom(purrr,partial)
 importFrom(purrr,pmap)
 importFrom(purrr,pwalk)
 importFrom(purrr,reduce)
-importFrom(readr,write_tsv)
+importFrom(utils,write.table)

R/get_transformers.R

@@ -49,7 +49,9 @@ get_transformers_flat <- function(strict = TRUE) {
 get_transformers_nested <- function(strict = TRUE, indent_by = 2) {
   c(create_filler,
     partial(indent_round, indent_by = indent_by),
+    partial(indent_curly, indent_by = indent_by),
     strip_eol_spaces,
-    get_transformers_flat(strict)
+    get_transformers_flat(strict),
+    set_space_between_levels
     )
 }

R/modify_pd.R

@@ -21,6 +21,22 @@ indent_round <- function(pd, indent_by) {
   pd
 }
 
+
+#' @rdname update_indention
+indent_curly <- function(pd, indent_by) {
+  opening <- which(pd$token == "'{'")
+  if (length(opening) > 0) {
+    start <- opening + 1
+    stop <- nrow(pd) - 1
+  } else {
+    start <- stop <- 0
+  }
+  pd <- pd %>%
+    mutate(indent = indent + ifelse(seq_len(nrow(pd)) %in% start:stop, indent_by, 0)) %>%
+    select_(~indent, ~newlines, ~everything())
+  pd
+}
+
 #' Strip EOL spaces
 #'
 #' Remove end-of-line spaces.

R/rules.R

@@ -90,3 +90,19 @@ set_space_after_comma <- function(pd_flat) {
   pd_flat$spaces[comma_after & (pd_flat$newlines == 0L)] <- 1L
   pd_flat
 }
+
+#' Set space between levels of nesting
+#'
+#' With the nested approach, certain rules do not have an effect anymore because
+#'   of the nature of the nested structure. Setting spacing before curly
+#'   brackets in for / if / while statements and function declarations will be
+#'   such a case since a curly bracket is always at the first position in a
+#'   parse table, so spacing cannot be set after the previous token.
+#' @param pd_flat A flat parse table.
+set_space_between_levels <- function(pd_flat) {
+  if (pd_flat$token[1] %in% c("FUNCTION", "FOR", "IF", "WHILE")) {
+    pd_flat$spaces[nrow(pd_flat) - 1] <- 1L
+  }
+  pd_flat
+}
+

R/serialized_tests.R

@@ -84,7 +84,7 @@ construct_tree <- function(in_paths, suffix = "_tree") {
 #' @param write_tree Whether or not the tree structure of the test should be
 #'   computed and written to a file.
 #' @param out_tree Name of tree file if written out.
-#' @importFrom readr write_tsv
+#' @importFrom utils write.table
 transform_and_check <- function(in_item, out_item,
                                 in_name = in_item, out_name = out_item,
                                 transformer, write_back,
@@ -94,7 +94,7 @@ transform_and_check <- function(in_item, out_item,
   read_in <- utf8::read_lines_enc(in_item)
   if (write_tree) {
     create_tree(read_in) %>%
-      write_tsv(out_tree, col_names = FALSE)
+      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE)
   }
   transformed <- read_in %>%
     transformer()
@@ -143,11 +143,37 @@ style_indent_round <- function(text) {
 
 
 #' @describeIn test_transformer Nest and unnest `text` without applying any
-#'   transformations but remove indention due to the way the serialization is
-#'   set up.
+#'   transformations but remove EOL spaces and indention due to the way the
+#'   serialization is set up.
 style_empty <- function(text) {
   text %>%
     compute_parse_data_nested() %>%
-    visit(funs = c(create_filler)) %>%
+    visit(funs = c(create_filler, strip_eol_spaces)) %>%
+    serialize_parse_data_nested()
+}
+
+#' @describeIn test_transformer Transformations for indention based on curly
+#'   brackets only.
+style_indent_curly <- function(text) {
+  text %>%
+    compute_parse_data_nested() %>%
+    visit(funs = c(create_filler,
+                   partial(indent_curly, indent_by = 2),
+                   strip_eol_spaces)) %>%
+
+    serialize_parse_data_nested()
+}
+
+
+#' @describeIn test_transformer Transformations for indention based on curly
+#'   brackets and round brackets.
+style_indent_curly_round <- function(text) {
+  text %>%
+    compute_parse_data_nested() %>%
+    visit(funs = c(create_filler,
+                   partial(indent_curly, indent_by = 2),
+                   partial(indent_round, indent_by = 2),
+                   strip_eol_spaces)) %>%
+
     serialize_parse_data_nested()
 }

man/set_space_between_levels.Rd

@@ -0,0 +1,4 @@
+      {
+         {1 + 3}
+{2 + sin(pi)}
+      }

tests/testthat/indention_curly_brackets/multi_line_curly_only-in.R

@@ -0,0 +1,25 @@
+ROOT (token: short_text [newlines/spaces])
+ °--expr:  [0/0]                          
+     ¦--'{': { [1/9]                      
+     ¦--expr:  [1/0]                      
+     ¦   ¦--'{': { [0/0]                  
+     ¦   ¦--expr:  [0/0]                  
+     ¦   ¦   ¦--expr:  [0/1]              
+     ¦   ¦   ¦   °--NUM_CONST: 1 [0/0]    
+     ¦   ¦   ¦--'+': + [0/1]              
+     ¦   ¦   °--expr:  [0/0]              
+     ¦   ¦       °--NUM_CONST: 3 [0/0]    
+     ¦   °--'}': } [0/0]                  
+     ¦--expr:  [1/6]                      
+     ¦   ¦--'{': { [0/0]                  
+     ¦   ¦--expr:  [0/0]                  
+     ¦   ¦   ¦--expr:  [0/1]              
+     ¦   ¦   ¦   °--NUM_CONST: 2 [0/0]    
+     ¦   ¦   ¦--'+': + [0/1]              
+     ¦   ¦   °--expr:  [0/0]              
+     ¦   ¦       ¦--expr:  [0/0]          
+     ¦   ¦       ¦   °--SYMBOL: pi [0/0]  
+     ¦   ¦       ¦--'(': ( [0/0]          
+     ¦   ¦       °--')': ) [0/0]          
+     ¦   °--'}': } [0/0]                  
+     °--'}': } [0/0]                      

tests/testthat/indention_curly_brackets/multi_line_curly_only-in_tree

@@ -0,0 +1,4 @@
+{
+  {1 + 3}
+  {2 + sin(pi)}
+}

tests/testthat/indention_curly_brackets/multi_line_curly_only-out.R

@@ -0,0 +1,9 @@
+a <- function(x) {
+x <- c(1,
+       2 + 3,
+sin(pi))
+
+if(x > 10) {
+    return("done")
+                }
+        }