Merge pull request #39 from JeremiahSanders/release/1.0.0

Release/1.0.0

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "cicee": {
-      "version": "1.5.1",
+      "version": "1.11.0",
       "commands": [
         "cicee"
       ]

README.md

@@ -138,6 +138,10 @@ using Jds.LanguageExt.Extras;
   * Filters `TSuccess` results by executing `filter`. If it returns `true`, the existing value is returned. If it returns `false`, then it executes `onFalse` to create an `Exception`. Memoizes successful results.
 * `TryAsync<TSuccess>.FilterAsync<TSuccess>(Func<TSuccess, Task<bool>> filter, Func<TSuccess, Exception> onFalse)`
   * Filters `TSuccess` results by executing `filter`. If it returns `true`, the existing value is returned. If it returns `false`, then it executes `onFalse` to create an `Exception`. Memoizes successful results.
+* `TryAsync<TSuccess>.Filter<TSuccess>(Func<TSuccess, Exception> ifCanceled, CancellationToken cancellationToken)`
+  * Filters based upon `cancellationToken`. If it is **not** cancelled, the existing value is returned. If it **is** cancelled, then it executes `ifCanceled` to create an `Exception`.
+* `TryAsync<TSuccess>.Filter<TSuccess>(CancellationToken cancellationToken)`
+  * Filters based upon `cancellationToken`. If it is **not** cancelled, the existing value is returned. If it **is** cancelled, then it creates an `OperationCanceledException` with `cancellationToken`.
 * `TryAsync<TSuccess>.Tap<TSuccess>(Action<TSuccess> onSuccess, Action<Exception> onFailure)`
   * Executes a side effect, e.g., logging, based upon the state of the result. The current value is returned unchanged.
 * `TryAsync<TSuccess>.Tap<TSuccess>(Func<TSuccess, Task> onSuccess, Func<Exception, Task> onFailure)`

docs/api/Jds.LanguageExt.Extras/TryAsyncMonadExtensions.md

@@ -10,7 +10,7 @@ public static class TryAsyncMonadExtensions
 
 | name | description |
 | --- | --- |
-| static [Filter<TSuccess>](TryAsyncMonadExtensions/Filter.md)(…) | Returns a TryAsync which filters the result of *tryAsync*. When *filter* returns `false`, *onFalse* creates the failure result. (2 methods) |
+| static [Filter<TSuccess>](TryAsyncMonadExtensions/Filter.md)(…) | Returns a TryAsync which filters the result of *tryAsync*. When *filter* returns `false`, *onFalse* creates the failure result. (4 methods) |
 | static [Tap<TSuccess>](TryAsyncMonadExtensions/Tap.md)(…) | Execute a side effect and returns *tryAsync* result unchanged. (2 methods) |
 | static [TapFailure<TSuccess>](TryAsyncMonadExtensions/TapFailure.md)(…) | Execute a side effect when *tryAsync* fails and returns *tryAsync* result unchanged. (2 methods) |
 | static [TapSuccess<TSuccess>](TryAsyncMonadExtensions/TapSuccess.md)(…) | Execute a side effect when *tryAsync* succeeds and returns *tryAsync* result unchanged. (2 methods) |

docs/api/Jds.LanguageExt.Extras/TryAsyncMonadExtensions/Filter.md

@@ -1,4 +1,30 @@
-# TryAsyncMonadExtensions.Filter<TSuccess> method (1 of 2)
+# TryAsyncMonadExtensions.Filter<TSuccess> method (1 of 4)
+
+Returns a TryAsync which filters the result of *tryAsync* based upon whether the provided *cancellationToken* is canceled (via IsCancellationRequested).
+
+```csharp
+public static TryAsync<TSuccess> Filter<TSuccess>(this TryAsync<TSuccess> tryAsync, 
+    CancellationToken cancellationToken)
+```
+
+| parameter | description |
+| --- | --- |
+| TSuccess | A success type. |
+| tryAsync | A TryAsync. |
+| cancellationToken | An asynchronous operation cancellation token. |
+
+## Return Value
+
+A TryAsync. If *cancellationToken* is not canceled: current *TSuccess* is returned. If canceled: an OperationCanceledException is returned.
+
+## See Also
+
+* class [TryAsyncMonadExtensions](../TryAsyncMonadExtensions.md)
+* namespace [Jds.LanguageExt.Extras](../../LanguageExt.Extras.md)
+
+---
+
+# TryAsyncMonadExtensions.Filter&lt;TSuccess&gt; method (2 of 4)
 
 Returns a TryAsync which filters the result of *tryAsync*. When *filter* returns `false`, *onFalse* creates the failure result.
 
@@ -25,7 +51,34 @@ A TryAsync. If *filter* returns true, current *TSuccess* is returned. If it retu
 
 ---
 
-# TryAsyncMonadExtensions.Filter&lt;TSuccess&gt; method (2 of 2)
+# TryAsyncMonadExtensions.Filter&lt;TSuccess&gt; method (3 of 4)
+
+Returns a TryAsync which filters the result of *tryAsync* based upon whether the provided *cancellationToken* is canceled (via IsCancellationRequested).
+
+```csharp
+public static TryAsync<TSuccess> Filter<TSuccess>(this TryAsync<TSuccess> tryAsync, 
+    Func<TSuccess, Exception> ifCanceled, CancellationToken cancellationToken)
+```
+
+| parameter | description |
+| --- | --- |
+| TSuccess | A success type. |
+| tryAsync | A TryAsync. |
+| ifCanceled | A function which will provide the cancellation Exception when IsCancellationRequested returns `true`. |
+| cancellationToken | An asynchronous operation cancellation token. |
+
+## Return Value
+
+A TryAsync. If *cancellationToken* is not canceled: current *TSuccess* is returned. If canceled: the converted Exception (from *ifCanceled*) is returned.
+
+## See Also
+
+* class [TryAsyncMonadExtensions](../TryAsyncMonadExtensions.md)
+* namespace [Jds.LanguageExt.Extras](../../LanguageExt.Extras.md)
+
+---
+
+# TryAsyncMonadExtensions.Filter&lt;TSuccess&gt; method (4 of 4)
 
 Returns a TryAsync which filters the result of *tryAsync*. When *filter* returns `false`, *onFalse* creates the failure result.
 

project-metadata.json

@@ -2,7 +2,7 @@
   "name": "languageext-extras",
   "description": "",
   "title": "LanguageExt.Extras",
-  "version": "0.6.0",
+  "version": "1.0.0",
   "ciEnvironment": {
     "variables": [
       {

src/LanguageExt.Extras.csproj

@@ -38,7 +38,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="LanguageExt.Core" Version="4.4.0" />
+    <PackageReference Include="LanguageExt.Core" Version="4.4.7" />
   </ItemGroup>
 
 </Project>

src/TryAsyncMonadExtensions.cs

@@ -75,6 +75,53 @@ Func<TSuccess, Exception> onFalse
     });
   }
 
+  /// <summary>
+  ///   Returns a <see cref="TryAsync{A}" /> which filters the result of <paramref name="tryAsync" /> based upon whether
+  ///   the provided <paramref name="cancellationToken" /> is canceled (via
+  ///   <see cref="System.Threading.CancellationToken.IsCancellationRequested" />).
+  /// </summary>
+  /// <param name="tryAsync">A <see cref="TryAsync{A}" />.</param>
+  /// <param name="ifCanceled">
+  ///   A function which will provide the cancellation <see cref="Exception" /> when
+  ///   <see cref="System.Threading.CancellationToken.IsCancellationRequested" /> returns <c>true</c>.
+  /// </param>
+  /// <param name="cancellationToken">An asynchronous operation cancellation token.</param>
+  /// <typeparam name="TSuccess">A success type.</typeparam>
+  /// <returns>
+  ///   A <see cref="TryAsync{A}" />.
+  ///   If <paramref name="cancellationToken" /> is not canceled: current <typeparamref name="TSuccess" /> is returned.
+  ///   If canceled: the converted <see cref="Exception" /> (from <paramref name="ifCanceled" />) is returned.
+  /// </returns>
+  public static TryAsync<TSuccess> Filter<TSuccess>(
+    this TryAsync<TSuccess> tryAsync,
+    Func<TSuccess, Exception> ifCanceled,
+    CancellationToken cancellationToken
+  )
+  {
+    return tryAsync.Filter(_ => !cancellationToken.IsCancellationRequested, ifCanceled);
+  }
+
+  /// <summary>
+  ///   Returns a <see cref="TryAsync{A}" /> which filters the result of <paramref name="tryAsync" /> based upon whether
+  ///   the provided <paramref name="cancellationToken" /> is canceled (via
+  ///   <see cref="System.Threading.CancellationToken.IsCancellationRequested" />).
+  /// </summary>
+  /// <param name="tryAsync">A <see cref="TryAsync{A}" />.</param>
+  /// <param name="cancellationToken">An asynchronous operation cancellation token.</param>
+  /// <typeparam name="TSuccess">A success type.</typeparam>
+  /// <returns>
+  ///   A <see cref="TryAsync{A}" />.
+  ///   If <paramref name="cancellationToken" /> is not canceled: current <typeparamref name="TSuccess" /> is returned.
+  ///   If canceled: an <see cref="OperationCanceledException" /> is returned.
+  /// </returns>
+  public static TryAsync<TSuccess> Filter<TSuccess>(
+    this TryAsync<TSuccess> tryAsync,
+    CancellationToken cancellationToken
+  )
+  {
+    return tryAsync.Filter(_ => new OperationCanceledException(cancellationToken), cancellationToken);
+  }
+
   /// <summary>
   ///   Execute a side effect and returns <paramref name="tryAsync" /> result unchanged.
   /// </summary>

tests/unit/LanguageExt.Extras.Tests.Unit.csproj

@@ -9,13 +9,18 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="FluentAssertions" Version="6.12.0" />
+    <PackageReference Include="FluentAssertions.Analyzers" Version="0.31.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.6.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.5">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>