Added an exists= option to listRegisteredDirectories.

Author: LTLA

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: SewerRat
-Version: 0.3.4
-Date: 2025-03-12
+Version: 0.3.5
+Date: 2025-03-20
 Title: Client for the SewerRat API
 Description: 
     Search metadata files across a shared filesystem via the SewerRat API.

R/listRegisteredDirectories.R

@@ -10,6 +10,8 @@
 #' If not \code{NULL}, results are filtered to directories that contain 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.
+#' @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.
 #'
 #' @author Aaron Lun
 #'
@@ -42,7 +44,7 @@
 #' 
 #' @export
 #' @import httr2
-listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL) {
+listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL, exists=NULL) {
     query <- character(0)
     if (!is.null(user) && !isFALSE(user)) {
         if (isTRUE(user)) {
@@ -56,6 +58,9 @@ listRegisteredDirectories <- function(url, user=NULL, contains=NULL, prefix=NULL
     if (!is.null(prefix)) {
         query <- c(query, paste0("path_prefix=", URLencode(prefix, reserved=TRUE)))
     }
+    if (!is.null(exists)) {
+        query <- c(query, paste0("exists=", tolower(exists)))
+    }
 
     url <- paste0(url, "/registered")
     if (length(query)) {

R/startSewerRat.R

@@ -25,7 +25,7 @@
 #' startSewerRat() # initialize a new instance.
 #' 
 #' @export
-startSewerRat <- function(db=tempfile(fileext=".sqlite3"), port=NULL, wait = 1, version = "1.1.1", overwrite = FALSE) {
+startSewerRat <- function(db=tempfile(fileext=".sqlite3"), port=NULL, wait = 1, version = "1.1.3", overwrite = FALSE) {
     if (!is.null(running$active)) {
         return(list(new=FALSE, port=running$port, url=assemble_url(running$port)))
     }

man/listRegisteredDirectories.Rd

@@ -44,6 +44,19 @@ test_that("listRegisteredDirectories works as expected", {
     # Multiple filters work.
     filtered <- listRegisteredDirectories(info$url, prefix=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)
+    expect_identical(normalizePath(filtered[[1]]$path), normalizePath(tmp))
+
+    unlink(tmp, recursive=TRUE)
+    filtered2 <- listRegisteredDirectories(info$url, prefix=tmp, exists=FALSE)
+    expect_identical(filtered, filtered2)
+    filtered <- listRegisteredDirectories(info$url, prefix=tmp, exists=TRUE)
+    expect_identical(length(filtered), 0L)
+})
 })()