Working on fluent assertions

Author: andrewvk

CodeJam.Main/Assertions/ArgumentAssertionExtensions.cs

@@ -1,24 +1,106 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Runtime.CompilerServices;
+
+using JetBrains.Annotations;
+
+using static CodeJam.PlatformDependent;
 
 namespace CodeJam
 {
+	/// <summary>
+	/// <see cref="ArgumentAssertion{T}"/> extension methods.
+	/// </summary>
+	[PublicAPI]
 	public static class ArgumentAssertionExtensions
 	{
-		public static ArgumentAssertion<T> NotNull<T>(this ArgumentAssertion<T> arg) where T : class
+		/// <summary>
+		/// Ensures that <paramref name="arg"/> != <c>null</c>
+		/// </summary>
+		/// <typeparam name="T">Type of the value. Auto-inferred in most cases</typeparam>
+		/// <param name="arg">The argument.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
+		public static ArgumentAssertion<T> NotNull<T>([NoEnumeration] this ArgumentAssertion<T> arg) where T : class
+		{
+			Code.NotNull(arg.Argument, arg.ArgumentName);
+			return arg;
+		}
+
+		/// <summary>
+		/// Ensures that <paramref name="arg"/> != <c>null</c>
+		/// </summary>
+		/// <typeparam name="T">Type of the value. Auto-inferred in most cases</typeparam>
+		/// <param name="arg">The argument.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
+		public static ArgumentAssertion<T?> NotNull<T>([NoEnumeration] this ArgumentAssertion<T?> arg) where T : struct
 		{
 			Code.NotNull(arg.Argument, arg.ArgumentName);
 			return arg;
 		}
 
+		/// <summary>Ensures that all items in <paramref name="arg"/> != <c>null</c></summary>
+		/// <typeparam name="T">Type of the value. Auto-inferred in most cases</typeparam>
+		/// <param name="arg">The argument.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
 		public static ArgumentAssertion<IEnumerable<T>> ItemNotNull<T>(this ArgumentAssertion<IEnumerable<T>> arg) where T : class
 		{
 			Code.ItemNotNull(arg.Argument, arg.ArgumentName);
 			return arg;
 		}
 
-		public static ArgumentAssertion<T?> NotNull<T>(this ArgumentAssertion<T?> arg) where T : struct
+		/// <summary>Ensures that <paramref name="arg"/> is not null nor empty</summary>
+		/// <param name="arg">The argument.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
+		public static ArgumentAssertion<string> NotNullNorEmpty(this ArgumentAssertion<string> arg)
 		{
-			Code.NotNull(arg.Argument, arg.ArgumentName);
+			Code.NotNullNorEmpty(arg.Argument, arg.ArgumentName);
+			return arg;
+		}
+
+		/// <summary>Ensures that <paramref name="arg"/> is not null nor white space</summary>
+		/// <param name="arg">The argument.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
+		public static ArgumentAssertion<string> NotNullNorWhiteSpace(this ArgumentAssertion<string> arg)
+		{
+			Code.NotNullNorWhiteSpace(arg.Argument, arg.ArgumentName);
+			return arg;
+		}
+
+		/// <summary>Assertion for the argument value</summary>
+		/// <param name="arg">The argument.</param>
+		/// <param name="condition">The condition to check</param>
+		/// <param name="message">The message.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod]
+		public static ArgumentAssertion<T> Assert<T>(
+			this ArgumentAssertion<T> arg,
+			[AssertionCondition(AssertionConditionType.IS_TRUE)] bool condition,
+			[NotNull] string message)
+		{
+			Code.AssertArgument(condition, arg.ArgumentName, message);
+			return arg;
+		}
+
+		/// <summary>Assertion for the argument value</summary>
+		/// <param name="arg">Argument.</param>
+		/// <param name="condition">The condition to check</param>
+		/// <param name="messageFormat">The message format.</param>
+		/// <param name="args">Format string arguments.</param>
+		[DebuggerHidden, MethodImpl(AggressiveInlining)]
+		[AssertionMethod, StringFormatMethod("messageFormat")]
+		public static ArgumentAssertion<T> Assert<T>(
+			this ArgumentAssertion<T> arg,
+			[AssertionCondition(AssertionConditionType.IS_TRUE)] bool condition,
+			[NotNull] string messageFormat,
+			[CanBeNull] params object[] args)
+		{
+			Code.AssertArgument(condition, arg.ArgumentName, messageFormat, args);
 			return arg;
 		}
 	}

CodeJam.Main/Assertions/Code.cs

@@ -134,6 +134,13 @@ public static void AssertArgument(
 				throw CodeExceptions.Argument(argName, messageFormat, args);
 		}
 
+		/// <summary>
+		/// Creates <see cref="ArgumentAssertion{T}"/> for fluent assertions.
+		/// </summary>
+		/// <typeparam name="T">Type of argument</typeparam>
+		/// <param name="arg">Argument value.</param>
+		/// <param name="argName">Argument name.</param>
+		/// <returns><see cref="ArgumentAssertion{T}"/> instance.</returns>
 		public static ArgumentAssertion<T> Arg<T>(T arg, string argName) => new ArgumentAssertion<T>(arg, argName);
 		#endregion