tests/testthat/test-object-package.R

In roxygen2: In-Line Documentation for R

test_that("person turned into meaningful text", {
  person_desc <- function(
    given = "H",
    family = "W",
    email = "h@w.com",
    role = "aut",
    comment = NULL
  ) {
    out <- person(
      given = given,
      family = family,
      email = email,
      role = role,
      comment = comment
    )
    author_desc(unclass(out)[[1]])
  }

  expect_snapshot({
    "Multiple given/family names"
    person_desc(c("First", "Second"), c("Family1", "Family2"))

    "Multiple roles"
    person_desc(role = "ctb")

    "ORCID comments"
    person_desc(comment = c("ORCID" = "0000-0003-4757-117X"))
    person_desc(comment = c("ORCID" = "https://orcid.org/0000-0003-4757-117X"))
    person_desc(comment = c("ORCID" = "0000-0003-4757-117X", "extra"))

    "ROR comments"
    person_desc(comment = c("ROR" = "03wc8by49"))
    person_desc(comment = c("ROR" = "https://ror.org/03wc8by49"))
    person_desc(comment = c("ROR" = "03wc8by49", "extra"))

    "Arbitrary comments (#1746)"
    person_desc(comment = c(acronym = "rajo", "Contributed XY"))
    person_desc(comment = c("comment 1", "comment 2"))
  })
})

test_that("cre+aut person appears in both maintainer and authors (#1588)", {
  authors <- 'c(
    person("A", "B", role = c("aut", "cre"), email = "a@b.com"),
    person("C", "D", role = "aut")
  )'
  out <- package_authors(authors)
  expect_match(out, "Maintainer.*A B")
  expect_match(out, "Authors.*A B")
  expect_match(out, "Authors.*C D")
})

test_that("useful message if Authors@R is corrupted", {
  expect_snapshot({
    package_authors("1 + ")
    package_authors("stop('Uhoh')")
  })
})

test_that("can convert quote percentage signs in urls", {
  expect_equal(
    package_seealso_urls("https://www.foo.bar/search?q=see%20also"),
    "\\url{https://www.foo.bar/search?q=see\\%20also}"
  )

  expect_equal(
    package_seealso_urls(
      BugReports = "https://www.foo.bar/search?q=bug%20report"
    ),
    "Report bugs at \\url{https://www.foo.bar/search?q=bug\\%20report}"
  )
})

test_that("can convert DOIs in url", {
  expect_equal(
    package_seealso_urls("https://doi.org/10.5281/zenodo.1485309"),
    "\\doi{10.5281/zenodo.1485309}"
  )
})

test_that("annotated URLs are extracted correctly (#1420)", {
  expect_equal(
    package_seealso_urls("https://x (XYZ), https://u (ABC)"),
    c("\\url{https://x} (XYZ)", "\\url{https://u} (ABC)")
  )
})

test_that("can autolink urls on package Description", {
  expect_equal(
    package_url_parse("x <https://x.com> y"),
    "x \\url{https://x.com} y"
  )
  expect_equal(
    package_url_parse("x <https://x.com/%3C-%3E> y"),
    "x \\url{https://x.com/\\%3C-\\%3E} y"
  )
})

test_that("can autolink DOIs", {
  expect_equal(package_url_parse("x <doi:abcdef> y"), "x \\doi{abcdef} y")
  expect_equal(package_url_parse("x <DOI:abcdef> y"), "x \\doi{abcdef} y")
  # URL-decodes %XX sequences since \doi{} can't contain % (#1321)
  expect_equal(package_url_parse("x <DOI:%3C-%3E> y"), "x \\doi{<->} y")
  expect_equal(
    package_url_parse(
      "x <doi:10.1175/1520-0469(1996)053%3C2365:PORWON%3E2.0.CO;2>"
    ),
    "x \\doi{10.1175/1520-0469(1996)053<2365:PORWON>2.0.CO;2}"
  )
})

test_that("can autolink arxiv", {
  expect_equal(
    package_url_parse("x <arXiv:abc> y"),
    "x \\href{https://arxiv.org/abs/abc}{arXiv:abc} y"
  )
  expect_equal(
    package_url_parse("x <arxiv:abc> y"),
    "x \\href{https://arxiv.org/abs/abc}{arXiv:abc} y"
  )
  expect_equal(
    package_url_parse("x <arxiv:abc [def]> y"),
    "x \\href{https://arxiv.org/abs/abc}{arXiv:abc [def]} y"
  )
})

test_that("autolink several matching patterns", {
  text <- "url <http://a.com> doi <doi:xx> arxiv <arXiv:xx>"
  expect_equal(
    package_url_parse(text),
    paste(
      "url \\url{http://a.com}",
      "doi \\doi{xx}",
      "arxiv \\href{https://arxiv.org/abs/xx}{arXiv:xx}"
    )
  )
})

test_that("multiple email addresses for a person are acceptable #1487", {
  me <- person("me", email = c("one@email.me", "two@email.me"))
  expect_equal(
    author_desc(unclass(me)[[1]]),
    "me \\email{one@email.me} \\email{two@email.me}"
  )
})