Merge pull request #49 from ThinkR-open/renv_en_folie

Add pkg_ignore to create_renv()

Author: statnmap

NEWS.md

@@ -1,7 +1,7 @@
 # attachment 0.2.4.900x
 ## Major changes
 
-* add `create_renv_for_dev()` and `create_renv_for_prod()` function to create `renv.lock` file based on development project (@VincentGuyader).
+* add `create_renv_for_dev()` and `create_renv_for_prod()` function to create `renv.lock` file based on development project (@VincentGuyader and @statnmap).
 
 ## Minor changes
 

R/create_renv.R

@@ -18,7 +18,7 @@ extra_dev_pkg <- c(
 #'
 #'
 #' @param path Path to your current package source folder
-#' @param dev_pkg Package development toolbox you need. Use `_default`
+#' @param dev_pkg Vector of packages you need for development. Use `_default`
 #' (with underscore before to avoid confusing with a package name), to
 #' use the default list. Use `NULL` for no extra package.
 #' Use `attachment:::extra_dev_pkg` for the list.
@@ -27,6 +27,8 @@ extra_dev_pkg <- c(
 #' @param install_if_missing Logical. Install missing packages. `TRUE` by default
 #' @param document Logical. Whether to run [att_amend_desc()] before
 #' detecting packages in DESCRIPTION.
+#' @param pkg_ignore Vector of packages to ignore from being discovered in your files.
+#' This does not prevent them to be in "renv.lock" if they are recursive dependencies.
 #' @param ... Other arguments to pass to [renv::snapshot()]
 #'
 #' @return a renv.lock file
@@ -47,6 +49,7 @@ create_renv_for_dev <- function(path = ".",
                                 output = "renv.lock",
                                 install_if_missing = TRUE,
                                 document = TRUE,
+                                pkg_ignore = NULL,
                                 ...) {
 
   if (!requireNamespace("renv")) {
@@ -66,11 +69,12 @@ create_renv_for_dev <- function(path = ".",
     att_amend_desc(path)
   }
 
-  pkg_list <-
+  pkg_list <- unique(
     c(
       att_from_description(path = file.path(path, "DESCRIPTION")),
       dev_pkg
     )
+  )
 
   # Extra folders
   folder_to_include_relative <- folder_to_include
@@ -98,6 +102,11 @@ create_renv_for_dev <- function(path = ".",
     pkg_list <- unique(c(pkg_list, from_r_script, from_rmd))
   }
 
+  # Ignore
+  if (!is.null(pkg_ignore)) {
+    pkg_list <- pkg_list[!pkg_list %in% pkg_ignore]
+  }
+
   # Install
   if (install_if_missing) {
     install_if_missing(pkg_list)

man/create_renv_for_dev.Rd

@@ -100,7 +100,7 @@ test_that("lockfile are renv files", {
 pkg_extra <- names(local_renv_extra$data()$Packages)
 pkg_blank <- names(local_renv_blank$data()$Packages)
 
-test_that("extrapackage is present thank to dev_pkg", {
+test_that("extrapackage is present thanks to dev_pkg", {
   expect_true("extrapackage" %in% pkg_extra)
   expect_false("extrapackage" %in% pkg_blank)
   # all blank are in extra
@@ -115,7 +115,7 @@ test_that("extrapackage is present thank to dev_pkg", {
 #   expect_equal_to_reference(names(pkg_blank),"my_renv_blank.test")
 # })
 
-# Test for extra and "_default" in interactive
+# Test for extra and "_default" in interactive ----
 test_that("_default works", {
   skip_if_not(interactive())
 
@@ -143,7 +143,7 @@ test_that("_default works", {
   expect_true(all(c("devtools", "fusen") %in% pkg_extra_default))
 })
 
-# Test for "folder_to_include" in dummypackage
+# Test for "folder_to_include" in dummypackage ----
 dir.create(file.path(dummypackage, "dev"))
 cat("library(glue)", file = file.path(dummypackage, "dev", "my_r.R"))
 cat("```{r}\nlibrary(\"extrapackage\")\n```", file = file.path(dummypackage, "dev", "my_rmd.Rmd"))
@@ -157,7 +157,7 @@ test_that("folder_to_include works", {
       install_if_missing = FALSE,
       output = lock_includes_devdir,
       force = TRUE)}
-    # "There is no directory named: dev, data-raw" # cli
+    # "There is no directory named: data-raw" # cli
   )
 
   expect_true(file.exists(lock_includes_devdir))
@@ -171,5 +171,32 @@ test_that("folder_to_include works", {
   expect_true(all(c("glue", "extrapackage") %in% pkg_devdir))
 })
 
+# Test pkg_ignore works ----
+# extrapackage is in "dev/" but I want it to be ignored
+test_that("create_renv_(pkg_ignore) works", {
+
+  lock_includes_ignore <- file.path(tmpdir, "for_ignore.lock")
+  expect_message({my_renv_ignore <-
+    create_renv_for_dev(
+      path = dummypackage,
+      install_if_missing = FALSE,
+      output = lock_includes_ignore,
+      pkg_ignore = "extrapackage",
+      force = TRUE)}
+  )
+
+  expect_true(file.exists(lock_includes_ignore))
+  expect_true(file.exists(my_renv_ignore))
+
+  local_renv_ignore <- getFromNamespace("lockfile", "renv")(my_renv_ignore)
+  expect_s3_class(local_renv_ignore, "renv_lockfile_api")
+
+  pkg_ignore <- names(local_renv_ignore$data()$Packages)
+  # glue and  in dev/ are there
+  expect_true(all(c("glue") %in% pkg_ignore))
+  # extrapackage is ignored in dev/
+  expect_false(all(c("extrapackage") %in% pkg_ignore))
+})
+
 remove.packages("extrapackage")
 unlink(tmpdir, recursive = TRUE)