tests/testthat/test-DateFilterState.R

In teal.slice: Filter Module for 'teal' Applications

dates <- as.Date("2000-01-01") + 0:9

# initialize ----
testthat::test_that("constructor accepts a Date object", {
  testthat::expect_no_error(
    DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  )
  testthat::expect_error(
    DateFilterState$new(as.POSIXct(dates), slice = teal_slice(dataname = "data", varname = "variable")),
    "Assertion on 'x' failed"
  )
})

testthat::test_that("constructor raises warning when selected out of range", {
  testthat::expect_warning(
    DateFilterState$new(
      dates,
      slice = teal_slice(dataname = "data", varname = "variable", selected = range(dates) + c(-1, 1))
    ),
    regexp = "outside of the possible range"
  )
})

testthat::test_that("constructor raises warning when selected is not sorted", {
  testthat::expect_warning(
    DateFilterState$new(
      dates,
      slice = teal_slice(dataname = "data", varname = "variable", selected = dates[c(10, 1)])
    ),
    regexp = "Start date 2000-01-10 is set after"
  )
})

testthat::test_that("constructor raises error when selection is not Date", {
  testthat::expect_error(
    DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable", selected = c("a", "b"))),
    "Vector of set values must contain values coercible to Date."
  )
})

testthat::test_that("constructor raises warning when chioces is not sorted", {
  testthat::expect_warning(
    DateFilterState$new(
      dates,
      slice = teal_slice(dataname = "data", varname = "variable", choices = dates[c(10, 1)])
    ),
    regexp = "Invalid choices"
  )
})

testthat::test_that("constructor raises warning when chioces out of range", {
  testthat::expect_warning(
    DateFilterState$new(
      dates,
      slice = teal_slice(dataname = "data", varname = "variable", choices = range(dates) + c(-1, 1))
    ),
    regexp = "Choices adjusted"
  )
})

testthat::test_that("constructor raises error when selection is not Date", {
  testthat::expect_error(
    DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable", choices = c("a", "b"))),
    "Must be of class 'Date'"
  )
})

testthat::test_that("constructor sets default state", {
  fs <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  expect_identical_slice(
    fs$get_state(),
    teal_slice(
      dataname = "data",
      varname = "variable",
      choices = dates[c(1, 10)],
      selected = dates[c(1, 10)]
    )
  )
})


# set_state ----
testthat::test_that("set_state: selected accepts vector of two coercible to Date elements", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  testthat::expect_no_error(
    filter_state$set_state(teal_slice(selected = dates[c(1, 10)], dataname = "data", varname = "variable"))
  )
  testthat::expect_no_error(
    filter_state$set_state(teal_slice(selected = as.integer(dates[c(1, 10)]), dataname = "data", varname = "variable"))
  )
  testthat::expect_error(
    filter_state$set_state(teal_slice(selected = dates[1], dataname = "data", varname = "variable")),
    "Vector of set values must have length two"
  )
  testthat::expect_error(
    filter_state$set_state(teal_slice(selected = c("a", "b"), dataname = "data", varname = "variable")),
    "Vector of set values must contain values coercible to Date"
  )
})

testthat::test_that("set_state: selected raises warning when selection is not within the possible range", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))

  testthat::expect_warning(
    filter_state$set_state(
      teal_slice(dataname = "data", varname = "variable", choices = dates, selected = c(dates[1] - 1, dates[10]))
    ),
    "outside of the possible range"
  )
  testthat::expect_warning(
    filter_state$set_state(
      teal_slice(dataname = "data", varname = "variable", choices = dates, selected = c(dates[1], dates[10] + 1))
    ),
    "outside of the possible range"
  )
  testthat::expect_warning(
    filter_state$set_state(
      teal_slice(dataname = "data", varname = "variable", choices = dates, selected = c(dates[1] - 1, dates[10] + 1))
    ),
    "outside of the possible range"
  )
})

testthat::test_that("set_state: selected range is limited to lower and upper bound of possible range", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  suppressWarnings(filter_state$set_state(
    teal_slice(dataname = "data", varname = "variable", selected = c(dates[1] - 1, dates[10]))
  ))
  testthat::expect_equal(shiny::isolate(filter_state$get_state()$selected), c(dates[1], dates[10]))
  suppressWarnings(filter_state$set_state(
    teal_slice(dataname = "data", varname = "variable", selected = c(dates[1], dates[10] + 1))
  ))
  testthat::expect_equal(shiny::isolate(filter_state$get_state()$selected), c(dates[1], dates[10]))
  suppressWarnings(filter_state$set_state(
    teal_slice(dataname = "data", varname = "variable", selected = c(dates[1] - 1, dates[10] + 1))
  ))
  testthat::expect_equal(shiny::isolate(filter_state$get_state()$selected), c(dates[1], dates[10]))
})

testthat::test_that("set_state: selected raises error when selection is not a Date or coercible", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  testthat::expect_error(
    filter_state$set_state(teal_slice(dataname = "data", varname = "variable", selected = c("a", "b"))),
    "Vector of set values must contain values coercible to Date"
  )
})


# get_call ----
testthat::test_that("method get_call of default DateFilterState object returns NULL", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "dates"))
  testthat::expect_null(shiny::isolate(filter_state$get_call()))
})

testthat::test_that("get_call returns call selected different than choices", {
  filter_state <- DateFilterState$new(
    dates,
    slice = teal_slice(dataname = "data", varname = "variable", selected = dates[c(1, 3)])
  )
  testthat::expect_identical(
    shiny::isolate(filter_state$get_call()),
    quote(variable >= as.Date("2000-01-01") & variable <= as.Date("2000-01-03"))
  )
})

testthat::test_that("get_call returns call always if choices are limited - regardless of selected", {
  filter_state <- DateFilterState$new(
    x = dates,
    slice = teal_slice(dataname = "data", varname = "variable", choices = dates[c(1, 3)], selected = dates[c(1, 3)])
  )
  testthat::expect_identical(
    shiny::isolate(filter_state$get_call()),
    quote(variable >= as.Date("2000-01-01") & variable <= as.Date("2000-01-03"))
  )
})

testthat::test_that("get_call prefixes varname by dataname$varname if extract_type='list'", {
  filter_state <- DateFilterState$new(
    x = dates,
    slice = teal_slice(dataname = "data", varname = "variable", selected = dates[c(1, 3)]),
    extract_type = "list"
  )
  testthat::expect_identical(
    shiny::isolate(filter_state$get_call(dataname = "dataname")),
    quote(dataname$variable >= as.Date("2000-01-01") & dataname$variable <= as.Date("2000-01-03"))
  )
})

testthat::test_that("get_call prefixes varname by dataname[, 'varname'] if extract_type='matrix'", {
  filter_state <- DateFilterState$new(
    x = dates,
    slice = teal_slice(dataname = "data", varname = "variable", selected = dates[c(1, 3)]),
    extract_type = "matrix"
  )
  testthat::expect_identical(
    shiny::isolate(filter_state$get_call(dataname = "dataname")),
    quote(dataname[, "variable"] >= as.Date("2000-01-01") & dataname[, "variable"] <= as.Date("2000-01-03"))
  )
})

testthat::test_that("get_call adds is.na(variable) to returned call if keep_na is true", {
  filter_state <- DateFilterState$new(
    x = c(dates, NA),
    slice = teal_slice(dataname = "data", varname = "variable", selected = dates[c(1, 3)], keep_na = TRUE)
  )
  testthat::expect_identical(
    shiny::isolate(filter_state$get_call()),
    quote(is.na(variable) | variable >= as.Date("2000-01-01") & variable <= as.Date("2000-01-03"))
  )
})

testthat::test_that("get_call returns call if all selected but NA exists", {
  filter_state <- DateFilterState$new(
    x = c(dates, NA),
    slice = teal_slice(dataname = "data", varname = "variable", keep_na = FALSE)
  )
  testthat::expect_equal(
    shiny::isolate(filter_state$get_call()),
    quote(!is.na(variable) & (variable >= as.Date("2000-01-01") & variable <= as.Date("2000-01-10")))
  )
})

# format ----
testthat::test_that("format accepts logical show_all", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  testthat::expect_no_error(shiny::isolate(filter_state$format(show_all = TRUE)))
  testthat::expect_no_error(shiny::isolate(filter_state$format(show_all = FALSE)))
  testthat::expect_error(
    shiny::isolate(filter_state$format(show_all = 1)),
    "Assertion on 'show_all' failed: Must be of type 'logical flag', not 'double'"
  )
  testthat::expect_error(
    shiny::isolate(filter_state$format(show_all = 0)),
    "Assertion on 'show_all' failed: Must be of type 'logical flag', not 'double'"
  )
  testthat::expect_error(
    shiny::isolate(filter_state$format(show_all = "TRUE")),
    "Assertion on 'show_all' failed"
  )
})

testthat::test_that("format returns a properly formatted string representation", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  testthat::expect_equal(
    shiny::isolate(filter_state$format()),
    paste0(
      "DateFilterState:\n",
      format(shiny::isolate(filter_state$get_state()))
    )
  )
  testthat::expect_equal(
    shiny::isolate(filter_state$format(show_all = TRUE)),
    paste0(
      "DateFilterState:\n",
      format(shiny::isolate(filter_state$get_state()), show_all = TRUE)
    )
  )
})

# print ---
testthat::test_that("print returns a properly formatted string representation", {
  filter_state <- DateFilterState$new(dates, slice = teal_slice(dataname = "data", varname = "variable"))
  testthat::expect_equal(
    utils::capture.output(cat(filter_state$print())),
    c("DateFilterState:", utils::capture.output(print(shiny::isolate(filter_state$get_state()))))
  )
  testthat::expect_equal(
    utils::capture.output(cat(filter_state$print(show_all = TRUE))),
    c("DateFilterState:", utils::capture.output(print(shiny::isolate(filter_state$get_state()), show_all = TRUE)))
  )
})