Added utility to unpack a Gobbler path to its project/asset/version d…

…etails.

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: gobbler
-Version: 0.3.8
-Date: 2024-09-18
+Version: 0.3.9
+Date: 2024-10-02
 Title: Interface to the gobbler service
 Description:
     Friendly interface to the gobbler service.

NAMESPACE

@@ -25,6 +25,7 @@ export(serviceInfo)
 export(setPermissions)
 export(startGobbler)
 export(stopGobbler)
+export(unpackPath)
 export(uploadDirectory)
 export(versionPath)
 import(httr2)

R/unpackPath.R

@@ -0,0 +1,27 @@
+#' Unpack a path to its project-asset-version combination
+#'
+#' Unpack a Gobbler path to its combination of project, asset, version, and (optionally) path,
+#' for easier use in the various \pkg{gobbler} functions.
+#'
+#' @param path String containing a relative path within the Gobbler registry. 
+#'
+#' @return List containing \code{project}, \code{asset}, \code{version} and \code{path}.
+#' All are strings, except for \code{path}, which may be \code{NULL}.
+#'
+#' @author Aaron Lun
+#'
+#' @examples
+#' unpackPath("project/asset/version/path")
+#' unpackPath("project/asset/version")
+#'
+#' @export
+unpackPath <- function(path) {
+    components <- strsplit(path, "/")[[1]]
+    stopifnot(length(components) >= 3L)
+    if (length(components) == 3L || components[4] == "") {
+        path <- NULL
+    } else {
+        path <- paste(tail(components, -3), collapse="/")
+    }
+    list(project=components[1], asset=components[2], version=components[3], path=path)
+}

tests/testthat/test-unpackPath.R

@@ -0,0 +1,12 @@
+# library(gobbler); library(testthat); source("test-unpackPath.R")
+
+test_that("unpackPath works as expected", {
+    out <- unpackPath("project/asset/version/path")
+    expect_identical(out, list(project="project", asset="asset", version="version", path="path"))
+
+    out <- unpackPath("project/asset/version")
+    expect_identical(out, list(project="project", asset="asset", version="version", path=NULL))
+
+    out <- unpackPath("project/asset/version/")
+    expect_identical(out, list(project="project", asset="asset", version="version", path=NULL))
+})