vectorise textVersion of bib entries

NEWS.md

@@ -1,5 +1,8 @@
 # pkgdown (development version)
 
+* Better handling for mix of citations with and without text version. Also
+  escapes HTML in the text version (@bastistician, #1507).
+
 * Make links of 404's navbar absolute (#1524).
 
 * Make navbar specification more flexible: it is now possible to not include 
@@ -9,6 +12,7 @@
     * change the placement of elements on the left and right
     * add text to the left and right (or even remove/replace default text)
   (#1502)
+
 * pkgdown now recognizes GitLab URLs to the source repository and adds the corresponding icon
   to the navbar (#1493). 
 

R/build-home-citation.R

@@ -45,19 +45,16 @@ data_citations <- function(pkg = ".") {
   cit <- read_citation(pkg$src_path)
 
   text_version <- format(cit, style = "textVersion")
-  if (identical(text_version, "")) {
-    cit <- list(
-      html = format(cit, style = "html"),
-      bibtex = format(cit, style = "bibtex")
-    )
-  } else {
-    cit <- list(
-      html = paste0("<p>",text_version, "</p>"),
-      bibtex = format(cit, style = "bibtex")
-    )
-  }
+  cit <- list(
+    html = ifelse(
+      text_version == "",
+      format(cit, style = "html"),
+      paste0("<p>", escape_html(text_version), "</p>")
+    ),
+    bibtex = format(cit, style = "bibtex")
+  )
 
-   purrr::transpose(cit)
+  purrr::transpose(cit)
 }
 
 build_citation_authors <- function(pkg = ".") {

tests/testthat/_snaps/build-citation-authors.md

@@ -0,0 +1,19 @@
+# multiple citations all have HTML and BibTeX formats
+
+    [[1]]
+    [[1]]$html
+    [1] "<p>A &amp; B (2021): Proof of b &lt; a &gt; c.</p>"
+
+    [[1]]$bibtex
+    [1] "@Misc{,\n  title = {Proof of b < a > c},\n  author = {{A} and {B}},\n  year = {2021},\n}"
+
+
+    [[2]]
+    [[2]]$html
+    [1] "<p>Two A (2022).\n&ldquo;Title Two.&rdquo; \n</p>"
+
+    [[2]]$bibtex
+    [1] "@Misc{,\n  title = {Title Two},\n  author = {Author Two},\n  year = {2022},\n}"
+
+
+

tests/testthat/assets/site-citation/multi/DESCRIPTION

@@ -0,0 +1,6 @@
+Package: testpackage
+Title: A test package
+Version: 1.0.0
+Author: Sebastian Meyer
+Maintainer: Sebastian Meyer <noreply@example.org>
+Description: Test multiple citations.

tests/testthat/assets/site-citation/multi/inst/CITATION

@@ -0,0 +1,3 @@
+bibentry("misc", title="Proof of b < a > c", author=c("A", "B"), year="2021",
+         textVersion="A & B (2021): Proof of b < a > c.")
+bibentry("misc", title="Title Two", author="Author Two", year="2022")

tests/testthat/test-build-citation-authors.R

@@ -34,3 +34,10 @@ test_that("source link is added to citation page", {
   lines <- read_lines(path(path, "docs", "authors.html"))
   expect_true(any(grepl("<code>inst/CITATION</code></a></small>", lines)))
 })
+
+test_that("multiple citations all have HTML and BibTeX formats", {
+  path <- test_path("assets/site-citation/multi")
+  citations <- data_citations(path)
+  expect_equal(lengths(citations), c(2, 2))
+  expect_snapshot_output(citations)
+})