Merge branch 'r-0.0-5' into production

Author: krlmlr

API

@@ -2,7 +2,9 @@
 
 ## Exported functions
 
-get_transformers(strict = TRUE)
-style_pkg(pkg = ".", transformers = get_transformers())
-style_src(path = ".", transformers = get_transformers(), recursive = TRUE)
-style_text(text, transformers = get_transformers())
+get_transformers(flat, ...)
+get_transformers_flat(strict = TRUE, start_comments_with_one_space = FALSE)
+get_transformers_nested(strict = TRUE, indent_by = 2, start_comments_with_one_space = FALSE)
+style_pkg(pkg = ".", flat = FALSE, transformers = get_transformers(flat = flat))
+style_src(path = ".", flat = FALSE, recursive = TRUE, transformers = get_transformers(flat = flat))
+style_text(text, flat = FALSE, transformers = get_transformers(flat = flat))

DESCRIPTION

@@ -1,30 +1,33 @@
 Package: styler
 Title: Non-invasive Pretty Printing of R code
-Version: 0.0-4
+Version: 0.0-5
 Authors@R: person("Kirill", "Müller", role = c("aut", "cre"), email = "[email protected]")
 Description:
     Pretty-prints R code without changing the user's formatting intent.
 Imports:
-    rprojroot,
-    utf8,
-    withr,
     dplyr,
+    magrittr,
+    pkgload,
+    purrr,
+    readr,
+    rprojroot,
     tibble,
     tidyr,
-    purrr,
-    magrittr
+    utf8,
+    withr
 Suggests:
     data.tree,
     here,
     knitr,
     rmarkdown,
     testthat
 Remotes:
+    r-lib/pkgload,
     krlmlr/utf8
 License: GPL-3
 Encoding: UTF-8
 LazyData: true
-Date: 2017-06-15
+Date: 2017-06-30
 BugReports: https://github.com/krlmlr/styler/issues
 URL: https://github.com/krlmlr/styler, http://krlmlr.github.io/styler
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "pkgapi::api_roclet"))

NAMESPACE

@@ -1,12 +1,19 @@
 # Generated by roxygen2: do not edit by hand
 
 export(get_transformers)
+export(get_transformers_flat)
+export(get_transformers_nested)
 export(style_pkg)
 export(style_src)
 export(style_text)
 import(dplyr)
 import(tibble)
 import(tidyr)
+importFrom(purrr,flatten_chr)
 importFrom(purrr,map)
 importFrom(purrr,map2)
+importFrom(purrr,partial)
 importFrom(purrr,pmap)
+importFrom(purrr,pwalk)
+importFrom(purrr,reduce)
+importFrom(utils,write.table)

NEWS.md

@@ -1,3 +1,23 @@
+## styler 0.0-5 (2017-06-30)
+
+* Correctly deal with comments (spacing before comments, start comment with space)
+* T more flexibly (`test_collection()` and friends now support `...`)
+* Indention based on curly brackets
+* Spacing across different levels of nesting (e.g. a space after `)` in `function(x) {...}`)
+* Write tree structure to file via test_collection()` for easy understanding of the nested structure
+* Outsource tokenise
+* Account for situations where code does not start on line1
+* Correctly style comments
+* Add style_empty for tailored testing
+* Initialize indent in create filler
+* Adapt vignette and documentation to visitor concept
+* Refine testing to use visiting approach
+* Parse multiple expressions: Make nested approach wok on multiple expressions too.
+* Internal: introducing the visitor concept instead of "looping" many times through whole nested structure.
+* Integrate nested approach in top-level APIs `style_text` and friends via an additional argument. `flat`.
+* Add tools for scalable testing. Transform *-in.R with a transformer function and check whether result corresponds to *-out.R
+
+
 ## styler 0.0-4 (2017-06-15)
 
 - Fix `README.Rmd` for compatibility with pkgdown.

R/get_transformers.R

@@ -0,0 +1,66 @@
+#' Get the transformer functions for styling
+#'
+#' @param flat Whether the transformer functions for flat or nested styling
+#'   should be returned.
+#' @return A list of transformer functions that operate on flat parse tables.
+#' @param ... Parameters passed to
+#'   * [get_transformers_flat()] if `flat = TRUE` or
+#'   * [get_transformers_nested()] if `flat = FALSE`.
+#' @export
+get_transformers <- function(flat, ...) {
+  if (flat) {
+    get_transformers_flat(...)
+  } else {
+    get_transformers_nested(...)
+  }
+}
+#' Get the transformer functions for flat styling
+#'
+#' @param strict A logical value indicating whether a set of strict
+#'   or not so strict transformer functions should be returned.
+#' @param start_comments_with_one_space Whether or not comments should start
+#'   with only one space (see [start_comments_with_space()]).
+#' @return A list of transformer functions that operate on flat parse
+#'   tables.
+#' @export
+#' @family obtain transformers
+#' @importFrom purrr partial
+get_transformers_flat <- function(strict = TRUE,
+                                  start_comments_with_one_space = FALSE) {
+  c(
+    fix_quotes,
+    remove_space_before_closing_paren,
+    if (strict) remove_space_before_opening_paren,
+    add_space_after_for_if_while,
+    add_space_before_brace,
+    if (strict) set_space_around_op else add_space_around_op,
+    if (strict) set_space_after_comma else add_space_after_comma,
+    remove_space_after_unary_pm,
+    remove_space_after_opening_paren,
+    partial(start_comments_with_space,
+            force_one = start_comments_with_one_space),
+    NULL)
+}
+
+#' Get the transformer functions for nested styling
+#'
+#' Similar to [get_transformers_flat()], but additionally, returns some
+#'   functions needed due the fact that styling is done in a nested way.
+#' @param indent_by How many spaces of indention should be inserted after
+#'   operators such as '('.
+#' @inheritParams get_transformers_flat
+#' @family obtain transformers
+#' @importFrom purrr partial
+#' @export
+get_transformers_nested <- function(strict = TRUE,
+                                    indent_by = 2,
+                                    start_comments_with_one_space = FALSE) {
+  c(create_filler,
+    partial(indent_round, indent_by = indent_by),
+    partial(indent_curly, indent_by = indent_by),
+    strip_eol_spaces,
+    get_transformers_flat(strict, start_comments_with_one_space),
+    set_space_before_comments,
+    set_space_between_levels
+    )
+}

R/modify_pd.R

@@ -1,8 +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()] or
-#'   [create_filler_nested()].
+#'   line break and space information via [create_filler()].
 #' @param indent_by How many spaces should be added after the token of interest.
 #' @name update_indention
 NULL
@@ -17,41 +16,33 @@ indent_round <- function(pd, indent_by) {
     start <- stop <- 0
   }
   pd <- pd %>%
-    mutate(indent = ifelse(seq_len(nrow(pd)) %in% start:stop, indent_by, 0)) %>%
+    mutate(indent = indent + ifelse(seq_len(nrow(pd)) %in% start:stop, indent_by, 0)) %>%
     select_(~indent, ~newlines, ~everything())
   pd
 }
 
 
-
-#' Update indention information of nested parse data
-#'
-#' These functions apply the update functions of the same name but without
-#'   suffix nested to each level of nesting of the nested parse table.
-#' @param pd A nested parse table that is already enhanced with
-#'   line break and space information via [create_filler_nested].
-#' @name update_indention_nested
-NULL
-
-#' @rdname update_indention_nested
-indent_round_nested <- function(pd) {
-  if (is.null(pd)) return(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 %>%
-    indent_round(indent_by = 2) %>%
-    mutate(child = map(child, indent_round_nested))
+    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.
-#' @param pd_nested A nested parse table.
+#' @param pd_flat A flat parse table.
 #' @return A nested parse table.
-strip_eol_spaces_nested <- function(pd_nested) {
-  if (is.null(pd_nested)) return()
-  pd_nested <- pd_nested %>%
-    mutate(spaces = spaces * (newlines == 0),
-           child  = map(child, strip_eol_spaces_nested))
-  pd_nested
+strip_eol_spaces <- function(pd_flat) {
+  pd_flat %>%
+    mutate(spaces = spaces * (newlines == 0))
 }