Merge branch 'r-0.0-10' into production

Author: krlmlr

.Rbuildignore

@@ -9,3 +9,4 @@
 ^\.travis\.yml$
 ^docs$
 ^_pkgdown\.yml$
+CONTRIBUTING.md

.gitignore

@@ -3,3 +3,5 @@
 .RData
 inst/doc
 docs
+.gitsum
+gitsum

.travis.yml

@@ -3,7 +3,7 @@
 # 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()'
+before_install: R -q -e 'install.packages(c("remotes", "curl")); 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()'
@@ -29,6 +29,16 @@ dist: trusty
 cache: packages
 latex: false
 
+matrix:
+  include:
+  - r: 3.1
+  - r: 3.2
+  - r: oldrel
+  - r: release
+    env:
+    - BUILD_PKGDOWN: true
+  - r: devel
+
 #env
 env:
   global:

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Issue Management
+
+This project follows the issue management recommendations outlined by [saamwerk](https://github.com/lorenzwalthert/saamwerk/blob/master/issue-management/labelling-strategy.md).
+In particular, issues labelled with `Status: Postponed` are closed even if they are not resolved.

DESCRIPTION

@@ -1,19 +1,20 @@
 Package: styler
 Title: Non-invasive Pretty Printing of R code
-Version: 0.0-9
+Version: 0.0-10
 Authors@R: c(person("Kirill", "Müller", role = c("aut"), email = "[email protected]"),
   person("Lorenz", "Walthert", role = c("cre", "aut"), email = "[email protected]"))
 Description:
     Pretty-prints R code without changing the user's formatting intent.
 Imports:
+    backports,
+    enc,
+    magrittr,
     purrr,
+    rematch2,
     rlang,
     rprojroot,
     tibble,
-    utf8,
-    withr,
-    rematch2,
-    magrittr
+    withr
 Suggests:
     data.tree,
     dplyr,
@@ -23,14 +24,12 @@ Suggests:
     rmarkdown,
     rstudioapi,
     testthat
-Remotes:
-    krlmlr/utf8
 License: GPL-3
 Encoding: UTF-8
 LazyData: true
-Date: 2017-10-23
-BugReports: https://github.com/krlmlr/styler/issues
-URL: https://github.com/krlmlr/styler, http://krlmlr.github.io/styler
+Date: 2017-11-27
+BugReports: https://github.com/r-lib/styler/issues
+URL: https://github.com/r-lib/styler, https://r-lib.github.io/styler/
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "collate", "pkgapi::api_roclet"))
 RoxygenNote: 6.0.1
 VignetteBuilder: knitr
@@ -39,9 +38,9 @@ Collate:
     'compat-tidyr.R'
     'dplyr.R'
     'expr-is.R'
+    'indent.R'
     'initialize.R'
-    'modify_pd.R'
-    'nested.R'
+    'nest.R'
     'nested_to_tree.R'
     'parse.R'
     'reindent.R'
@@ -54,12 +53,13 @@ Collate:
     'serialize.R'
     'serialized_tests.R'
     'style_guides.R'
-    'style_rmd.R'
     'styler.R'
     'token-create.R'
-    'transform.R'
+    'transform-code.R'
+    'transform-files.R'
+    'ui.R'
     'unindent.R'
     'utils.R'
     'vertical.R'
     'visit.R'
-    'ws.R'
+    'zzz.R'

NAMESPACE

@@ -20,6 +20,7 @@ importFrom(purrr,flatten_int)
 importFrom(purrr,map)
 importFrom(purrr,map2)
 importFrom(purrr,map_chr)
+importFrom(purrr,map_dfr)
 importFrom(purrr,map_lgl)
 importFrom(purrr,partial)
 importFrom(purrr,pmap)

NEWS.md

@@ -1,3 +1,27 @@
+## styler 0.0-10 (2017-11-27)
+
+- Adapt documentation (#290).
+- Add roundtrip (#287).
+- Fix AppVeyor builds.
+- Fix token insertion / comment interaction (#279).
+- Clarify labelling strategy (#285).
+- Fixing and extending Rstudioaddins (#283).
+- Fix eq assign parsing (#276).
+- style_files -> vectorized style_file (#273).
+- Refactoring (#270).
+- Fix CI (#275).
+- Fix covr (#274).
+- Renaming files (#271).
+- Handle styling of an unsaved active file (#243).
+- Test R 3.1 and R 3.2 (#249).
+- Allow empty {} without line break (#261).
+- Wrap expr in expr before enclosing with curly braces (#263).
+- Avoid checking for hard-coded dot (#262).
+- Account for dependency renaming (utf8 changed to enc) (#264).
+- Indention of function declaration and closing braces (#260).
+- Only remove line break before closing with strict option (#252).
+
+
 ## styler 0.0-9 (2017-10-23)
 
 - Hotfix: utf8 should not be verbose (#245).

R/addins.R

@@ -1,25 +1,72 @@
-#' Style the active file
+#' Stylers for RStudio Addins
 #'
-#' Helper function for RStudio Addin.
+#' Helper functions for styling via RStudio Addins.
+#'
+#' @section Auto-Save Option:
+#' By default, both of the RStudio Addins will apply styling to the (selected)
+#' file contents without saving changes. Automatic saving can be enabled by
+#' setting the environment variable `save_after_styling` to `TRUE`.
+#'
+#' Consider setting this in your `.Rprofile` file if you want to persist
+#' this setting across multiple sessions. Untitled files will always need to be
+#' saved manually after styling.
+#'
+#' @name styler_addins
+#' @family stylers
+#' @seealso [Sys.setenv()]
+NULL
+
+#' @describeIn styler_addins Styles the active file with [tidyverse_style()] and
+#'   `strict = TRUE`.
 style_active_file <- function() {
+  transformer <- make_transformer(tidyverse_style())
   context <- get_rstudio_context()
-  style_file(context$path, style = tidyverse_style)
+  if (is_rmd_file(context$path)) {
+    out <- transform_rmd(context$contents, transformer)
+  } else if (is_plain_r_file(context$path) | is_unsaved_file(context$path)) {
+    out <- try_transform_as_r_file(context, transformer)
+  } else {
+    stop("Can only style .R and .Rmd files.", call. = FALSE)
+  }
+  rstudioapi::modifyRange(
+    c(1, 1, length(context$contents) + 1, 1),
+    paste0(out, collapse = "\n"), id = context$id
+  )
+  if (Sys.getenv("save_after_styling") == TRUE && context$path != "") {
+    rstudioapi::documentSave(context$id)
+  }
 }
 
-
-#' Style the highlighted region
+#' Style a file as if it was an .R file
 #'
-#' Helper function for RStudio Addin. This function is complicated because of
-#' one thing: You can highlight also just parts of lines.
-#' @importFrom rlang seq2
-style_active_region <- function() {
+#' If not successful, the file is most
+#' likely not a .R file, so saving the file and try styling again will work if
+#' the file is an .Rmd file. Otherwise, we can throw an error that the file must
+#' be a .R or .Rmd file.
+#' @param context The context from `styler:::get_rstudio_context()`.
+#' @param transformer A transformer function most conveniently constructed with
+#'   [make_transformer()].
+try_transform_as_r_file <- function(context, transformer) {
+  tryCatch(
+    transformer(context$contents),
+    error = function(e) stop(
+      "Cannot style unsaved files other than .R files. Please save the file.", call. = FALSE
+  ))
+}
+
+#' @describeIn styler_addins Styles the highlighted selection in a `.R` or
+#'   `.Rmd` file.
+style_selection <- function() {
   context <- get_rstudio_context()
   text <- context$selection[[1]]$text
   if (all(nchar(text) == 0)) stop("No code selected")
   out <- style_text(text)
   rstudioapi::modifyRange(
     context$selection[[1]]$range, paste0(out, collapse = "\n"), id = context$id
   )
+  if (Sys.getenv("save_after_styling") == TRUE && context$path != "") {
+    rstudioapi::documentSave(context$id)
+  }
 }
 
 get_rstudio_context <- function() {

R/dplyr.R

@@ -73,7 +73,7 @@ left_join <- function(x, y, by, ...) {
     by_x <- by_y <- by
   }
   res <- as_tibble(merge(x, y, by.x = by_x, by.y = by_y, all.x = TRUE, ...))
-  res <- arrange(res, line1, col1, line2, col2, parent)
+  res <- arrange(res, pos_id)
 
   # dplyr::left_join set unknown list columns to NULL, merge sets them
   # to NA

R/expr-is.R

@@ -22,3 +22,38 @@ is_function_call <- function(pd) {
   if (is.na(pd$token_before[2])) return(FALSE)
   pd$token_before[2] == "SYMBOL_FUNCTION_CALL"
 }
+
+#' @describeIn pd_is Checks whether `pd` is a function declaration.
+is_function_dec <- function(pd) {
+  if (is.null(pd)) return(FALSE)
+  pd$token[1] == "FUNCTION"
+}
+
+
+contains_else_expr <- function(pd) {
+  any(pd$token == "ELSE")
+}
+
+#' Check whether an else expression needs braces
+#'
+#' Checks whether an else expression in a nest needs braces. Note that for
+#' if-else-if expressions, there is no need to add braces since the if in
+#' else-if will be visited separately with the visitor. This applies to all
+#' conditional statents with more than one alternative.
+#' @param pd A parse table
+contains_else_expr_that_needs_braces <- function(pd) {
+  else_idx <- which(pd$token == "ELSE")
+  if (length(else_idx) > 0) {
+    non_comment_after_else <- next_non_comment(pd, else_idx)
+    sub_expr <- pd$child[[non_comment_after_else]]
+    # needs braces if NOT if_condition, NOT curly expr
+    !is_cond_expr(sub_expr) &&  !is_curly_expr(sub_expr)
+  } else {
+    FALSE
+  }
+}
+
+
+is_cond_expr <- function(pd) {
+  pd$token[1] == "IF"
+}