Add support voption to require function (#243)

* added voption to result

* added voption to async result

* fixed formatting

* added voption to job result

* added voption to task result

* added bind task/job/async result and require voption

* added voption to docs

---------

Co-authored-by: Jimmy Byrd <[email protected]>

Author: Maxumka

gitbook/asyncResult/others.md

@@ -28,6 +28,20 @@ Converts an async-wrapped Option to a Result, using the given error if Some.
 'a -> Async<'b option> -> Async<Result<unit, 'a>>`
 ```
 
+### requireValueSome
+
+Converts an async-wrapped ValueOption to a Result, using the given error if ValueNone.
+```fsharp
+'a -> Async<'b voption> -> Async<Result<'b, 'a>>
+```
+
+### requireValueNone
+
+Converts an async-wrapped ValueOption to a Result, using the given error if ValueSome.
+
+```fsharp
+'a -> Async<'b voption> -> Async<Result<unit, 'a>>
+```
 
 ### requireEqual
 

gitbook/jobResult/others.md

@@ -28,6 +28,19 @@ Converts an job-wrapped Option to a Result, using the given error if Some.
 'a -> job<'b option> -> job<Result<unit, 'a>>`
 ```
 
+### requireValueSome
+
+Converts an job-wrapped ValueOption to a Result, using the given error if ValueNone.
+```fsharp
+'a -> job<'b voption> -> job<Result<'b, 'a>>
+```
+### requireValueNone
+
+Converts an job-wrapped ValueOption to a Result, using the given error if ValueSome.
+
+```fsharp
+'a -> job<'b voption> -> job<Result<unit, 'a>>
+```
 
 ### requireEqual
 

gitbook/result/requireFunctions.md

@@ -128,6 +128,70 @@ let result : Result<unit, string> =
 // Error "Value must be None"
 ```
 
+## requireValueSome
+
+Converts an ValueOption to a Result, using the given error if ValueNone.
+
+### Function Signature
+
+```fsharp
+'a -> 'b voption -> Result<'b, 'a>
+```
+
+### Examples
+
+#### Example 1
+
+```fsharp
+let result : Result<unit, string> =
+    ValueSome 1
+    |> Result.requireValueSome "Value must be ValueSome"
+    
+// Ok ()
+```
+
+#### Example 2
+
+```fsharp
+let result : Result<unit, string> =
+    None
+    |> Result.requireValueSome "Value must be ValueSome"
+    
+// Error "Value must be ValueSome"
+```
+
+## requireValueNone
+
+Converts an ValueOption to a Result, using the given error if ValueSome.
+
+### Function Signature
+
+```fsharp
+'a -> 'b voption -> Result<unit, 'a>
+```
+
+### Examples
+
+#### Example 1
+
+```fsharp
+let result : Result<unit, string> =
+    ValueNone
+    |> Result.requireValueNone "Value must be ValueNone"
+    
+// Ok ()
+```
+
+#### Example 2
+
+```fsharp
+let result : Result<unit, string> =
+    ValueSome 1
+    |> Result.requireValueNone "Value must be ValueNone"
+    
+// Error "Value must be ValueNone"
+```
+
 ## requireNotNull
 
 Converts a nullable value to a Result, using the given error if null.

gitbook/taskResult/others.md

@@ -28,6 +28,19 @@ Converts an task-wrapped Option to a Result, using the given error if Some.
 'a -> Task<'b option> -> Task<Result<unit, 'a>>`
 ```
 
+### requireValueSome
+
+Converts an task-wrapped ValueOption to a Result, using the given error if ValueNone.
+```fsharp
+'a -> Task<'b voption> -> Task<Result<'b, 'a>>
+```
+### requireValueNone
+
+Converts an task-wrapped ValueOption to a Result, using the given error if ValueSome.
+
+```fsharp
+'a -> Task<'b voption> -> Task<Result<unit, 'a>>
+```
 
 ### requireEqual
 

src/FsToolkit.ErrorHandling.JobResult/JobResult.fs

@@ -131,6 +131,16 @@ module JobResult =
         option
         |> Job.map (Result.requireNone error)
 
+    // Converts an job-wrapped ValueOption to a Result, using the given error if ValueNone.
+    let inline requireValueSome error voption =
+        voption
+        |> Job.map (Result.requireValueSome error)
+
+    // Converts an job-wrapped ValueOption to a Result, using the given error if ValueSome.
+    let inline requireValueNone error voption =
+        voption
+        |> Job.map (Result.requireValueNone error)
+
     /// Returns Ok if the job-wrapped value and the provided value are equal, or the specified error if not.
     let inline requireEqual x1 x2 error =
         x2
@@ -262,3 +272,19 @@ module JobResult =
             Result.requireNone error
             >> Job.singleton
         )
+
+    /// Bind the JobResult and requireValueSome on the inner voption value.
+    let inline bindRequireValueSome error x =
+        x
+        |> bind (
+            Result.requireValueSome error
+            >> Job.singleton
+        )
+
+    /// Bind the JobResult and requireValueNone on the inner voption value.
+    let inline bindRequireValueNone error x =
+        x
+        |> bind (
+            Result.requireValueNone error
+            >> Job.singleton
+        )

src/FsToolkit.ErrorHandling.TaskResult/TaskResult.fs

@@ -119,6 +119,16 @@ module TaskResult =
         option
         |> Task.map (Result.requireNone error)
 
+    // Converts an task-wrapped ValueOption to a Result, using the given error if ValueNone.
+    let inline requireValueSome error voption =
+        voption
+        |> Task.map (Result.requireValueSome error)
+
+    // Converts an task-wrapped ValueOption to a Result, using the given error if ValueSome.
+    let inline requireValueNone error voption =
+        voption
+        |> Task.map (Result.requireValueNone error)
+
     /// Returns Ok if the task-wrapped value and the provided value are equal, or the specified error if not.
     let inline requireEqual x1 x2 error =
         x2
@@ -250,10 +260,27 @@ module TaskResult =
             Result.requireNone error
             >> Task.singleton
         )
+        
+    /// Bind the TaskResult and requireValueSome on the inner voption value.
+    let inline bindRequireValueSome error x =
+        x
+        |> bind (
+            Result.requireValueSome error
+            >> Task.singleton
+        )
 
+    /// Bind the TaskResult and requireValueNone on the inner voption value.
+    let inline bindRequireValueNone error x =
+        x
+        |> bind (
+            Result.requireValueNone error
+            >> Task.singleton
+        )
+        
     let inline foldResult
         ([<InlineIfLambda>] onSuccess: 'input -> 'output)
         ([<InlineIfLambda>] onError: 'inputError -> 'output)
         (input: Task<Result<'input, 'inputError>>)
         : Task<'output> =
         Task.map (Result.either onSuccess onError) input
+

src/FsToolkit.ErrorHandling/AsyncResult.fs

@@ -168,6 +168,22 @@ module AsyncResult =
         value
         |> Async.map (Result.requireNone error)
 
+    // Converts an async-wrapped ValueOption to a Result, using the given error if ValueNone.
+    let inline requireValueSome
+        (error: 'error)
+        (value: Async<'ok voption>)
+        : Async<Result<'ok, 'error>> =
+        value
+        |> Async.map (Result.requireValueSome error)
+
+    // Converts an async-wrapped ValueOption to a Result, using the given error if ValueSome.
+    let inline requireValueNone
+        (error: 'error)
+        (value: Async<'ok voption>)
+        : Async<Result<unit, 'error>> =
+        value
+        |> Async.map (Result.requireValueNone error)
+
     /// Returns Ok if the async-wrapped value and the provided value are equal, or the specified error if not.
     let inline requireEqual
         (value1: 'value)
@@ -349,3 +365,19 @@ module AsyncResult =
             Result.requireNone error
             >> Async.singleton
         )
+
+    /// Bind the AsyncResult and requireValueSome on the inner voption value.
+    let inline bindRequireValueSome error x =
+        x
+        |> bind (
+            Result.requireValueSome error
+            >> Async.singleton
+        )
+
+    /// Bind the AsyncResult and requireValueNone on the inner voption value.
+    let inline bindRequireValueNone error x =
+        x
+        |> bind (
+            Result.requireValueNone error
+            >> Async.singleton
+        )

src/FsToolkit.ErrorHandling/Result.fs

@@ -180,6 +180,18 @@ module Result =
         | Some _ -> Error error
         | None -> Ok()
 
+    /// Converts an ValueOption to a Result, using the given error if ValueNone.
+    let inline requireValueSome (error: 'error) (voption: 'ok voption) : Result<'ok, 'error> =
+        match voption with
+        | ValueSome x -> Ok x
+        | ValueNone -> Error error
+
+    /// Converts an ValueOption to a Result, using the given error if ValueSome.
+    let inline requireValueNone (error: 'error) (voption: 'value voption) : Result<unit, 'error> =
+        match voption with
+        | ValueSome _ -> Error error
+        | ValueNone -> Ok()
+
     /// Converts a nullable value into a Result, using the given error if null
     let inline requireNotNull (error: 'error) (value: 'ok) : Result<'ok, 'error> =
         match value with

tests/FsToolkit.ErrorHandling.JobResult.Tests/JobResult.fs

@@ -300,6 +300,38 @@ let requireNoneTests =
             |> Expect.hasJobErrorValueSync err
     ]
 
+[<Tests>]
+let requireValueSomeTests =
+    testList "JobResult.requireValueSome Tests" [
+        testCase "requireValueSome happy path"
+        <| fun _ ->
+            toJob (ValueSome 42)
+            |> JobResult.requireValueSome err
+            |> Expect.hasJobOkValueSync 42
+
+        testCase "requireValueSome error path"
+        <| fun _ ->
+            toJob ValueNone
+            |> JobResult.requireValueSome err
+            |> Expect.hasJobErrorValueSync err
+    ]
+
+[<Tests>]
+let requireValueNoneTests =
+    testList "JobResult.requireValueNone Tests" [
+        testCase "requireValueNone happy path"
+        <| fun _ ->
+            toJob ValueNone
+            |> JobResult.requireValueNone err
+            |> Expect.hasJobOkValueSync ()
+
+        testCase "requireValueNone error path"
+        <| fun _ ->
+            toJob (ValueSome 42)
+            |> JobResult.requireValueNone err
+            |> Expect.hasJobErrorValueSync err
+    ]
+
 [<Tests>]
 let requireEqualToTests =
     testList "JobResult.requireEqualTo Tests" [
@@ -738,6 +770,28 @@ let bindRequireTests =
         }
     ]
 
+[<Tests>]
+let bindRequireValueOptionTests =
+    testList "JobResult Bind + RequireValueOption tests" [
+        testCaseJob "bindRequireValueNone"
+        <| job {
+            return!
+                ValueSome "john_doe"
+                |> JobResult.ok
+                |> JobResult.bindRequireValueNone "user exists"
+                |> Expect.hasJobErrorValue "user exists"
+        }
+
+        testCaseJob "bindRequireValueSome"
+        <| job {
+            return!
+                ValueSome "john_doe"
+                |> JobResult.ok
+                |> JobResult.bindRequireValueSome "user doesn't exists"
+                |> Expect.hasJobOkValue "john_doe"
+        }
+    ]
+
 type CreatePostResult =
     | PostSuccess of NotifyNewPostRequest
     | NotAllowedToPost