Soft-deprecate zip() and zip_append()

r-lib · Mar 11, 2019 · ef57e0e · ef57e0e
1 parent 027d05f
commit ef57e0e
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 14 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,9 @@
 
 # dev
 
+* `zip()` and `zip_append()` are now soft-deprecated, please use
+  `zipr()` and `zipr_append()` instead.
+
 # 2.0.0
 
 * New `zipr()` and `zipr_append()`, they always store relative file names

diff --git a/R/utils.R b/R/utils.R
@@ -125,3 +125,12 @@ need_packages <- function(pkgs, what = "this function") {
     }
   }
 }
+
+deprecated <- function(id, msg) {
+  if (isTRUE(zip_data$deprecated[[id]])) return(invisible())
+  zip_data$deprecated <- as.list(zip_data$deprecated)
+  zip_data$deprecated[[id]] <-  TRUE
+  m <- simpleMessage(paste0("Note: ", msg, "\n"))
+  class(m) <- c("deprecated", class(m))
+  message(m)
+}
diff --git a/R/zip.R b/R/zip.R
@@ -98,6 +98,7 @@ NULL
 #' zip_list(zipfile)
 
 zip <- function(zipfile, files, recurse = TRUE, compression_level = 9) {
+  deprecated("zip", "zip::zip() is deprecated, please use zip::zipr() instead")
   zip_internal(zipfile, files, recurse, compression_level, append = FALSE,
                keep_path = TRUE)
 }
@@ -115,6 +116,9 @@ zipr <- function(zipfile, files, recurse = TRUE, compression_level = 9) {
 
 zip_append <- function(zipfile, files, recurse = TRUE,
                        compression_level = 9) {
+  deprecated(
+    "zip_append",
+    "zip::zip_append() is deprecated, please use zip::zipr_append instead")
   zip_internal(zipfile, files, recurse, compression_level, append = TRUE,
                keep_path = TRUE)
 }

diff --git a/tests/testthat/helper.R b/tests/testthat/helper.R
@@ -92,3 +92,11 @@ make_a_zip <- function(mtime = Sys.time(), envir = parent.frame()) {
   zipr(zip, tmp)
   list(zip = zip, ex = tmp)
 }
+
+expect_deprecated <- function(expr) {
+  expect_silent(
+    withCallingHandlers(
+      expr,
+      "deprecated" = function(e) invokeRestart("muffleMessage"))
+  )
+}
diff --git a/tests/testthat/test-zip.R b/tests/testthat/test-zip.R
@@ -11,7 +11,7 @@ test_that("can compress single directory", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))
@@ -36,7 +36,7 @@ test_that("can compress single file", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))
@@ -58,7 +58,7 @@ test_that("can compress multiple files", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp1),
       zip(zipfile, basename(c(tmp1, tmp2)))
@@ -84,7 +84,7 @@ test_that("can compress multiple directories", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp1),
       zip(zipfile, basename(c(tmp1, tmp2)))
@@ -127,7 +127,7 @@ test_that("can compress files and directories", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(c(file1, tmp, file2)))
@@ -184,14 +184,14 @@ test_that("compression level is used", {
   zipfile1 <- tempfile(fileext = ".zip")
   zipfile2 <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(file),
       zip(zipfile1, basename(file), compression_level = 1)
     )
   )
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(file),
       zip(zipfile2, basename(file), compression_level = 9)
@@ -220,7 +220,7 @@ test_that("can append a directory to an archive", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))
@@ -239,7 +239,7 @@ test_that("can append a directory to an archive", {
   cat("first file2", file = file.path(tmp2, "file3"))
   cat("second file2", file = file.path(tmp2, "file4"))
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip_append(zipfile, basename(tmp2))
@@ -264,7 +264,7 @@ test_that("can append a file to an archive", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))
@@ -281,7 +281,7 @@ test_that("can append a file to an archive", {
 
   cat("first file2", file = file1 <- tempfile())
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip_append(zipfile, basename(file1))
@@ -306,7 +306,7 @@ test_that("can append files and directories to an archive", {
 
   zipfile <- tempfile(fileext = ".zip")
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))
@@ -326,7 +326,7 @@ test_that("can append files and directories to an archive", {
   cat("another", file = file.path(tmp2, "file3"))
   cat("and another", file = file.path(tmp2, "file4"))
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip_append(zipfile, basename(c(file1, tmp2)))
@@ -352,7 +352,7 @@ test_that("empty directories are archived as directories", {
   dir.create(file.path(tmp, "foo", "bar2"))
   cat("contents\n", file = file.path(tmp, "foo", "file1"))
 
-  expect_silent(
+  expect_deprecated(
     withr::with_dir(
       dirname(tmp),
       zip(zipfile, basename(tmp))