Refactor snapshot tests to use helper functions

[olivroy]

Summary

Changes in the snapshots is currently very painful to do due to an issue in testthat.

It seems that there are issues with updating snapshots when pipes %>% are present.

This refactors the tests to use new helpers

• expect_snapshot_html()
• expect_snapshot_latex()
• expect_snapshot_word()
• expect_snapshot_rtf()

I used the following script to replace programatically the easiest ones.

test_files <- fs::dir_ls("tests/testthat", glob = "*.R")
test_files <- fs::path_filter(test_files, regexp = "helper-", invert = TRUE)

obj <- test_files %>% 
  purrr::set_names() %>% 
  purrr::map(\(x) readLines(x, warn = FALSE, encoding = "UTF-8"))

html_snap_old_regex <- " %>% render_as_html() %>% expect_snapshot()"
html_snap_new_regex <- "expect_snapshot_html(\\1)"

latex_snap_old_regex <- " %>% as_latex() %>% as.character() %>% expect_snapshot()"
latex_snap_new_regex <- "expect_snapshot_latex(\\1)"

rtf_snap_old_regex <- " %>% as_rtf() %>% expect_snapshot()"
rtf_snap_new_regex <- "expect_snapshot_rtf(\\1)"

final_obj <- obj %>% 
  purrr::map(\(x) replace_pipe_in_snap(x, html_snap_old_regex, html_snap_new_regex)) %>% 
  purrr::map(\(x) replace_pipe_in_snap(x, latex_snap_old_regex, latex_snap_new_regex)) %>%
  purrr::map(\(x) replace_pipe_in_snap(x, rtf_snap_old_regex, rtf_snap_new_regex)) %>% 
  purrr::imap(\(x, name) writeLines(x, con = name))

replace_pipe_in_snap <- function(lines, old_snap_regex, new_snap_regex) {
  has_to_replace <- grepl(old_snap_regex, lines, fixed = TRUE)
  
  lines_to_change <- lines[has_to_replace]
  
  lines_to_change <- gsub(old_snap_regex, "", lines_to_change, fixed = TRUE)
  
  lines_new <- gsub("(\\w+)", new_snap_regex, lines_to_change)
  
  lines[has_to_replace] <- lines_new
  
  lines
}

Related GitHub Issues and PRs

Context, while working on #1842, it was difficult to iterate quickly as the snapshots were impossible to update via the usual way. I tried looking into #1837, but it proved challenging due to snapshot difficulties again.

Workaround r-lib/testthat#1646 and facilitate iteration. (Some people said that pipes were problematic)

Checklist

• I understand and agree to the Code of Conduct.
• I have listed any major changes in the NEWS.
• I have added testthat unit tests to tests/testthat for any new functionality.

[olivroy]

It was the same with different settings, hence the test simplification

[rich-iannone]

LGTM!