Merge pull request #56 from Merck/file-src

Expand `file_src()` file specification scope
Merck · Sep 27, 2024 · 3667507 · 3667507
2 parents 6d40aa9 + cfdb57e
commit 3667507
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 33 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: pkglite
 Title: Compact Package Representations
-Version: 0.2.3
+Version: 0.2.3.9000
 Authors@R: c(
     person("Nan", "Xiao", email = "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-0250-5673")),

diff --git a/NAMESPACE b/NAMESPACE
@@ -27,6 +27,7 @@ export(pack)
 export(pattern_file_root_all)
 export(pattern_file_root_core)
 export(pattern_file_sanitize)
+export(pattern_file_src)
 export(prune)
 export(remove_content)
 export(sanitize)

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,12 @@
+# pkglite 0.2.3.9000
+
+## Enhancements
+
+- Increase the default file specification coverage for `file_src()`.
+  This helps identifying the correct file collections for R packages
+  with `src/Makevars` or `src/Makefile`, for example, packages that
+  interface with Stan via the rstan package (#56).
+
 # pkglite 0.2.3
 
 ## Enhancements

diff --git a/R/dictionary.R b/R/dictionary.R
@@ -41,7 +41,7 @@ ext_text <- function(flat = FALSE) {
     "src" = c(
       "c", "h", "cpp", "cc", "ipp", "cxx", "hpp", "hxx", "hh", "cu", "cuh",
       "f", "f90", "f95", "f03",
-      "win", "in", "ucrt", "ac", "mk", "guess"
+      "win", "ucrt", "in", "ac", "mk", "guess", "def"
     ),
     "vignette" = c(
       "Rmd", "qmd", "orig", "md", "tex", "csl", "Rnw", "Snw", "Rtex", "Stex",
@@ -165,10 +165,12 @@ pattern_file_root_core <- function() {
     "\\.Rinstignore$",
     "^configure$",
     "^configure\\.win$",
+    "^configure\\.ucrt$",
     "^configure\\.ac$",
     "^configure\\.in$",
     "^cleanup$",
-    "^cleanup\\.win$"
+    "^cleanup\\.win$",
+    "^cleanup\\.ucrt$"
   )
 }
 
@@ -188,6 +190,20 @@ pattern_file_root_all <- function() {
   )
 }
 
+#' @rdname file_name_patterns
+#' @export pattern_file_src
+pattern_file_src <- function() {
+  c(
+    "^Makevars$",
+    "^Makevars\\.win$",
+    "^Makevars\\.ucrt$",
+    "^Makefile$",
+    "^Makefile\\.win$",
+    "^Makefile\\.ucrt$",
+    "^CMakeLists\\.txt$"
+  )
+}
+
 #' @rdname file_name_patterns
 #' @export pattern_file_sanitize
 pattern_file_sanitize <- function() {

diff --git a/R/templates.R b/R/templates.R
@@ -99,10 +99,17 @@ file_man <- function() {
 #' @rdname file_spec_templates
 #' @export file_src
 file_src <- function() {
-  file_spec(
+  spec_make <- file_spec(
+    path = "src/", pattern = cat_patterns(pattern_file_src()),
+    format = c("text"), recursive = TRUE, ignore_case = FALSE, all_files = FALSE
+  )
+
+  spec_src <- file_spec(
     path = "src/", pattern = cat_patterns(ends_with(ext_text()$"src")),
     format = c("text"), recursive = TRUE, ignore_case = TRUE, all_files = FALSE
   )
+
+  list(spec_make, spec_src)
 }
 
 #' @rdname file_spec_templates

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -73,6 +73,7 @@ reference:
       - ext_binary
       - pattern_file_root_core
       - pattern_file_root_all
+      - pattern_file_src
       - pattern_file_sanitize
   - title: "Deprecated"
     desc: "Deprecated functions that will be removed"

diff --git a/man/file_name_patterns.Rd b/man/file_name_patterns.Rd
diff --git a/tests/testthat/test-independent-test_dictionary.R b/tests/testthat/test-independent-test_dictionary.R
@@ -6,7 +6,7 @@ test_that("Test ext_text() generate the right string list", {
     "src" = c(
       "c", "h", "cpp", "cc", "ipp", "cxx", "hpp", "hxx", "hh", "cu", "cuh",
       "f", "f90", "f95", "f03",
-      "win", "in", "ucrt", "ac", "mk", "guess"
+      "win", "ucrt", "in", "ac", "mk", "guess", "def"
     ),
     "vignette" = c(
       "Rmd", "qmd", "orig", "md", "tex", "csl", "Rnw", "Snw", "Rtex", "Stex",
@@ -109,10 +109,12 @@ test_that("Test pattern_file_root_core() generate the right string list", {
     "\\.Rinstignore$",
     "^configure$",
     "^configure\\.win$",
+    "^configure\\.ucrt$",
     "^configure\\.ac$",
     "^configure\\.in$",
     "^cleanup$",
-    "^cleanup\\.win$"
+    "^cleanup\\.win$",
+    "^cleanup\\.ucrt$"
   )
 
   ls_target <- str_ls

diff --git a/tests/testthat/test-independent-test_templates.R b/tests/testthat/test-independent-test_templates.R
diff --git a/tests/testthat/test-independent_test_collate.R b/tests/testthat/test-independent_test_collate.R
@@ -72,7 +72,7 @@ test_that("fs_to_df returns 0-row data when the file spec is not in the right fo
   pkg <- "pkg1"
   files <- pkg %>%
     find_package() %>%
-    fs_to_df(file_src())
+    fs_to_df(file_src()[[2]])
   expect_equal(nrow(files), 0L)
 })
 

diff --git a/tests/testthat/test-independent_test_collection.R b/tests/testthat/test-independent_test_collection.R
@@ -1,10 +1,9 @@
-test_that("is_file_collection detects whether an object is of class
-                    file collection", {
+test_that("is_file_collection detects whether an object is of class file collection", {
   pkg <- "pkg1"
   expect_false(
     pkg %>%
       find_package() %>%
-      fs_to_df(file_spec = file_src()) %>%
+      fs_to_df(file_spec = file_src()[[2]]) %>%
       is_file_collection()
   )
 })