Merge pull request #165 from lorenzwalthert/communication

- add informative messages while styling files (#165).

Author: lorenzwalthert

R/rules-other.R

@@ -7,9 +7,11 @@ add_brackets_in_pipe <- function(pd) {
              lag_newlines = rep(0, 2),
              terminal = rep(TRUE, 2),
              spaces = rep(0, 2),
+             multi_line = rep(FALSE, 2),
+             indention_ref_id = rep(NA, 2),
              line1 = pd$line1[has_no_brackets],
              line2 = line1,
-             col1 = pd$col1[has_no_brackets],
+             col1 = pd$col1[has_no_brackets] + c(0.3, 0.6),
              col2 = col1 + 1:2,
              indent = rep(0, 2),
              child = rep(list(NULL), 2)

R/transform.R

@@ -10,12 +10,54 @@
 #'   carefully inspect the changes via a message sent to the console.
 transform_files <- function(files, transformers) {
   transformer <- make_transformer(transformers)
-  changed <- utf8::transform_lines_enc(files, transformer)
-  if (any(changed, na.rm = TRUE)) {
+  max_char <- min(max(nchar(files), 0), 80)
+  if (length(files) > 0) message("Styling files:")
+  changed <- map_lgl(
+    files, transform_file, fun = transformer, max_char_path = max_char
+  )
+  if (!any(changed, na.rm = TRUE)) {
+    message("No files changed.")
+  } else {
+    message("* File changed.")
     message("Please review the changes carefully!")
   }
   invisible(changed)
 }
+
+#' Transform a file an give customized message
+#'
+#' Wraps `utf8::transform_lines_enc()` and gives customized messages.
+#' @param max_char_path The number of characters of the longest path. Determines
+#'   the indention level of `message_after`.
+#' @param message_before The message to print before the path.
+#' @param message_after The message to print after the path.
+#' @param message_after_if_changed The message to print after `message_after` if
+#'   any file was transformed.
+#' @inheritParams utf8::transform_lines_enc
+#' @param ... Further arguments passed to `utf8::transform_lines_enc()`.
+transform_file <- function(path,
+                           fun,
+                           verbose = FALSE,
+                           max_char_path,
+                           message_before = "",
+                           message_after = " [DONE]",
+                           message_after_if_changed = " *",
+                           ...) {
+  char_after_path <- nchar(message_before) + nchar(path) + 1
+  max_char_after_message_path <- nchar(message_before) + max_char_path + 1
+  n_spaces_before_message_after <-
+    max_char_after_message_path - char_after_path
+  message(message_before, path, ".", appendLF = FALSE)
+  changed <- utf8::transform_lines_enc(path, fun = fun, verbose = verbose, ...)
+
+  message(
+    rep(" ", max(0, n_spaces_before_message_after)),
+    message_after,
+    if (any(changed, na.rm = TRUE)) message_after_if_changed
+  )
+  invisible(changed)
+}
+
 #' Closure to return a transformer function
 #'
 #' This function takes a list of transformer functions as input and

man/transform_file.Rd

@@ -0,0 +1 @@
+# empty

tests/testthat/public-api/xyzemptydir/non_r_file

@@ -16,4 +16,8 @@ test_that("styler can style file", {
   )
 })
 
-# style_active_file() must be tested manually.
+test_that("styler does not return error when there is no file to style", {
+  expect_error(style_dir(paste0(base, "/xyzemptydir"), strict = FALSE), NA)
+})
+
+