Add expectedNumberOfRequests parameter to With methods

- the `With()` method is renamed to `WithFilter()` since `With` is a language keyword.
- the `Times()` method is replaced by an overload on the `WithFilter()` method that accepts an integer to indicate the exact number of requests expected.
- an extra overload for WithFilter is added that accepts a nullable integer. Passing `null` indicates that at least 1 request is expected, passing a number indicates the exact number of requests that are expected.
- all existing `With*()` methods also received the an overload that accepts an integer to indicate the exact number of expected requests.

Note that both the `With` and `Times` methods will be removed in the release after 0.5

Fixes #47

Author: dnperfors

CHANGELOG.md

@@ -5,12 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Deprecated
+- `WithUriPattern(this IHttpRequestMessagesCheck, string)` will be removed in favour of `WithRequestUri(this IHttpRequestMessagesCheck, string)`
+- `With(Func<HttpRequestMessage, bool>, string)` will be removed in favour of `WithFilter(Func<HttpRequestMessage, bool>, string)`, since it conflicts with the language keyword `with`.
+- `Times(int)` will be removed in favour of the `With*` methods with an `int` parameter.
+
 ### Added
 - It is now possible to use NFluent to check `TestableHttpMessageHandler` by using `Check.That(handler).HasMadeRequests()` and `Check.That(handler).HasMadeRequestsTo("https://github.com/dnperfors/testablehttpclient")`. All existing `With` checks are supported.
+- All `With*` methods got an extra overload to specify the exact number of expected requests. This is instead of the `Times` method.
+
 ### Changed
 - Introduced `IHttpRequestMessagesCheck` as the public interface for all checks on requests made to `TestableHttpMessageHandler`. It contains the following api:
-  - `With(Func<HttpRequestMessage, bool>, string)`
-  - `Times(int)`
+  - `WithFilter(Func<HttpRequestMessage, bool>, string)`
+  - `WithFilter(Func<HttpRequestMessage, bool>, int, string)`
+  - `WithFilter(Func<HttpRequestMessage, bool>, int?, string)`
 - Moved some api's from `TestableHttpMessageHandler` to `TestableHttpMessageHandlerAssertionExtensions`:
   - `ShouldHaveMadeRequests(this TestableHttpMessageHandler)`
   - `ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler, string)`
@@ -30,9 +38,6 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   - `WithJsonContent(this IHttpRequestMessagesCheck, object)`
   - `WithFormUrlEncodedContent(this IHttpRequestMessagesCheck, IEnumerable<KeyValuePair<string, string>)`
 
-### Deprecated
-- `WithUriPattern(this IHttpRequestMessagesCheck, string)` will be removed in favour of `WithRequestUri(this IHttpRequestMessagesCheck, string)`
-
 ### Removed
 - `HttpRequestMessageAsserter` is made internal.
 

src/TestableHttpClient.NFluent/FluentHttpRequestMessagesChecks.cs

@@ -22,29 +22,33 @@ internal class FluentHttpRequestMessagesChecks : FluentSut<IEnumerable<HttpReque
         public FluentHttpRequestMessagesChecks(IEnumerable<HttpRequestMessage> httpRequestMessages)
             : base(httpRequestMessages, Check.Reporter, false)
         {
-            if (httpRequestMessages == null)
-            {
-                throw new ArgumentNullException(nameof(httpRequestMessages));
-            }
-            requests = httpRequestMessages;
+            requests = httpRequestMessages ?? throw new ArgumentNullException(nameof(httpRequestMessages));
         }
 
-        public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> predicate, string message)
+        [Obsolete("With is a language keyword and should be avoided, use WithFilter instead.", true)]
+        public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> predicate, string message) => WithFilter(predicate, message);
+
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, string condition) => WithFilter(requestFilter, null, condition);
+
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int expectedNumberOfRequests, string condition) => WithFilter(requestFilter, (int?)expectedNumberOfRequests, condition);
+
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int? expectedNumberOfRequests, string condition)
         {
-            if (!string.IsNullOrEmpty(message))
+            if (!string.IsNullOrEmpty(condition))
             {
-                requestConditions.Add(message);
+                requestConditions.Add(condition);
             }
 
             var checkLogic = ExtensibilityHelper.BeginCheck(this)
-                .CantBeNegated(nameof(With))
-                .FailWhen(_ => predicate == null, "The predicate should not be null.", MessageOption.NoCheckedBlock | MessageOption.NoExpectedBlock)
-                .Analyze((sut, _) => requests = requests.Where(predicate));
+                .CantBeNegated(nameof(WithFilter))
+                .FailWhen(_ => requestFilter == null, "The request filter should not be null.", MessageOption.NoCheckedBlock | MessageOption.NoExpectedBlock)
+                .Analyze((sut, _) => requests = requests.Where(requestFilter));
 
-            AnalyzeNumberOfRequests(checkLogic, null);
+            AnalyzeNumberOfRequests(checkLogic, expectedNumberOfRequests);
             return this;
         }
 
+        [Obsolete("Times as a seperate check is no longer supported, use the With overload with expectdNumberOfRequests.")]
         public IHttpRequestMessagesCheck Times(int count)
         {
             var checkLogic = ExtensibilityHelper.BeginCheck(this)

src/TestableHttpClient/HttpRequestMessageAsserter.cs

@@ -65,21 +65,40 @@ private void Assert(int? expectedCount = null)
             }
         }
 
+        /// <summary>
+        /// Asserts whether requests comply with a specific filter.
+        /// </summary>
+        /// <param name="predicate">The filter to filter requests with before asserting.</param>
+        /// <param name="message">The name of the conditon, used in the exception message.</param>
+        /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+        [Obsolete("With is a language keyword and should be avoided, use WithFilter instead.", true)]
+        public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> predicate, string message) => WithFilter(predicate, message);
+
         /// <summary>
         /// Asserts whether requests comply with a specific filter.
         /// </summary>
         /// <param name="requestFilter">The filter to filter requests with before asserting.</param>
         /// <param name="condition">The name of the conditon, used in the exception message.</param>
         /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-        public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> requestFilter, string condition)
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, string condition) => WithFilter(requestFilter, null, condition);
+
+        /// <summary>
+        /// Asserts whether requests comply with a specific filter.
+        /// </summary>
+        /// <param name="requestFilter">The filter to filter requests with before asserting.</param>
+        /// <param name="condition">The name of the conditon, used in the exception message.</param>
+        /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int expectedNumberOfRequests, string condition) => WithFilter(requestFilter, (int?)expectedNumberOfRequests, condition);
+
+        public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int? expectedNumberOfRequests, string condition)
         {
             if (!string.IsNullOrEmpty(condition))
             {
                 _expectedConditions.Add(condition);
             }
 
             Requests = Requests.Where(requestFilter);
-            Assert();
+            Assert(expectedNumberOfRequests);
             return this;
         }
 
@@ -88,6 +107,7 @@ public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> requestFilt
         /// </summary>
         /// <param name="count">The number of requests that are expected, should be a positive value.</param>
         /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+        [Obsolete("Times as a seperate check is no longer supported, use the WithFilter overload with expectdNumberOfRequests.", true)]
         public IHttpRequestMessagesCheck Times(int count)
         {
             if (count < 0)