Merge pull request #811 from lorenzwalthert/issue-806

- Allow to exclude sub-directories (#811).

Author: lorenzwalthert

NEWS.md

@@ -61,6 +61,9 @@
 * `#>` is recognized as an output marker and no space is added after `#` (#771).
 * multi-expressions containing multiple assignments no longer remove line breaks
   if they are not causing blank lines (#809).
+* `exclude_dirs` in `style_pkg()` is now properly respected if it is a 
+  sub-directory of a directory that is scheduled for styling (e.g. 
+  `test/testthat/some/dir`) (#811).
 * R code chunks in nested non-R chunks in R markdown don't yield an error 
   anymore when document is styled, chunks are still not styled (#788, #794).
 * `cache_activate()` and `cache_deactivate()` now respect the R 

R/ui-styling.R

@@ -110,47 +110,42 @@ prettify_pkg <- function(transformers,
                          include_roxygen_examples,
                          base_indention,
                          dry) {
-  filetype <- set_and_assert_arg_filetype(filetype)
+  filetype_ <- set_and_assert_arg_filetype(filetype)
   r_files <- rprofile_files <- vignette_files <- readme <- NULL
-  exclude_files <- set_arg_paths(exclude_files)
-  exclude_dirs <- set_arg_paths(exclude_dirs)
-  without_excluded <- purrr::partial(setdiff, y = exclude_dirs)
-  if ("\\.r" %in% filetype) {
+  exclude_files <- c(
+    set_arg_paths(exclude_files),
+    dir_without_.(exclude_dirs, pattern = map_filetype_to_pattern(filetype))
+  )
+  if ("\\.r" %in% filetype_) {
     r_files <- dir_without_.(
-      path = without_excluded(c("R", "tests", "data-raw", "demo")),
-      pattern = "\\.r$",
-      ignore.case = TRUE,
-      recursive = TRUE
+      path = c("R", "tests", "data-raw", "demo"),
+      pattern = "\\.r$"
     )
   }
 
-  if ("\\.rprofile" %in% filetype) {
+  if ("\\.rprofile" %in% filetype_) {
     rprofile_files <- dir_without_.(
-      path = without_excluded("."), pattern = "^\\.rprofile$",
-      ignore.case = TRUE, recursive = FALSE, all.files = TRUE
+      path = ".", pattern = "^\\.rprofile$"
     )
   }
-  if ("\\.rmd" %in% filetype) {
+  if ("\\.rmd" %in% filetype_) {
     vignette_files <- dir_without_.(
-      path = without_excluded("vignettes"), pattern = "\\.rmd$",
-      ignore.case = TRUE, recursive = TRUE
+      path = "vignettes", pattern = "\\.rmd$"
     )
     readme <- dir_without_.(
       path = ".",
-      pattern = without_excluded("^readme\\.rmd$"), ignore.case = TRUE
+      pattern = "^readme\\.rmd$"
     )
   }
 
-  if ("\\.rnw" %in% filetype) {
+  if ("\\.rnw" %in% filetype_) {
     vignette_files <- append(
       vignette_files,
       dir_without_.(
-        path = without_excluded("vignettes"), pattern = "\\.rnw$",
-        ignore.case = TRUE, recursive = TRUE
+        path = "vignettes", pattern = "\\.rnw$"
       )
     )
   }
-
   files <- setdiff(
     c(r_files, rprofile_files, vignette_files, readme),
     exclude_files
@@ -277,8 +272,7 @@ prettify_any <- function(transformers,
       setdiff(c("", exclude_dirs)) %>%
       dir_without_.(
         pattern = map_filetype_to_pattern(filetype),
-        ignore.case = TRUE, recursive = FALSE,
-        all.files = TRUE
+        recursive = FALSE
       )
   } else {
     files_other <- c()

R/utils-files.R

@@ -27,28 +27,36 @@ map_filetype_to_pattern <- function(filetype) {
   paste0("(", paste(set_and_assert_arg_filetype(filetype), collapse = "|"), ")$")
 }
 
-#' `dir()`, but without dot-prefix
+#' `dir()`, but without dot-prefix and different defaults
 #'
 #' When using `dir()`, you can set `full.names = FALSE`, but then you can only
 #' pass a character vector of length one as `path` to not loose the information
 #' about where the files are. This function solves that case. It's needed when
 #' one wants to standardize paths to use set operations on them, i.e. when the
 #' user supplied input does not have a dot prefix. See 'Examples'.
+#'
+#' For different defaults, see `dir_without_._one`.
 #' @param path A path.
 #' @param ... Passed to [base::dir()].
 #' @seealso set_and_assert_arg_paths
 #' @keywords internal
 #' @examples
 #' setdiff("./file.R", "file.R") # you want to standardize first.
-dir_without_. <- function(path, ...) {
-  purrr::map(path, dir_without_._one, ...) %>%
+dir_without_. <- function(path, recursive = TRUE, ...) {
+  purrr::map(path, dir_without_._one, recursive = recursive, ...) %>%
     unlist()
 }
 
-dir_without_._one <- function(path, ...) {
+#' `dir()`, but with full names, ignored case, and included hidden files and
+#' recursive.
+#' @keywords internal
+dir_without_._one <- function(path, recursive, ...) {
   relative <- dir(
     path = path,
     full.names = FALSE,
+    ignore.case = TRUE,
+    recursive = recursive,
+    all.files = TRUE,
     ...
   )
   if (path == ".") {

man/combine_children.Rd

@@ -10,15 +10,28 @@ test_that("styler can style package", {
 })
 
 test_that("styler can style package and exclude some directories", {
-  capture_output(expect_true({
+  capture_output(
     styled <- style_pkg(testthat_file("public-api", "xyzpackage"),
       exclude_dirs = "tests"
     )
-    nrow(styled) == 1
-  }))
+  )
+  expect_true(nrow(styled) == 1)
+  expect_false(any(grepl("tests/testthat/test-package-xyz.R", styled$file)))
+})
+
+test_that("styler can style package and exclude some sub-directories", {
+  capture_output(
+    styled <- style_pkg(testthat_file("public-api", "xyzpackage"),
+      exclude_dirs = "tests/testthat"
+    )
+  )
+  expect_true(nrow(styled) == 2)
+  expect_true(any(grepl("tests/testthat.R", styled$file)))
+  expect_false(any(grepl("tests/testthat/test-package-xyz.R", styled$file)))
 })
 
 
+
 test_that("styler can style package and exclude some directories and files", {
   capture_output(expect_true({
     styled <- style_pkg(testthat_file("public-api", "xyzpackage"),