Refactor tests

Author: dieghernan

NEWS.md

@@ -3,6 +3,7 @@
 - The JOSS paper is now linked as an external pkgdown article instead of being
   rebuilt as a package vignette.
 - `cff_gha_update()` now uses `path` when updating `.Rbuildignore`.
+- `cff_write()` now formats the `inst/CITATION` update message correctly.
 
 # cffr 1.4.1
 

R/cff_write.R

@@ -188,7 +188,11 @@ auto_r_citation <- function(
 
   # Otherwise update `inst/CITATION`.
   if (verbose) {
-    cli::cat_rule("Updating {.file inst/CITATION}", col = "cyan", line = 2)
+    cli::cat_rule(
+      cli::format_inline("Updating {.file inst/CITATION}"),
+      col = "cyan",
+      line = 2
+    )
   }
   cffobj <- cff_read(outfile)
   fpath <- "./inst/CITATION"

codemeta.json

@@ -234,7 +234,7 @@
   },
   "isPartOf": "https://ropensci.org",
   "keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "citation-file-format", "cran", "r", "r-package", "ropensci", "rstats", "r-cran"],
-  "fileSize": "986.856KB",
+  "fileSize": "983.123KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

tests/testthat/_snaps/cff_write.md

@@ -77,7 +77,7 @@
         given-names: Marc
         email: marcbasic@gmail.com
 
-# Test in mock package
+# cff_write creates and updates inst/CITATION in a mock package
 
     Code
       auto_cit1
@@ -113,103 +113,3 @@
           version = {1.0.0},
         }
 
----
-
-    Code
-      cffobj
-    Output
-      cff-version: 1.2.0
-      message: 'To cite package "manyurls" in publications use:'
-      type: software
-      license: GPL-3.0-only
-      title: 'manyurls: A lot of urls'
-      version: 1.0.0
-      doi: 10.1111/2041-210X.12469
-      identifiers:
-      - type: url
-        value: https://r-forge.r-project.org/projects/test/
-      - type: url
-        value: http://google.ru
-      - type: url
-        value: https://gitlab.com/r-packages/behaviorchange
-      abstract: This package has many urls. Specifically, 1 Bug Reports and 6 URLs. Expected
-        is to have 1 repository-code, 1 url and 3 URLs, since there is 1 duplicate and 1
-        invalid url.
-      authors:
-      - family-names: Basic
-        given-names: Marc
-        email: marcbasic@gmail.com
-      preferred-citation:
-        type: article
-        title: 'RNeXML: A Package for Reading and Writing Richly Annotated Phylogenetic,
-          Character, and Trait Data in R'
-        authors:
-        - family-names: Boettiger
-          given-names: Carl
-        - family-names: Chamberlain
-          given-names: Scott
-        - family-names: Vos
-          given-names: Rutger
-        - family-names: Lapp
-          given-names: Hilmar
-        journal: Methods in Ecology and Evolution
-        year: '2016'
-        volume: '7'
-        doi: 10.1111/2041-210X.12469
-        start: '352'
-        end: '357'
-      repository-code: https://github.com/test/package
-      url: https://test.github.io/package/
-      contact:
-      - family-names: Basic
-        given-names: Marc
-        email: marcbasic@gmail.com
-      references:
-      - type: book
-        title: 'ggplot2: Elegant Graphics for Data Analysis'
-        authors:
-        - family-names: Wickham
-          given-names: Hadley
-        publisher:
-          name: Springer-Verlag New York
-        year: '2016'
-        isbn: 978-3-319-24277-4
-        url: https://ggplot2.tidyverse.org
-
----
-
-    Code
-      toBibtex(cit)
-    Output
-      @Article{,
-        title = {{RNeXML}: {A} Package for Reading and Writing Richly Annotated Phylogenetic, Character, and Trait Data in {R}},
-        journal = {Methods in Ecology and Evolution},
-        author = {Carl Boettiger and Scott Chamberlain and Rutger Vos and Hilmar Lapp},
-        year = {2016},
-        volume = {7},
-        pages = {352--357},
-        doi = {10.1111/2041-210X.12469},
-      }
-      
-      @Book{,
-        author = {Hadley Wickham},
-        title = {ggplot2: Elegant Graphics for Data Analysis},
-        publisher = {Springer-Verlag New York},
-        year = {2016},
-        isbn = {978-3-319-24277-4},
-        url = {https://ggplot2.tidyverse.org},
-      }
-
----
-
-    Code
-      toBibtex(a_bib)
-    Output
-      @Misc{basic,
-        title = {manyurls: A lot of urls},
-        author = {Marc Basic},
-        url = {https://test.github.io/package/},
-        abstract = {This package has many urls. Specifically, 1 Bug Reports and 6 URLs. Expected is to have 1 repository-code, 1 url and 3 URLs, since there is 1 duplicate and 1 invalid url.},
-        version = {1.0.0},
-      }
-

tests/testthat/helper-mock-package.R

@@ -0,0 +1,33 @@
+local_mock_package <- function(
+  description = "DESCRIPTION_basic",
+  rbuildignore = FALSE,
+  local_dir = TRUE,
+  .local_envir = parent.frame()
+) {
+  path <- withr::local_tempdir(
+    pattern = "mock-pack-",
+    .local_envir = .local_envir
+  )
+  desc_src <- system.file("examples", description, package = "cffr")
+  desc_dst <- file.path(path, "DESCRIPTION")
+
+  if (!nzchar(desc_src)) {
+    stop("Can't find example DESCRIPTION file: ", description, call. = FALSE)
+  }
+  if (!file.copy(desc_src, desc_dst) || !file.exists(desc_dst)) {
+    stop("Can't create mock package DESCRIPTION.", call. = FALSE)
+  }
+
+  if (isTRUE(rbuildignore)) {
+    rbuildignore_path <- file.path(path, ".Rbuildignore")
+    if (!file.create(rbuildignore_path, showWarnings = FALSE)) {
+      stop("Can't create mock package .Rbuildignore.", call. = FALSE)
+    }
+  }
+
+  if (isTRUE(local_dir)) {
+    withr::local_dir(path, .local_envir = .local_envir)
+  }
+
+  path
+}

tests/testthat/test-as_bibentry.R

@@ -69,14 +69,7 @@ test_that("as_bibentry default", {
 test_that("as_bibentry NULL", {
   skip_on_cran()
 
-  new_dir <- withr::local_tempdir(pattern = "mock-pack-")
-  withr::local_dir(new_dir)
-
-  # Move files
-  file.copy(
-    system.file("examples/DESCRIPTION_basic", package = "cffr"),
-    to = "DESCRIPTION"
-  )
+  local_mock_package()
 
   # Get bibentry
   a_bib <- as_bibentry()

tests/testthat/test-as_cff_person.R

@@ -146,7 +146,7 @@ test_that("No valid emails", {
 
   p2 <- as_cff_person(pp2)
 
-  expect_equal(p, as_cff_person(person(given = "John", family = "Doe")))
+  expect_equal(p, p2)
 })
 
 test_that("Can extract comments from format", {

tests/testthat/test-cff_create.R

@@ -11,14 +11,7 @@ test_that("Test installed packages", {
 test_that("Test indev", {
   skip_on_cran()
 
-  new_dir <- withr::local_tempdir(pattern = "mock-pack-")
-  withr::local_dir(new_dir)
-
-  # Move files
-  file.copy(
-    system.file("examples/DESCRIPTION_basic", package = "cffr"),
-    to = "DESCRIPTION"
-  )
+  local_mock_package()
 
   a_cff <- cff_create()
 
@@ -145,20 +138,6 @@ test_that("Default roles on write", {
   expect_identical(cf, cf2)
 })
 
-test_that("Add new roles", {
-  p <- system.file("examples/DESCRIPTION_no_URL", package = "cffr")
-
-  cf <- cff_create(p, dependencies = FALSE)
-  cf2 <- cff_create(
-    p,
-    authors_roles = c("aut", "cre", "ctb"),
-    dependencies = FALSE
-  )
-
-  expect_gt(length(cf2$authors), length(cf$authors))
-  expect_true(cff_validate(cf2, verbose = FALSE))
-})
-
 test_that("Add new roles on write", {
   p <- system.file("examples/DESCRIPTION_no_URL", package = "cffr")
 

tests/testthat/test-cff_gha_update.R

@@ -1,17 +1,12 @@
 test_that("cff_gha_update installs a workflow in the requested package", {
   skip_on_cran()
 
-  new_dir <- withr::local_tempdir(pattern = "mock-pack-")
-
-  # Move files
-  file.copy(
-    system.file("examples/DESCRIPTION_many_urls", package = "cffr"),
-    to = file.path(new_dir, "DESCRIPTION")
+  new_dir <- local_mock_package(
+    description = "DESCRIPTION_many_urls",
+    rbuildignore = TRUE,
+    local_dir = FALSE
   )
-
-  # Create Rbuildignore
   rbuildignore <- file.path(new_dir, ".Rbuildignore")
-  file.create(rbuildignore, showWarnings = FALSE)
   expect_true(file_exist_abort(rbuildignore))
 
   # Add action