Added Guard.IsTrue/False overloads with custom message

Author: Sergio0694

Microsoft.Toolkit/Diagnostics/Guard.cs

@@ -268,6 +268,22 @@ public static void IsTrue([DoesNotReturnIf(false)] bool value, string name)
             }
         }
 
+        /// <summary>
+        /// Asserts that the input value must be <see langword="true"/>.
+        /// </summary>
+        /// <param name="value">The input <see cref="bool"/> to test.</param>
+        /// <param name="name">The name of the input parameter being tested.</param>
+        /// <param name="message">A message to display if <paramref name="value"/> is <see langword="false"/>.</param>
+        /// <exception cref="ArgumentException">Thrown if <paramref name="value"/> is <see langword="false"/>.</exception>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static void IsTrue([DoesNotReturnIf(false)] bool value, string name, string message)
+        {
+            if (!value)
+            {
+                ThrowHelper.ThrowArgumentExceptionForIsTrue(name, message);
+            }
+        }
+
         /// <summary>
         /// Asserts that the input value must be <see langword="false"/>.
         /// </summary>
@@ -282,5 +298,21 @@ public static void IsFalse([DoesNotReturnIf(true)] bool value, string name)
                 ThrowHelper.ThrowArgumentExceptionForIsFalse(name);
             }
         }
+
+        /// <summary>
+        /// Asserts that the input value must be <see langword="false"/>.
+        /// </summary>
+        /// <param name="value">The input <see cref="bool"/> to test.</param>
+        /// <param name="name">The name of the input parameter being tested.</param>
+        /// <param name="message">A message to display if <paramref name="value"/> is <see langword="true"/>.</param>
+        /// <exception cref="ArgumentException">Thrown if <paramref name="value"/> is <see langword="true"/>.</exception>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static void IsFalse([DoesNotReturnIf(true)] bool value, string name, string message)
+        {
+            if (value)
+            {
+                ThrowHelper.ThrowArgumentExceptionForIsFalse(name, message);
+            }
+        }
     }
 }

Microsoft.Toolkit/Diagnostics/ThrowHelper.cs

@@ -157,7 +157,7 @@ public static void ThrowArgumentExceptionForIsReferenceNotEqualTo<T>(string name
         }
 
         /// <summary>
-        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsTrue"/> fails.
+        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsTrue(bool,string)"/> fails.
         /// </summary>
         [MethodImpl(MethodImplOptions.NoInlining)]
         public static void ThrowArgumentExceptionForIsTrue(string name)
@@ -166,12 +166,30 @@ public static void ThrowArgumentExceptionForIsTrue(string name)
         }
 
         /// <summary>
-        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsFalse"/> fails.
+        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsTrue(bool,string,string)"/> fails.
+        /// </summary>
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        public static void ThrowArgumentExceptionForIsTrue(string name, string message)
+        {
+            ThrowArgumentException(name, $"Parameter {name.ToAssertString()} must be true, was false: {message.ToAssertString()}");
+        }
+
+        /// <summary>
+        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsFalse(bool,string)"/> fails.
         /// </summary>
         [MethodImpl(MethodImplOptions.NoInlining)]
         public static void ThrowArgumentExceptionForIsFalse(string name)
         {
             ThrowArgumentException(name, $"Parameter {name.ToAssertString()} must be false, was true");
         }
+
+        /// <summary>
+        /// Throws an <see cref="ArgumentException"/> when <see cref="Guard.IsFalse(bool,string,string)"/> fails.
+        /// </summary>
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        public static void ThrowArgumentExceptionForIsFalse(string name, string message)
+        {
+            ThrowArgumentException(name, $"Parameter {name.ToAssertString()} must be false, was true: {message.ToAssertString()}");
+        }
     }
 }

UnitTests/UnitTests.Shared/Diagnostics/Test_Guard.cs

@@ -216,6 +216,7 @@ public void Test_Guard_IsReferenceNotEqualTo_Fail()
         public void Test_Guard_IsTrue_Ok()
         {
             Guard.IsTrue(true, nameof(Test_Guard_IsTrue_Ok));
+            Guard.IsTrue(true, nameof(Test_Guard_IsTrue_Ok), "Hello world");
         }
 
         [TestCategory("Guard")]
@@ -226,11 +227,32 @@ public void Test_Guard_IsTrue_Fail()
             Guard.IsTrue(false, nameof(Test_Guard_IsTrue_Fail));
         }
 
+        [TestCategory("Guard")]
+        [TestMethod]
+        public void Test_Guard_IsTrue_Fail_WithMessage()
+        {
+            try
+            {
+                Guard.IsTrue(false, nameof(Test_Guard_IsTrue_Fail_WithMessage), "Hello world");
+            }
+            catch (ArgumentException e)
+            {
+                Assert.IsTrue(e.Message.Contains("\"Hello world\""));
+
+                return;
+            }
+
+            // Compiler detects this is unreachable from attribute,
+            // but we leave the assertion to double check that's valid
+            Assert.Fail();
+        }
+
         [TestCategory("Guard")]
         [TestMethod]
         public void Test_Guard_IsFalse_Ok()
         {
             Guard.IsFalse(false, nameof(Test_Guard_IsFalse_Ok));
+            Guard.IsFalse(false, nameof(Test_Guard_IsFalse_Ok), "Hello world");
         }
 
         [TestCategory("Guard")]
@@ -241,6 +263,24 @@ public void Test_Guard_IsFalse_Fail()
             Guard.IsFalse(true, nameof(Test_Guard_IsFalse_Fail));
         }
 
+        [TestCategory("Guard")]
+        [TestMethod]
+        public void Test_Guard_IsFalse_Fail_WithMessage()
+        {
+            try
+            {
+                Guard.IsFalse(true, nameof(Test_Guard_IsFalse_Fail_WithMessage), "Hello world");
+            }
+            catch (ArgumentException e)
+            {
+                Assert.IsTrue(e.Message.Contains("\"Hello world\""));
+
+                return;
+            }
+
+            Assert.Fail();
+        }
+
         [TestCategory("Guard")]
         [TestMethod]
         public void Test_Guard_IsLessThan_Ok()