tests/testthat/test-setup.R

In tjmahr/tarnotes: Notebooks Using 'Targets' and 'Bookdown'

test_that("use_notestar() defaults provide a make-able notebook", {
  create_local_project()
  was_successful <- use_notestar(open = FALSE)
  expect_true(was_successful)

  expect_false(file.exists("notebook/book/docs/notebook.html"))
  tar_make_quietly()
  expect_true(file.exists("notebook/book/docs/notebook.html"))
})


test_that("use_notestar() paths are customizable", {
  create_local_project()
  was_successful <- use_notestar(
    dir_notebook = "pages",
    dir_md = "book",
    notebook_helper = "knitr-helpers.R",
    notebook_filename = "notes",
    open = FALSE
  )
  expect_true(was_successful)

  config <- notebook_config()
  expect_equal(config$dir_notebook, "pages")
  expect_equal(config$dir_md, "book")
  expect_equal(config$notebook_helper, "pages/knitr-helpers.R")

  tar_make_quietly()
  expect_true(file.exists("pages/knitr-helpers.R"))
  expect_true(file.exists("book/docs/notes.html"))
})


test_that("changing config.yml theme should outdate notebook", {
  create_local_project()
  was_successful <- use_notestar(open = FALSE)
  tar_make_quietly()

  yaml_in <- yaml::read_yaml("config.yml")
  yaml_in$default$notestar$cleanrmd_theme$value <- "sakura-vader"
  yaml::write_yaml(yaml_in, "config.yml")

  outdated <- targets::tar_outdated()
  expect_true("notebook" %in% outdated)
})


test_that("notesstar can track/purge generated figures", {
  skip_if_not_installed("ragg")
  skip_on_os("mac")
  skip_on_os("linux")

  entry <- "
  <!--- Timestamp to trigger book rebuilds: `r Sys.time()` --->

  ## Demo entry

  <small>Source: <code>`r knitr::current_input()`</code></small>

  ```{r faithful}
  plot(faithful)
  ```
  "
  entry <- gsub("\\n  ", "\n", entry)

  new_entry <- "
  <!--- Timestamp to trigger book rebuilds: `r Sys.time()` --->

  ## Demo entry

  <small>Source: <code>`r knitr::current_input()`</code></small>

  ```{r faithful}
  # plotting code removed
  ```
  "
  new_entry <- gsub("\\n  ", "\n", new_entry)

  create_local_project()
  was_successful <- use_notestar(open = FALSE)

  # Create a notebook with the plot
  writeLines(entry, "notebook/2021-01-01-plot.Rmd")
  tar_make_quietly()

  # Notebook is current
  outdated <- targets::tar_outdated(reporter = "silent")
  expect_false("entry_2021_01_01_plot_md" %in% outdated)

  # Plot landed where it was expected
  expect_true(
    file.exists("notebook/book/assets/figure/2021-01-01-plot/faithful-1.png")
  )

  # Plot is being tracked
  expect_equal(
    targets::tar_read("entry_2021_01_01_plot_md"),
    c(
      "notebook/book/2021-01-01-plot.md",
      "notebook/book/assets/figure/2021-01-01-plot/faithful-1.png"
    )
  )

  # Notebook depends on plot file
  file.remove("notebook/book/assets/figure/2021-01-01-plot/faithful-1.png")
  outdated <- targets::tar_outdated(reporter = "silent")
  expect_true("entry_2021_01_01_plot_md" %in% outdated)
  expect_true("notebook" %in% outdated)

  # Restore the notebook and plot
  tar_make_quietly()

  # Update entry to remove the plot
  writeLines(new_entry, "notebook/2021-01-01-plot.Rmd")
  capture_output(targets::tar_make(reporter = "silent"))

  # Plot has been removed
  expect_false(
    file.exists("notebook/book/assets/figure/2021-01-01-plot/faithful-1.png")
  )

  # Plot is not being tracked
  expect_equal(
    targets::tar_read("entry_2021_01_01_plot_md"),
    "notebook/book/2021-01-01-plot.md"
  )
})


test_that("index.Rmd can be customized", {
  create_local_project()
  was_successful <- use_notestar(open = FALSE)

  tar_make_quietly()
  old_yaml <- rmarkdown::yaml_front_matter("notebook/index.Rmd")

  writeLines(
    gsub(
      "title = .*,",
      "title = \"Test title\", subtitle = \"another test\",",
      readLines("_targets.R")
    ),
    "_targets.R"
  )

  expect_true(
    all(c("notebook_index_rmd", "notebook") %in% targets::tar_outdated())
  )

  tar_make_quietly()
  new_yaml <- rmarkdown::yaml_front_matter("notebook/index.Rmd")

  expect_equal(new_yaml$subtitle, "another test")
  expect_false(old_yaml$title == new_yaml$subtitle)
})


test_that("index.Rmd can be customized (references)", {
  create_local_project()
  was_successful <- use_notestar(open = FALSE)
  use_notestar_references()
  tar_make_quietly()

  old_yaml <- rmarkdown::yaml_front_matter("notebook/index.Rmd")
  old_assets <- list.files("notebook/book/assets/")
  expect_length(old_assets, 0)

  writeLines(
    gsub(
      "# bibliography = \"refs.bib\"",
      "bibliography = \"refs.bib\"",
      readLines("_targets.R")
    ),
    "_targets.R"
  )

  writeLines(
    gsub(
      "# csl = \"apa.csl\"",
      "csl = \"apa.csl\"",
      readLines("_targets.R")
    ),
    "_targets.R"
  )

  tar_make_quietly()
  new_yaml <- rmarkdown::yaml_front_matter("notebook/index.Rmd")
  new_assets <- list.files("notebook/book/assets/")

  expect_length(new_assets, 2)
  expect_equal(new_yaml$csl, "./assets/apa.csl")
  expect_equal(new_yaml$bibliography, "./assets/refs.bib")

  # Modifying the references should outdate notebook
  expect_false("notebook" %in% targets::tar_outdated())

  writeLines(
    gsub(
      "@Manual.R.base,",
      "@Manual{R-base-entry,",
      readLines("./notebook/refs.bib")
    ),
    "./notebook/refs.bib"
  )
  outdated <- targets::tar_outdated()
  expect_true("notebook" %in% outdated)
  tar_make_quietly("notebook_bibliography_asset")

  expect_true("notebook" %in% outdated)
  tar_make_quietly()

  outdated <- targets::tar_outdated()
  expect_false("notebook" %in% outdated)

  writeLines(
    c(readLines("./notebook/refs.bib"), format(toBibtex(citation("stats")))),
    "./notebook/refs.bib"
  )

  tar_make_quietly("notebook_bibliography_asset")
  outdated <- targets::tar_outdated()
  expect_true("notebook" %in% outdated)

})


test_that("can edit out yaml bibliography field in non index.Rmd entries", {
  skip_on_ci()
  create_local_project()
  was_successful <- use_notestar(open = FALSE)

  tar_make_quietly()

  notebook_create_page("test", date = "2020-01-01", open = FALSE)

  yaml_to_add <- "---
editor_options:
  markdown:
    wrap: 72
bibliography: references.bib
---
"
  writeLines(
    c(yaml_to_add, readLines("notebook/2020-01-01-test.Rmd")),
    "notebook/2020-01-01-test.Rmd"
  )
  tar_make_quietly()

  rmarkdown::yaml_front_matter("notebook/2020-01-01-test.Rmd") |>
    expect_named(c("editor_options", "bibliography"))
  rmarkdown::yaml_front_matter("notebook/book/2020-01-01-test.md") |>
    expect_named(c("editor_options"))
})