tests/testthat/test-compat_friendly_type.R

In admiraldev: Utility Functions and Development Tools for the Admiral Package Family

# friendly_type_of ----
## Test 1: friendly_type_of() supports objects ----
test_that("friendly_type_of Test 1: friendly_type_of() supports objects", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_equal(friendly_type_of(mtcars), "a <data.frame> object")
  expect_equal(friendly_type_of(rlang::quo(1)), "a <quosure> object")
})

## Test 2: friendly_type_of() supports matrices and arrays ----
test_that("friendly_type_of Test 2: friendly_type_of() supports matrices and arrays", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_equal(friendly_type_of(list()), "an empty list")
  expect_equal(friendly_type_of(matrix(list(1, 2))), "a list matrix")
  expect_equal(friendly_type_of(array(list(1, 2, 3), dim = 1:3)), "a list array")

  expect_equal(friendly_type_of(matrix(1:3)), "an integer matrix")
  expect_equal(friendly_type_of(array(1:3, dim = 1:3)), "an integer array")

  expect_equal(friendly_type_of(matrix(letters)), "a character matrix")
  expect_equal(friendly_type_of(array(letters[1:3], dim = 1:3)), "a character array")
})

## Test 3: friendly_type_of() handles scalars ----
test_that("friendly_type_of Test 3: friendly_type_of() handles scalars", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_equal(friendly_type_of(NA), "`NA`")

  expect_equal(friendly_type_of(TRUE), "`TRUE`")
  expect_equal(friendly_type_of(FALSE), "`FALSE`")

  expect_equal(friendly_type_of(1L), "an integer")
  expect_equal(friendly_type_of(1.0), "a number")
  expect_equal(friendly_type_of(1i), "a complex number")
  expect_equal(friendly_type_of(as.raw(1)), "a raw value")

  expect_equal(friendly_type_of("foo"), "a string")
  expect_equal(friendly_type_of(""), "`\"\"`")

  expect_equal(friendly_type_of(list(1)), "a list")

  expect_equal(friendly_type_of(matrix(NA)), "a logical matrix")
  expect_equal(friendly_type_of(matrix(1)), "a double matrix")
})

## Test 4: friendly_type_of() edge cases ----
test_that("friendly_type_of Test 4: friendly_type_of() edge cases", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_equal(friendly_type_of(), "absent")
  expect_equal(friendly_type_of(1:2, length = TRUE), "an integer vector of length 2")

  expect_equal(friendly_type_of(list(test = 1:3)), "a list")
  expect_equal(friendly_type_of(NULL), "NULL")
  expect_equal(friendly_type_of(new.env(parent = emptyenv())), "an environment")

  # If we go through with adding xml2 into namespace this should work, xml2 is in renv.lock
  # expect_equal(friendly_type_of(xml2::read_xml("<foo><bar /></foo>")$node), "a pointer") nolint

  test_weakref <- rlang::new_weakref(new.env(parent = emptyenv()),
    finalizer = function(e) suppressMessages(message("finalized"))
  )
  expect_equal(friendly_type_of(test_weakref), "a weak reference")

  # Skip name
  expect_equal(friendly_type_of(sym("test symbol")), "a symbol")
  expect_equal(friendly_type_of(expr(1 + 1)), "a call")
  expect_equal(friendly_type_of(pairlist(x = 1, y = 2)), "a pairlist node")
  expect_equal(friendly_type_of(expression(x <- 4, x)), "an expression vector")

  # Unsure what char is in compat_friendly_type.R line 118
  # Promise seems impossible because it stops being a promise at evaluation?
  # Unsure how to check for `...`
  # Unsure how to check for `any`

  expect_equal(friendly_type_of(compiler::compile(quote(1 + 3))), "an internal bytecode object")

  # Skip primitive
  # Skip builtin
  expect_equal(friendly_type_of(switch), "a primitive function")
  expect_equal(friendly_type_of(mean), "a function")
})
# .rlang_as_friendly_type ----
## Test 5: .rlang_as_friendly_type() works ----
test_that(".rlang_as_friendly_type Test 5: .rlang_as_friendly_type() works", {
  withr::local_options(lifecycle_verbosity = "quiet")
  setClass("person", slots = c(name = "character", age = "numeric"))
  john <- new("person", name = "John", age = 18)
  expect_equal(.rlang_as_friendly_type(typeof(john)), "an S4 object")
})

# .rlang_stop_unexpected_typeof ----
## Test 6: .rlang_stop_unexpected_typeof() works ----
test_that(".rlang_stop_unexpected_typeof Test 6: .rlang_stop_unexpected_typeof() works", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_error(.rlang_stop_unexpected_typeof("test"), "Unexpected type <character>.")
})

# stop_input_type ----
## Test 7: stop_input_type() works ----
test_that("stop_input_type Test 7: stop_input_type() works", {
  withr::local_options(lifecycle_verbosity = "quiet")
  expect_error(stop_input_type(1, what = "character"))
})