Add more informative feedback in expect_named()

R/expect-named.R

@@ -39,21 +39,48 @@ expect_named <- function(
     if (identical(act$names, NULL)) {
       msg <- sprintf("%s does not have names.", act$lab)
       return(fail(msg))
+    } else {
+      return(pass(act$val))
     }
-  } else {
-    exp_names <- normalise_names(expected, ignore.order, ignore.case)
-    act$names <- normalise_names(act$names, ignore.order, ignore.case)
+  }
+
+  exp <- quasi_label(enquo(expected), arg = "expected")
+
+  exp$val <- normalise_names(exp$val, ignore.order, ignore.case)
+  act$names <- normalise_names(act$names, ignore.order, ignore.case)
 
-    if (!identical(act$names, exp_names)) {
+  if (ignore.order) {
+    act_miss <- unique(act$names[!act$names %in% exp$val])
+    exp_miss <- unique(exp$val[!exp$val %in% act$names])
+
+    if (length(exp_miss) != 0 || length(act_miss) != 0) {
+      msg <- paste0(
+        "Names of ",
+        act$lab,
+        " (`actual`) and ",
+        exp$lab,
+        " (`expected`) don't have the same values.\n",
+        if (length(act_miss)) {
+          paste0("* Only in `actual`: ", values(act_miss), "\n")
+        },
+        if (length(exp_miss)) {
+          paste0("* Only in `expected`: ", values(exp_miss), "\n")
+        }
+      )
+      return(fail(msg))
+    }
+  } else {
+    if (!identical(act$names, exp$val)) {
       msg <- sprintf(
         "Names of %s (%s) don't match %s",
         act$lab,
         paste0("'", act$names, "'", collapse = ", "),
-        paste0("'", exp_names, "'", collapse = ", ")
+        paste0("'", exp$val, "'", collapse = ", ")
       )
-      return(fail(msg, info = info))
+      return(fail(msg))
     }
   }
+
   pass(act$val)
 }
 

tests/testthat/_snaps/expect-named.md

@@ -0,0 +1,19 @@
+# provide useful feedback on failure
+
+    Names of c(a = 1) (`actual`) and c("a", "b") (`expected`) don't have the same values.
+    * Only in `expected`: "b"
+
+
+---
+
+    Names of c(a = 1, b = 1) (`actual`) and c("a") (`expected`) don't have the same values.
+    * Only in `actual`: "b"
+
+
+---
+
+    Names of c(a = 1) (`actual`) and c("b") (`expected`) don't have the same values.
+    * Only in `actual`: "a"
+    * Only in `expected`: "b"
+
+

tests/testthat/test-expect-named.R

@@ -19,3 +19,15 @@ test_that("expected_named optionally ignores order", {
     ignore.order = TRUE
   ))
 })
+
+test_that("provide useful feedback on failure", {
+  expect_snapshot_error(
+    expect_named(c(a = 1), c("a", "b"), ignore.order = TRUE)
+  )
+  expect_snapshot_error(
+    expect_named(c(a = 1, b = 1), c("a"), ignore.order = TRUE)
+  )
+  expect_snapshot_error(
+    expect_named(c(a = 1), c("b"), ignore.order = TRUE)
+  )
+})