Patch overwrite (#27)

* implement cleaner overwrite logic, closes #25 * update pkgdown docs too * update CRAN comments too
ropensci · Feb 6, 2019 · 5e8971b · 5e8971b
1 parent 2e741b8
commit 5e8971b
Show file tree

Hide file tree

Showing 25 changed files with 98 additions and 63 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,9 @@
 # piggyback 0.0.10
 
+* Improve interface regarding `overwrite` behavior in `pb_upload()` (#25)
 * Bugfixes for errors introduced in 0.0.9: 
-   - Uploading of directory paths could cause download errors in `pb_download()`. (#24)
    - Access all assets on a release instead of first 30.  This could break upload and download. (#23, #24)
+   - Uploading of directory paths could cause download errors in `pb_download()`. (#24, #26)
 
 # piggyback 0.0.9, 2019-01-08
 

diff --git a/R/pb_upload.R b/R/pb_upload.R
@@ -8,10 +8,10 @@
 #' @param name name for uploaded file. If not provided will use the basename of
 #' `file` (i.e. filename without directory)
 #' @param overwrite overwrite any existing file with the same name already
-#'  attached to the on release? Defaults to `TRUE`
-#' @param use_timestamps logical, if `TRUE`, then files will only be downloaded
-#' if timestamp on GitHub is newer than the local timestamp (if
-#' `overwrite=TRUE`).  Defaults to `TRUE`.
+#'  attached to the on release? Defaults to `use_timestamps`, only overwriting
+#'  those files which are older.  Set to `TRUE` to always overwrite, or `FALSE`
+#'  to never overwrite existing files.
+#' @param use_timestamps DEPRECATED. please use `overwrite="use_timestamps"`
 #' @param show_progress logical, show a progress bar be shown for uploading?
 #' Defaults to `TRUE`.
 #' @param .token GitHub authentication token. Typically set from an
@@ -33,8 +33,8 @@ pb_upload <- function(file,
                       repo = guess_repo(),
                       tag = "latest",
                       name = NULL,
-                      overwrite = TRUE,
-                      use_timestamps = TRUE,
+                      overwrite = "use_timestamps",
+                      use_timestamps = NULL,
                       show_progress = TRUE,
                       .token = get_token(),
                       dir = ".") {
@@ -57,15 +57,36 @@ pb_upload_file <- function(file,
                            repo = guess_repo(),
                            tag = "latest",
                            name = NULL,
-                           overwrite = FALSE,
-                           use_timestamps = TRUE,
+                           overwrite = "use_timestamps",
+                           use_timestamps = NULL,
                            show_progress = TRUE,
                            .token = get_token(),
                            dir = ".") {
   if (!file.exists(file)) {
     warning("file ", file, " does not exist")
     return(NULL)
   }
+  if(!is.null(use_timestamps)){
+    warning(paste("use_timestamps argument is deprecated",
+                  "please set overwrite='use_timestamps'",
+                  "instead."))
+  }
+
+
+  ## Yeah, having two separate arguments was clearly a mistake!
+  ## Code has been partially refactored now so that user just
+  ## sets `overwrite` and we handle the twisted logic internally here:
+  use_timestamps <- switch (as.character(overwrite),
+    "TRUE" = FALSE,
+    "FALSE" = FALSE,
+    "use_timestamps" = TRUE
+  )
+  overwrite <- switch (as.character(overwrite),
+    "TRUE" = TRUE,
+    "FALSE" = FALSE,
+    "use_timestamps" = TRUE
+  )
+
   progress <- httr::progress("up")
   if (!show_progress) {
     progress <- NULL

diff --git a/codemeta.json b/codemeta.json
@@ -10,7 +10,7 @@
   "codeRepository": "https://github.com/ropensci/piggyback",
   "issueTracker": "https://github.com/ropensci/piggyback/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -274,7 +274,7 @@
   ],
   "releaseNotes": "https://github.com/ropensci/piggyback/blob/master/NEWS.md",
   "readme": "https://github.com/ropensci/piggyback/blob/master/README.md",
-  "fileSize": "274.26KB",
+  "fileSize": "275.036KB",
   "contIntegration": [
     "https://travis-ci.org/ropensci/piggyback",
     "https://codecov.io/github/ropensci/piggyback?branch=master",

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,8 +1,9 @@
 Dear CRAN Maintainers,
 
-We are pleased to submit an updated release of `piggyback` which improves the
-existing documentation and provides a fallback mechanism in the event of 
-a interrupted network connection error when uploading a large numbers of files.
+This release fixes a bug that was introduced in the previous release,
+which prevented functions from seeing more than 30 file assets on 
+any given release.  This release also improves the user interface
+regarding the overwrite behavior, as detailed in NEWS.md.  
 
 
 ## Test environments

diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/alternatives.html b/docs/articles/alternatives.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/intro.html b/docs/articles/intro.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/paper.html b/docs/paper.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/pb_delete.html b/docs/reference/pb_delete.html
diff --git a/docs/reference/pb_download.html b/docs/reference/pb_download.html
diff --git a/docs/reference/pb_download_url.html b/docs/reference/pb_download_url.html
diff --git a/docs/reference/pb_list.html b/docs/reference/pb_list.html
diff --git a/docs/reference/pb_new_release.html b/docs/reference/pb_new_release.html
diff --git a/docs/reference/pb_track.html b/docs/reference/pb_track.html
diff --git a/docs/reference/pb_upload.html b/docs/reference/pb_upload.html