Only remove trailing slashes in tidyverse_url() (#1527)

* Don't use ui_*() functions inside ui_code_block()

* only remove trailing slash in tv urls

* `site_url` doesn't exist yet

* Be less opinionated about trailing slash

* Don't strip trailing slash in pkgdown_url()

* Add a NEWS bullet

* Add a test

Co-authored-by: Jenny Bryan <[email protected]>

Author: malcolmbarrett

NEWS.md

@@ -1,5 +1,7 @@
 # usethis (development version)
 
+pkgdown-related functions no longer automatically strip a trailing slash from the pkgdown site URL, in order to play more nicely with CRAN's URL checks (#1526).
+
 `edit_pkgdown_config()` is a new function that opens the pkgdown YAML configuration file for the current Project, if such a file exists.
 
 The error thrown when reporting an unsupported GitHub configuration has been fixed for forward compatibility with a future version of rlang, i.e. what is anticipated to be rlang v1.0.0.

R/code-of-conduct.R

@@ -42,6 +42,7 @@ use_code_of_conduct <- function(contact, path = NULL) {
 
   href <- pkgdown_url(pedantic = TRUE) %||%
     "https://contributor-covenant.org/version/2/0"
+  href <- sub("/$", "", href)
   href <- paste0(href, "/CODE_OF_CONDUCT.html")
 
   ui_todo("Don't forget to describe the code of conduct in your README:")

R/pkgdown.R

@@ -74,8 +74,7 @@ use_pkgdown_github_pages <- function() {
   site <- use_github_pages()
   use_github_action("pkgdown")
 
-  site_url <- sub("/$", "", site$html_url)
-  site_url <- tidyverse_url(url = site_url, tr = tr)
+  site_url <- tidyverse_url(url = site$html_url, tr = tr)
   use_pkgdown_url(url = site_url, tr = tr)
 
   if (tr$repo_owner %in% c("tidyverse", "tidymodels", "r-lib")) {
@@ -124,13 +123,14 @@ tidyverse_url <- function(url, tr = NULL) {
       !tr$repo_owner %in% c("tidyverse", "r-lib", "tidymodels")) {
     return(url)
   }
+
   custom_url <- glue("https://{tr$repo_name}.{tr$repo_owner}.org")
-  if (url == custom_url) {
+  if (grepl(glue("{custom_url}/?"), url)) {
     return(url)
   }
   if (ui_yeah("
     {ui_value(tr$repo_name)} is owned by the {ui_value(tr$repo_owner)} GitHub \\
-    organization
+    organization.
     Shall we configure {ui_value(custom_url)} as the (eventual) \\
     pkgdown URL?")) {
     custom_url
@@ -173,16 +173,16 @@ pkgdown_url <- function(pedantic = FALSE) {
 
   meta <- pkgdown_config_meta()
   url <- meta$url
-  if (is.null(url)) {
-    if (pedantic) {
-      ui_warn("
-        pkgdown config does not specify the site's {ui_field('url')}, \\
-        which is optional but recommended")
-    }
-    NULL
-  } else {
-    gsub("/$", "", url)
+  if (!is.null(url)) {
+    return(url)
   }
+
+  if (pedantic) {
+    ui_warn("
+      pkgdown config does not specify the site's {ui_field('url')}, \\
+      which is optional but recommended")
+  }
+    NULL
 }
 
 # travis ----

tests/testthat/test-pkgdown.R

@@ -67,6 +67,12 @@ test_that("pkgdown_url() returns correct data, warns if pedantic", {
   expect_equal(pkgdown_url(), "https://usethis.r-lib.org")
 
   # config has url with trailing slash
-  writeLines("url: https://usethis.r-lib.org/", pkgdown_config_path())
-  expect_equal(pkgdown_url(), "https://usethis.r-lib.org")
+  writeLines("url: https://malcolmbarrett.github.io/tidysmd/", pkgdown_config_path())
+  expect_equal(pkgdown_url(), "https://malcolmbarrett.github.io/tidysmd/")
+})
+
+test_that("tidyverse_url() leaves trailing slash alone, almost always", {
+  url <- "https://malcolmbarrett.github.io/tidysmd/"
+  out <- tidyverse_url(url, tr = list(repo_name = "REPO", repo_owner = "OWNER"))
+  expect_equal(out, url)
 })