Merge branch 'r-0.0-6' into production

Author: krlmlr

.Rbuildignore

@@ -6,3 +6,4 @@
 ^.travis.yml
 ^appveyor\.yml$
 ^tic\.R$
+^\.travis\.yml$

.travis.yml

@@ -1,4 +1,26 @@
 # R for travis: see documentation at https://docs.travis-ci.com/user/languages/r
+# Default configuration for use with tic package
+# Usually you shouldn't need to change the first part of the file
+
+# DO NOT CHANGE THE CODE BELOW
+before_install: R -q -e 'install.packages("remotes"); remotes::install_github("ropenscilabs/tic"); tic::prepare_all_stages(); tic::before_install()'
+install: R -q -e 'tic::install()'
+after_install: R -q -e 'tic::after_install()'
+before_script: R -q -e 'tic::before_script()'
+script: R -q -e 'tic::script()'
+after_success: R -q -e 'tic::after_success()'
+after_failure: R -q -e 'tic::after_failure()'
+before_deploy: R -q -e 'tic::before_deploy()'
+deploy:
+  provider: script
+  script: R -q -e 'tic::deploy()'
+  on:
+    all_branches: true
+after_deploy: R -q -e 'tic::after_deploy()'
+after_script: R -q -e 'tic::after_script()'
+# DO NOT CHANGE THE CODE ABOVE
+
+# Custom parts:
 
 # Header
 language: r
@@ -13,57 +35,5 @@ env:
   - _R_CHECK_FORCE_SUGGESTS_=false
   - MAKEFLAGS="-j 2"
 
-#addons
-addons:
-  apt:
-    packages:
-    - libmagick++-dev
-    - libssh2-1-dev
-
-#matrix: 3x Linux, 1x OS X
-matrix:
-  include:
-  - r: release
-    env:
-    - BUILD_PKGDOWN=true
-  - r: oldrel
-  - r: devel
-  - os: osx
-    osx_image: xcode7.3
-    r: release
-    latex: false
-
-#notifications
-notifications:
-  email:
-    on_success: change
-    on_failure: change
-
-#before_script
-before_script:
-- R -q -e 'install.packages("remotes"); remotes::install_github("ropenscilabs/tic"); tic::prepare_all_stages()'
-
-#after_success
-after_success:
-- R -q -e 'tic::after_success()'
-
-#deploy // https://github.com/travis-ci/travis-build/blob/85ef7108/lib/travis/build/addons/deploy/script.rb#L100-L107
-deploy:
-  provider: script
-  script: R -q -e 'tic::deploy()'
-  on:
-    all_branches: true
-
-# Custom parts:
-
-#r_github_packages
-r_github_packages:
-
-#r_packages
-r_packages:
-
 #services
 services:
-
-#before_install
-before_install:

API

@@ -2,9 +2,10 @@
 
 ## Exported functions
 
-get_transformers(flat, ...)
+get_transformers(flat = FALSE, ...)
 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_dir(path = ".", flat = FALSE, recursive = TRUE, transformers = get_transformers(flat = flat))
+style_file(path, flat = FALSE, transformers = get_transformers(flat = flat))
 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,6 +1,6 @@
 Package: styler
 Title: Non-invasive Pretty Printing of R code
-Version: 0.0-5
+Version: 0.0-6
 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.
@@ -20,14 +20,16 @@ Suggests:
     here,
     knitr,
     rmarkdown,
-    testthat
+    rstudioapi,
+    testthat,
+    pkgload
 Remotes:
     r-lib/pkgload,
     krlmlr/utf8
 License: GPL-3
 Encoding: UTF-8
 LazyData: true
-Date: 2017-06-30
+Date: 2017-07-10
 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

@@ -3,17 +3,20 @@
 export(get_transformers)
 export(get_transformers_flat)
 export(get_transformers_nested)
+export(style_dir)
+export(style_file)
 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,map_lgl)
 importFrom(purrr,partial)
 importFrom(purrr,pmap)
 importFrom(purrr,pwalk)
 importFrom(purrr,reduce)
+importFrom(purrr,when)
 importFrom(utils,write.table)

NEWS.md

@@ -1,14 +1,28 @@
+## styler 0.0-6 (2017-07-10)
+
+* Tidy up README (#43).
+* Fix indention of long operator chains (#69).
+* Properly format unary operators (#38).
+* Fixing indent multiple - one more time (#68).
+* Remove spaces before comma (#62).
+* Fixing indention with multiple parentheses (#57).
+* data.tree gains unique node IDs for proper printing.
+* Add `style_file()` function to style a single .R file.
+* Add RStudio add-in to style active .R file.
+* hotfix: make `style_pkg()` and `style_src()` work by passing flat argument.
+
+
 ## 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
+* 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
+* Outsource tokenise
 * Account for situations where code does not start on line1
-* Correctly style comments
-* Add style_empty for tailored testing
+* 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

R/get_transformers.R

@@ -7,7 +7,7 @@
 #'   * [get_transformers_flat()] if `flat = TRUE` or
 #'   * [get_transformers_nested()] if `flat = FALSE`.
 #' @export
-get_transformers <- function(flat, ...) {
+get_transformers <- function(flat = FALSE, ...) {
   if (flat) {
     get_transformers_flat(...)
   } else {
@@ -35,6 +35,7 @@ get_transformers_flat <- function(strict = TRUE,
     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_before_comma,
     remove_space_after_unary_pm,
     remove_space_after_opening_paren,
     partial(start_comments_with_space,
@@ -58,8 +59,10 @@ get_transformers_nested <- function(strict = TRUE,
   c(create_filler,
     partial(indent_round, indent_by = indent_by),
     partial(indent_curly, indent_by = indent_by),
+    partial(indent_op, indent_by = indent_by),
     strip_eol_spaces,
     get_transformers_flat(strict, start_comments_with_one_space),
+    remove_space_after_unary_pm_nested,
     set_space_before_comments,
     set_space_between_levels
     )

R/modify_pd.R

@@ -3,31 +3,108 @@
 #' @param pd A nested or flat parse table that is already enhanced with
 #'   line break and space information via [create_filler()].
 #' @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
 NULL
 
 #' @rdname update_indention
 indent_round <- function(pd, indent_by) {
-  opening <- which(pd$token == "'('")
-  if (length(opening) > 0) {
+  indention_needed <- needs_indention(pd, token = "'('")
+  if (indention_needed) {
+    opening <- which(pd$token == "'('")
     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))
+  }
+  pd %>%
+    set_unindention_child(token = "')'", unindent_by = indent_by) %>%
+    select_(~indent, ~newlines, ~everything())
+
+}
+
+#' @rdname update_indention
+indent_curly <- function(pd, indent_by) {
+  indention_needed <- needs_indention(pd, token = "'{'")
+  if (indention_needed) {
+    opening <- which(pd$token == "'{'")
+    start <- opening + 1
+    stop <- nrow(pd) - 1
+    pd <- pd %>%
+      mutate(indent = indent + ifelse(seq_len(nrow(pd)) %in% start:stop,
+                                      indent_by, 0))
   }
   pd <- pd %>%
-    mutate(indent = indent + ifelse(seq_len(nrow(pd)) %in% start:stop, indent_by, 0)) %>%
+    set_unindention_child(token = "'}'", unindent_by = indent_by) %>%
     select_(~indent, ~newlines, ~everything())
   pd
 }
 
 
+#' Check whether indention is needed
+#'
+#' @param pd A parse table.
+#' @param token Which token the check should be based on.
+#' @return returns `TRUE` if indention is needed, `FALSE` otherwise. Indention
+#'   is needed:
+#'     * if `token` occurs in `pd`.
+#'     * if there is no child that starts on the same line as `token` and
+#'       "opens" indention without closing it on this line.
+#' @return `TRUE` if indention is needed, `FALSE` otherwise.
+needs_indention <- function(pd, token = "'('") {
+  opening <- which(pd$token %in% token)
+  length(opening) > 0 && !child_indents(pd, opening, c("'('", "'{'"))
+}
+
+#' Check whether a child will indent
+#'
+#' @param pd A parse table.
+#' @param opening The row number of the opening token in the parse table.
+#' @return Returns `TRUE` if `pd` has at least one child that indents starting
+#'   on the same line as the opening token, `FALSE` otherwise.
+#' @param token On which token the indention check should be based on.
+#' @importFrom purrr map_lgl
+child_indents <- function(pd, opening, token) {
+  if (is.null(pd$child)) return(FALSE)
+  opening_line <- pd$line1[opening]
+  pd <- pd %>%
+    filter(!terminal, line1 == opening_line, line2 != opening_line)
+  if (nrow(pd) == 0) return(FALSE)
+  children_indent <- map_lgl(pd$child, pd_has_token, token)
+  any(children_indent)
+}
+
+#' Check whether a parse table contains a token
+#'
+#' Checks whether a token is in a parse table. `pd_has_token_not_one` is usesful
+#'   in the situation where one wants to check whether the *operator* + or - is
+#'   in the parse table, but not the *sign* + or -.
+#'   We use the fact that signs always appear as first tokens in the parse
+#'   table. There are two functions and not just one for performance reasons
+#'   only, as this function is rather low level and gets called very often.
+#' @param pd A parse table.
+#' @param token The token for which it should be checked whether it is in the
+#'   parse table.
+#' @return `TRUE` if the token is in the parse table, `FALSE` otherwise.
+pd_has_token <- function(pd, token) {
+  has_indention_token <- token %in% pd$token
+  any(has_indention_token)
+}
+
+#' @rdname pd_has_token
+pd_has_token_not_first <- function(pd, token) {
+  has_indention_token <- token %in% pd$token[-1]
+  any(has_indention_token)
+}
+
+
 #' @rdname update_indention
-indent_curly <- function(pd, indent_by) {
-  opening <- which(pd$token == "'{'")
+indent_op <- function(pd, indent_by, token = c(math_token, "SPECIAL")) {
+  opening <- which(pd$token %in% token)
   if (length(opening) > 0) {
-    start <- opening + 1
-    stop <- nrow(pd) - 1
+    start <- opening[1] + 1
+    stop <- nrow(pd)
   } else {
     start <- stop <- 0
   }
@@ -37,6 +114,7 @@ indent_curly <- function(pd, indent_by) {
   pd
 }
 
+
 #' Strip EOL spaces
 #'
 #' Remove end-of-line spaces.

R/nested_to_tree.R

@@ -2,10 +2,14 @@
 #'
 #' Create a tree representation from a text.
 #' @param text A character vector.
+#' @param re_nest Whether or not the parse table should be renested with
+#'   [re_nest()].
 #' @return A data frame.
-create_tree <- function(text) {
+#' @importFrom purrr when
+create_tree <- function(text, re_nest = FALSE) {
   compute_parse_data_nested(text) %>%
-    visit(c(styler:::create_filler)) %>%
+    visit(c(create_filler)) %>%
+    when(re_nest ~ re_nest(.), ~.) %>%
     create_node_from_nested_root() %>%
     as.data.frame()
 }
@@ -23,7 +27,7 @@ create_tree <- function(text) {
 #'   styler:::visit(c(styler:::create_filler)) %>%
 #'   styler:::create_node_from_nested_root()
 create_node_from_nested_root <- function(pd_nested) {
-  n <- data.tree::Node$new("ROOT (token: short_text [newlines/spaces])")
+  n <- data.tree::Node$new("ROOT (token: short_text [newlines/spaces] {id})")
   create_node_from_nested(pd_nested, n)
   n
 }
@@ -39,7 +43,7 @@ create_node_from_nested <- function(pd_nested, parent) {
 
   node_info <-
     pd_nested %>%
-    transmute(formatted = paste0(token, ": ", short, " [", newlines, "/", spaces, "]")) %>%
+    transmute(formatted = paste0(token, ": ", short, " [", newlines, "/", spaces, "] {", id, "}")) %>%
     .[["formatted"]]
 
   child_nodes <-

R/parsed.R

@@ -113,11 +113,14 @@ create_filler <- function(pd_flat) {
       newlines = ~line3 - line2,
       lag_newlines = ~lag(newlines, default = 0),
       col2_nl = ~if_else(newlines > 0L, 0L, col2),
-      spaces = ~col3 - col2_nl - 1L,
-      indent = 0
+      spaces = ~col3 - col2_nl - 1L
     ) %>%
     select_(~-line3, ~-col3, ~-col2_nl)
 
+  if (!("indent" %in% names(ret))) {
+    ret$indent <- 0
+  }
+
   if (any(ret$spaces < 0L)) {
     stop("Invalid parse data")
   }