tests/testthat/test-writeCodeBookLatex.R

In Crunch-io/crunchtabs: Custom Report Generation for Crunch Datasets

context("writeCodeBookLatex")

test_that("End to end writeCodeBookLatex", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", NULL
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_allpets.rds"))
  )

  mockery::stub(writeCodeBookLatex, "file.open", NULL)
  mockery::stub(writeCodeBookLatex, "tinytex::pdflatex", TRUE)

  res <- suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      title = "Hello",
      subtitle = "Goodbye",
      sample_desc = "US Voting Adults",
      logo = "yougov",
      pdf = TRUE,
      open = TRUE
    )
  )

  tex <- readLines("Example-dataset.tex")
  expect_equal(res, NULL)
  expect_equal(length(tex), 153)
  # expect_true(file.size("Example-dataset.pdf") > 61200)
  # Test title
  expect_true(
    any(grepl("fancyhead*.*Hello", tex))
  )
  # Test subtitle
  expect_true(
    any(grepl("fancyhead*.*Goodbye", tex))
  )
  # Test sample description
  expect_true(
    any(grepl("US Voting Adults", tex))
  )
  # Test logo
  expect_true(
    any(grepl("includegraphics*.*YouGov", tex))
  )
  # Test allpets header
  allpets <- "\\addcontentsline{lot}{table}{\\parbox{1.8in}{\\ttfamily{allpets}} All pets owned}"
  expect_true(
    any(grepl(allpets, tex, fixed = TRUE))
  )
  expect_true(file.exists("Example-dataset.tex"))
  #expect_true(file.exists("Example-dataset.pdf"))
  expect_true(file.remove("Example-dataset.tex"))
  #expect_true(file.remove("Example-dataset.pdf"))
})

test_that("Dataset name as title if title not specified", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", NULL
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_allpets.rds"))
  )



  mockery::stub(
    writeCodeBookLatex,
    "crunch::name",
    "AnAmazingTitle"
  )

  res <- suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      title = NULL,
      subtitle = NULL,
      sample_desc = "US Voting Adults",
      logo = "yougov",
      pdf = FALSE
    )
  )
  tex <- readLines("Example-dataset.tex")
  expect_true(
    any(grepl("AnAmazingTitle", tex))
  )

  expect_true(file.exists("Example-dataset.tex"))
  expect_true(file.remove("Example-dataset.tex"))
})

test_that("Dataset name as title if title not specified", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", NULL
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_allpets.rds"))
  )

  mockery::stub(
    writeCodeBookLatex,
    "crunch::name",
    "AnAmazingTitle"
  )

  res <- suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      title = NULL,
      subtitle = NULL,
      sample_desc = "US Voting Adults",
      logo = "ygblue",
      pdf = FALSE
    )
  )
  tex <- readLines("Example-dataset.tex")
  expect_true(
    any(grepl("AnAmazingTitle", tex))
  )
  # Test ygblue logo while we're here
  expect_true(
    any(grepl("includegraphics*.*YouGovBlue", tex))
  )

  expect_true(file.exists("Example-dataset.tex"))
  expect_true(file.remove("Example-dataset.tex"))
})


test_that("Appendices are positioned as expected", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  # inputregstate comes from DFP
  # ds <- loadDataset("Data for Progress National Issues Survey Wave 4")
  # codeBookItemBody(ds$inputregstate) %>%
  #   dput %>%
  #   saveRDS("tests/testthat/fixtures/codeBookItem_inputregstate")

  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", NULL
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_inputregstate.rds"))
  )

  mockery::stub(
    writeCodeBookLatex,
    "crunch::name",
    "AnAmazingTitle"
  )

  res <- suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      sample_desc = "US Voting Adults",
      appendix = TRUE,
      pdf = FALSE
    )
  )

  tex <- readLines("Example-dataset.tex")
  # Test ygblue logo while we're here

  # Test no logo
  expect_true(
    !any(grepl("includegraphics", tex))
  )

  # We expect Appendix title to be found on 100th line or greater
  expect_true({
    which(grepl("\\fancyhead[L]{{\\fontsize{16}{24}\\textbf{Appendix}}}", tex, fixed = TRUE)) > 100
  })

  expect_true(file.exists("Example-dataset.tex"))
  expect_true(file.remove("Example-dataset.tex"))
})

test_that("Position functions as expected", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  # ds <- loadDataset("Example dataset")
  # codeBookItemBody(ds$allpets) %>% dput() %>%
  #   saveRDS("tests/testthat/fixtures/codeBookItem_allpets.rds")
  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", NULL
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_allpets.rds"))
  )

  mockery::stub(
    writeCodeBookLatex,
    "crunch::name",
    "AnAmazingTitle"
  )

  suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      sample_desc = "US Voting Adults",
      position = "c",
      pdf = FALSE
    )
  )

  tex <- readLines("Example-dataset.tex")
  # Test ygblue logo while we're here

  # Test no logo
  expect_true(
    !any(grepl("includegraphics", tex))
  )

  # Should be [c] not [l]
  expect_true(
    any(grepl("\\begin{longtable}[c]{lJJJJ}", tex, fixed = TRUE))
  )



  expect_true(file.exists("Example-dataset.tex"))
  expect_true(file.remove("Example-dataset.tex"))
})


context("codeBookItemBody")

test_that("Works for generic numeric data", {
  res <- c("", "\\begin{longtable}[l]{cccccc}", "\\toprule", "{Mean} & {SD} & {Min} & {Max} & {n} & {Missing}\\\\",
           "\\midrule", "2.5 & 1 & 1 & 4 & 4 & 0\\\\", "\\bottomrule", "\\end{longtable}"
  )
  expect_equal(capture.output(codeBookItemBody(c(1, 2, 3, 4))), res)
})

context("kable_strip_rules")

test_that("strips rules as expected", {
  x <- "\\toprule\\bottomrule\\midrule"
  r <- kable_strip_rules(x)
  expect_equal(r, "")

  r <- kable_strip_toprules(x)
  expect_equal(r, "\\bottomrule\\midrule")
})

test_that("fixes underscore", {
  x <- "___"
  r <- fixUnderscore(x)
  expect_equal(r, "\\_\\_\\_")
})

test_that("default yg logo returns normal path", {
  p <- default_yg_logo()
  expect_equal(p, system.file("YouGov.png", package = "crunchtabs"))
})

test_that("Expect a stop if dataset is weighted", {
  ds <- readRDS(test_path("fixtures/example_dataset.rds"))

  mockery::stub(
    writeCodeBookLatex,
    "crunch::weight", "weight_alias"
  )

  mockery::stub(
    writeCodeBookLatex,
    "codeBookItemBody",
    readRDS(test_path("fixtures/codeBookItem_allpets.rds"))
  )

  mockery::stub(writeCodeBookLatex, "file.open", NULL)

  expect_error(suppressWarnings(
    writeCodeBookLatex(
      ds[c("allpets")],
      title = "Hello",
      subtitle = "Goodbye",
      sample_desc = "US Voting Adults",
      logo = "yougov",
      pdf = TRUE
    )
  ), "Codebooks are designed to work with whole numbers")
})