Merge branch 'r-0.0-11' into production

Author: krlmlr

.Rbuildignore

@@ -10,3 +10,6 @@
 ^docs$
 ^_pkgdown\.yml$
 CONTRIBUTING.md
+^\.gitsum$
+^gitsum$
+

API

@@ -3,13 +3,16 @@
 ## Exported functions
 
 create_style_guide(initialize = initialize_attributes, line_break = NULL, space = NULL, token = NULL, indention = NULL, use_raw_indention = FALSE, reindention = tidyverse_reindention())
-regex_none()
 specify_math_token_spacing(zero = NULL, one = c("'+'", "'-'", "'*'", "'/'", "'^'"))
-specify_reindention(regex_pattern = regex_none(), indention = 0, comments_only = TRUE)
-style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), recursive = TRUE, exclude_files = NULL)
+specify_reindention(regex_pattern = NULL, indention = 0, comments_only = TRUE)
+style_dir(path = ".", ..., style = tidyverse_style, transformers = style(...), filetype = "R", recursive = TRUE, exclude_files = NULL)
 style_file(path, ..., style = tidyverse_style, transformers = style(...))
-style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...), exclude_files = "R/RcppExports.R")
+style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...), filetype = "R", exclude_files = "R/RcppExports.R")
 style_text(text, ..., style = tidyverse_style, transformers = style(...))
 tidyverse_math_token_spacing()
 tidyverse_reindention()
 tidyverse_style(scope = "tokens", strict = TRUE, indent_by = 2, start_comments_with_one_space = FALSE, reindention = tidyverse_reindention(), math_token_spacing = tidyverse_math_token_spacing())
+
+## Foreign S3 methods
+
+print.vertical(x, ...)

DESCRIPTION

@@ -1,12 +1,13 @@
 Package: styler
 Title: Non-invasive Pretty Printing of R code
-Version: 0.0-10
+Version: 0.0-11
 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,
+    cli,
     enc,
     magrittr,
     purrr,
@@ -27,14 +28,15 @@ Suggests:
 License: GPL-3
 Encoding: UTF-8
 LazyData: true
-Date: 2017-11-27
+Date: 2017-12-05
 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
 Collate: 
     'addins.R'
+    'communicate.R'
     'compat-tidyr.R'
     'dplyr.R'
     'expr-is.R'
@@ -52,6 +54,7 @@ Collate:
     'rules-spacing.R'
     'serialize.R'
     'serialized_tests.R'
+    'set-assert-args.R'
     'style_guides.R'
     'styler.R'
     'token-create.R'

NAMESPACE

@@ -2,7 +2,6 @@
 
 S3method(print,vertical)
 export(create_style_guide)
-export(regex_none)
 export(specify_math_token_spacing)
 export(specify_reindention)
 export(style_dir)

NEWS.md

@@ -1,3 +1,13 @@
+## styler 0.0-11 (2017-12-05)
+
+- Remove `regex_none()`, document `NULL` default.
+- `style_dir()` and `style_pkg()` now also handle `.Rmd` files (#292, @jonmcalder).
+- Add test for styling `.Rmd` files.
+- Better error message for styling new files via the RStudio addin (#295).
+- Spelling via devtools::spell_check() (#294).
+- Roundtrip and CLI (#289).
+
+
 ## styler 0.0-10 (2017-11-27)
 
 - Adapt documentation (#290).

R/addins.R

@@ -50,7 +50,12 @@ 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
+      paste(
+        "Styling of unsaved files is only supported for R files with valid code.",
+        "Please save the file (as .R or .Rmd) and make sure that the R code in it",
+        "can be parsed. Then, try to style again.",
+        "The error was \n", e
+      ), call. = FALSE
   ))
 }
 

R/communicate.R

@@ -0,0 +1,27 @@
+#' Communicate a warning if necessary
+#'
+#' If roundtrip verification was not possible, issue a warning to review the
+#' changes carefully.
+#' @param changed Boolean with indicating for each file whether or not it has
+#'   been changed.
+#' @inheritParams can_verify_roundtrip
+communicate_warning <- function(changed, transformers) {
+  if (any(changed, na.rm = TRUE) && !can_verify_roundtrip(transformers)) {
+    cat("Please review the changes carefully!")
+  }
+}
+
+#' Communicate the summary of styling
+#'
+#' @param changed Boolean with indicating for each file whether or not it has
+#'   been changed.
+#' @param ruler_width Integer used to determine the width of the ruler.
+communicate_summary <- function(changed, ruler_width) {
+  cli::cat_rule(width = max(40, ruler_width))
+  cat("Status\tCount\tLegend \n")
+  cli::cat_bullet("\t", sum(!changed, na.rm = TRUE), "\tFile unchanged.", bullet = "tick")
+  cli::cat_bullet("\t", sum(changed, na.rm = TRUE), "\tFile changed.", bullet = "info")
+  cli::cat_bullet(bullet = "cross", "\t", sum(is.na(changed)), "\tStyling threw an eror.")
+  cli::cat_rule(width = max(40, ruler_width))
+
+}

R/expr-is.R

@@ -1,4 +1,4 @@
-#' Check whether a parse table corresponds to a a certain expression
+#' Check whether a parse table corresponds to a certain expression
 #'
 #' @param pd A parse table.
 #' @name pd_is
@@ -39,7 +39,7 @@ contains_else_expr <- function(pd) {
 #' 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.
+#' conditional statements with more than one alternative.
 #' @param pd A parse table
 contains_else_expr_that_needs_braces <- function(pd) {
   else_idx <- which(pd$token == "ELSE")

R/indent.R

@@ -194,8 +194,8 @@ pd_is_multi_line <- function(pd) {
 
 #' Update the newlines attribute
 #'
-#' As we work only with the `lag_newlines` attribute for setting the linebreaks,
-#' (R/rules-line_break.R) but we need `newlines` to determine
+#' As we work only with the `lag_newlines` attribute for setting the line
+#' breaks, (R/rules-line_break.R) but we need `newlines` to determine
 #' whether or not to set `spaces` (R/rules-spacing.R), we have to update the
 #' attribute. We cannot simply use `dplyr::lead(pd$lag_newlines)` since we would
 #' lose information for the last token. `spaces` is left as is in

R/parse.R

@@ -37,7 +37,7 @@ get_parse_data <- function(text, include_text = TRUE, ...) {
 
 #' Add column `pos_id` and `short`
 #'
-#' Addds column `pos_id` and `short` to a flat parse table.
+#' Adds column `pos_id` and `short` to a flat parse table.
 #' @param pd A flat parse table
 add_id_and_short <- function(pd) {
   pd$pos_id <- seq2(1L, nrow(pd))