Merged origin/main into plietar-vector-assert

Author: hadley

.Rbuildignore

@@ -25,3 +25,4 @@
 ^\.git-blame-ignore-rev$
 ^CLAUDE\.md$
 ^\.claude$
+^vignettes/articles$

CLAUDE.md

@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 testthat is R's most popular unit testing framework, used by thousands of CRAN packages. It provides functions to make testing R code as fun and addictive as possible, with clear expectations, visual progress indicators, and seamless integration with R package development workflows.
 
-## Key Development Commands
+## Key development commands
 
 General advice:
 * When running R from the console, always run it with `--quiet --vanilla`
@@ -25,10 +25,11 @@ General advice:
 
 ### Documentation
 
-- Always run `devtools::document()` after changing any roxygen2 docs.
+- Run `devtools::document()` after changing any roxygen2 docs.
 - Every user facing function should be exported and have roxygen2 documentation.
 - Whenever you add a new documentation file, make sure to also add the topic name to `_pkgdown.yml`. 
 - Run `pkgdown::check_pkgdown()` to check that all topics are included in the reference index.
+- Use sentence case for all headings
 
 ## Core Architecture
 

DESCRIPTION

@@ -57,4 +57,4 @@ Config/testthat/parallel: true
 Config/testthat/start-first: watcher, parallel*
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE, r6 = FALSE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3

NEWS.md

@@ -1,8 +1,10 @@
 # testthat (development version)
 
+* New `vignette("mocking")` explains mocking in detail (#1265).
+* New `vignette("challenging-functions")` provides an index to other documentation organised by testing challenges (#1265).
 * When running a test interactively, testthat now reports the number of succeses. The results should also be more useful if you are using nested tests.
 * The hints generated by `expect_snapshot()` and `expect_snapshot_file()` now include the path to the package, if its not in the current working directory (#1577).
-* `expect_snapshot_file()` now clearly errors if the `path` doesnt exist (#2191).
+* `expect_snapshot_file()` now clearly errors if the `path` doesn't exist (#2191).
 * `expect_snapshot_file()` now considers `.json` to be a text file (#1593).
 * `expect_snapshot_file()` now shows differences for text files (#1593).
 * The failure messages for all `expect_` functions have been rewritten to first state what was expected and then what was actually received (#2142).
@@ -17,7 +19,7 @@
 * `local_mock()` and `with_mock()` have been deprecated because they are no longer permitted in R 4.5.
 * `snapshot_review()` now passes `...` on to `shiny::runApp()` (#1928).
 * `expect_named()` now gives more informative errors (#2091).
-* `expect_*()` functions consistently and rigorously check their inputs (#1754). 
+* `expect_*()` functions consistently and rigorously check their inputs (#1754).
 * `test_that()` no longer warns about the absence of `{}` since it no longer seems to be necessary.
 * `test_that()`, `describe()`, and `it()` can now be arbitrarily nested. Each component will skip only if it and its subtests don't contain any expectations. The interactive stop reporter has been fixed so it doesn't duplicate failures. (#2063, #2188).
 * Test filtering now works with `it()`, and the `desc` argument can take a character vector in order to recursively filter subtests (i.e. `it()` nested inside of `describe()`) (#2118).
@@ -36,7 +38,7 @@
 * New `expect_r6_class()` (#2030).
 * `expect_*()` functions consistently and rigorously check their inputs (#1754).
 * `JunitReporter()` no longer fails with `"no applicable method for xml_add_child"` for warnings outside of tests (#1913). Additionally, warnings now save their backtraces.
-* `JunitReporter()` strips ANSI escapes in more placese (#1852, #2032).
+* `JunitReporter()` strips ANSI escapes in more places (#1852, #2032).
 * `try_again()` is now publicised. The first argument is now the number of retries, not tries (#2050).
 * `vignette("custom-expectations)` has been overhauled to make it much clearer how to create high-quality expectations (#2113, #2132, #2072).
 * `expect_snapshot()` and friends will now fail when creating a new snapshot on CI. This is usually a signal that you've forgotten to run it locally before committing (#1461).
@@ -985,7 +987,7 @@ This release mostly focusses on an overhaul of how testthat works with condition
 * In `expect_equal_to_reference()`, the default value for `update` is
   now `FALSE` (@BrodieG, #683).
 
-* `expect_error()` now returns the error object as documentated (#724).
+* `expect_error()` now returns the error object as documented (#724).
   It also now warns if you're using a classed expectation and you're
   not using the `class` argument. This is good practice as it decouples the
   error object (which tends to be stable) from its rendering to the user
@@ -1677,7 +1679,7 @@ The reporters system class has been considerably refactored to make existing rep
 * `safe_digest()` uses a better strategy, and returns NA for directories
   (#138, #146).
 
-* Random praise is renabled by default (again!) (#164).
+* Random praise is re-enabled by default (again!) (#164).
 
 * Teamcity reporter now correctly escapes output messages (#150, @windelinckx).
   It also uses nested suites to include test names.

R/expect-named.R

@@ -35,7 +35,6 @@ expect_named <- function(
   check_bool(ignore.order)
   check_bool(ignore.case)
 
-  
   act <- quasi_label(enquo(object), label)
 
   if (missing(expected)) {

R/expect-self-test.R

@@ -39,7 +39,7 @@ capture_success_failure <- function(expr) {
 #' Use `show_failure()` in examples to print the failure message without
 #' throwing an error.
 #'
-#' @param expr Code to evalute
+#' @param expr Code to evaluate
 #' @param message Check that the failure message matches this regexp.
 #' @param ... Other arguments passed on to [expect_match()].
 #' @export

R/expect-setequal.R

@@ -28,8 +28,8 @@ expect_setequal <- function(object, expected) {
   act <- quasi_label(enquo(object))
   exp <- quasi_label(enquo(expected))
 
-  check_vector(object)
-  check_vector(expected)
+  check_vector(act$val, error_arg = "object")
+  check_vector(exp$val, error_arg = "expected")
   if (!is.null(names(act$val)) && !is.null(names(exp$val))) {
     testthat_warn("expect_setequal() ignores names")
   }

R/expect-that.R

@@ -15,7 +15,7 @@
 #' @param srcref Location of the failure. Should only needed to be explicitly
 #'   supplied when you need to forward a srcref captured elsewhere.
 #' @param trace_env If `trace` is not specified, this is used to generate an
-#'   informative traceack for failures. You should only need to set this if
+#'   informative traceback for failures. You should only need to set this if
 #'   you're calling `fail()` from a helper function; see
 #'   `vignette("custom-expectation")` for details.
 #' @param trace An optional backtrace created by [rlang::trace_back()].

R/mock2.R

@@ -100,7 +100,7 @@
 #'
 #' To mock a function that returns different values in sequence,
 #' for instance an API call whose status would be 502 then 200,
-#' or an user intput to `readline()`, you can use [mock_output_sequence()]
+#' or an user input to `readline()`, you can use [mock_output_sequence()]
 #'
 #' ```R
 #' local_mocked_bindings(readline = mock_output_sequence("3", "This is a note", "n"))

R/quasi-label.R

@@ -59,10 +59,11 @@ quasi_label <- function(quo, label = NULL, arg = NULL) {
 }
 
 labelled_value <- function(value, label) {
-  list(
-    val = value,
-    lab = label
-  )
+  if (missing(value)) {
+    list(val = missing_arg(), lab = label)
+  } else {
+    list(val = value, lab = label)
+  }
 }
 
 quasi_capture <- function(.quo, .label, .capture, ...) {