tests/testthat/test_validate_bibliography.R

In TeXCheckR: Parses LaTeX Documents for Errors

context("Validate bibliography")

test_that("Bills of Parliament", {
  expect_error(validate_bibliography(file = "./validate-bib/invalid-Bill.bib"),
               regexp = "Bills? of Parliament")
  expect_null(validate_bibliography(file = "./validate-bib/valid-Bill.bib"))
})

test_that("Duplicate fields noticed", {
  expect_error(any_bib_duplicates("./validate-bib/dup_fields.bib"), 
               regexp = "Duplicate fields found in RMS2010Hunter")
})

test_that("Duplicate entries error", {
  expect_error(any_bib_duplicates("./validate-bib/dup_entries.bib"), 
               regexp = "[Dd]uplicate entries in bibliography")
  expect_error(any_bib_duplicates("./validate-bib/dup_entries-2.bib"), 
               regexp = "[Dd]uplicate entries in bibliography")
})

test_that("Duplicate entry keys", {
  expect_error(any_bib_duplicates("./validate-bib/dup-key.bib"),
               regexp = "Duplicate bib key used")
})

test_that("Broken fields detected", {
  expect_error(validate_bibliography(file = "./validate-bib/field-broken-over2lines.bib"), 
               regexp = "which is neither a key, nor field")
})

test_that("Near-duplicate authors", {
  expect_error(any_bib_duplicates("validate-bib/near-dup-authors.bib", report2console),
               regexp = "Same author used with inconsistent.*case")
})

test_that("Hypercorrected mendeleys", {
  if (isTRUE(getOption("TeXCheckR.halt_on_error"))) {
    expect_error(validate_bibliography(file = "./validate-bib/invalid-hypercorrected.bib"),
                 regexp = "URL contains hypercorrected escapes.",
                 fixed = TRUE)
    options("TeXCheckR.halt_on_error" = FALSE)
    options("TeXCheckR.capture.output" = TRUE)
    expect_output(validate_bibliography(file = "./validate-bib/invalid-hypercorrected.bib"),
                  regexp = "URL contains hypercorrected escapes.",
                  fixed = TRUE)
    options("TeXCheckR.halt_on_error" = TRUE)
    options("TeXCheckR.capture.output" = FALSE)
  } else {
    options("TeXCheckR.capture.output" = TRUE)
    expect_output(validate_bibliography(file = "./validate-bib/invalid-hypercorrected.bib"),
                  regexp = "URL contains hypercorrected escapes.",
                  fixed = TRUE)
    options("TeXCheckR.halt_on_error" = TRUE)
    options("TeXCheckR.capture.output" = FALSE)
    expect_error(validate_bibliography(file = "./validate-bib/invalid-hypercorrected.bib"),
                 regexp = "URL contains hypercorrected escapes.",
                 fixed = TRUE)
    options("TeXCheckR.halt_on_error" = FALSE)
  }
  expect_null(validate_bibliography(file = "./validate-bib/valid-hypercorrected.bib"))
})

test_that("DOI", {
  doi_bib <- tempfile(fileext = ".bib")
  writeLines(c("@Article{Akerstedt1997Goodsleepits,",
               "  author       = {Akerstedt, T. and Hume, K. and Minors, D. and Waterhouse, J.},",
               "  title        = {Good sleep - its timing and physiological sleep characteristics},", 
               "  journal      = {Journal of Sleep Research},",
               "  year         = {1997},", 
               "  volume       = {6},",
               "  doi          = {http://dx.doi.org/10.1111/j.1365-2869.1997.00221.x},", 
               "}", ""),
             doi_bib)
  if (isTRUE(getOption("TeXCheckR.halt_on_error"))) {
    expect_error(validate_bibliography(file = doi_bib), 
                 regexp = "DOI entries must be in the form")
    options("TeXCheckR.halt_on_error" = FALSE)
    options("TeXCheckR.capture.output" = TRUE)
    expect_output(validate_bibliography(file = doi_bib), 
                  regexp = "DOI entries must be in the form")
    options("TeXCheckR.halt_on_error" = TRUE)
    options("TeXCheckR.capture.output" = FALSE)
  } else {
    options("TeXCheckR.capture.output" = TRUE)
    expect_output(validate_bibliography(file = doi_bib), 
                  regexp = "DOI entries must be in the form")
    options("TeXCheckR.halt_on_error" = TRUE)
    options("TeXCheckR.capture.output" = FALSE)
    expect_error(validate_bibliography(file = doi_bib), 
                 regexp = "DOI entries must be in the form")
    options("TeXCheckR.halt_on_error" = FALSE)
  }
  
})

test_that("Ends with comma", {
  doi_bib <- tempfile(fileext = ".bib")
  writeLines(c("@Article{Akerstedt1997Goodsleepits,",
               "  author       = {Akerstedt, T. and Hume, K. and Minors, D. and Waterhouse, J.},",
               "  title        = {Good sleep - its timing and physiological sleep characteristics},", 
               "  journal      = {Journal of Sleep Research},",
               "  year         = {1997},", 
               "  volume       = {6}",
               "  url          = {http://dx.doi.org/10.1111/j.1365-2869.1997.00221.x},", 
               "}", ""),
             doi_bib)
  expect_error(validate_bibliography(file = doi_bib),
               regexp = "Each field line in .bib must end with a comma (to allow intra-entry reordering).",
               fixed = TRUE)
})

test_that("Ends with comma", {
  doi_bib <- tempfile(fileext = ".bib")
  writeLines(c("@Article{Akerstedt1997Goodsleepits,",
               "  author       = {Australian Taxation Office},",
               "  title        = {Good sleep - its timing and physiological sleep characteristics},", 
               "  journal      = {Journal of Sleep Research},",
               "  year         = {1997},", 
               "  volume       = {6},",
               "  url          = {http://dx.doi.org/10.1111/j.1365-2869.1997.00221.x},", 
               "}", ""),
             doi_bib)
  expect_error(validate_bibliography(file = doi_bib),
               regexp = "Institutional authors should be abbreviated.",
               fixed = TRUE)
})

test_that("No year #70", {
  expect_null(any_bib_duplicates("fread-bib/citr-zotero-test.bib"))
})

test_that("Unescaped % in non-url fields", {
  expect_error(fread_bib("fread-bib/issue-44.bib"),
               regexp = "BlakersLuStocks2017")
  expect_error(fread_bib("fread-bib/issue-44.bib"),
               regexp = "contains unescaped %",
               fixed = TRUE)
})

test_that("Unescaped % in non-url fields (output)", {
  skip_if_not_installed("rlang")
  rlang::with_options({
    output <- capture.output(fread_bib("fread-bib/issue-44.bib",
                                       halt = FALSE))
    expect_true(any(endsWith(output, "^^"))) # test caret = 2L
    expect_true("Insert a backslash before this %." %in% output)
  },
  TeXCheckR.capture.output = TRUE)
  
  # Test halt = NULL
  rlang::with_options({
    expect_error(fread_bib("fread-bib/issue-44.bib",
                           halt = NULL),
                 regexp = "BlakersLuStocks2017")
  },
  TeXCheckR.halt_on_error = TRUE)
})