R/gist.R

In gadenbuie/rsprefs: Manage and Sync Your RStudio Preferences

gist <- function(id, file = "user-prefs.json") {
  structure(
    list(id = id, file = file),
    class = "rsprefs_gist"
  )
}

is_gist <- function(x) {
  inherits(x, "rsprefs_gist")
}

maybe_gist <- function(x) {
  if (is_gist(x) || !is.character(x)) {
    return(x)
  }
  if (fs::file_exists(x)) {
    return(x)
  }
  if (grepl("[^0-9a-f]", x) || nchar(x) < 8) {
    return(x)
  }
  gist(x)
}

#' @export
print.rsprefs_gist <- function(x, ...) {
  url <- gist_url_html(x)
  cli::cli_inform("{.url {url}}")
}

#' @export
as.character.rsprefs_gist <- function(x, ...) {
  gist_url_html(x)
}

gist_url_html <- function(gist) {
  gist <- maybe_gist(gist)
  stopifnot(is_gist(gist))
  sprintf("https://gist.github.com/%s", gist$id)
}

gist_get <- function(gist) {
  gh_has_gist_scope()

  gist <- maybe_gist(gist)
  stopifnot(is_gist(gist))
  tryCatch(
    gh::gh("/gists/{gist_id}", gist_id = gist$id),
    http_error_404 = function(err) {
      cli::cli_abort(
        "Gist {.field {gist$id}} does not exist.",
        parent = err,
        class = "http_error_404"
      )
    },
    error = function(err) {
      cli::cli_abort(
        c(
          "Could not get gist {.field {gist$id}}. Does that gist exist?",
          "*" = "{.url {gist_url_html(gist)}}"
        ),
        parent = err
      )
    }
  )
}

gist_prefs_read <- function(gist = NULL) {
  gh_has_gist_scope()

  gist <- maybe_gist(gist %||% prefs_gist_default())
  stopifnot(is_gist(gist))

  x <- gist_get(gist)

  if (!gist$file %in% names(x[["files"]])) {
    cli::cli_abort("{.file {gist$file}} is not a file in gist {.field {gist$id}}")
  }

  if (!identical(x[["files"]][[gist$file]][["type"]], "application/json")) {
    cli::cli_abort("{.file {gist$file}} is not a JSON file in gist {.field {gist$id}}")
  }

  contents <- x[["files"]][[gist$file]][["content"]]
  tmpfile <- fs::file_temp(ext = "json")
  on.exit(fs::file_delete(tmpfile))
  writeLines(contents, tmpfile)

  jsonlite::read_json(tmpfile)
}

gist_prefs_write <- function(prefs, gist = NULL) {
  gh_has_gist_scope()

  gist <- maybe_gist(gist %||% prefs_gist_default())
  stopifnot(is_gist(gist))

  x <- gist_get(gist)

  files <- list()
  files[[gist[["file"]]]] <- list(
    content = jsonlite::toJSON(prefs, null = "null", auto_unbox = TRUE, pretty = 2)
  )

  res <- gh::gh(
    "PATCH /gists/{gist_id}",
    gist_id = gist$id,
    .params = list(files = files)
  )
  cli::cli_alert_success("Updated {.file {gist$file}} in gist {.field {gist$id}}")
  invisible(res)
}

gist_prefs_create <- function(prefs, file = "user-prefs.json", public = FALSE, browse = TRUE) {
  gh_has_gist_scope()

  files <- list()
  files[[file]] <- list(
    content = jsonlite::toJSON(prefs, null = "null", auto_unbox = TRUE, pretty = 2)
  )

  cli::cli_process_start("Creating gist with {.path {file}}")

  res <- gh::gh(
    "POST /gists",
    .params = list(
      files = files,
      public = isTRUE(public),
      description = "{rsprefs} RStudio Preferences Sync"
    )
  )

  cli::cli_alert_success("Created gist with id {.field {res$id}}")
  cli::cli_alert_info("Use this gist automatically by adding the following to your {.path ~/.Rprofile}.")
  cli::cli_text("Call {.code usethis::edit_r_profile()}")
  cli::cli_text("")
  cli::cli_text('\t\toptions(rsprefs.gist_id = "{res$id}")')
  cli::cli_text("")

  if (isTRUE(browse)) {
    utils::browseURL(res$html_url)
  }

  invisible(res)
}

gh_has_gist_scope <- function() {
  user <- gh::gh_whoami()

  scopes <- strsplit(gh::gh_whoami()$scopes, ",\\s*")[[1]]
  if (!"gist" %in% scopes) {
    cli::cli_abort(c(
      "Your GitHub token ({.field {user$token}}) doesn't include the {.strong gist} ",
      "scope. You can add {.strong gists} to the scope of your token from ",
      "the settings page at {.url https://github.com/settings/tokens}."
    ), wrap = TRUE)
  }

  invisible(TRUE)
}