create check_path() and use throughout the package

Author: idmn

R/cli.R

@@ -310,3 +310,35 @@ check_bool <- function(x, alt_null = FALSE, add_msg = NULL) {
     ))
   }
 }
+
+
+#' @title Validate a path
+#' 
+#' @description Makes sure that a path passed to a cloud function is in the
+#'   right format.
+#' 
+#' @param file Path to a file relative to project folder root. Can contain only
+#'   letters, digits, '-', '_', '.', spaces and '/' symbols.
+#' @param error if `TRUE` (default), throws an error if `file` is not a valid 
+#'   file path.
+#'   
+#' @return Either `TRUE` or `FALSE` if `error` is `FALSE`. Either `TRUE` or
+#' an error if `error` is `TRUE`.
+#'
+#' @keywords internal
+check_path <- function(path, error = TRUE) {
+  res <- grepl("^([A-Za-z]|[0-9]|-|_|\\.| |/)+$", path)
+  if (error) {
+    if (path == "") cli::cli_abort("A valid path must not be empty.")
+    if (!res) cli_abort(c(
+      "Path '{path}' is not valid",
+      "A valid path must consist of:",
+      "*" = "uppercase/lowercase letters",
+      "*" = "digits",
+      "*" = "'/' symbols to separate directories in the path",
+      "*" = "'_', '-', '.' symbols or spaces"
+    ))
+  }
+  res
+}
+

R/cloud_local.R

@@ -129,17 +129,7 @@ cloud_object_ls <- function(x, path, extension, prefix = "", suffix = "") {
   check_string(extension)
   check_string(prefix)
   check_string(suffix)
-  
-  if (!grepl("^([A-Za-z]|[0-9]|-|_|\\.|/)+$", path)) {
-    cli::cli_abort(c(
-      "Directory path {.path {path}} is not valid. A valid directory path must \\
-      consist of:",
-      "*" = "uppercase/lowercase letters",
-      "*" = "digits",
-      "*" = "'/' symbols to describe its location inside project's folder",
-      "*" = "'_', '-', '.' symbols or spaces."
-    ))
-  }
+  check_path(path)
 
   if (!grepl("^([A-Za-z]|[0-9])+$", extension)) {
     cli::cli_abort(c(

R/common.R

@@ -49,38 +49,6 @@ proj_desc_get <- function(key, project = ".") {
   unname(value)
 }
 
-#' @title Validate file path for cloud functions
-#' 
-#' @description Makes sure that file path passed to a cloud function is in the
-#'   right format.
-#' 
-#' @param file Path to a file relative to project folder root. Can contain only
-#'   letters, digits, '-', '_', '.', spaces and '/' symbols.
-#' @param error if `TRUE` (default), throws an error if `file` is not a valid 
-#'   file path.
-#'   
-#' @return Either `TRUE` or `FALSE` if `error` is `FALSE`. Either `TRUE` or
-#' an error if `error` is `TRUE`.
-#'
-#' @keywords internal
-cloud_validate_file_path <- function(file, error = TRUE) {
-  check_string(file)
-  res <- grepl("^([A-Za-z]|[0-9]|-|_|\\.| |/)+$", file)
-  if (error) {
-    if (file == "") cli::cli_abort("A valid file name should not be empty.")
-    if (!res) cli_abort(c(
-      "File name '{file}' is not valid",
-      "A valid file name must consist of:",
-      "*" = "uppercase/lowercase letters",
-      "*" = "digits",
-      "*" = "spaces",
-      "*" = "'/' symbols to describe its location inside project's folder",
-      "*" = "'_', '-', '.' symbols"
-    ))
-  }
-  res
-}
-
 #' @title Validate file names
 #' 
 #' @description Given a character vector of filenames checks that all names pass

R/doc.R

@@ -0,0 +1,9 @@
+#' @title Package-wide description of `file` parameter
+#' @description A dummy function to be referred by `@inheritParams` for a
+#'   parameter documentation.
+#' 
+#' @param file Path to a file relative to project folder root. Can contain only
+#'   letters, digits, '-', '_', '.', spaces and '/' symbols.
+#'
+#' @keywords internal
+doc_file <- function(file) {}

R/drive_transfer.R

@@ -3,7 +3,7 @@
 #' @description Uploads a local file from the project's directory to its
 #'   corresponding location within the project's Google Drive root folder.
 #' 
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_drive_ls
 #'  
 #' @inherit cloud_drive_find_path details
@@ -25,7 +25,7 @@
 #' 
 #' @export
 cloud_drive_upload <- function(file, root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
 
   if (!file.exists(file)) {
     cli::cli_abort("File {.path {file}} does not exist.")
@@ -51,7 +51,7 @@ cloud_drive_upload <- function(file, root = NULL) {
 #'   saves it to the local project folder, maintaining the original folder 
 #'   structure.
 #' 
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_drive_ls
 #' 
 #' @inherit cloud_drive_find_path details
@@ -68,7 +68,7 @@ cloud_drive_upload <- function(file, root = NULL) {
 #' 
 #' @export
 cloud_drive_download <- function(file, root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
 
   check_string(root, alt_null = TRUE)
   if (is.null(root)) root <- cloud_drive_get_root()
@@ -95,7 +95,7 @@ cloud_drive_download <- function(file, root = NULL) {
 #'   function will infer the appropriate writing method based on the file's
 #'   extension.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_drive_ls
 #' 
 #' @param x An R object to be written to Google Drive.
@@ -121,7 +121,7 @@ cloud_drive_download <- function(file, root = NULL) {
 #' @export
 cloud_drive_write <- function(x, file, fun = NULL, ..., local = FALSE,
                            root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
   check_bool(local)
 
   if (is.null(fun)) {
@@ -162,7 +162,7 @@ cloud_drive_write <- function(x, file, fun = NULL, ..., local = FALSE,
 #'   reading function based on the file's extension. However, you can specify a
 #'   custom reading function if necessary.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_drive_ls
 #' 
 #' @param fun A custom reading function. If `NULL` (default), the appropriate
@@ -185,7 +185,7 @@ cloud_drive_write <- function(x, file, fun = NULL, ..., local = FALSE,
 #' 
 #' @export
 cloud_drive_read <- function(file, fun = NULL, ..., root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
   if (is.null(fun)) {
     fun <- cloud_guess_read_fun(file)
   }

R/drive_utils.R

@@ -78,7 +78,7 @@ cloud_drive_download_by_id <- function(file, path, overwrite = FALSE) {
 #' 
 #' @noRd
 cloud_drive_guess_type <- function(file) {
-  cloud_validate_file_path(file)
+  check_path(file)
   ext <- tolower(tools::file_ext(file))
   switch (
     ext,
@@ -112,7 +112,7 @@ cloud_drive_put <- function(media, path) {
 #' @description Finds the spreadsheet by path relative to a project root.
 #'   Applies [googlesheets4::range_autofit()] to each sheet.
 #' 
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_drive_ls
 #' 
 #' @return The file ID of the resized Google spreadsheet as an invisible result.
@@ -123,7 +123,7 @@ cloud_drive_put <- function(media, path) {
 #' 
 #' @export 
 cloud_drive_spreadsheet_autofit <- function(file, root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
   check_string(root, alt_null = TRUE)
 
   if (is.null(root)) root <- cloud_drive_get_root()

R/read_write.R

@@ -3,7 +3,7 @@
 #' @description Take a look at the switch call. That's basically it. Returns an
 #'   appropriate function or throws an error if wasn't able to find one.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #'   
 #' @section Default writing functions:
 #' 
@@ -21,7 +21,7 @@
 #' 
 #' @keywords internal
 cloud_guess_write_fun <- function(file) {
-  cloud_validate_file_path(file)
+  check_path(file)
   ext <- tolower(tools::file_ext(file))
   if (ext == "") stop("Missing file extension, unable to guess writing function.")
   fun <- switch (
@@ -47,7 +47,7 @@ cloud_guess_write_fun <- function(file) {
 #' @description Take a look at the switch call. That's basically it. Returns an
 #'   appropriate function or throws an error if wasn't able to find one.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' 
 #' @section Default reading functions:
 #' 
@@ -64,7 +64,7 @@ cloud_guess_write_fun <- function(file) {
 #' 
 #' @keywords internal
 cloud_guess_read_fun <- function(file) {
-  cloud_validate_file_path(file)
+  check_path(file)
   ext <- tolower(tools::file_ext(file))
   if (ext == "") stop("Missing file extension, unable to guess reading function.")
   fun <- switch (

R/s3_transfer.R

@@ -3,7 +3,7 @@
 #' @description Uploads a local file from the project's directory to its
 #'   corresponding location within the project's S3 root folder.
 #' 
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_s3_ls
 #'  
 #' @return Invisibly returns `NULL` after successfully uploading the file.
@@ -21,7 +21,7 @@
 #' 
 #' @export
 cloud_s3_upload <- function(file, root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
 
   check_string(root, alt_null = TRUE)
   if (is.null(root)) root <- cloud_s3_get_root()
@@ -51,7 +51,7 @@ cloud_s3_upload <- function(file, root = NULL) {
 #' @description Retrieves a file from the project's S3 root folder and saves it
 #'   to the local project folder, maintaining the original folder structure.
 #' 
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_s3_ls
 #' 
 #' @return Invisibly returns `NULL` after successfully downloading the file.
@@ -66,7 +66,7 @@ cloud_s3_upload <- function(file, root = NULL) {
 #' 
 #' @export
 cloud_s3_download <- function(file, root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
 
   check_string(root, alt_null = TRUE)
   if (is.null(root)) root <- cloud_s3_get_root()
@@ -90,7 +90,7 @@ cloud_s3_download <- function(file, root = NULL) {
 #'   S3 storage. If no custom writing function is specified, the function will
 #'   infer the appropriate writing method based on the file's extension.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_s3_ls
 #' 
 #' @param x An R object to be written to S3.
@@ -115,7 +115,7 @@ cloud_s3_download <- function(file, root = NULL) {
 #' @export
 cloud_s3_write <- function(x, file, fun = NULL, ..., local = FALSE,
                          root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
   check_bool(local)
   check_class(fun, "function", alt_null = TRUE)
   check_string(root, alt_null = TRUE)
@@ -158,7 +158,7 @@ cloud_s3_write <- function(x, file, fun = NULL, ..., local = FALSE,
 #'   function based on the file's extension. However, you can specify a custom
 #'   reading function if necessary.
 #'   
-#' @inheritParams cloud_validate_file_path
+#' @inheritParams doc_file
 #' @inheritParams cloud_s3_ls
 #' 
 #' @param fun A custom reading function. If `NULL` (default), the appropriate
@@ -179,7 +179,7 @@ cloud_s3_write <- function(x, file, fun = NULL, ..., local = FALSE,
 #' 
 #' @export
 cloud_s3_read <- function(file, fun = NULL, ..., root = NULL) {
-  cloud_validate_file_path(file)
+  check_path(file)
   check_string(root, alt_null = TRUE)
 
   if (is.null(fun)) {