Updated README.md for model state number of errors testing (closes #33)

Author: ivaylokenov

documentation/README.md

@@ -136,6 +136,14 @@ MyWebApi
 	.ShouldHave()
 	.InvalidModelState();
 
+// tests whether model state is not valid
+// with specific number of errors
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.SomeAction(requestModel))
+	.ShouldHave()
+	.InvalidModelState(withNumberOfErrors: 5);
+	
 // tests whether model state is valid and returns some action result
 MyWebApi
 	.Controller<WebApiController>()

src/MyWebApi.Tests/BuildersTests/ActionsTests/ShouldHaveModelStateTests.cs

@@ -134,7 +134,7 @@ public void ShouldHaveInvalidModelStateShouldThrowExceptionWithValidRequestModel
                 .Controller<WebApiController>()
                 .Calling(c => c.ModelStateCheck(requestModel))
                 .ShouldHave()
-                .InvalidModelState(5);
+                .InvalidModelState(withNumberOfErrors: 5);
         }
 
         [Test]

src/MyWebApi/Builders/Actions/ShouldHave/ShouldHaveModelState.cs

@@ -51,20 +51,20 @@ public IAndTestBuilder<TActionResult> ValidModelState()
         /// <summary>
         /// Checks whether the tested action's provided model state is not valid.
         /// </summary>
-        /// <param name="numberOfErrors">Expected number of errors. If default null is provided, the test builder checks only if any errors are found.</param>
+        /// <param name="withNumberOfErrors">Expected number of errors. If default null is provided, the test builder checks only if any errors are found.</param>
         /// <returns>Test builder with AndAlso method.</returns>
-        public IAndTestBuilder<TActionResult> InvalidModelState(int? numberOfErrors = null)
+        public IAndTestBuilder<TActionResult> InvalidModelState(int? withNumberOfErrors = null)
         {
             var actualModelStateErrors = this.Controller.ModelState.Count;
             if (actualModelStateErrors == 0
-                || (numberOfErrors != null && actualModelStateErrors != numberOfErrors))
+                || (withNumberOfErrors != null && actualModelStateErrors != withNumberOfErrors))
             {
                 throw new ModelErrorAssertionException(string.Format(
                     "When calling {0} action in {1} expected to have invalid model state{2}, {3}.",
                     this.ActionName,
                     this.Controller.GetName(),
-                    numberOfErrors == null ? string.Empty : string.Format(" with {0} errors", numberOfErrors),
-                    numberOfErrors == null ? "but was in fact valid" : string.Format("but contained {0}", actualModelStateErrors)));
+                    withNumberOfErrors == null ? string.Empty : string.Format(" with {0} errors", withNumberOfErrors),
+                    withNumberOfErrors == null ? "but was in fact valid" : string.Format("but contained {0}", actualModelStateErrors)));
             }
 
             return this.NewAndTestBuilder();

src/MyWebApi/Builders/Contracts/Actions/IShouldHaveTestBuilder.cs

@@ -42,8 +42,8 @@ public interface IShouldHaveTestBuilder<TActionResult> : IBaseTestBuilderWithAct
         /// <summary>
         /// Checks whether the tested action's provided model state is not valid.
         /// </summary>
-        /// <param name="numberOfErrors">Expected number of errors. If default null is provided, the test builder checks only if any errors are found.</param>
+        /// <param name="withNumberOfErrors">Expected number of errors. If default null is provided, the test builder checks only if any errors are found.</param>
         /// <returns>Test builder with AndAlso method.</returns>
-        IAndTestBuilder<TActionResult> InvalidModelState(int? numberOfErrors = null);
+        IAndTestBuilder<TActionResult> InvalidModelState(int? withNumberOfErrors = null);
     }
 }