support argument root for deps in desc

Author: lorenzwalthert

inst/hooks/exported/deps-in-desc.R

@@ -2,10 +2,12 @@
 
 "Ensure all dependencies of the form pkg::fun are in DESCRIPTION
 Usage:
-  deps-in-desc [--allow_private_imports] <files>...
+  deps-in-desc [--allow_private_imports] [--root=<root_>]<files>...
 
 Options:
   --allow_private_imports  Whether or not to allow the use of ::: on imported functions.
+  --root=<root_>  Path relative to the git root that contains the R package root [default: .].
+
 " -> doc
 pre_installed <- c(
   "base", "boot", "class", "cluster", "codetools", "compiler",
@@ -16,6 +18,8 @@ pre_installed <- c(
 )
 
 arguments <- docopt::docopt(doc)
+arguments$files <- normalizePath(arguments$files) # because working directory changes to root
+setwd(normalizePath(arguments$root))
 deps_in_desc <- function(file, arguments) {
   if (basename(file) == "README.Rmd") {
     # is .Rbuildignored, dependencies irrelevant
@@ -70,6 +74,7 @@ deps_in_desc <- function(file, arguments) {
   }
   out
 }
+
 out <- lapply(arguments$files, deps_in_desc, arguments = arguments)
 if (!all(unlist(out))) {
   stop("Dependency check failed", call. = FALSE)

tests/testthat/test-hooks.R

@@ -213,6 +213,26 @@ run_test("deps-in-desc",
   artifacts = c("DESCRIPTION" = test_path("in/DESCRIPTION"))
 )
 
+# in sub directory with wrong root
+run_test("deps-in-desc",
+  suffix = "-fail.R", std_err = "contains a file",
+  artifacts = c("rpkg/DESCRIPTION" = test_path("in/DESCRIPTION"))
+)
+
+# in sub directory with correct root
+run_test("deps-in-desc",
+  cmd_args = "--root=rpkg",
+  suffix = "-fail.R", std_err = "Dependency check failed",
+  artifacts = c("rpkg/DESCRIPTION" = test_path("in/DESCRIPTION"))
+)
+
+# in sub directory with correct root
+run_test("deps-in-desc",
+  cmd_args = "--root=rpkg",
+  suffix = "-success.R", std_err = NULL,
+  artifacts = c("rpkg/DESCRIPTION" = test_path("in/DESCRIPTION"))
+)
+
 # with :::
 run_test("deps-in-desc",
   "deps-in-desc-dot3",

vignettes/available-hooks.Rmd

@@ -226,14 +226,32 @@ roclets you specified in `DESCRIPTION`.
 ## `deps-in-desc`
 
 Checks if packages used with the `pkgname::fun()` syntax are listed in
-your DESCRIPTION file. Note that `README.Rmd` is never checked. Flag
-`allow_private_imports` lets the user specify that private imports into
-the package namespace are tolerable, e.g. `somepkg:::x()`. Flag not set
-by default, i.e. the hook will fail if such a call is found.
+your DESCRIPTION file. Note that `README.Rmd` is never checked.
 
+**Arguments**
+
+-   Flag `allow_private_imports` lets the user specify that private
+    imports into the package namespace are tolerable, e.g.
+    `somepkg:::x()`. Flag not set by default, i.e. the hook will fail if
+    such a call is found.
+
+```{=html}
+<!-- -->
+```
       id: deps-in-desc 
       args: [--allow_private_imports] 
 
+-   Argument `root` specifies the directory in the git repo that
+    contains the R package. Defaults to `.` since for most R package git
+    repos, the git and R package root coincide. Added in version
+    0.3.2.9000.
+
+```{=html}
+<!-- -->
+```
+    id: deps-in-desc 
+      args: [--root=<R package root>] 
+
 This hook does not modify the file `DESCRIPTION` because the user should
 decide for each package if it should go to `Imports:` or `Suggests:`,
 which can be done easily with `usethis::use_package()`.