Merge branch 'communication' of github.com:michaelquinn32/styler into communication

Author: michaelquinn32

NEWS.md

@@ -17,7 +17,6 @@
 - always strip trailing spaces and make cache insensitive to it (#626).
 - typos in documentation (#618, #614).
 
-
 # styler 1.3.2
 
 Release upon request by the CRAN team.

R/io.R

@@ -33,7 +33,10 @@ transform_utf8_one <- function(path, fun, dry) {
       if (!identical) {
         if (dry == "fail") {
           rlang::abort(
-            paste0("File `", path, "` would be modified by styler and `dry` = 'fail'."),
+            paste0(
+              "File `", path, "` would be modified by styler and argument dry",
+              " is set to 'fail'."
+            ),
             class = "dryError"
           )
         } else if (dry == "on") {

R/testing.R

@@ -41,10 +41,17 @@ test_collection <- function(test, sub_test = NULL,
 
   out_names <- construct_out(in_names)
 
-  out_items <- file.path(path, out_names)
-  in_items <- file.path(path, in_names)
-
-  out_trees <- construct_tree(in_items)
+  if (getOption("styler.test_dir_writable", TRUE)) {
+    out_items <- file.path(path, out_names)
+    in_items <- file.path(path, in_names)
+    out_trees <- construct_tree(in_items)
+  } else {
+    in_items <- file.path(path, in_names)
+    out_items <- file.path(tempdir(), out_names)
+    ref_items <- file.path(path, out_names)
+    file.copy(ref_items, out_items, overwrite = TRUE, copy.mode = FALSE)
+    out_trees <- file.path(tempdir(), construct_tree(in_names))
+  }
 
   pwalk(list(in_items, out_items, in_names, out_names, out_trees),
     transform_and_check,
@@ -106,7 +113,9 @@ transform_and_check <- function(in_item, out_item,
   read_in <- xfun::read_utf8(in_item)
   if (write_tree) {
     create_tree(read_in) %>%
-      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE, fileEncoding = "UTF-8")
+      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE,
+        fileEncoding = "UTF-8"
+      )
   }
   transformed_text <- read_in %>%
     transformer(...) %>%

R/ui-styling.R

@@ -22,8 +22,8 @@ NULL
 #' @inheritParams prettify_pkg
 #' @section Warning:
 #' This function overwrites files (if styling results in a change of the
-#' code to be formatted). It is strongly suggested to only style files
-#' that are under version control or to create a backup copy.
+#' code to be formatted and `dry = "off"`). It is strongly suggested to only
+#' style files that are under version control or to create a backup copy.
 #'
 #' We suggest to first style with `scope < "tokens"` and inspect and commit
 #' changes, because these changes are guaranteed to leave the abstract syntax

R/zzz.R

@@ -7,7 +7,8 @@
     styler.addins_style_transformer = "styler::tidyverse_style()",
     styler.ignore_start = "# styler: off",
     styler.ignore_stop = "# styler: on",
-    styler.quiet = FALSE
+    styler.quiet = FALSE,
+    styler.test_dir_writable = TRUE
   )
   toset <- !(names(op.styler) %in% names(op))
   if (any(toset)) options(op.styler[toset])

man/style_dir.Rd

@@ -64,7 +64,8 @@ capture.output(test_that("cached expressions are displayed propperly", {
   cache_info <- cache_info("testthat", format = "tabular")
   expect_known_value(
     cache_info[, c("n", "size", "last_modified", "activated")],
-    file = test_path("reference-objects/cache-info-1")
+    file = test_path("reference-objects/cache-info-1"),
+    update = getOption("styler.test_dir_writable", TRUE)
   )
 
   activate_testthat_cache()
@@ -73,14 +74,18 @@ capture.output(test_that("cached expressions are displayed propperly", {
   cache_info$size <- round(cache_info$size, -2)
   expect_known_value(
     cache_info[, c("n", "size", "activated")],
-    file = test_path("reference-objects/cache-info-2")
+    file = test_path("reference-objects/cache-info-2"),
+    update = getOption("styler.test_dir_writable", TRUE)
+
   )
   style_text("a <-function() NULL")
   cache_info <- cache_info(format = "tabular")
   cache_info$size <- round(cache_info$size, -2)
   expect_known_value(
     cache_info[, c("n", "size", "activated")],
-    file = test_path("reference-objects/cache-info-3")
+    file = test_path("reference-objects/cache-info-3"),
+    update = getOption("styler.test_dir_writable", TRUE)
+
   )
 }))
 

man/style_file.Rd

@@ -163,7 +163,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
 
         # No message if scope > line_breaks and code does not change
@@ -175,7 +176,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/clean-reference-with-scope-tokens-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
 
         # No message if scope <= line_breaks even if code is changed.
@@ -187,7 +189,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
       }
     )