Merge pull request #65 from tanho63/tandev

Refactoring of pb_list() and other changes

.Rbuildignore

@@ -21,6 +21,7 @@
 ^paper\.bib$
 ^codemeta\.json$
 ^docs$
+^dev$
 ^.*\.gz$
 mtcars.tsv.gz$
 ^\.github$

DESCRIPTION

@@ -33,12 +33,12 @@ License: GPL-3
 Encoding: UTF-8
 ByteCompile: true
 Imports:
+    cli,
+    glue,
     gh,
     httr,
     jsonlite,
     fs,
-    crayon,
-    clisymbols,
     lubridate,
     memoise
 Suggests:

NAMESPACE

@@ -5,23 +5,5 @@ export(pb_download)
 export(pb_download_url)
 export(pb_list)
 export(pb_new_release)
+export(pb_releases)
 export(pb_upload)
-importFrom(clisymbols,symbol)
-importFrom(crayon,blue)
-importFrom(crayon,green)
-importFrom(fs,dir_create)
-importFrom(gh,gh)
-importFrom(gh,gh_token)
-importFrom(httr,GET)
-importFrom(httr,POST)
-importFrom(httr,add_headers)
-importFrom(httr,content)
-importFrom(httr,progress)
-importFrom(httr,stop_for_status)
-importFrom(httr,upload_file)
-importFrom(httr,write_disk)
-importFrom(jsonlite,toJSON)
-importFrom(lubridate,as_datetime)
-importFrom(memoise,forget)
-importFrom(memoise,memoise)
-importFrom(memoise,timeout)

NEWS.md

@@ -5,6 +5,12 @@
 * update intro vignette to remove mention of path name handling and instead provide examples of how path names are handled.
 * update intro vignette instructions for git authentication
 * `pb_new_release()` now reports HTTP errors when attempting to create a new release and returns the contents of the error if it fails. 
+* `pb_releases()` created - it returns a list of releases available in the repository.
+* Internal function `pb_info()` refactored to search for the specified tag(s) which should improve performance. Should handle multiple tags gracefully.
+* Internal function `pb_info()` (and therefore `pb_list()`, `pb_download()`, `pb_download_url()`) no longer ask about creating new releases if the release is not found. 
+* `pb_upload()` is now the only function that offers (interactively) to create a new release if release is not found. If noninteractive, user must run `pb_new_release()` manually prior to uploading. 
+* CLI messaging now consistently uses `{cli}` package and no longer uses clisymbols or crayon - this is to align with the imports from the `{gh}` package.
+* Documentation updated.
 
 # piggyback 0.1.1
 

R/pb_delete.R

@@ -13,7 +13,7 @@
 #' ## Upload
 #' pb_upload("mtcars.tsv.gz",
 #'           repo = "cboettig/piggyback-tests",
-#'            overwrite = TRUE)
+#'           overwrite = TRUE)
 #' pb_delete("mtcars.tsv.gz",
 #'           repo = "cboettig/piggyback-tests",
 #'           tag = "v0.0.1")
@@ -22,25 +22,37 @@
 pb_delete <- function(file = NULL,
                       repo = guess_repo(),
                       tag = "latest",
-                      .token = get_token()) {
+                      .token = gh::gh_token()) {
   df <- pb_info(repo, tag, .token)
 
-  if (is.null(file)) {
-    ids <- df$id
-  } else {
+  if (is.null(file)) ids <- df$id
+
+  if(!is.null(file) && any(!file %in% df$file_name)){
+    missing <- file[!file %in% df$file_name]
+    file <- file[file != missing]
+    cli::cli_warn("{.val {missing}} not found in {.val {tag}} release of {.val {repo}}")
+  }
+
+  if(!is.null(file)){
     ids <- df[df$file_name %in% file, "id"]
   }
 
   if (length(ids) < 1) {
-    message(paste(file, "not found on GitHub"))
-    return(NULL)
+    cli::cli_warn("No file deletions performed.")
+    return(invisible(NULL))
   }
 
   lapply(ids, function(id) {
     ## If we find matching id, Delete file from release.
     gh::gh("DELETE /repos/:owner/:repo/releases/assets/:id",
-           owner = df$owner[[1]], repo = df$repo[[1]], id = id, .token = .token
+           owner = df$owner[[1]],
+           repo = df$repo[[1]],
+           id = id,
+           .token = .token
     )
   })
-  invisible(TRUE)
+
+  cli::cli_alert_info("Deleted {.val {file}} from {.val {tag}} release on {.val {repo}}")
+
+  return(invisible(TRUE))
 }

R/pb_download.R

@@ -10,9 +10,7 @@
 #' @param ignore a list of files to ignore (if downloading "all" because
 #'  `file=NULL`).
 #' @inheritParams pb_upload
-#' @importFrom httr GET add_headers write_disk
-#' @importFrom gh gh gh_token
-#' @importFrom fs dir_create
+#'
 #' @export
 #' @examples \dontrun{
 #'  ## Download a specific file.
@@ -35,12 +33,11 @@ pb_download <- function(file = NULL,
                         ignore = "manifest.json",
                         use_timestamps = TRUE,
                         show_progress = TRUE,
-                        .token = get_token()) {
+                        .token = gh::gh_token()) {
+
   progress <- httr::progress("down")
-  if (!show_progress) {
-    progress <- NULL
-  }
 
+  if (!show_progress) progress <- NULL
 
   df <- pb_info(repo, tag, .token)
 
@@ -50,12 +47,7 @@ pb_download <- function(file = NULL,
   if (!is.null(file)) {
     i <- which(df$file_name %in% file)
     if (length(i) < 1) {
-      warning(paste(
-        "file(s)",
-        paste(crayon::blue(file), collapse = " "),
-        "not found in repo",
-        crayon::blue(repo)
-      ))
+      cli::cli_warn("file(s) {.file {file}} not found in repo {.val {repo}}")
     }
 
     df <- df[i, ]
@@ -69,11 +61,10 @@ pb_download <- function(file = NULL,
 
 
   ## if dest paths are not provided, we will write all files to dest dir
+  # User is responsible for making sure dest dir exists!
   if (length(dest) == 1) {
     i <- which(df$file_name %in% file)
     dest <- file.path(dest, df$file_name[i])
-    # User is responsible for making sure dest dir exists!
-    # fs::dir_create(fs::path_dir(dest))
   }
   # dest should now be of length df
   df$dest <- dest
@@ -86,43 +77,42 @@ pb_download <- function(file = NULL,
     df <- df[update, ]
 
     if (dim(df)[[1]] < 1) {
-      message(paste("All files up-to-date already\n"))
+      cli::cli_alert_info("All local files already up-to-date!")
     }
   }
 
   resp <- lapply(seq_along(df$id), function(i)
     gh_download_asset(df$owner[[1]],
                       df$repo[[1]],
                       id = df$id[i],
-                      destfile = dest[i],
+                      destfile = df$dest[i],
                       overwrite = overwrite,
                       progress = progress
     ))
   invisible(resp)
 }
 
-
-
-
 ## gh() fails on this, so we do with httr. See https://github.com/r-lib/gh/issues/57
-## Consider option to supress progress bar?
+## Consider option to suppress progress bar?
 gh_download_asset <- function(owner,
                               repo,
                               id,
                               destfile,
                               overwrite = TRUE,
-                              .token = get_token(),
+                              .token = gh::gh_token(),
                               progress = httr::progress("down")) {
   if (fs::file_exists(destfile) && !overwrite) {
-    warning(paste(
-      destfile, "already exists, skipping download.",
-      "Set overwrite = TRUE to overwrite files."
-    ))
+    cli::cli_warn(
+      c("!"="{.val {destfile}} already exists, skipping download.",
+        "Set {.code overwrite = TRUE} to overwrite files.")
+    )
     return(NULL)
   }
 
   if (!is.null(progress)) {
-    message(paste("downloading", basename(destfile), "..."))
+    cli::cli_alert_info(
+      "Downloading {.val {basename(destfile)}}..."
+    )
   }
 
   resp <- httr::GET(
@@ -149,9 +139,10 @@ gh_download_asset <- function(owner,
   }
 
   # handle error cases? resp not found
-  if(getOption("verbose")) httr::warn_for_status(resp)
+  if(getOption("piggyback.verbose", default = TRUE)) httr::warn_for_status(resp)
 
   invisible(resp)
+
 #  gh::gh(paste0(
 #         "https://api.github.com/repos/", owner, "/",
 #         repo, "/", "releases/assets/", id),

R/pb_download_url.R

@@ -1,4 +1,3 @@
-
 #' Get the download url of a given file
 #'
 #' Returns the URL download for a public file. This can be useful when writing
@@ -17,13 +16,21 @@
 pb_download_url <- function(file = NULL,
                             repo = guess_repo(),
                             tag = "latest",
-                            .token = get_token()) {
+                            .token = gh::gh_token()) {
   df <- pb_info(repo, tag, .token)
-  if (is.null(file)) {
-    return(df$browser_download_url)
-  } else if (file %in% df$file_name) {
-    return(df[file == df$file_name, "browser_download_url"])
-  } else {
-    stop(paste("file", file, "not found in release", tag, "for repo", repo))
+
+  if(is.null(file)) return(df$browser_download_url)
+
+  if(any(!file %in% df$file_name)) {
+
+    missing <- file[!file %in% df$file_name]
+
+    cli::cli_warn("file {.val {missing}} not found in release {.val {tag}} for repo {.val {repo}}")
+
+    file <- file[file %in% df$file_name]
   }
+
+  if(length(file) == 0) return(cli::cli_abort("No download URLs to return."))
+
+  return(df[df$file_name %in% file,"browser_download_url"])
 }