feat: unstashing (tested)

R/unstash.R

@@ -0,0 +1,32 @@
+#' Unstash an object
+#'
+#' Remove an object from the stash.
+#'
+#' @param var The name or a vector of names of objects to remove.
+#'
+#' @return \code{NULL}
+#'
+#' @examples
+#' \dontrun{
+#' stash("x",
+#' {
+#'     x <- 1
+#' })
+#'
+#' unstash("x")
+#' }
+#'
+#' @export unstash
+unstash <- function(var) {
+
+    f <- function(v) {
+        if (has_been_stashed(v)) {
+            message(paste0("Unstashing '", v, "'."))
+            file.remove(unlist(stash_filename(v)))
+        } else {
+            message(paste0("No object '", v, "' in stash."))
+        }
+    }
+    lapply(var, f)
+    invisible(NULL)
+}

tests/testthat/test-unstash.R

@@ -0,0 +1,23 @@
+test_that("unstashing works", {
+    expect_null(stash("a", { a <- 1 }))
+
+    expect_true(has_been_stashed("a"))
+
+    expect_null(unstash("a"))
+
+    expect_false(has_been_stashed("a"))
+
+    expect_null(stash("b", { b <- 2 }))
+    expect_null(stash("c", { c <- 2 }))
+
+    expect_true(has_been_stashed("b"))
+    expect_true(has_been_stashed("c"))
+
+    expect_message(unstash("a"), "No object 'a'")
+    expect_message(unstash("b"), "Unstashing 'b'")
+
+    expect_false(has_been_stashed("b"))
+    expect_true(has_been_stashed("c"))
+
+    if (dir.exists(".mustashe")) unlink(".mustashe", recursive = TRUE)
+})