Support 'within=' in listRegisteredDirectories to replace 'prefix='.

This matches the updates to the /registered endpoint in the backend.

Author: LTLA

R/listRegisteredDirectories.R

@@ -8,8 +8,11 @@
 #' If \code{TRUE}, this is set to the current user.
 #' @param contains String containing an absolute path.
 #' If not \code{NULL}, results are filtered to directories that contain this path.
+#' @param within String containing an absolute path.
+#' If not \code{NULL}, results are filtered to directories that are equal to or lie within this path.
 #' @param prefix String containing an absolute path or a prefix thereof.
 #' If not \code{NULL}, results are filtered to directories that start with this string.
+#' This is soft-deprecated and users should prefer to use \code{within}.
 #' @param exists Logical scalar indicating whether to only report directories that exist on the filesystem.
 #' If \code{FALSE}, only non-existent directories are reported, and if \code{NULL}, no filtering is applied based on existence.
 #'
@@ -44,7 +47,7 @@
 #' 
 #' @export
 #' @import httr2
-listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL, exists=NULL) {
+listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL, within=NULL, exists=NULL) {
     query <- character(0)
     if (!is.null(user) && !isFALSE(user)) {
         if (isTRUE(user)) {
@@ -55,6 +58,9 @@ listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL
     if (!is.null(contains)) {
         query <- c(query, paste0("contains_path=", URLencode(contains, reserved=TRUE)))
     }
+    if (!is.null(within)) {
+        query <- c(query, paste0("within_path=", URLencode(within, reserved=TRUE)))
+    }
     if (!is.null(prefix)) {
         query <- c(query, paste0("path_prefix=", URLencode(prefix, reserved=TRUE)))
     }

man/listRegisteredDirectories.Rd

@@ -34,29 +34,29 @@ test_that("listRegisteredDirectories works as expected", {
     filtered <- listRegisteredDirectories(info$url, contains=tempfile())
     expect_identical(length(filtered), 0L)
 
-    # Filter by prefix.
-    filtered <- listRegisteredDirectories(info$url, prefix=dirname(mydir))
+    # Filter by within.
+    filtered <- listRegisteredDirectories(info$url, within=dirname(mydir))
     expect_identical(all, filtered)
 
-    filtered <- listRegisteredDirectories(info$url, prefix=paste0(dirname(mydir), "-asdasdad"))
+    filtered <- listRegisteredDirectories(info$url, within=paste0(dirname(mydir), "-asdasdad"))
     expect_identical(length(filtered), 0L)
 
     # Multiple filters work.
-    filtered <- listRegisteredDirectories(info$url, prefix=dirname(mydir), user=TRUE, contains=file.path(mydir, "diet"))
+    filtered <- listRegisteredDirectories(info$url, within=dirname(mydir), user=TRUE, contains=file.path(mydir, "diet"))
     expect_identical(all, filtered)
 
     # Existence filter works.
     tmp <- tempfile()
     dir.create(tmp)
     register(tmp, names="metadata.json", url=info$url)
     on.exit(deregister(tmp, url=info$url), add=TRUE, after=FALSE)
-    filtered <- listRegisteredDirectories(info$url, prefix=tmp, exists=TRUE)
+    filtered <- listRegisteredDirectories(info$url, within=tmp, exists=TRUE)
     expect_identical(normalizePath(filtered[[1]]$path), normalizePath(tmp))
 
     unlink(tmp, recursive=TRUE)
-    filtered2 <- listRegisteredDirectories(info$url, prefix=tmp, exists=FALSE)
+    filtered2 <- listRegisteredDirectories(info$url, within=tmp, exists=FALSE)
     expect_identical(filtered, filtered2)
-    filtered <- listRegisteredDirectories(info$url, prefix=tmp, exists=TRUE)
+    filtered <- listRegisteredDirectories(info$url, within=tmp, exists=TRUE)
     expect_identical(length(filtered), 0L)
 })
 })()