Make labels more flexible

Author: hadley

R/expect-equality.R

@@ -68,7 +68,8 @@ expect_equal <- function(
   check_number_decimal(tolerance, min = 0, allow_null = TRUE)
 
   if (edition_get() >= 3) {
-    expect_waldo_equal_("equal", act, exp, info, ..., tolerance = tolerance)
+    msg <- "Expected %s to equal %s."
+    expect_waldo_equal_(msg, act, exp, info, ..., tolerance = tolerance)
   } else {
     if (!is.null(tolerance)) {
       comp <- compare(act$val, exp$val, ..., tolerance = tolerance)
@@ -105,7 +106,8 @@ expect_identical <- function(
   exp <- quasi_label(enquo(expected), expected.label)
 
   if (edition_get() >= 3) {
-    expect_waldo_equal_("identical", act, exp, info, ...)
+    msg <- "Expected %s to be identical to %s."
+    expect_waldo_equal_(msg, act, exp, info, ...)
   } else {
     if (identical(act$val, exp$val, ...)) {
       pass()
@@ -129,7 +131,7 @@ expect_identical <- function(
 }
 
 expect_waldo_equal_ <- function(
-  type,
+  msg,
   act,
   exp,
   info = NULL,
@@ -147,7 +149,7 @@ expect_waldo_equal_ <- function(
     pass()
   } else {
     msg <- c(
-      sprintf("Expected %s to be %s to %s.", act$lab, type, exp$lab),
+      sprintf(msg, act$lab, exp$lab),
       "Differences:",
       paste0(comp, collpase = "\n")
     )

R/expect-named.R

@@ -51,13 +51,14 @@ expect_named <- function(
     exp$val <- normalise_names(exp$val, ignore.order, ignore.case)
     act_names <- labelled_value(
       normalise_names(names(act$val), ignore.order, ignore.case),
-      paste0("names of ", act$lab)
+      act$lab
     )
 
+    msg <- "Expected %s to have names %s."
     if (ignore.order) {
-      expect_setequal_(act_names, exp)
+      expect_setequal_(msg, act_names, exp)
     } else {
-      expect_waldo_equal_("equal", act_names, exp)
+      expect_waldo_equal_(msg, act_names, exp)
     }
   }
 

R/expect-setequal.R

@@ -34,10 +34,11 @@ expect_setequal <- function(object, expected) {
     testthat_warn("expect_setequal() ignores names")
   }
 
-  expect_setequal_(act, exp)
+  expect_setequal_("Expected %s to have the same values as %s.", act, exp)
 }
 
 expect_setequal_ <- function(
+  msg,
   act,
   exp,
   trace_env = caller_env()
@@ -48,11 +49,7 @@ expect_setequal_ <- function(
   if (length(exp_miss) == 0 && length(act_miss) == 0) {
     pass()
   } else {
-    msg_exp <- sprintf(
-      "Expected %s to have the same values as %s.",
-      act$lab,
-      exp$lab
-    )
+    msg_exp <- sprintf(msg, act$lab, exp$lab)
     msg_act <- c(
       sprintf("Actual: %s", values(act$val)),
       sprintf("Expected: %s", values(exp$val)),
@@ -103,13 +100,16 @@ expect_mapequal <- function(object, expected) {
     pass()
   } else {
     if (!setequal(act_nms, exp_nms)) {
-      act_names <- labelled_value(names(act$val), paste0("names of ", act$lab))
-      exp_names <- labelled_value(names(exp$val), paste0("names of ", exp$lab))
-      expect_setequal_(act_names, exp_names)
+      msg <- "Expected %s to have the same names as %s."
+      act_names <- labelled_value(names(act$val), act$lab)
+      exp_names <- labelled_value(names(exp$val), exp$lab)
+      expect_setequal_(msg, act_names, exp_names)
     } else {
       if (edition_get() >= 3) {
         act <- labelled_value(act$val[exp_nms], act$lab)
-        expect_waldo_equal_("equal", act, exp)
+
+        msg <- "Expected %s to contain same values as %s."
+        expect_waldo_equal_(msg, act, exp)
       } else {
         # Packages depend on 2e behaviour, but the expectation isn't written
         # to be reused, and we don't want to bother

tests/testthat/_snaps/expect-equality.md

@@ -15,7 +15,7 @@
       expect_equal(x, "a")
     Condition
       Error:
-      ! Expected `x` to be equal to "a".
+      ! Expected `x` to equal "a".
       Differences:
       `actual` is a double vector (1)
       `expected` is a character vector ('a')
@@ -66,7 +66,7 @@
       expect_equal(x, !!y)
     Condition
       Error:
-      ! Expected `x` to be equal to 2.
+      ! Expected `x` to equal 2.
       Differences:
         `actual`: 1.0
       `expected`: 2.0

tests/testthat/_snaps/expect-named.md

@@ -12,7 +12,7 @@
       expect_named(x, "b")
     Condition
       Error:
-      ! Expected names of `x` to be equal to "b".
+      ! Expected `x` to have names "b".
       Differences:
       `actual`:   "a"
       `expected`: "b"
@@ -23,7 +23,7 @@
       expect_named(x1, c("a", "b"), ignore.order = TRUE)
     Condition
       Error:
-      ! Expected names of `x1` to have the same values as `c("a", "b")`.
+      ! Expected `x1` to have names `c("a", "b")`.
       Actual: "a"
       Expected: "a", "b"
       Absent: "b"
@@ -34,7 +34,7 @@
       expect_named(x2, "a", ignore.order = TRUE)
     Condition
       Error:
-      ! Expected names of `x2` to have the same values as "a".
+      ! Expected `x2` to have names "a".
       Actual: "a", "b"
       Expected: "a"
       Needs: "b"
@@ -45,7 +45,7 @@
       expect_named(x1, "b", ignore.order = TRUE)
     Condition
       Error:
-      ! Expected names of `x1` to have the same values as "b".
+      ! Expected `x1` to have names "b".
       Actual: "a"
       Expected: "b"
       Needs: "a"
@@ -57,7 +57,7 @@
       expect_named(x1, c("a", "b"), ignore.order = FALSE)
     Condition
       Error:
-      ! Expected names of `x1` to be equal to `c("a", "b")`.
+      ! Expected `x1` to have names `c("a", "b")`.
       Differences:
       `actual`:   "a"    
       `expected`: "a" "b"
@@ -68,7 +68,7 @@
       expect_named(x2, "a", ignore.order = FALSE)
     Condition
       Error:
-      ! Expected names of `x2` to be equal to "a".
+      ! Expected `x2` to have names "a".
       Differences:
       `actual`:   "a" "b"
       `expected`: "a"    
@@ -79,7 +79,7 @@
       expect_named(x1, "b", ignore.order = FALSE)
     Condition
       Error:
-      ! Expected names of `x1` to be equal to "b".
+      ! Expected `x1` to have names "b".
       Differences:
       `actual`:   "a"
       `expected`: "b"

tests/testthat/_snaps/expect-setequal.md

@@ -115,7 +115,7 @@
       expect_mapequal(x, y)
     Condition
       Error:
-      ! Expected names of `x` to have the same values as names of `y`.
+      ! Expected `x` to have the same names as `y`.
       Actual: "a", "b"
       Expected: "a"
       Needs: "b"
@@ -126,7 +126,7 @@
       expect_mapequal(y, x)
     Condition
       Error:
-      ! Expected names of `y` to have the same values as names of `x`.
+      ! Expected `y` to have the same names as `x`.
       Actual: "a"
       Expected: "a", "b"
       Absent: "b"
@@ -137,7 +137,7 @@
       expect_mapequal(x, y)
     Condition
       Error:
-      ! Expected `x` to be equal to `y`.
+      ! Expected `x` to contain same values as `y`.
       Differences:
         `actual$b`: 2.0
       `expected$b`: 3.0

tests/testthat/_snaps/try-again.md

@@ -14,7 +14,7 @@
       i Expectation failed; trying again (1)...
     Condition
       Error:
-      ! Expected `i` to be equal to 0.
+      ! Expected `i` to equal 0.
       Differences:
         `actual`: 1.0
       `expected`: 0.0