use_air() (#466)

* use_air()

* Format the workspace

* Add the format-suggest workflow but temporarily pin it

I pinned reviewdog/[email protected] as a temporary workaround for reviewdog/action-suggester#95, but the usual version tag is just `v1`

Author: jennybc

.Rbuildignore

@@ -25,3 +25,5 @@
 ^\.covrignore$
 ^tests/testthat/all-test.+
 ^CRAN-SUBMISSION$
+^[.]?air[.]toml$
+^\.vscode$

.github/workflows/format-suggest.yaml

@@ -0,0 +1,46 @@
+# Workflow derived from https://github.com/posit-dev/setup-air/tree/main/examples
+
+on:
+  # Using `pull_request_target` over `pull_request` for elevated `GITHUB_TOKEN`
+  # privileges, otherwise we can't set `pull-requests: write` when the pull
+  # request comes from a fork, which is our main use case (external contributors).
+  #
+  # `pull_request_target` runs in the context of the target branch (`main`, usually),
+  # rather than in the context of the pull request like `pull_request` does. Due
+  # to this, we must explicitly checkout `ref: ${{ github.event.pull_request.head.sha }}`.
+  # This is typically frowned upon by GitHub, as it exposes you to potentially running
+  # untrusted code in a context where you have elevated privileges, but they explicitly
+  # call out the use case of reformatting and committing back / commenting on the PR
+  # as a situation that should be safe (because we aren't actually running the untrusted
+  # code, we are just treating it as passive data).
+  # https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/
+  pull_request_target:
+
+name: format-suggest.yaml
+
+jobs:
+  format-suggest:
+    name: format-suggest
+    runs-on: ubuntu-latest
+
+    permissions:
+      # Required to push suggestion comments to the PR
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install
+        uses: posit-dev/setup-air@v1
+
+      - name: Format
+        run: air format .
+
+      - name: Suggest
+        uses: reviewdog/[email protected]
+        with:
+          level: error
+          fail_level: error
+          tool_name: air

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "Posit.air-vscode"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "[r]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "Posit.air-vscode"
+    },
+    "[quarto]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "quarto.quarto"
+    }
+}

R/aaa.R

@@ -3,7 +3,9 @@
 
 .drive$translate_mime_types <-
   system.file(
-    "extdata", "data", "translate_mime_types.csv",
+    "extdata",
+    "data",
+    "translate_mime_types.csv",
     package = "googledrive",
     mustWork = TRUE
   ) %>%
@@ -12,7 +14,9 @@
 
 .drive$mime_tbl <-
   system.file(
-    "extdata", "data", "mime_tbl.csv",
+    "extdata",
+    "data",
+    "mime_tbl.csv",
     package = "googledrive",
     mustWork = TRUE
   ) %>%
@@ -21,7 +25,9 @@
 
 .drive$files_fields <-
   system.file(
-    "extdata", "data", "files_fields.csv",
+    "extdata",
+    "data",
+    "files_fields.csv",
     package = "googledrive",
     mustWork = TRUE
   ) %>%

R/compat-vctrs.R

@@ -98,5 +98,11 @@ vec_cast.data.frame.dribble <- function(x, to, ..., x_arg = "", to_arg = "") {
 
 stop_incompatible_cast_dribble <- function(x, to, ..., x_arg, to_arg) {
   details <- "Can't cast to a <dribble> because the resulting structure is likely invalid."
-  stop_incompatible_cast(x, to, x_arg = x_arg, to_arg = to_arg, details = details)
+  stop_incompatible_cast(
+    x,
+    to,
+    x_arg = x_arg,
+    to_arg = to_arg,
+    details = details
+  )
 }

R/deprecated.R

@@ -48,7 +48,9 @@ drive_auth_config <- function(active, app, path, api_key) {
 #' @export
 drive_oauth_app <- function() {
   lifecycle::deprecate_warn(
-    "2.1.0", "drive_oauth_app()", "drive_oauth_client()"
+    "2.1.0",
+    "drive_oauth_app()",
+    "drive_oauth_client()"
   )
   drive_oauth_client()
 }

R/dribble.R

@@ -135,7 +135,9 @@ id_can_be_drive_id <- function(x) {
 has_drive_resource <- function(x) {
   kind <- map_chr(x$drive_resource, "kind", .default = NA_character_)
   # TODO: remove `drive#teamDrive` here, when possible
-  all(!is.na(kind) & kind %in% c("drive#file", "drive#drive", "drive#teamDrive"))
+  all(
+    !is.na(kind) & kind %in% c("drive#file", "drive#drive", "drive#teamDrive")
+  )
 }
 
 #' Coerce to a `dribble`
@@ -191,9 +193,11 @@ as_dribble <- function(x, ...) UseMethod("as_dribble")
 
 #' @export
 as_dribble.default <- function(x, ...) {
-  drive_abort("
+  drive_abort(
+    "
     Don't know how to coerce an object of class {.cls {class(x)}} into \\
-    a {.cls dribble}.")
+    a {.cls dribble}."
+  )
 }
 
 #' @export
@@ -374,7 +378,8 @@ is_folder_shortcut <- function(d) {
       d$drive_resource,
       c("shortcutDetails", "targetMimeType"),
       .default = ""
-    ) == "application/vnd.google-apps.folder")
+    ) ==
+      "application/vnd.google-apps.folder")
 }
 
 #' @export

R/drive_auth.R

@@ -7,11 +7,11 @@
 ## The roxygen comments for these functions are mostly generated from data
 ## in this list and template text maintained in gargle.
 gargle_lookup_table <- list(
-  PACKAGE     = "googledrive",
-  YOUR_STUFF  = "your Drive files",
-  PRODUCT     = "Google Drive",
-  API         = "Drive API",
-  PREFIX      = "drive"
+  PACKAGE = "googledrive",
+  YOUR_STUFF = "your Drive files",
+  PRODUCT = "Google Drive",
+  API = "Drive API",
+  PREFIX = "drive"
 )
 
 #' Authorize googledrive
@@ -59,12 +59,15 @@ gargle_lookup_table <- list(
 #'
 #' # use a service account token
 #' drive_auth(path = "foofy-83ee9e7c9c48.json")
-drive_auth <- function(email = gargle::gargle_oauth_email(),
-                       path = NULL, subject = NULL,
-                       scopes = "drive",
-                       cache = gargle::gargle_oauth_cache(),
-                       use_oob = gargle::gargle_oob_default(),
-                       token = NULL) {
+drive_auth <- function(
+  email = gargle::gargle_oauth_email(),
+  path = NULL,
+  subject = NULL,
+  scopes = "drive",
+  cache = gargle::gargle_oauth_cache(),
+  use_oob = gargle::gargle_oob_default(),
+  token = NULL
+) {
   gargle::check_is_service_account(path, hint = "drive_auth_configure")
   scopes <- drive_scopes(scopes)
   env_unbind(.googledrive, "root_folder")
@@ -205,15 +208,21 @@ drive_auth_configure <- function(client, path, api_key, app = deprecated()) {
   }
 
   if (!missing(client) && !missing(path)) {
-    drive_abort("Must supply exactly one of {.arg client} or {.arg path}, not both")
+    drive_abort(
+      "Must supply exactly one of {.arg client} or {.arg path}, not both"
+    )
   }
   stopifnot(missing(api_key) || is.null(api_key) || is_string(api_key))
 
   if (!missing(path)) {
     stopifnot(is_string(path))
     client <- gargle::gargle_oauth_client_from_json(path)
   }
-  stopifnot(missing(client) || is.null(client) || inherits(client, "gargle_oauth_client"))
+  stopifnot(
+    missing(client) ||
+      is.null(client) ||
+      inherits(client, "gargle_oauth_client")
+  )
 
   if (!missing(client) || !missing(path)) {
     .auth$set_client(client)
@@ -283,8 +292,7 @@ resolve_scopes <- function(user_scopes, package_scopes) {
 }
 
 # unexported helpers that are nice for internal use ----
-drive_auth_internal <- function(account = c("docs", "testing"),
-                                scopes = NULL) {
+drive_auth_internal <- function(account = c("docs", "testing"), scopes = NULL) {
   account <- match.arg(account)
   can_decrypt <- gargle::secret_has_key("GOOGLEDRIVE_KEY")
   online <- !is.null(curl::nslookup("drive.googleapis.com", error = FALSE))
@@ -296,15 +304,20 @@ drive_auth_internal <- function(account = c("docs", "testing"),
           c("x" = "Can't decrypt the {.field {account}} service account token.")
         },
         if (!online) {
-          c("x" = "We don't appear to be online. Or maybe the Drive API is down?")
+          c(
+            "x" = "We don't appear to be online. Or maybe the Drive API is down?"
+          )
         }
       ),
       class = "googledrive_auth_internal_error",
-      can_decrypt = can_decrypt, online = online
+      can_decrypt = can_decrypt,
+      online = online
     )
   }
 
-  if (!is_interactive()) local_drive_quiet()
+  if (!is_interactive()) {
+    local_drive_quiet()
+  }
   filename <- glue("googledrive-{account}.json")
   # TODO: revisit when I do PKG_scopes()
   # https://github.com/r-lib/gargle/issues/103

R/drive_cp.R

@@ -68,12 +68,14 @@
 #'
 #' # Clean up
 #' drive_rm(chicken_sheet)
-drive_cp <- function(file,
-                     path = NULL,
-                     name = NULL,
-                     ...,
-                     overwrite = NA,
-                     verbose = deprecated()) {
+drive_cp <- function(
+  file,
+  path = NULL,
+  name = NULL,
+  ...,
+  overwrite = NA,
+  verbose = deprecated()
+) {
   warn_for_verbose(verbose)
 
   file <- as_dribble(file)