tests/testthat/test-submissions_summary.R

In tutorial.helpers: Helper Functions for Creating Tutorials

test_dir <- test_path("fixtures", "process_submissions_dir") 
# If test_dir does not work try using this path = test_path("fixtures", "process_submissions_dir") 

# Currently, I do not have tests which explore the verbose argument in detail.

# Tests which confirm that the returned tibble is correct.

test_that("submissions_summary returns the expected summary tibble", {
  expected_output <- tibble::tibble(
    `information-name` = c("Areeb Atif", "Gitanjali Sheth"),
    answers = c(11L, 11L)
  )
  
  actual_output <- submissions_summary(
    path = test_dir,
    title = "getting",
    vars = c("information-name")
  )
  
  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary returns the expected summary tibble with email vars", {
  expected_output <- tibble::tibble(
    `information-email` = c("dave.kane@gmail.com", "areebatif2007@gmail.com", "gbhatia1@yahoo.com"),
    answers = c(6L, 11L, 11L)
  )
  
  actual_output <- submissions_summary(
    path = test_dir,
    title = "get",
    vars = c("information-email")
  )
  
  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary returns the expected summary tibble with name and email vars", {
  expected_output <- tibble::tibble(
    `information-name` = c("David Kane", "Areeb Atif", "Gitanjali Sheth"),
    `information-email` = c("dave.kane@gmail.com", "areebatif2007@gmail.com", "gbhatia1@yahoo.com"),
    answers = c(6L, 11L, 11L)
  )
  
  actual_output <- submissions_summary(
    path = test_dir,
    title = "get",
    vars = c("information-name", "information-email")
  )
  
  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary returns a tibble of the expected size with return_value 'All'", {
  actual_output <- submissions_summary(
    path = test_dir,
    title = "getting",
    return_value = "All"
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(dim(actual_output), c(22L, 3L))
})

test_that("submissions_summary returns a tibble of the expected size with return_value 'All' and title 'get'", {
  actual_output <- submissions_summary(
    path = test_dir,
    title = "get",
    return_value = "All"
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(dim(actual_output), c(28L, 3L))
})

test_that("submissions_summary with one key_var", {
  actual_output <- submissions_summary(
    path = test_dir,
    title = "get",
    return_value = "All",
    vars = "information-name"
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(dim(actual_output), c(28L, 4L))
})

test_that("submissions_summary with two vars", {
  actual_output <- submissions_summary(
    path = test_dir,
    title = "get",
    return_value = "All",
    vars = c("information-name", "information-email")
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(dim(actual_output), c(28L, 5L))
})

# Tests which confirm various errors.

test_that("submissions_summary stops with an error when return_value is 'Summary' and no vars are provided", {
  expect_error(
    submissions_summary(
      path = test_dir,
      title = "get",
      return_value = "Summary"
    ),
    "vars must be provided when return_value is 'Summary'."
  )
})

test_that("submissions_summary stops with an error when the specified directory does not exist", {
  expect_error(
    submissions_summary(
      path = "z",
      title = "get",
      return_value = "All"
    ),
    "The specified directory does not exist."
  )
})

test_that("submissions_summary stops with an error when an invalid return_value is provided", {
  expect_error(
    submissions_summary(
      path = test_dir,
      title = "get",
      return_value = "wrong"
    ),
    "Invalid return_value. Allowed values are 'Summary' or 'All'."
  )
})

## keep_file_name tests

test_that("submissions_summary stops with an error when an invalid keep_file_name is provided", {
  expect_error(
    submissions_summary(
      path = test_dir,
      title = "getting",
      vars = c("information-name"),
      keep_file_name = "Hey"
    ),
    "Invalid keep_file_name. Allowed values are NULL, 'All', 'Space', or 'Underscore'."
  )
})

test_that("submissions_summary stops with an error when keep_file_name is used with return_value 'All'", {
  expect_error(
    submissions_summary(
      path = test_dir,
      title = "getting",
      return_value = "All",
      keep_file_name = "All"
    ),
    "keep_file_name can only be used when return_value is 'Summary'."
  )
})

# Testing files with spaces required the use of setup/teardown scaffolding. Note
# the use Sys.getenv("TEST_DIR") as the value of the path argument.

test_that("submissions_summary returns the expected summary tibble with keep_file_name 'All'", {
  expected_output <- tibble::tibble(
    source = c(
      "introduction_answers -- Aadi.html",
      "introduction_answers -- astrxr.html",
      "ivy-introduction -- Ivy S.html"
    ),
    `information-name` = c("Aaditya Gupta", "Mithru Narayan Naidu", "Ivy Spratt"),
    answers = c(29L, 29L, 29L)
  ) %>%
    dplyr::arrange(source)

  actual_output <- submissions_summary(
    path = Sys.getenv("TEST_DIR"),
    title = "introduction",
    vars = c("information-name"),
    keep_file_name = "All"
  ) %>%
    dplyr::arrange(source)

  expect_equal(actual_output, expected_output)
})


test_that("submissions_summary returns the expected summary tibble with keep_file_name 'Space' and mixed file names", {
  expected_output <- tibble::tibble(
    source = c(
      "introduction_answers",
      "introduction_answers",
      "ivy-introduction"
    ),
    `information-name` = c("Aaditya Gupta", "Mithru Narayan Naidu", "Ivy Spratt"),
    answers = c(29L, 29L, 29L)
  ) %>%
    dplyr::arrange(`information-name`)

  actual_output <- submissions_summary(
    path = Sys.getenv("TEST_DIR"),
    title = "introduction",
    vars = c("information-name"),
    keep_file_name = "Space"
  ) %>%
    dplyr::arrange(`information-name`)

  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary returns the expected summary tibble with keep_file_name 'Underscore' and mixed file names", {
  expected_output <- tibble::tibble(
    source = c(
      "introduction",
      "introduction",
      "ivy-introduction -- Ivy S.html"
    ),
    `information-name` = c("Aaditya Gupta", "Mithru Narayan Naidu", "Ivy Spratt"),
    answers = c(29L, 29L, 29L)
  ) %>%
    dplyr::arrange(`information-name`)
  
  actual_output <- submissions_summary(
    path = Sys.getenv("TEST_DIR"),
    title = "introduction",
    vars = c("information-name"),
    keep_file_name = "Underscore"
  ) %>%
    dplyr::arrange(`information-name`)
  
  expect_equal(actual_output, expected_output)
})

# Tests using new variable names.

test_that("submissions_summary returns the expected summary tibble", {
  expected_output <- tibble::tibble(
    name = c("David Kane"),
    answers = c(10)
  )
  
  actual_output <- submissions_summary(
    path = "fixtures/process_submissions_dir2/",
    title = "new-labels",
    vars = c("name")
  )
  
  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary returns the expected summary tibble", {
  expected_output <- tibble::tibble(
    name = "David Kane",
    email = "dave.kane@gmail.com",
    minutes = "9",
    answers = c(10)
  )
  
  actual_output <- submissions_summary(
    path = "fixtures/process_submissions_dir2/",
    title = "new-labels",
    vars = c("name", "email", "minutes")
  )
  
  expect_equal(actual_output, expected_output)
})

# Tests for title as vector

test_that("submissions_summary works with multiple titles in vector - All mode", {
  actual_output <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = c("getting", "astrxr"),
    return_value = "All"
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(dim(actual_output), c(51L, 3L))
})

test_that("submissions_summary works with non-overlapping titles", {
  expected_output <- tibble::tibble(
    `information-name` = c("Areeb Atif", "Gitanjali Sheth", "Mithru Narayan Naidu"),
    `information-email` = c("areebatif2007@gmail.com", "gbhatia1@yahoo.com", "conflict454@gmail.com"),
    answers = c(11L, 11L, 29L)
  )
  
  actual_output <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = c("getting", "astrxr"),  # These should be non-overlapping
    vars = c("information-name", "information-email")
  )
  
  expect_equal(actual_output, expected_output)
})

test_that("submissions_summary works with empty title matches", {
  # Test with titles that don't match any files
  actual_output <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = c("email", "none"),
    vars = c("information-name", "information-email")
  )
  
  expect_s3_class(actual_output, "tbl_df")
  expect_equal(nrow(actual_output), 0L)
})

test_that("submissions_summary works with mixed existing and non-existing titles", {
  # Test with some titles that match and some that don't
  actual_output <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = c("none", "none", "getting", "none", "none"),
    vars = c("information-name", "information-email")
  )
  
  expect_s3_class(actual_output, "tbl_df")
  # Should only return results from the matching title
  expect_equal(nrow(actual_output), 2L)  # Only "getting" title matches
})

# Tests for emails parameter

test_that("submissions_summary works with default emails parameter", {
  result_default <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = "get",
    vars = c("information-email")
  )
  
  result_explicit <- submissions_summary(
    path = test_path("fixtures", "process_submissions_dir"),
    title = "get",
    vars = c("information-email"),
    emails = "*"
  )
  
  expect_equal(result_default, result_explicit)
})