tests/testthat/test-asis-nodes.R

In ropenscilabs/tinkr: Cast '(R)Markdown' Files to 'XML' and Back Again

test_that("(#121) single dollar lines dont throw errors", {
  expected <- "I've only got $2 in the bank. Feels bad, man.\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  expect_no_error(protxt <- protect_inline_math(txt, md_ns()))
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)
})

test_that("(#124) french dollar lines dont throw errors", {
  expected <- "I've only got 2$ in the bank. Feels bad, man. Feels bad to not have 2 $\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  expect_no_error(protxt <- protect_inline_math(txt, md_ns()))
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)
})

test_that("mal-formed inline math throws an informative error", {
  patherr  <- system.file("extdata", "basic-math.md", package = "tinkr")
  me <- yarn$new(patherr, sourcepos = TRUE)
  expect_snapshot_error(me$protect_math())
})

test_that("multi-line inline math can have punctutation after", {
  template <- "C) $E(\\text{Weight}) = 81.37 + 1.26 \\times x_1 +\n2.65 \\times x_2$punk\n"
  for (punk in c('--', '---', ',', ';', '.', '?', ')', ']', '}', '>')) {
    expected <- sub("punk", punk, template)
    math <- commonmark::markdown_xml(expected)
    txt <- xml2::read_xml(math)
    protxt <- protect_inline_math(txt, md_ns())
    actual <- to_md(list(yaml = NULL, body = protxt))
    expect_equal(actual, expected)
  }
})

test_that("math with inline code still works", {

  expected <- "some inline math, for example $R^2 = `r runif(1)`$, is failing with code\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  protxt <- protect_inline_math(txt, md_ns())
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)

})

test_that("math with inline code still works", {

  expected <- "example\n\n- 42 $\\alpha$,\n- $R^2 = `r runif(1)`$,\n- is working with $\\beta$ code\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  protxt <- protect_inline_math(txt, md_ns())
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)

})

test_that("math with inline code works -- one character", {

  expected <- "example\n\n- 42 $R$ note\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  protxt <- protect_inline_math(txt, md_ns())
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)

})


test_that("math that starts a line will be protected", {
  expected <-  "- so $\\beta^2 = `r runif(1)`$ works and\n- $\\beta$ does too\n"
  math <- commonmark::markdown_xml(expected)
  txt <- xml2::read_xml(math)
  protxt <- protect_inline_math(txt, md_ns())
  actual <- to_md(list(yaml = NULL, body = protxt))
  expect_equal(actual, expected)
})


test_that("block math can be protected", {
  pathmath <- system.file("extdata", "math-example.md", package = "tinkr")
  m <- yarn$new(pathmath, sourcepos = TRUE)
  expect_length(xml2::xml_ns(m$body), 1L)
  expect_equal(md_ns()[[1]], xml2::xml_ns(m$body)[[1]])
  expect_snapshot(show_user(m$protect_math()$tail(48), force = TRUE))
  expect_length(xml2::xml_ns(m$body), 1L)
  expect_equal(md_ns()[[1]], xml2::xml_ns(m$body)[[1]])
  # 3 math blocks with code examples
  expect_length(grep("$$", m$show(), fixed = TRUE), 12)
  # 3 math delimiters included in the get_protected
  expect_equal(sum(xml2::xml_text(m$get_protected("math")) == "$$"), 6)


})


test_that("tick boxes can be protected without needing intervention", {
  src <- commonmark::markdown_xml("- a\n- b\n- c")
  xml <- xml2::read_xml(src)

  # no tickboxes returns the original body
  expect_identical(protect_tickbox(xml, md_ns()), xml)

  item <- xml2::xml_find_all(xml, ".//md:text[not(text()='b')]", ns = md_ns())
  xml2::xml_set_text(item, c("[ ] a", "[x] c"))

  new <- protect_tickbox(xml, md_ns())
  expect_failure(expect_identical(protect_tickbox(xml, md_ns()), xml))
  expect_identical(to_md(list(body = new, yaml = NULL)),
    "- [ ] a\n- b\n- [x] c\n")
})

test_that("tick boxes are protected by default", {
  pathmath <- system.file("extdata", "math-example.md", package = "tinkr")
  m <- yarn$new(pathmath, sourcepos = TRUE)
  m$protect_math()
  expect_length(xml2::xml_ns(m$body), 1L)
  expect_equal(md_ns()[[1]], xml2::xml_ns(m$body)[[1]])
  expect_snapshot(show_user(m$head(15), force = TRUE))
})

test_that("documents with no math do no harm", {
  x <- xml2::read_xml(commonmark::markdown_xml("no math here"))
  expect_length(xml2::xml_ns(x), 1L)
  expect_equal(md_ns()[[1]], xml2::xml_ns(x)[[1]])
  x1 <- as.character(x)
  x <- protect_math(x, md_ns())
  expect_length(xml2::xml_ns(x), 1L)
  expect_equal(md_ns()[[1]], xml2::xml_ns(x)[[1]])
  # block math does nothing
  expect_equal(as.character(x), x1)
})

test_that("protect_unescaped() will throw a warning if no sourcpos is available", {
  pathmath <- system.file("extdata", "math-example.md", package = "tinkr")
  m <- yarn$new(pathmath, sourcepos = TRUE)
  x <- to_xml(m$path)
  expect_warning({
    protect_unescaped(x$body, txt = readLines(m$path)[-seq_along(m$yaml)], "sourcepos")
  })
})