tests/testthat/test-collapse-to-string.R

In metrumresearchgroup/bbr: R package for bbi

context("Collapse columns to string representation")

# setup
cleanup()
create_rlg_models()
# teardown
withr::defer(cleanup())

test_that("collapse_to_string() works correctly [BBR-CTS-001]", {
  # add a note to collapse
  mod2 <- read_model(file.path(MODEL_DIR, 2)) %>% add_notes(NEW_NOTES)
  on.exit(replace_all_notes(mod2, NULL))

  log_df <- run_log(MODEL_DIR)
  expect_true(inherits(log_df[[YAML_TAGS]], "list"))
  expect_true(inherits(log_df[[YAML_NOTES]], "list"))

  log_df <- log_df %>%
    collapse_to_string({{YAML_TAGS}}, {{YAML_NOTES}})

  expect_identical(
    log_df[[YAML_TAGS]],
    c(
      paste(ORIG_TAGS, collapse = ", "),
      paste(NEW_TAGS, collapse = ", "),
      paste(ORIG_TAGS, collapse = ", ")
    )
  )

  expect_identical(
    log_df[[YAML_NOTES]],
    c(
      NA,
      paste(NEW_NOTES, collapse = ", "),
      NA
    )
  )
})

test_that("collapse_to_string() warns correctly [BBR-CTS-002]", {
  log_df <- run_log(MODEL_DIR) %>%
    collapse_to_string({{YAML_TAGS}})

  expect_warning(
    collapse_to_string(log_df, {{YAML_TAGS}}),
    regexp = "The following columns are not lists and will be ignored: tags"
  )
})

test_that("collapse_to_string() errors correctly [BBR-CTS-003]", {
  log_df <- run_log(MODEL_DIR) %>%
    collapse_to_string({{YAML_TAGS}})

  expect_error(
    collapse_to_string(log_df, bags),
    class = "vctrs_error_subscript_oob"
  )
})

test_that("collapse_to_string() renders dput correctly [BBR-CTS-004]", {
  log_df <- run_log(MODEL_DIR)
  ref_args <- purrr::map_chr(
    log_df[[YAML_BBI_ARGS]],
    ~ capture.output(dput(.x))
  )

  log_df <- log_df %>%
    collapse_to_string({{YAML_BBI_ARGS}})

  expect_identical(ref_args, log_df[[YAML_BBI_ARGS]])
})

test_that("collapse_to_string() renders dput for tibbles [BBR-CTS-005]", {
  nums <- seq_len(3)
  df <- tibble::tibble(
    row_num   = nums,
    tibby     = list(
      tibble::tibble(a = nums, b=nums, c=nums),
      tibble::tibble(d = nums, e=nums, f=nums),
      tibble::tibble(g = nums, h=nums, i=nums)
    )
  )

  ref_tib <- purrr::map_chr(
    df$tibby,
    ~ paste(capture.output(dput(.x)), collapse = "")
  )

  df <- collapse_to_string(df, tibby)

  expect_identical(ref_tib, df$tibby)
})

test_that("add_tags() converts lists upstream of collapse_to_string() [BBR-CTS-006]", {
  mod2 <- read_model(file.path(MODEL_DIR, 2))
  tags_old <- mod2[[YAML_TAGS]]
  # Note: The shape of the value here matters: it needs to be
  # something that isn't unlisted by the write_yaml/read_yaml
  # sequence.  For example, list("ab", "cd", "ef") won't work as a
  # regression case because it will come back as c("ab", "cd", "ef").
  tags_new <- list(c("ab", "cd"), c("ef"))
  mod2 <- mod2 %>% replace_all_tags(NULL) %>% add_tags(tags_new)
  on.exit(replace_all_tags(mod2, tags_old))

  log_df <- run_log(MODEL_DIR) %>% collapse_to_string({{YAML_TAGS}})
  expect_identical(
    log_df[[YAML_TAGS]],
    c(
      paste(ORIG_TAGS, collapse = ", "),
      paste(unlist(tags_new), collapse = ", "),
      paste(ORIG_TAGS, collapse = ", ")
    )
  )
})