From f6c6f50969e0ab9be091c838075cd619570f70b3 Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Thu, 19 Oct 2023 11:29:55 -0600 Subject: [PATCH] Add new `urls` to metadata (#795) * Add new `urls` to metadata * Redocument * Update tests * Add URLs to Connect preview * Update NEWS * Update html bundle tests * Apply suggestions from code review Co-authored-by: Hadley Wickham * Only run these tests for inputs once (not every backend) * Back to using {{{urls}}} in html preview * Update tests * Remove unnecessary parens --------- Co-authored-by: Hadley Wickham --- NEWS.md | 2 ++ R/board_connect_bundle.R | 2 ++ R/meta.R | 4 +++- R/pin-meta.R | 13 +++---------- R/pin-read-write.R | 7 ++++++- inst/preview/index.html | 7 ++++++- man/pin_meta.Rd | 1 + man/pin_read.Rd | 4 ++++ tests/testthat/_snaps/board_azure_adls2.md | 16 ---------------- tests/testthat/_snaps/board_azure_blob.md | 16 ---------------- tests/testthat/_snaps/board_azure_file.md | 16 ---------------- tests/testthat/_snaps/board_connect.md | 8 -------- tests/testthat/_snaps/board_connect_bundle.md | 14 +++++++++++--- tests/testthat/_snaps/board_folder.md | 8 -------- tests/testthat/_snaps/board_gcs.md | 8 -------- tests/testthat/_snaps/board_gdrive.md | 8 -------- tests/testthat/_snaps/board_s3.md | 8 -------- tests/testthat/_snaps/meta.md | 3 ++- tests/testthat/_snaps/pin-read-write.md | 15 +++++++++++++++ tests/testthat/test-board_connect_bundle.R | 3 ++- tests/testthat/test-pin-read-write.R | 3 +++ 21 files changed, 60 insertions(+), 106 deletions(-) diff --git a/NEWS.md b/NEWS.md index abe96f47f..849c8c40c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -9,6 +9,8 @@ * Removed content and user caches for Connect altogether. Now, we look up usernames and content on the Connect server every time (#793). +* Added new `urls` item to metadata for a pin (#795). + # pins 1.2.2 * Fixed how dots are checked in `pin_write()` to make user-facing messages more diff --git a/R/board_connect_bundle.R b/R/board_connect_bundle.R index abf827bcb..9d72b059f 100644 --- a/R/board_connect_bundle.R +++ b/R/board_connect_bundle.R @@ -60,6 +60,8 @@ rsc_bundle_preview_index <- function(board, name, x, metadata) { pin_files = paste0("", metadata$file, "", collapse = ", "), data_preview = jsonlite::toJSON(data_preview, auto_unbox = TRUE), data_preview_style = if (is.data.frame(x)) "" else "display:none", + urls = paste0("", metadata$urls, "", collapse = ", "), + url_preview_style = if (!is.null(metadata$urls)) "" else "display:none", pin_name = paste0(owner, "/", name$name), pin_metadata = list( as_yaml = yaml::as.yaml(metadata), diff --git a/R/meta.R b/R/meta.R index 981bbfec1..ea0aff026 100644 --- a/R/meta.R +++ b/R/meta.R @@ -36,7 +36,8 @@ standard_meta <- function(paths, type, title = NULL, description = NULL, - tags = NULL) { + tags = NULL, + urls = NULL) { list( file = fs::path_file(paths), file_size = as.integer(fs::file_size(paths)), @@ -45,6 +46,7 @@ standard_meta <- function(paths, title = title, description = description, tags = if (is.null(tags)) tags else as.list(tags), + urls = if (is.null(urls)) urls else as.list(urls), created = format(Sys.time(), "%Y%m%dT%H%M%SZ", tz = "UTC"), api_version = 1L ) diff --git a/R/pin-meta.R b/R/pin-meta.R index 74c868553..7eb1fa3d3 100644 --- a/R/pin-meta.R +++ b/R/pin-meta.R @@ -12,6 +12,7 @@ #' * `$title` - pin title #' * `$description` - pin description #' * `$tags` - pin tags +#' * `$urls` - URLs for more info on pin #' * `$created` - date this (version of the pin) was created #' * `$api_version` - API version used by pin #' @@ -97,12 +98,13 @@ empty_local_meta <- local_meta(x = NULL, name = NULL, dir = NULL) test_api_meta <- function(board) { testthat::test_that("can round-trip pin metadata", { - name <- local_pin(board, 1, title = "title", description = "desc", metadata = list(a = "a"), tags = c("tag1", "tag2")) + name <- local_pin(board, 1, title = "title", description = "desc", metadata = list(a = "a"), tags = c("tag1", "tag2"), urls = "https://posit.co/") meta <- pin_meta(board, name) testthat::expect_equal(meta$name, name) testthat::expect_equal(meta$title, "title") testthat::expect_equal(meta$description, "desc") testthat::expect_equal(meta$tags, c("tag1", "tag2")) + testthat::expect_equal(meta$urls, "https://posit.co/") testthat::expect_equal(meta$user$a, "a") }) @@ -129,15 +131,6 @@ test_api_meta <- function(board) { ) }) - testthat::test_that("metadata checking functions give correct errors", { - testthat::expect_snapshot_error( - local_pin(board, 1, title = "title", tags = list(a = "a")) - ) - testthat::expect_snapshot_error( - local_pin(board, 1, title = "title", metadata = c("tag1", "tag2")) - ) - }) - testthat::test_that("pin_meta() returns pins_meta object", { name <- local_pin(board, 1) diff --git a/R/pin-read-write.R b/R/pin-read-write.R index a7405c134..2d2fb0d5d 100644 --- a/R/pin-read-write.R +++ b/R/pin-read-write.R @@ -64,6 +64,8 @@ pin_read <- function(board, name, version = NULL, hash = NULL, ...) { #' use the default for `board` #' @param tags A character vector of tags for the pin; most important for #' discoverability on shared boards. +#' @param urls A character vector of URLs for more info on the pin, such as a +#' link to a wiki or other documentation. #' @param force_identical_write Store the pin even if the pin contents are #' identical to the last version (compared using the hash). Only the pin #' contents are compared, not the pin metadata. Defaults to `FALSE`. @@ -78,6 +80,7 @@ pin_write <- function(board, x, metadata = NULL, versioned = NULL, tags = NULL, + urls = NULL, force_identical_write = FALSE) { check_board(board, "pin_write", "pin") dots <- list2(...) @@ -96,6 +99,7 @@ pin_write <- function(board, x, } check_metadata(metadata) check_character(tags, allow_null = TRUE) + check_character(urls, allow_null = TRUE) if (!is_string(name)) { abort("`name` must be a string") } @@ -114,7 +118,8 @@ pin_write <- function(board, x, type = type, title = title %||% default_title(name, data = x), description = description, - tags = tags + tags = tags, + urls = urls ) meta$user <- metadata diff --git a/inst/preview/index.html b/inst/preview/index.html index 972dc576c..1486461ba 100644 --- a/inst/preview/index.html +++ b/inst/preview/index.html @@ -44,7 +44,12 @@

{{{pin_name}}}

{{{as_yaml}}}
{{/pin_metadata}} - + + +
+

Learn more about this pin at:

+

{{{urls}}}

+

R Code

diff --git a/man/pin_meta.Rd b/man/pin_meta.Rd index ed93c0f20..844b555a4 100644 --- a/man/pin_meta.Rd +++ b/man/pin_meta.Rd @@ -33,6 +33,7 @@ Pin metadata comes from three sources: \item \verb{$title} - pin title \item \verb{$description} - pin description \item \verb{$tags} - pin tags +\item \verb{$urls} - URLs for more info on pin \item \verb{$created} - date this (version of the pin) was created \item \verb{$api_version} - API version used by pin } diff --git a/man/pin_read.Rd b/man/pin_read.Rd index fdc806970..f3b28cad5 100644 --- a/man/pin_read.Rd +++ b/man/pin_read.Rd @@ -18,6 +18,7 @@ pin_write( metadata = NULL, versioned = NULL, tags = NULL, + urls = NULL, force_identical_write = FALSE ) } @@ -60,6 +61,9 @@ use the default for \code{board}} \item{tags}{A character vector of tags for the pin; most important for discoverability on shared boards.} +\item{urls}{A character vector of URLs for more info on the pin, such as a +link to a wiki or other documentation.} + \item{force_identical_write}{Store the pin even if the pin contents are identical to the last version (compared using the hash). Only the pin contents are compared, not the pin metadata. Defaults to \code{FALSE}.} diff --git a/tests/testthat/_snaps/board_azure_adls2.md b/tests/testthat/_snaps/board_azure_adls2.md index a3971384b..f06a1602e 100644 --- a/tests/testthat/_snaps/board_azure_adls2.md +++ b/tests/testthat/_snaps/board_azure_adls2.md @@ -12,22 +12,6 @@ Output [1] "AzureStor" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - ---- - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # can deparse Code diff --git a/tests/testthat/_snaps/board_azure_blob.md b/tests/testthat/_snaps/board_azure_blob.md index 7a511ff3a..d68417e63 100644 --- a/tests/testthat/_snaps/board_azure_blob.md +++ b/tests/testthat/_snaps/board_azure_blob.md @@ -12,22 +12,6 @@ Output [1] "AzureStor" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - ---- - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # can deparse Code diff --git a/tests/testthat/_snaps/board_azure_file.md b/tests/testthat/_snaps/board_azure_file.md index e47235025..b284e169a 100644 --- a/tests/testthat/_snaps/board_azure_file.md +++ b/tests/testthat/_snaps/board_azure_file.md @@ -12,22 +12,6 @@ Output [1] "AzureStor" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - ---- - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # can deparse Code diff --git a/tests/testthat/_snaps/board_connect.md b/tests/testthat/_snaps/board_connect.md index 611dfe1c9..b93b3d907 100644 --- a/tests/testthat/_snaps/board_connect.md +++ b/tests/testthat/_snaps/board_connect.md @@ -5,14 +5,6 @@ Output [1] "rsconnect" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # get useful error for rebranding `board_rsconnect()` was deprecated in pins 1.1.0. diff --git a/tests/testthat/_snaps/board_connect_bundle.md b/tests/testthat/_snaps/board_connect_bundle.md index 1655f40bd..356b78e28 100644 --- a/tests/testthat/_snaps/board_connect_bundle.md +++ b/tests/testthat/_snaps/board_connect_bundle.md @@ -38,7 +38,7 @@ Format: rds • API: v1.0

-

+

Some simple data to test with

Download data: test.csv

Raw metadata @@ -47,14 +47,22 @@ pin_hash: 77fee172a9275a62 type: rds title: 'test: a pinned 2 x 2 data frame' - desctiption: Some simple data to test with + description: Some simple data to test with + urls: + - https://posit.co/ + - https://www.tidyverse.org/ created: 20211111T113956Z api_version: '1.0' user: my_meta: User defined metadata
-
+ + +
+

Learn more about this pin at:

+

https://posit.co/, https://www.tidyverse.org/

+

R Code

diff --git a/tests/testthat/_snaps/board_folder.md b/tests/testthat/_snaps/board_folder.md index bd47b491e..dfa7c3dc7 100644 --- a/tests/testthat/_snaps/board_folder.md +++ b/tests/testthat/_snaps/board_folder.md @@ -5,14 +5,6 @@ Output character(0) -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # has useful print method Code diff --git a/tests/testthat/_snaps/board_gcs.md b/tests/testthat/_snaps/board_gcs.md index 9155a1b47..833f330df 100644 --- a/tests/testthat/_snaps/board_gcs.md +++ b/tests/testthat/_snaps/board_gcs.md @@ -12,14 +12,6 @@ Output [1] "googleCloudStorageR" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # can deparse Code diff --git a/tests/testthat/_snaps/board_gdrive.md b/tests/testthat/_snaps/board_gdrive.md index b853e8249..a7ccae00b 100644 --- a/tests/testthat/_snaps/board_gdrive.md +++ b/tests/testthat/_snaps/board_gdrive.md @@ -5,11 +5,3 @@ Output [1] "googledrive" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - diff --git a/tests/testthat/_snaps/board_s3.md b/tests/testthat/_snaps/board_s3.md index 1dd61a296..f251761df 100644 --- a/tests/testthat/_snaps/board_s3.md +++ b/tests/testthat/_snaps/board_s3.md @@ -12,14 +12,6 @@ Output [1] "paws.storage" -# metadata checking functions give correct errors - - `tags` must be a character vector or `NULL`, not a list. - ---- - - `metadata` must be a list or `NULL`, not a character vector. - # can deparse Code diff --git a/tests/testthat/_snaps/meta.md b/tests/testthat/_snaps/meta.md index 8d5874c60..f0b12bc8a 100644 --- a/tests/testthat/_snaps/meta.md +++ b/tests/testthat/_snaps/meta.md @@ -1,6 +1,6 @@ # standard metadata is useful - List of 9 + List of 10 $ file : chr "df.rds" $ file_size : int 200 $ pin_hash : chr "db696042be80dbb4" @@ -8,6 +8,7 @@ $ title : chr "title" $ description: NULL $ tags : NULL + $ urls : NULL $ created : chr "" $ api_version: int 1 diff --git a/tests/testthat/_snaps/pin-read-write.md b/tests/testthat/_snaps/pin-read-write.md index dc94ca7ac..ee714194a 100644 --- a/tests/testthat/_snaps/pin-read-write.md +++ b/tests/testthat/_snaps/pin-read-write.md @@ -34,6 +34,21 @@ Condition Error in `pin_write()`: ! `metadata` must be a list or `NULL`, not the number 1. + Code + pin_write(board, mtcars, title = "title", tags = list(a = "a")) + Condition + Error in `pin_write()`: + ! `tags` must be a character vector or `NULL`, not a list. + Code + pin_write(board, mtcars, title = "title", urls = list(a = "a")) + Condition + Error in `pin_write()`: + ! `urls` must be a character vector or `NULL`, not a list. + Code + pin_write(board, mtcars, title = "title", metadata = c("tag1", "tag2")) + Condition + Error in `pin_write()`: + ! `metadata` must be a list or `NULL`, not a character vector. # pin_write() noisily generates name and type diff --git a/tests/testthat/test-board_connect_bundle.R b/tests/testthat/test-board_connect_bundle.R index 02c02edae..f3b2583b6 100644 --- a/tests/testthat/test-board_connect_bundle.R +++ b/tests/testthat/test-board_connect_bundle.R @@ -28,7 +28,8 @@ test_that("generates index files", { pin_hash = "77fee172a9275a62", type = "rds", title = "test: a pinned 2 x 2 data frame", - desctiption = "Some simple data to test with", + description = "Some simple data to test with", + urls = c("https://posit.co/", "https://www.tidyverse.org/"), created = "20211111T113956Z", api_version = "1.0", user = list(my_meta = "User defined metadata") diff --git a/tests/testthat/test-pin-read-write.R b/tests/testthat/test-pin-read-write.R index 0ba840500..1867c7145 100644 --- a/tests/testthat/test-pin-read-write.R +++ b/tests/testthat/test-pin-read-write.R @@ -44,6 +44,9 @@ test_that("useful errors on bad inputs", { pin_write(board, mtcars, name = "mtcars", "json") pin_write(board, mtcars, name = "mtcars", type = "froopy-loops") pin_write(board, mtcars, name = "mtcars", metadata = 1) + pin_write(board, mtcars, title = "title", tags = list(a = "a")) + pin_write(board, mtcars, title = "title", urls = list(a = "a")) + pin_write(board, mtcars, title = "title", metadata = c("tag1", "tag2")) }) })