Expect shape

NAMESPACE

@@ -119,6 +119,7 @@ export(expect_s3_class)
 export(expect_s4_class)
 export(expect_s7_class)
 export(expect_setequal)
+export(expect_shape)
 export(expect_silent)
 export(expect_snapshot)
 export(expect_snapshot_error)

NEWS.md

@@ -6,6 +6,7 @@
 * Fixed an issue preventing compilation from succeeding due to deprecation / removal of `std::uncaught_exception()` (@kevinushey, #2047).
 * New `skip_unless_r()` to skip running tests on unsuitable versions of R, e.g. `skip_unless_r(">= 4.1.0")` to skip tests that require, say, `...names` (@MichaelChirico, #2022)
 * `skip_on_os()` gains an option `"emscripten"` of the `os` argument to skip tests on Emscripten (@eitsupi, #2103).
+* New expectation, `expect_shape()`, for testing the shape (i.e., the `length()`, `nrow()`, `ncol()`, or `dim()`, all in one place (#1423, @michaelchirico).
 
 # testthat 3.2.3
 

R/expect-length.R

@@ -1,6 +1,7 @@
 #' Does code return a vector with the specified length?
 #'
-#' @seealso [expect_vector()] to make assertions about the "size" of a vector
+#' @seealso [expect_vector()] to make assertions about the "size" of a vector,
+#'   [expect_shape()] for more general assertions about object "shape".
 #' @inheritParams expect_that
 #' @param n Expected length.
 #' @family expectations

R/expect-shape.R

@@ -0,0 +1,68 @@
+#' Does code return an object with the specified shape?
+#'
+#' This is a generalization of [expect_length()] to test the "shape" of
+#'   more general objects like data.frames, matrices, and arrays.
+#'
+#' @seealso [expect_length()] to specifically make assertions about the
+#'   [length()] of a vector.
+#' @inheritParams expect_that
+#' @param ... Ignored.
+#' @param length Expected [length()] of `object`.
+#' @param nrow Expected [nrow()] of `object`.
+#' @param ncol Expected [ncol()] of `object`.
+#' @param dim Expected [dim()] of `object`.
+#' @family expectations
+#' @export
+#' @examples
+expect_shape = function(object, ..., length, nrow, ncol, dim) {
+  rlang::check_exclusive(length, nrow, ncol, dim)
+
+  # Re-use expect_length() to ensure they stay in sync.
+  if (!missing(length)) {
+    return(expect_length(object, length))
+  }
+
+  # need base:: qualification or we might trigger an error for missing(length)
+  length <- base::length
+
+  act <- quasi_label(enquo(object), arg = "object")
+  dim_object <- base::dim(object)
+
+  expect(
+    !is.null(dim_object),
+    sprintf("%s has no dimensions.", act$lab)
+  )
+
+  if (!missing(nrow)) {
+    act$nrow <- dim_object[1L]
+
+    expect(
+      identical(as.integer(act$nrow), as.integer(nrow)),
+      sprintf("%s has %i rows, not %i.", act$lab, act$nrow, nrow)
+    )
+  } else if (!missing(ncol)) {
+    expect(
+      length(dim_object) >= 2L,
+      sprintf("%s has only one dimension.", act$lab)
+    )
+
+    act$ncol <- dim_object[2L]
+
+    expect(
+      identical(as.integer(act$ncol), as.integer(ncol)),
+      sprintf("%s has %i columns, not %i.", act$lab, act$ncol, ncol)
+    )
+  } else { # !missing(dim)
+    act$dim <- dim_object
+
+    expect(
+      length(act$dim) == length(dim),
+      sprintf("%s has %i dimensions, not %i", act$lab, length(act$dim), length(dim))
+    )
+
+    expect(
+      identical(as.integer(act$dim), as.integer(dim)),
+      sprintf("%s has shape (%s), not (%s).", act$lab, toString(act$dim), toString(dim))
+    )
+  }
+}

_pkgdown.yml

@@ -26,6 +26,7 @@ reference:
 - subtitle: Vectors
   contents:
   - expect_length
+  - expect_shape
   - expect_gt
   - expect_match
   - expect_named

tests/testthat/_snaps/expect-shape.md

@@ -0,0 +1,77 @@
+# length compared correctly
+
+    `object` has length 1, not length 2.
+
+# dim compared correctly
+
+    matrix(nrow = 6, ncol = 3) has shape (6, 3), not (6, 2).
+
+---
+
+    matrix(nrow = 6, ncol = 3) has shape (6, 3), not (7, 3).
+
+---
+
+    array(dim = 1:3) has 3 dimensions, not 2
+
+---
+
+    array(dim = 1:3) has 3 dimensions, not 4
+
+# nrow compared correctly
+
+    matrix(nrow = 5, ncol = 5) has 5 rows, not 6.
+
+---
+
+    1 has no dimensions.
+
+# ncol compared correctly
+
+    matrix(nrow = 5, ncol = 5) has 5 columns, not 7.
+
+---
+
+    array(1) has only one dimension.
+
+---
+
+    array() has only one dimension.
+
+# NA handling (e.g. dbplyr)
+
+    `x` has NA rows, not 10.
+
+---
+
+    `x` has 10 columns, not NA.
+
+---
+
+    `x` has shape (NA, 10), not (10, NA).
+
+# at least one argument is required
+
+    Code
+      expect_shape(1:10)
+    Condition
+      Error in `expect_shape()`:
+      ! One of `length`, `nrow`, `ncol`, or `dim` must be supplied.
+
+---
+
+    Code
+      expect_shape(1:10, 2)
+    Condition
+      Error in `expect_shape()`:
+      ! One of `length`, `nrow`, `ncol`, or `dim` must be supplied.
+
+---
+
+    Code
+      expect_shape(1:10, nrow = 1L, ncol = 2L)
+    Condition
+      Error in `expect_shape()`:
+      ! Exactly one of `length`, `nrow`, `ncol`, or `dim` must be supplied.
+      x `nrow` and `ncol` were supplied together.
+

tests/testthat/test-expect-shape.R

@@ -0,0 +1,83 @@
+test_that("length compared correctly", {
+  expect_success(expect_shape(1, length = 1))
+  expect_snapshot_failure(expect_shape(1, length = 2))
+  expect_success(expect_shape(1:10, length = 10))
+  expect_success(expect_shape(letters[1:5], length = 5))
+  expect_success(expect_shape(integer(), length = 0))
+})
+
+test_that("dim compared correctly", {
+  expect_success(expect_shape(matrix(nrow = 5, ncol = 4), dim = c(5L, 4L)))
+  expect_snapshot_failure(expect_shape(matrix(nrow = 6, ncol = 3), dim = c(6L, 2L)))
+  expect_snapshot_failure(expect_shape(matrix(nrow = 6, ncol = 3), dim = c(7L, 3L)))
+  expect_success(expect_shape(data.frame(1:10, 11:20), dim = c(10, 2)))
+  expect_success(expect_shape(array(dim = 1:3), dim = 1:3))
+  expect_snapshot_failure(expect_shape(array(dim = 1:3), dim = 1:2))
+  expect_snapshot_failure(expect_shape(array(dim = 1:3), dim = 1:4))
+  expect_success(expect_shape(array(), dim = 0L))
+  dd <- c(0L, 0L, 0L, 5L, 0L, 0L, 0L)
+  expect_success(expect_shape(array(dim = dd), dim = dd))
+})
+
+test_that("nrow compared correctly", {
+  expect_success(expect_shape(matrix(nrow = 5, ncol = 4), nrow = 5L))
+  expect_snapshot_failure(expect_shape(matrix(nrow = 5, ncol = 5), nrow = 6L))
+  expect_success(expect_shape(data.frame(1:10, 11:20), nrow = 10L))
+  expect_snapshot_failure(expect_shape(1, nrow = 1))
+  expect_success(expect_shape(array(), nrow = 0L))
+  dd <- c(0L, 0L, 0L, 5L, 0L, 0L, 0L)
+  expect_success(expect_shape(array(dim = dd), nrow = 0L))
+})
+
+test_that("ncol compared correctly", {
+  expect_success(expect_shape(matrix(nrow = 5, ncol = 4), ncol = 4L))
+  expect_snapshot_failure(expect_shape(matrix(nrow = 5, ncol = 5), ncol = 7L))
+  expect_success(expect_shape(data.frame(1:10, 11:20), ncol = 2L))
+  expect_snapshot_failure(expect_shape(array(1), ncol = 1))
+  expect_snapshot_failure(expect_shape(array(), ncol = 0L))
+  dd <- c(0L, 0L, 0L, 5L, 0L, 0L, 0L)
+  expect_success(expect_shape(array(dim = dd), ncol = 0L))
+})
+
+test_that("uses S3 dim method", {
+  dim.testthat_expect_shape <- function(x) 1:2
+  x <- integer()
+  class(x) <- "testthat_expect_shape"
+  registerS3method("dim", "testthat_expect_shape", dim.testthat_expect_shape)
+
+  expect_success(expect_shape(x, dim = 1:2))
+})
+
+test_that("NA handling (e.g. dbplyr)", {
+  dim.testthat_expect_shape_missing <- function(x) c(NA_integer_, 10L)
+  x <- integer()
+  class(x) <- "testthat_expect_shape_missing"
+  registerS3method("dim", "testthat_expect_shape_missing", dim.testthat_expect_shape_missing)
+
+  expect_success(expect_shape(x, nrow = NA_integer_))
+  expect_success(expect_shape(x, ncol = 10L))
+  expect_success(expect_shape(x, dim = c(NA_integer_, 10L)))
+
+  expect_snapshot_failure(expect_shape(x, nrow = 10L))
+  expect_snapshot_failure(expect_shape(x, ncol = NA_integer_))
+  expect_snapshot_failure(expect_shape(x, dim = c(10L, NA_integer_)))
+})
+
+test_that("uses S4 dim method", {
+  A <- setClass("ExpectShapeA", slots = c(x = "numeric", y = "numeric"))
+  setMethod("dim", "ExpectShapeA", function(x) 8:10)
+  expect_success(expect_shape(A(x = 1:9, y = 3), dim = 8:10))
+})
+
+test_that("returns input", {
+  x <- list(1:10, letters)
+  out <- expect_shape(x, length = 2)
+  expect_identical(out, x)
+})
+
+test_that("at least one argument is required", {
+  err_msg <- "Exactly one of `length`, `nrow`, `ncol`, or `dim` must be provided."
+  expect_snapshot(expect_shape(1:10), error = TRUE) # no args
+  expect_snapshot(expect_shape(1:10, 2), error = TRUE) # no named args
+  expect_snapshot(expect_shape(1:10, nrow = 1L, ncol = 2L), error = TRUE) # multiple named args
+})