From 0a13b0a1feb1122bf83526f8621eff4386e72719 Mon Sep 17 00:00:00 2001
From: Bradford Hovinen <hovinen@gmail.com>
Date: Sat, 16 Dec 2023 20:28:49 +0100
Subject: [PATCH] Add support for trailing commas on `assert_that!` and
 `expect_that!`.

Previously, putting a trailing comma on `assert_that!` or `expect_that!` would produce a compilation error when no custom error message is present:

```
assert_that!(
   value,
   eq(2),  // Error!
);
```

This change adds support for trailing commas, making the behaviour of these macros more consistent with the rest of the library and Rust idioms.

Fixes #340
---
 googletest/src/assertions.rs               |  6 ++--
 integration_tests/src/integration_tests.rs | 33 ++++++++++++++++++++--
 2 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/googletest/src/assertions.rs b/googletest/src/assertions.rs
index 9fd93adc..26680281 100644
--- a/googletest/src/assertions.rs
+++ b/googletest/src/assertions.rs
@@ -136,7 +136,7 @@ macro_rules! verify_that {
             $crate::internal::source_location::SourceLocation::new(file!(), line!(), column!()),
         )
     };
-    ($actual:expr, $expected:expr) => {
+    ($actual:expr, $expected:expr $(,)?) => {
         $crate::assertions::internal::check_matcher(
             &$actual,
             $expected,
@@ -351,7 +351,7 @@ macro_rules! fail {
 /// equivalent to `ASSERT_THAT`, use [`verify_that!`] with the `?` operator.
 #[macro_export]
 macro_rules! assert_that {
-    ($actual:expr, $expected:expr) => {
+    ($actual:expr, $expected:expr $(,)?) => {
         match $crate::verify_that!($actual, $expected) {
             Ok(_) => {}
             Err(e) => {
@@ -442,7 +442,7 @@ macro_rules! assert_pred {
 /// ```
 #[macro_export]
 macro_rules! expect_that {
-    ($actual:expr, $expected:expr) => {{
+    ($actual:expr, $expected:expr $(,)?) => {{
         use $crate::GoogleTestSupport;
         $crate::verify_that!($actual, $expected).and_log_failure();
     }};
diff --git a/integration_tests/src/integration_tests.rs b/integration_tests/src/integration_tests.rs
index 045db057..cfe86fc0 100644
--- a/integration_tests/src/integration_tests.rs
+++ b/integration_tests/src/integration_tests.rs
@@ -26,6 +26,12 @@ mod tests {
         verify_that!(value, eq(2))
     }
 
+    #[test]
+    fn verify_that_supports_trailing_comma() -> Result<()> {
+        let value = 2;
+        verify_that!(value, eq(2),)
+    }
+
     #[test]
     fn should_pass_with_omitted_elements_are() -> Result<()> {
         verify_that!(vec![1, 2], [eq(1), eq(2)])
@@ -48,10 +54,21 @@ mod tests {
     }
 
     #[test]
-    fn should_pass_with_assert_that() -> Result<()> {
+    fn should_pass_with_assert_that() {
         let value = 2;
         assert_that!(value, eq(2));
-        Ok(())
+    }
+
+    #[test]
+    fn assert_that_supports_trailing_comma() {
+        let value = 2;
+        assert_that!(value, eq(2),);
+    }
+
+    #[test]
+    fn assert_that_with_custom_failure_message_supports_trailing_comma() {
+        let value = 2;
+        assert_that!(value, eq(2), "A custom error message",);
     }
 
     #[googletest::test]
@@ -67,6 +84,18 @@ mod tests {
         expect_that!(value, eq(2));
     }
 
+    #[googletest::test]
+    fn expect_that_supports_trailing_comma() {
+        let value = 2;
+        expect_that!(value, eq(2),);
+    }
+
+    #[googletest::test]
+    fn expect_that_with_custom_failure_message_supports_trailing_comma() {
+        let value = 2;
+        expect_that!(value, eq(2), "A custom error message",);
+    }
+
     #[test]
     fn should_fail_on_assertion_failure() -> Result<()> {
         let status = run_external_process("simple_assertion_failure").status()?;