scan_deps: use .Rproj files

r-lib · Dec 15, 2024 · 6424fad · 6424fad
1 parent 956effc
commit 6424fad
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 16 deletions.
diff --git a/R/scan-deps.R b/R/scan-deps.R
@@ -83,22 +83,10 @@
 
 scan_deps <- function(path = ".") {
   path <- tryCatch(find_project_root(path), error = function(...) path)
-  paths <- dir(path, pattern = scan_deps_pattern(), recursive = TRUE)
-  if (file.exists(file.path(path, "DESCRIPTION"))) {
-    paths <- c(paths, "DESCRIPTION")
-  }
-  if (file.exists(file.path(path, "NAMESPACE"))) {
-    paths <- c(paths, "NAMESPACE")
-  }
-  if (file.exists(file.path(path, "_pkgdown.yml"))) {
-    paths <- c(paths, "_pkgdown.yml")
-  }
-  if (file.exists(file.path(path, "renv.lock"))) {
-    paths <- c(paths, "renv.lock")
-  }
-  if (file.exists(file.path(path, "rsconnect"))) {
-    paths <- c(paths, "rsconnect")
-  }
+  paths <- c(
+    dir(path, pattern = scan_deps_pattern(), recursive = TRUE),
+    dir(path, pattern = scan_deps_pattern_root(), recursive = FALSE)
+  )
   full_paths <- normalizePath(file.path(path, paths))
   deps_list <- lapply(full_paths, scan_path_deps)
   deps <- do.call("rbind", c(list(scan_deps_df()), deps_list))
@@ -118,13 +106,26 @@ scan_deps_pattern <- function() {
     "[.]rmarkdown",
     "[.]Rmarkdown",
     "[.]qmd$",
+    "[.]Rproj$",
     "^_bookdown[.]yml$",
     "^_quarto[.]yml$",
     NULL
   )
   paste0("(", paste0(collapse = "|", ptrns), ")")
 }
 
+scan_deps_pattern_root <- function() {
+  ptrns <- c(
+    "^DESCRIPTION$",
+    "^NAMESPACE$",
+    "^_pkgdown.yml$",
+    "^renv[.]lock$",
+    "^rsconnect$",
+    NULL
+  )
+  paste0("(", paste0(collapse = "|", ptrns), ")")
+}
+
 scan_deps_file_type_use_basename <- function() {
   # for these we don't use the extension but the basename
   # to decide which parser to use
@@ -285,6 +286,7 @@ scan_path_deps_do <- function(code, path) {
     "_quarto.yml" = scan_path_deps_do_quarto(code, path),
     "renv.lock" = scan_path_deps_do_renv_lock(code, path),
     "rsconnect" = scan_path_deps_do_rsconnect(code, path),
+    ".rproj" = scan_path_deps_do_rproj(code, path),
     stop("Cannot parse ", ext, " file for dependencies, internal error")
   )
 }
@@ -1040,3 +1042,16 @@ scan_path_deps_do_rsconnect <- function(code, path) {
 }
 
 # -------------------------------------------------------------------------
+
+scan_path_deps_do_rproj <- function(code, path) {
+  con <- if (is.raw(code)) rawConnection(code) else textConnection(code)
+  on.exit(close(con), add = TRUE)
+  if ("yes" %in% tolower(read.dcf(con, fields = "PackageUseDevtools"))) {
+    scan_deps_df(
+      path = path,
+      package = c("devtools", "roxygen2"),
+      type = "dev",
+      code = "PackageUseDevtools: Yes"
+    )
+  }
+}
diff --git a/tests/testthat/_snaps/scan-deps.md b/tests/testthat/_snaps/scan-deps.md
@@ -394,3 +394,14 @@
       3 renv.lock              renv      renv      *       prod  <NA>          1            1          1
       4 rsconnect              rsconnect rsconnect *       prod  <NA>          1            1          1
 
+# .Rproj file
+
+    Code
+      scan_deps(project)[]
+    Output
+      # A data frame: 2 x 9
+        path             ref      package  version type  code                    start_row start_column start_byte
+        <chr>            <chr>    <chr>    <chr>   <chr> <chr>                       <int>        <int>      <int>
+      1 pkgdepends.Rproj devtools devtools *       prod  PackageUseDevtools: Yes         1            1          1
+      2 pkgdepends.Rproj roxygen2 roxygen2 *       prod  PackageUseDevtools: Yes         1            1          1
+
diff --git a/tests/testthat/fixtures/scan/project-2/pkgdepends.Rproj b/tests/testthat/fixtures/scan/project-2/pkgdepends.Rproj
@@ -0,0 +1,20 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: No
+PackageInstallArgs: --no-multiarch --with-keep.source
diff --git a/tests/testthat/fixtures/scan/project-3/DESCRIPTION b/tests/testthat/fixtures/scan/project-3/DESCRIPTION
@@ -0,0 +1,2 @@
+Package: testpackage
+Version: 1.0.0
diff --git a/tests/testthat/fixtures/scan/project-3/pkgdepends.Rproj b/tests/testthat/fixtures/scan/project-3/pkgdepends.Rproj
@@ -0,0 +1,20 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
diff --git a/tests/testthat/test-scan-deps.R b/tests/testthat/test-scan-deps.R
@@ -491,3 +491,11 @@ test_that("scan_path_deps_do_{bookdown,pkgdown,quarto,renv_lock,rsconnect}", {
     scan_deps(project)[]
   })
 })
+
+test_that(".Rproj file", {
+  local_reproducible_output(width = 500)
+  project <- test_path("fixtures/scan/project-3")
+  expect_snapshot({
+    scan_deps(project)[]
+  })
+})