1
0
mirror of https://github.com/IBM/fp-go.git synced 2026-02-24 12:57:26 +02:00

Compare commits

..

12 Commits

Author SHA1 Message Date
Dr. Carsten Leue
c4cac1cb3e fix: add FromReaderResult
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-21 16:44:51 +01:00
Dr. Carsten Leue
a3fdb03df4 fix: better assertions
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-13 09:27:49 +01:00
Dr. Carsten Leue
47727fd514 fix: add support for go 1.26
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-12 10:51:34 +01:00
Dr. Carsten Leue
ece7d088ea fix: add support for go 1.26
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-12 10:50:30 +01:00
Dr. Carsten Leue
13d25eca32 fix: add composition logic to Iso
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-12 10:46:41 +01:00
Dr. Carsten Leue
a68e32308d fix: add filterable to Either and Result
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-12 09:28:42 +01:00
Dr. Carsten Leue
61b948425b fix: cleaner use of Kleisli
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-11 16:24:11 +01:00
Dr. Carsten Leue
a276f3acff fix: add llms.txt
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-10 09:48:19 +01:00
Dr. Carsten Leue
8c656a4297 fix: more Alt tests
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-10 08:52:39 +01:00
Dr. Carsten Leue
bd9a642e93 fix: implement Alt for Codec
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-05 18:31:00 +01:00
Dr. Carsten Leue
3b55cae265 fix: implement alternative monoid for codec
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-05 09:59:17 +01:00
Dr. Carsten Leue
1472fa5a50 fix: add some more validation
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-04 17:58:08 +01:00
69 changed files with 17220 additions and 623 deletions

View File

@@ -24,7 +24,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
go-version: ['1.20.x', '1.21.x', '1.22.x', '1.23.x', '1.24.x', '1.25.x']
go-version: ['1.20.x', '1.21.x', '1.22.x', '1.23.x', '1.24.x', '1.25.x', '1.26.x']
fail-fast: false # Continue with other versions if one fails
steps:
# full checkout for semantic-release
@@ -64,7 +64,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
go-version: ['1.24.x', '1.25.x']
go-version: ['1.24.x', '1.25.x', '1.26.x']
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:

View File

@@ -1 +0,0 @@
{"mcpServers":{}}

226
v2/AGENTS.md Normal file
View File

@@ -0,0 +1,226 @@
# Agent Guidelines for fp-go/v2
This document provides guidelines for AI agents working on the fp-go/v2 project.
## Documentation Standards
### Go Doc Comments
1. **Use Standard Go Doc Format**
- Do NOT use markdown-style links like `[text](url)`
- Use simple type references: `ReaderResult`, `Validate[I, A]`, `validation.Success`
- Go's documentation system will automatically create links
2. **Structure**
```go
// FunctionName does something useful.
//
// Longer description explaining the purpose and behavior.
//
// # Type Parameters
//
// - T: Description of type parameter
//
// # Parameters
//
// - param: Description of parameter
//
// # Returns
//
// - ReturnType: Description of return value
//
// # Example Usage
//
// code example here
//
// # See Also
//
// - RelatedFunction: Brief description
func FunctionName[T any](param T) ReturnType {
```
3. **Code Examples**
- Use idiomatic Go patterns
- Prefer `result.Eitherize1(strconv.Atoi)` over manual error handling
- Show realistic, runnable examples
### File Headers
Always include the Apache 2.0 license header:
```go
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
```
## Testing Standards
### Test Structure
1. **Organize Tests by Category**
```go
func TestFunctionName_Success(t *testing.T) {
t.Run("specific success case", func(t *testing.T) {
// test code
})
}
func TestFunctionName_Failure(t *testing.T) {
t.Run("specific failure case", func(t *testing.T) {
// test code
})
}
func TestFunctionName_EdgeCases(t *testing.T) {
// edge case tests
}
func TestFunctionName_Integration(t *testing.T) {
// integration tests
}
```
2. **Use Direct Assertions**
- Prefer: `assert.Equal(t, validation.Success(expected), actual)`
- Avoid: Verbose `either.MonadFold` patterns unless necessary
- Exception: When you need to verify pointer is not nil or extract specific fields
3. **Use Idiomatic Patterns**
- Use `result.Eitherize1` for converting `(T, error)` functions
- Use `result.Of` for success values
- Use `result.Left` for error values
### Test Coverage
Include tests for:
- **Success cases**: Normal operation with various input types
- **Failure cases**: Error handling and error preservation
- **Edge cases**: Nil, empty, zero values, boundary conditions
- **Integration**: Composition with other functions
- **Type safety**: Verify type parameters work correctly
- **Benchmarks**: Performance-critical paths
### Example Test Pattern
```go
func TestFromReaderResult_Success(t *testing.T) {
t.Run("converts successful ReaderResult", func(t *testing.T) {
// Arrange
parseIntRR := result.Eitherize1(strconv.Atoi)
validator := FromReaderResult[string, int](parseIntRR)
// Act
result := validator("42")(nil)
// Assert
assert.Equal(t, validation.Success(42), result)
})
}
```
## Code Style
### Functional Patterns
1. **Prefer Composition**
```go
validator := F.Pipe1(
FromReaderResult[string, int](parseIntRR),
Chain(validatePositive),
)
```
2. **Use Type-Safe Helpers**
- `result.Eitherize1` for `func(T) (R, error)`
- `result.Of` for wrapping success values
- `result.Left` for wrapping errors
3. **Avoid Verbose Patterns**
- Don't manually handle `(value, error)` tuples when helpers exist
- Don't use `either.MonadFold` in tests unless necessary
### Error Handling
1. **In Production Code**
- Use `validation.Success` for successful validations
- Use `validation.FailureWithMessage` for simple failures
- Use `validation.FailureWithError` to preserve error causes
2. **In Tests**
- Verify error messages and causes
- Check error context is preserved
- Test error accumulation when applicable
## Common Patterns
### Converting Error-Based Functions
```go
// Good: Use Eitherize1
parseIntRR := result.Eitherize1(strconv.Atoi)
// Avoid: Manual error handling
parseIntRR := func(input string) result.Result[int] {
val, err := strconv.Atoi(input)
if err != nil {
return result.Left[int](err)
}
return result.Of(val)
}
```
### Testing Validation Results
```go
// Good: Direct comparison
assert.Equal(t, validation.Success(42), result)
// Avoid: Verbose extraction (unless you need to verify specific fields)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
```
### Documentation Examples
```go
// Good: Concise and idiomatic
// parseIntRR := result.Eitherize1(strconv.Atoi)
// validator := FromReaderResult[string, int](parseIntRR)
// Avoid: Verbose manual patterns
// parseIntRR := func(input string) result.Result[int] {
// val, err := strconv.Atoi(input)
// if err != nil {
// return result.Left[int](err)
// }
// return result.Of(val)
// }
```
## Checklist for New Code
- [ ] Apache 2.0 license header included
- [ ] Go doc comments use standard format (no markdown links)
- [ ] Code examples are idiomatic and concise
- [ ] Tests cover success, failure, edge cases, and integration
- [ ] Tests use direct assertions where possible
- [ ] Benchmarks included for performance-critical code
- [ ] All tests pass
- [ ] Code uses functional composition patterns
- [ ] Error handling preserves context and causes

View File

@@ -21,7 +21,7 @@ import (
"github.com/IBM/fp-go/v2/internal/array"
M "github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/tuple"
"github.com/IBM/fp-go/v2/pair"
)
// From constructs an array from a set of variadic arguments
@@ -163,11 +163,11 @@ func FilterMapWithIndex[A, B any](f func(int, A) Option[B]) Operator[A, B] {
return G.FilterMapWithIndex[[]A, []B](f)
}
// FilterChain maps an array with an iterating function that returns an [Option] of an array. It keeps only the Some values discarding the Nones and then flattens the result.
// ChainOptionK maps an array with an iterating function that returns an [Option] of an array. It keeps only the Some values discarding the Nones and then flattens the result.
//
//go:inline
func FilterChain[A, B any](f option.Kleisli[A, []B]) Operator[A, B] {
return G.FilterChain[[]A](f)
func ChainOptionK[A, B any](f option.Kleisli[A, []B]) Operator[A, B] {
return G.ChainOptionK[[]A](f)
}
// FilterMapRef filters an array using a predicate on pointers and maps the matching elements using a function on pointers.
@@ -453,7 +453,7 @@ func Size[A any](as []A) int {
// the second contains elements for which it returns true.
//
//go:inline
func MonadPartition[A any](as []A, pred func(A) bool) tuple.Tuple2[[]A, []A] {
func MonadPartition[A any](as []A, pred func(A) bool) pair.Pair[[]A, []A] {
return G.MonadPartition(as, pred)
}
@@ -461,7 +461,7 @@ func MonadPartition[A any](as []A, pred func(A) bool) tuple.Tuple2[[]A, []A] {
// for which the predicate returns false, the right one those for which the predicate returns true
//
//go:inline
func Partition[A any](pred func(A) bool) func([]A) tuple.Tuple2[[]A, []A] {
func Partition[A any](pred func(A) bool) func([]A) pair.Pair[[]A, []A] {
return G.Partition[[]A](pred)
}

View File

@@ -24,8 +24,8 @@ import (
"github.com/IBM/fp-go/v2/internal/utils"
N "github.com/IBM/fp-go/v2/number"
O "github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
S "github.com/IBM/fp-go/v2/string"
T "github.com/IBM/fp-go/v2/tuple"
"github.com/stretchr/testify/assert"
)
@@ -163,11 +163,11 @@ func TestPartition(t *testing.T) {
return n > 2
}
assert.Equal(t, T.MakeTuple2(Empty[int](), Empty[int]()), Partition(pred)(Empty[int]()))
assert.Equal(t, T.MakeTuple2(From(1), From(3)), Partition(pred)(From(1, 3)))
assert.Equal(t, pair.MakePair(Empty[int](), Empty[int]()), Partition(pred)(Empty[int]()))
assert.Equal(t, pair.MakePair(From(1), From(3)), Partition(pred)(From(1, 3)))
}
func TestFilterChain(t *testing.T) {
func TestChainOptionK(t *testing.T) {
src := From(1, 2, 3)
f := func(i int) O.Option[[]string] {
@@ -177,7 +177,7 @@ func TestFilterChain(t *testing.T) {
return O.None[[]string]()
}
res := FilterChain(f)(src)
res := ChainOptionK(f)(src)
assert.Equal(t, From("a1", "b1", "a3", "b3"), res)
}

View File

@@ -21,7 +21,7 @@ import (
FC "github.com/IBM/fp-go/v2/internal/functor"
M "github.com/IBM/fp-go/v2/monoid"
O "github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/tuple"
"github.com/IBM/fp-go/v2/pair"
)
// Of constructs a single element array
@@ -215,7 +215,7 @@ func Filter[AS ~[]A, PRED ~func(A) bool, A any](pred PRED) func(AS) AS {
return FilterWithIndex[AS](F.Ignore1of2[int](pred))
}
func FilterChain[GA ~[]A, GB ~[]B, A, B any](f func(a A) O.Option[GB]) func(GA) GB {
func ChainOptionK[GA ~[]A, GB ~[]B, A, B any](f func(a A) O.Option[GB]) func(GA) GB {
return F.Flow2(
FilterMap[GA, []GB](f),
Flatten[[]GB],
@@ -234,7 +234,7 @@ func FilterMapWithIndex[GA ~[]A, GB ~[]B, A, B any](f func(int, A) O.Option[B])
return F.Bind2nd(MonadFilterMapWithIndex[GA, GB, A, B], f)
}
func MonadPartition[GA ~[]A, A any](as GA, pred func(A) bool) tuple.Tuple2[GA, GA] {
func MonadPartition[GA ~[]A, A any](as GA, pred func(A) bool) pair.Pair[GA, GA] {
left := Empty[GA]()
right := Empty[GA]()
array.Reduce(as, func(c bool, a A) bool {
@@ -246,10 +246,10 @@ func MonadPartition[GA ~[]A, A any](as GA, pred func(A) bool) tuple.Tuple2[GA, G
return c
}, true)
// returns the partition
return tuple.MakeTuple2(left, right)
return pair.MakePair(left, right)
}
func Partition[GA ~[]A, A any](pred func(A) bool) func(GA) tuple.Tuple2[GA, GA] {
func Partition[GA ~[]A, A any](pred func(A) bool) func(GA) pair.Pair[GA, GA] {
return F.Bind2nd(MonadPartition[GA, A], pred)
}

View File

@@ -18,7 +18,7 @@ package generic
import (
F "github.com/IBM/fp-go/v2/function"
N "github.com/IBM/fp-go/v2/number"
T "github.com/IBM/fp-go/v2/tuple"
"github.com/IBM/fp-go/v2/pair"
)
// ZipWith applies a function to pairs of elements at the same index in two arrays, collecting the results in a new array. If one
@@ -34,19 +34,19 @@ func ZipWith[AS ~[]A, BS ~[]B, CS ~[]C, FCT ~func(A, B) C, A, B, C any](fa AS, f
// Zip takes two arrays and returns an array of corresponding pairs. If one input array is short, excess elements of the
// longer array are discarded
func Zip[AS ~[]A, BS ~[]B, CS ~[]T.Tuple2[A, B], A, B any](fb BS) func(AS) CS {
return F.Bind23of3(ZipWith[AS, BS, CS, func(A, B) T.Tuple2[A, B]])(fb, T.MakeTuple2[A, B])
func Zip[AS ~[]A, BS ~[]B, CS ~[]pair.Pair[A, B], A, B any](fb BS) func(AS) CS {
return F.Bind23of3(ZipWith[AS, BS, CS, func(A, B) pair.Pair[A, B]])(fb, pair.MakePair[A, B])
}
// Unzip is the function is reverse of [Zip]. Takes an array of pairs and return two corresponding arrays
func Unzip[AS ~[]A, BS ~[]B, CS ~[]T.Tuple2[A, B], A, B any](cs CS) T.Tuple2[AS, BS] {
func Unzip[AS ~[]A, BS ~[]B, CS ~[]pair.Pair[A, B], A, B any](cs CS) pair.Pair[AS, BS] {
l := len(cs)
as := make(AS, l)
bs := make(BS, l)
for i := range l {
t := cs[i]
as[i] = t.F1
bs[i] = t.F2
as[i] = pair.Head(t)
bs[i] = pair.Tail(t)
}
return T.MakeTuple2(as, bs)
return pair.MakePair(as, bs)
}

View File

@@ -17,7 +17,7 @@ package array
import (
G "github.com/IBM/fp-go/v2/array/generic"
T "github.com/IBM/fp-go/v2/tuple"
"github.com/IBM/fp-go/v2/pair"
)
// ZipWith applies a function to pairs of elements at the same index in two arrays,
@@ -55,8 +55,8 @@ func ZipWith[FCT ~func(A, B) C, A, B, C any](fa []A, fb []B, f FCT) []C {
// // Result: [(a, 1), (b, 2)]
//
//go:inline
func Zip[A, B any](fb []B) func([]A) []T.Tuple2[A, B] {
return G.Zip[[]A, []B, []T.Tuple2[A, B]](fb)
func Zip[A, B any](fb []B) func([]A) []pair.Pair[A, B] {
return G.Zip[[]A, []B, []pair.Pair[A, B]](fb)
}
// Unzip is the reverse of Zip. It takes an array of pairs (tuples) and returns
@@ -78,6 +78,6 @@ func Zip[A, B any](fb []B) func([]A) []T.Tuple2[A, B] {
// ages := result.Tail // [30, 25, 35]
//
//go:inline
func Unzip[A, B any](cs []T.Tuple2[A, B]) T.Tuple2[[]A, []B] {
func Unzip[A, B any](cs []pair.Pair[A, B]) pair.Pair[[]A, []B] {
return G.Unzip[[]A, []B](cs)
}

View File

@@ -19,7 +19,7 @@ import (
"fmt"
"testing"
T "github.com/IBM/fp-go/v2/tuple"
"github.com/IBM/fp-go/v2/pair"
"github.com/stretchr/testify/assert"
)
@@ -40,7 +40,7 @@ func TestZip(t *testing.T) {
res := Zip[string](left)(right)
assert.Equal(t, From(T.MakeTuple2("a", 1), T.MakeTuple2("b", 2), T.MakeTuple2("c", 3)), res)
assert.Equal(t, From(pair.MakePair("a", 1), pair.MakePair("b", 2), pair.MakePair("c", 3)), res)
}
func TestUnzip(t *testing.T) {
@@ -51,6 +51,6 @@ func TestUnzip(t *testing.T) {
unzipped := Unzip(zipped)
assert.Equal(t, right, unzipped.F1)
assert.Equal(t, left, unzipped.F2)
assert.Equal(t, right, pair.Head(unzipped))
assert.Equal(t, left, pair.Tail(unzipped))
}

View File

@@ -194,6 +194,25 @@ func ArrayNotEmpty[T any](arr []T) Reader {
}
}
// ArrayEmpty checks if an array is empty.
//
// This is the complement of ArrayNotEmpty, asserting that a slice has no elements.
//
// Example:
//
// func TestArrayEmpty(t *testing.T) {
// empty := []int{}
// assert.ArrayEmpty(empty)(t) // Passes
//
// numbers := []int{1, 2, 3}
// assert.ArrayEmpty(numbers)(t) // Fails
// }
func ArrayEmpty[T any](arr []T) Reader {
return func(t *testing.T) bool {
return assert.Empty(t, arr)
}
}
// RecordNotEmpty checks if a map is not empty.
//
// Example:
@@ -211,6 +230,25 @@ func RecordNotEmpty[K comparable, T any](mp map[K]T) Reader {
}
}
// RecordEmpty checks if a map is empty.
//
// This is the complement of RecordNotEmpty, asserting that a map has no key-value pairs.
//
// Example:
//
// func TestRecordEmpty(t *testing.T) {
// empty := map[string]int{}
// assert.RecordEmpty(empty)(t) // Passes
//
// config := map[string]int{"timeout": 30}
// assert.RecordEmpty(config)(t) // Fails
// }
func RecordEmpty[K comparable, T any](mp map[K]T) Reader {
return func(t *testing.T) bool {
return assert.Empty(t, mp)
}
}
// StringNotEmpty checks if a string is not empty.
//
// Example:
@@ -504,15 +542,7 @@ func AllOf(readers []Reader) Reader {
//
//go:inline
func RunAll(testcases map[string]Reader) Reader {
return func(t *testing.T) bool {
current := true
for k, r := range testcases {
current = current && t.Run(k, func(t1 *testing.T) {
r(t1)
})
}
return current
}
return SequenceRecord(testcases)
}
// Local transforms a Reader that works on type R1 into a Reader that works on type R2,

View File

@@ -85,6 +85,33 @@ func TestArrayNotEmpty(t *testing.T) {
})
}
func TestArrayEmpty(t *testing.T) {
t.Run("should pass for empty array", func(t *testing.T) {
arr := []int{}
result := ArrayEmpty(arr)(t)
if !result {
t.Error("Expected ArrayEmpty to pass for empty array")
}
})
t.Run("should fail for non-empty array", func(t *testing.T) {
mockT := &testing.T{}
arr := []int{1, 2, 3}
result := ArrayEmpty(arr)(mockT)
if result {
t.Error("Expected ArrayEmpty to fail for non-empty array")
}
})
t.Run("should work with different types", func(t *testing.T) {
strArr := []string{}
result := ArrayEmpty(strArr)(t)
if !result {
t.Error("Expected ArrayEmpty to pass for empty string array")
}
})
}
func TestRecordNotEmpty(t *testing.T) {
t.Run("should pass for non-empty map", func(t *testing.T) {
mp := map[string]int{"a": 1, "b": 2}
@@ -131,6 +158,33 @@ func TestArrayLength(t *testing.T) {
})
}
func TestRecordEmpty(t *testing.T) {
t.Run("should pass for empty map", func(t *testing.T) {
mp := map[string]int{}
result := RecordEmpty(mp)(t)
if !result {
t.Error("Expected RecordEmpty to pass for empty map")
}
})
t.Run("should fail for non-empty map", func(t *testing.T) {
mockT := &testing.T{}
mp := map[string]int{"a": 1, "b": 2}
result := RecordEmpty(mp)(mockT)
if result {
t.Error("Expected RecordEmpty to fail for non-empty map")
}
})
t.Run("should work with different key-value types", func(t *testing.T) {
mp := map[int]string{}
result := RecordEmpty(mp)(t)
if !result {
t.Error("Expected RecordEmpty to pass for empty map with int keys")
}
})
}
func TestRecordLength(t *testing.T) {
t.Run("should pass when map length matches", func(t *testing.T) {
mp := map[string]int{"a": 1, "b": 2}
@@ -150,6 +204,33 @@ func TestRecordLength(t *testing.T) {
})
}
func TestStringNotEmpty(t *testing.T) {
t.Run("should pass for non-empty string", func(t *testing.T) {
str := "Hello, World!"
result := StringNotEmpty(str)(t)
if !result {
t.Error("Expected StringNotEmpty to pass for non-empty string")
}
})
t.Run("should fail for empty string", func(t *testing.T) {
mockT := &testing.T{}
str := ""
result := StringNotEmpty(str)(mockT)
if result {
t.Error("Expected StringNotEmpty to fail for empty string")
}
})
t.Run("should pass for string with whitespace", func(t *testing.T) {
str := " "
result := StringNotEmpty(str)(t)
if !result {
t.Error("Expected StringNotEmpty to pass for string with whitespace")
}
})
}
func TestStringLength(t *testing.T) {
t.Run("should pass when string length matches", func(t *testing.T) {
str := "hello"

122
v2/assert/from.go Normal file
View File

@@ -0,0 +1,122 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"testing"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/result"
)
// FromReaderIOResult converts a ReaderIOResult[Reader] into a Reader.
//
// This function bridges the gap between context-aware, IO-based computations that may fail
// (ReaderIOResult) and the simpler Reader type used for test assertions. It executes the
// ReaderIOResult computation using the test's context, handles any potential errors by
// converting them to test failures via NoError, and returns the resulting Reader.
//
// The conversion process:
// 1. Executes the ReaderIOResult with the test context (t.Context())
// 2. Runs the resulting IO operation ()
// 3. Extracts the Result, converting errors to test failures using NoError
// 4. Returns a Reader that can be applied to *testing.T
//
// This is particularly useful when you have test assertions that need to:
// - Access context for cancellation or deadlines
// - Perform IO operations (file access, network calls, etc.)
// - Handle potential errors gracefully in tests
//
// Parameters:
// - ri: A ReaderIOResult that produces a Reader when given a context and executed
//
// Returns:
// - A Reader that can be directly applied to *testing.T for assertion
//
// Example:
//
// func TestWithContext(t *testing.T) {
// // Create a ReaderIOResult that performs an IO operation
// checkDatabase := func(ctx context.Context) func() result.Result[assert.Reader] {
// return func() result.Result[assert.Reader] {
// // Simulate database check
// if err := db.PingContext(ctx); err != nil {
// return result.Error[assert.Reader](err)
// }
// return result.Of[assert.Reader](assert.NoError(nil))
// }
// }
//
// // Convert to Reader and execute
// assertion := assert.FromReaderIOResult(checkDatabase)
// assertion(t)
// }
func FromReaderIOResult(ri ReaderIOResult[Reader]) Reader {
return func(t *testing.T) bool {
return F.Pipe1(
ri(t.Context())(),
result.GetOrElse(NoError),
)(t)
}
}
// FromReaderIO converts a ReaderIO[Reader] into a Reader.
//
// This function bridges the gap between context-aware, IO-based computations (ReaderIO)
// and the simpler Reader type used for test assertions. It executes the ReaderIO
// computation using the test's context and returns the resulting Reader.
//
// Unlike FromReaderIOResult, this function does not handle errors explicitly - it assumes
// the IO operation will succeed or that any errors are handled within the ReaderIO itself.
//
// The conversion process:
// 1. Executes the ReaderIO with the test context (t.Context())
// 2. Runs the resulting IO operation ()
// 3. Returns a Reader that can be applied to *testing.T
//
// This is particularly useful when you have test assertions that need to:
// - Access context for cancellation or deadlines
// - Perform IO operations that don't fail (or handle failures internally)
// - Integrate with context-aware testing utilities
//
// Parameters:
// - ri: A ReaderIO that produces a Reader when given a context and executed
//
// Returns:
// - A Reader that can be directly applied to *testing.T for assertion
//
// Example:
//
// func TestWithIO(t *testing.T) {
// // Create a ReaderIO that performs an IO operation
// logAndCheck := func(ctx context.Context) func() assert.Reader {
// return func() assert.Reader {
// // Log something using context
// logger.InfoContext(ctx, "Running test")
// // Return an assertion
// return assert.Equal(42)(computeValue())
// }
// }
//
// // Convert to Reader and execute
// assertion := assert.FromReaderIO(logAndCheck)
// assertion(t)
// }
func FromReaderIO(ri ReaderIO[Reader]) Reader {
return func(t *testing.T) bool {
return ri(t.Context())()(t)
}
}

383
v2/assert/from_test.go Normal file
View File

@@ -0,0 +1,383 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"context"
"errors"
"testing"
"github.com/IBM/fp-go/v2/result"
)
func TestFromReaderIOResult(t *testing.T) {
t.Run("should pass when ReaderIOResult returns success with passing assertion", func(t *testing.T) {
// Create a ReaderIOResult that returns a successful Reader
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
// Return a Reader that always passes
return result.Of[Reader](func(t *testing.T) bool {
return true
})
}
}
reader := FromReaderIOResult(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIOResult to pass when ReaderIOResult returns success")
}
})
t.Run("should pass when ReaderIOResult returns success with Equal assertion", func(t *testing.T) {
// Create a ReaderIOResult that returns a successful Equal assertion
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
return result.Of[Reader](Equal(42)(42))
}
}
reader := FromReaderIOResult(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIOResult to pass with Equal assertion")
}
})
t.Run("should fail when ReaderIOResult returns error", func(t *testing.T) {
mockT := &testing.T{}
// Create a ReaderIOResult that returns an error
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
return result.Left[Reader](errors.New("test error"))
}
}
reader := FromReaderIOResult(ri)
res := reader(mockT)
if res {
t.Error("Expected FromReaderIOResult to fail when ReaderIOResult returns error")
}
})
t.Run("should fail when ReaderIOResult returns success but assertion fails", func(t *testing.T) {
mockT := &testing.T{}
// Create a ReaderIOResult that returns a failing assertion
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
return result.Of[Reader](Equal(42)(43))
}
}
reader := FromReaderIOResult(ri)
res := reader(mockT)
if res {
t.Error("Expected FromReaderIOResult to fail when assertion fails")
}
})
t.Run("should use test context", func(t *testing.T) {
contextUsed := false
// Create a ReaderIOResult that checks if context is provided
ri := func(ctx context.Context) func() result.Result[Reader] {
if ctx != nil {
contextUsed = true
}
return func() result.Result[Reader] {
return result.Of[Reader](func(t *testing.T) bool {
return true
})
}
}
reader := FromReaderIOResult(ri)
reader(t)
if !contextUsed {
t.Error("Expected FromReaderIOResult to use test context")
}
})
t.Run("should work with NoError assertion", func(t *testing.T) {
// Create a ReaderIOResult that returns NoError assertion
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
return result.Of[Reader](NoError(nil))
}
}
reader := FromReaderIOResult(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIOResult to pass with NoError assertion")
}
})
t.Run("should work with complex assertions", func(t *testing.T) {
// Create a ReaderIOResult with multiple composed assertions
ri := func(ctx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
arr := []int{1, 2, 3}
assertions := AllOf([]Reader{
ArrayNotEmpty(arr),
ArrayLength[int](3)(arr),
ArrayContains(2)(arr),
})
return result.Of[Reader](assertions)
}
}
reader := FromReaderIOResult(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIOResult to pass with complex assertions")
}
})
}
func TestFromReaderIO(t *testing.T) {
t.Run("should pass when ReaderIO returns passing assertion", func(t *testing.T) {
// Create a ReaderIO that returns a Reader that always passes
ri := func(ctx context.Context) func() Reader {
return func() Reader {
return func(t *testing.T) bool {
return true
}
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass when ReaderIO returns passing assertion")
}
})
t.Run("should pass when ReaderIO returns Equal assertion", func(t *testing.T) {
// Create a ReaderIO that returns an Equal assertion
ri := func(ctx context.Context) func() Reader {
return func() Reader {
return Equal(42)(42)
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with Equal assertion")
}
})
t.Run("should fail when ReaderIO returns failing assertion", func(t *testing.T) {
mockT := &testing.T{}
// Create a ReaderIO that returns a failing assertion
ri := func(ctx context.Context) func() Reader {
return func() Reader {
return Equal(42)(43)
}
}
reader := FromReaderIO(ri)
res := reader(mockT)
if res {
t.Error("Expected FromReaderIO to fail when assertion fails")
}
})
t.Run("should use test context", func(t *testing.T) {
contextUsed := false
// Create a ReaderIO that checks if context is provided
ri := func(ctx context.Context) func() Reader {
if ctx != nil {
contextUsed = true
}
return func() Reader {
return func(t *testing.T) bool {
return true
}
}
}
reader := FromReaderIO(ri)
reader(t)
if !contextUsed {
t.Error("Expected FromReaderIO to use test context")
}
})
t.Run("should work with NoError assertion", func(t *testing.T) {
// Create a ReaderIO that returns NoError assertion
ri := func(ctx context.Context) func() Reader {
return func() Reader {
return NoError(nil)
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with NoError assertion")
}
})
t.Run("should work with Error assertion", func(t *testing.T) {
// Create a ReaderIO that returns Error assertion
ri := func(ctx context.Context) func() Reader {
return func() Reader {
return Error(errors.New("expected error"))
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with Error assertion")
}
})
t.Run("should work with complex assertions", func(t *testing.T) {
// Create a ReaderIO with multiple composed assertions
ri := func(ctx context.Context) func() Reader {
return func() Reader {
mp := map[string]int{"a": 1, "b": 2}
return AllOf([]Reader{
RecordNotEmpty(mp),
RecordLength[string, int](2)(mp),
ContainsKey[int]("a")(mp),
})
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with complex assertions")
}
})
t.Run("should work with string assertions", func(t *testing.T) {
// Create a ReaderIO with string assertions
ri := func(ctx context.Context) func() Reader {
return func() Reader {
str := "hello world"
return AllOf([]Reader{
StringNotEmpty(str),
StringLength[any, any](11)(str),
})
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with string assertions")
}
})
t.Run("should work with Result assertions", func(t *testing.T) {
// Create a ReaderIO with Result assertions
ri := func(ctx context.Context) func() Reader {
return func() Reader {
successResult := result.Of[int](42)
return Success(successResult)
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with Success assertion")
}
})
t.Run("should work with Failure assertion", func(t *testing.T) {
// Create a ReaderIO with Failure assertion
ri := func(ctx context.Context) func() Reader {
return func() Reader {
failureResult := result.Left[int](errors.New("test error"))
return Failure(failureResult)
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected FromReaderIO to pass with Failure assertion")
}
})
}
// TestFromReaderIOResultIntegration tests integration scenarios
func TestFromReaderIOResultIntegration(t *testing.T) {
t.Run("should work in a realistic scenario with context cancellation", func(t *testing.T) {
// Create a ReaderIOResult that uses the context
ri := func(testCtx context.Context) func() result.Result[Reader] {
return func() result.Result[Reader] {
// Check if context is valid
if testCtx == nil {
return result.Left[Reader](errors.New("context is nil"))
}
// Return a successful assertion
return result.Of[Reader](Equal("test")("test"))
}
}
// Use the actual testing.T from the subtest
reader := FromReaderIOResult(ri)
res := reader(t)
if !res {
t.Error("Expected integration test to pass")
}
})
}
// TestFromReaderIOIntegration tests integration scenarios
func TestFromReaderIOIntegration(t *testing.T) {
t.Run("should work in a realistic scenario with logging", func(t *testing.T) {
logCalled := false
// Create a ReaderIO that simulates logging
ri := func(ctx context.Context) func() Reader {
return func() Reader {
// Simulate logging with context
if ctx != nil {
logCalled = true
}
// Return an assertion
return Equal(100)(100)
}
}
reader := FromReaderIO(ri)
res := reader(t)
if !res {
t.Error("Expected integration test to pass")
}
if !logCalled {
t.Error("Expected logging to be called")
}
})
}

207
v2/assert/logger.go Normal file
View File

@@ -0,0 +1,207 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"testing"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/readerio"
)
// Logf creates a logging function that outputs formatted test messages using Go's testing.T.Logf.
//
// This function provides a functional programming approach to test logging, returning a
// [ReaderIO] that can be composed with other test operations. It's particularly useful
// for debugging tests, tracing execution flow, or documenting test behavior without
// affecting test outcomes.
//
// The function uses a curried design pattern:
// 1. First, you provide a format string (prefix) with format verbs (like %v, %d, %s)
// 2. This returns a function that takes a value of type T
// 3. That function returns a ReaderIO that performs the logging when executed
//
// # Parameters
//
// - prefix: A format string compatible with fmt.Printf (e.g., "Value: %v", "Count: %d")
// The format string should contain exactly one format verb that matches type T
//
// # Returns
//
// - A function that takes a value of type T and returns a [ReaderIO][*testing.T, Void]
// When executed, this ReaderIO logs the formatted message to the test output
//
// # Type Parameters
//
// - T: The type of value to be logged. Can be any type that can be formatted by fmt
//
// # Use Cases
//
// - Debugging test execution by logging intermediate values
// - Tracing the flow of complex test scenarios
// - Documenting test behavior in the test output
// - Logging values in functional pipelines without breaking the chain
// - Creating reusable logging operations for specific types
//
// # Example - Basic Logging
//
// func TestBasicLogging(t *testing.T) {
// // Create a logger for integers
// logInt := assert.Logf[int]("Processing value: %d")
//
// // Use it to log a value
// value := 42
// logInt(value)(t)() // Outputs: "Processing value: 42"
// }
//
// # Example - Logging in Test Pipeline
//
// func TestPipelineWithLogging(t *testing.T) {
// type User struct {
// Name string
// Age int
// }
//
// user := User{Name: "Alice", Age: 30}
//
// // Create a logger for User
// logUser := assert.Logf[User]("Testing user: %+v")
//
// // Log the user being tested
// logUser(user)(t)()
//
// // Continue with assertions
// assert.StringNotEmpty(user.Name)(t)
// assert.That(func(age int) bool { return age > 0 })(user.Age)(t)
// }
//
// # Example - Multiple Loggers for Different Types
//
// func TestMultipleLoggers(t *testing.T) {
// // Create type-specific loggers
// logString := assert.Logf[string]("String value: %s")
// logInt := assert.Logf[int]("Integer value: %d")
// logFloat := assert.Logf[float64]("Float value: %.2f")
//
// // Use them throughout the test
// logString("hello")(t)() // Outputs: "String value: hello"
// logInt(42)(t)() // Outputs: "Integer value: 42"
// logFloat(3.14159)(t)() // Outputs: "Float value: 3.14"
// }
//
// # Example - Logging Complex Structures
//
// func TestComplexStructureLogging(t *testing.T) {
// type Config struct {
// Host string
// Port int
// Timeout int
// }
//
// config := Config{Host: "localhost", Port: 8080, Timeout: 30}
//
// // Use %+v to include field names
// logConfig := assert.Logf[Config]("Configuration: %+v")
// logConfig(config)(t)()
// // Outputs: "Configuration: {Host:localhost Port:8080 Timeout:30}"
//
// // Or use %#v for Go-syntax representation
// logConfigGo := assert.Logf[Config]("Config (Go syntax): %#v")
// logConfigGo(config)(t)()
// // Outputs: "Config (Go syntax): assert.Config{Host:"localhost", Port:8080, Timeout:30}"
// }
//
// # Example - Debugging Test Failures
//
// func TestWithDebugLogging(t *testing.T) {
// numbers := []int{1, 2, 3, 4, 5}
// logSlice := assert.Logf[[]int]("Testing slice: %v")
//
// // Log the input data
// logSlice(numbers)(t)()
//
// // Perform assertions
// assert.ArrayNotEmpty(numbers)(t)
// assert.ArrayLength[int](5)(numbers)(t)
//
// // Log intermediate results
// sum := 0
// for _, n := range numbers {
// sum += n
// }
// logInt := assert.Logf[int]("Sum: %d")
// logInt(sum)(t)()
//
// assert.Equal(15)(sum)(t)
// }
//
// # Example - Conditional Logging
//
// func TestConditionalLogging(t *testing.T) {
// logDebug := assert.Logf[string]("DEBUG: %s")
//
// values := []int{1, 2, 3, 4, 5}
// for _, v := range values {
// if v%2 == 0 {
// logDebug(fmt.Sprintf("Found even number: %d", v))(t)()
// }
// }
// // Outputs:
// // DEBUG: Found even number: 2
// // DEBUG: Found even number: 4
// }
//
// # Format Verbs
//
// Common format verbs you can use in the prefix string:
// - %v: Default format
// - %+v: Default format with field names for structs
// - %#v: Go-syntax representation
// - %T: Type of the value
// - %d: Integer in base 10
// - %s: String
// - %f: Floating point number
// - %t: Boolean (true/false)
// - %p: Pointer address
//
// See the fmt package documentation for a complete list of format verbs.
//
// # Notes
//
// - Logging does not affect test pass/fail status
// - Log output appears in test results when running with -v flag or when tests fail
// - The function returns Void, indicating it's used for side effects only
// - The ReaderIO pattern allows logging to be composed with other operations
//
// # Related Functions
//
// - [FromReaderIO]: Converts ReaderIO operations into test assertions
// - testing.T.Logf: The underlying Go testing log function
//
// # References
//
// - Go testing package: https://pkg.go.dev/testing
// - fmt package format verbs: https://pkg.go.dev/fmt
// - ReaderIO pattern: Combines Reader (context dependency) with IO (side effects)
func Logf[T any](prefix string) func(T) readerio.ReaderIO[*testing.T, Void] {
return func(a T) readerio.ReaderIO[*testing.T, Void] {
return func(t *testing.T) IO[Void] {
return io.FromImpure(func() {
t.Logf(prefix, a)
})
}
}
}

406
v2/assert/logger_test.go Normal file
View File

@@ -0,0 +1,406 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"fmt"
"testing"
)
// TestLogf_BasicInteger tests basic integer logging
func TestLogf_BasicInteger(t *testing.T) {
logInt := Logf[int]("Processing value: %d")
// This should not panic and should log the value
logInt(42)(t)()
// Test passes if no panic occurs
}
// TestLogf_BasicString tests basic string logging
func TestLogf_BasicString(t *testing.T) {
logString := Logf[string]("String value: %s")
logString("hello world")(t)()
// Test passes if no panic occurs
}
// TestLogf_BasicFloat tests basic float logging
func TestLogf_BasicFloat(t *testing.T) {
logFloat := Logf[float64]("Float value: %.2f")
logFloat(3.14159)(t)()
// Test passes if no panic occurs
}
// TestLogf_BasicBoolean tests basic boolean logging
func TestLogf_BasicBoolean(t *testing.T) {
logBool := Logf[bool]("Boolean value: %t")
logBool(true)(t)()
logBool(false)(t)()
// Test passes if no panic occurs
}
// TestLogf_ComplexStruct tests logging of complex structures
func TestLogf_ComplexStruct(t *testing.T) {
type User struct {
Name string
Age int
}
logUser := Logf[User]("User: %+v")
user := User{Name: "Alice", Age: 30}
logUser(user)(t)()
// Test passes if no panic occurs
}
// TestLogf_Slice tests logging of slices
func TestLogf_Slice(t *testing.T) {
logSlice := Logf[[]int]("Slice: %v")
numbers := []int{1, 2, 3, 4, 5}
logSlice(numbers)(t)()
// Test passes if no panic occurs
}
// TestLogf_Map tests logging of maps
func TestLogf_Map(t *testing.T) {
logMap := Logf[map[string]int]("Map: %v")
data := map[string]int{"a": 1, "b": 2, "c": 3}
logMap(data)(t)()
// Test passes if no panic occurs
}
// TestLogf_Pointer tests logging of pointers
func TestLogf_Pointer(t *testing.T) {
logPtr := Logf[*int]("Pointer: %p")
value := 42
logPtr(&value)(t)()
// Test passes if no panic occurs
}
// TestLogf_NilPointer tests logging of nil pointers
func TestLogf_NilPointer(t *testing.T) {
logPtr := Logf[*int]("Pointer: %v")
var nilPtr *int
logPtr(nilPtr)(t)()
// Test passes if no panic occurs
}
// TestLogf_EmptyString tests logging of empty strings
func TestLogf_EmptyString(t *testing.T) {
logString := Logf[string]("String: '%s'")
logString("")(t)()
// Test passes if no panic occurs
}
// TestLogf_EmptySlice tests logging of empty slices
func TestLogf_EmptySlice(t *testing.T) {
logSlice := Logf[[]int]("Slice: %v")
logSlice([]int{})(t)()
// Test passes if no panic occurs
}
// TestLogf_EmptyMap tests logging of empty maps
func TestLogf_EmptyMap(t *testing.T) {
logMap := Logf[map[string]int]("Map: %v")
logMap(map[string]int{})(t)()
// Test passes if no panic occurs
}
// TestLogf_MultipleTypes tests using multiple loggers for different types
func TestLogf_MultipleTypes(t *testing.T) {
logString := Logf[string]("String: %s")
logInt := Logf[int]("Integer: %d")
logFloat := Logf[float64]("Float: %.2f")
logString("test")(t)()
logInt(42)(t)()
logFloat(3.14)(t)()
// Test passes if no panic occurs
}
// TestLogf_WithinTestPipeline tests logging within a test pipeline
func TestLogf_WithinTestPipeline(t *testing.T) {
type Config struct {
Host string
Port int
}
config := Config{Host: "localhost", Port: 8080}
logConfig := Logf[Config]("Testing config: %+v")
logConfig(config)(t)()
// Continue with assertions
StringNotEmpty(config.Host)(t)
That(func(port int) bool { return port > 0 })(config.Port)(t)
// Test passes if no panic occurs and assertions pass
}
// TestLogf_NestedStructures tests logging of nested structures
func TestLogf_NestedStructures(t *testing.T) {
type Address struct {
Street string
City string
}
type Person struct {
Name string
Address Address
}
logPerson := Logf[Person]("Person: %+v")
person := Person{
Name: "Bob",
Address: Address{
Street: "123 Main St",
City: "Springfield",
},
}
logPerson(person)(t)()
// Test passes if no panic occurs
}
// TestLogf_Interface tests logging of interface values
func TestLogf_Interface(t *testing.T) {
logAny := Logf[any]("Value: %v")
logAny(42)(t)()
logAny("string")(t)()
logAny([]int{1, 2, 3})(t)()
// Test passes if no panic occurs
}
// TestLogf_GoSyntaxFormat tests logging with Go-syntax format
func TestLogf_GoSyntaxFormat(t *testing.T) {
type Point struct {
X int
Y int
}
logPoint := Logf[Point]("Point: %#v")
point := Point{X: 10, Y: 20}
logPoint(point)(t)()
// Test passes if no panic occurs
}
// TestLogf_TypeFormat tests logging with type format
func TestLogf_TypeFormat(t *testing.T) {
logType := Logf[any]("Type: %T, Value: %v")
logType(42)(t)()
logType("string")(t)()
logType(3.14)(t)()
// Test passes if no panic occurs
}
// TestLogf_LargeNumbers tests logging of large numbers
func TestLogf_LargeNumbers(t *testing.T) {
logInt := Logf[int64]("Large number: %d")
logInt(9223372036854775807)(t)() // Max int64
// Test passes if no panic occurs
}
// TestLogf_NegativeNumbers tests logging of negative numbers
func TestLogf_NegativeNumbers(t *testing.T) {
logInt := Logf[int]("Number: %d")
logInt(-42)(t)()
logInt(-100)(t)()
// Test passes if no panic occurs
}
// TestLogf_SpecialFloats tests logging of special float values
func TestLogf_SpecialFloats(t *testing.T) {
logFloat := Logf[float64]("Float: %v")
logFloat(0.0)(t)()
logFloat(-0.0)(t)()
// Test passes if no panic occurs
}
// TestLogf_UnicodeStrings tests logging of unicode strings
func TestLogf_UnicodeStrings(t *testing.T) {
logString := Logf[string]("Unicode: %s")
logString("Hello, 世界")(t)()
logString("Emoji: 🎉🎊")(t)()
// Test passes if no panic occurs
}
// TestLogf_MultilineStrings tests logging of multiline strings
func TestLogf_MultilineStrings(t *testing.T) {
logString := Logf[string]("Multiline:\n%s")
multiline := `Line 1
Line 2
Line 3`
logString(multiline)(t)()
// Test passes if no panic occurs
}
// TestLogf_ReuseLogger tests reusing the same logger multiple times
func TestLogf_ReuseLogger(t *testing.T) {
logInt := Logf[int]("Value: %d")
for i := 0; i < 5; i++ {
logInt(i)(t)()
}
// Test passes if no panic occurs
}
// TestLogf_ConditionalLogging tests conditional logging based on values
func TestLogf_ConditionalLogging(t *testing.T) {
logDebug := Logf[string]("DEBUG: %s")
values := []int{1, 2, 3, 4, 5}
for _, v := range values {
if v%2 == 0 {
logDebug(fmt.Sprintf("Found even number: %d", v))(t)()
}
}
// Test passes if no panic occurs
}
// TestLogf_WithAssertions tests combining logging with assertions
func TestLogf_WithAssertions(t *testing.T) {
logInt := Logf[int]("Testing value: %d")
value := 42
logInt(value)(t)()
// Perform assertion after logging
Equal(42)(value)(t)
// Test passes if assertion passes
}
// TestLogf_DebuggingFailures demonstrates using logging to debug test failures
func TestLogf_DebuggingFailures(t *testing.T) {
logSlice := Logf[[]int]("Input slice: %v")
logInt := Logf[int]("Computed sum: %d")
numbers := []int{1, 2, 3, 4, 5}
logSlice(numbers)(t)()
sum := 0
for _, n := range numbers {
sum += n
}
logInt(sum)(t)()
Equal(15)(sum)(t)
// Test passes if assertion passes
}
// TestLogf_ComplexDataStructures tests logging of complex nested data
func TestLogf_ComplexDataStructures(t *testing.T) {
type Metadata struct {
Version string
Tags []string
}
type Document struct {
ID int
Title string
Metadata Metadata
}
logDoc := Logf[Document]("Document: %+v")
doc := Document{
ID: 1,
Title: "Test Document",
Metadata: Metadata{
Version: "1.0",
Tags: []string{"test", "example"},
},
}
logDoc(doc)(t)()
// Test passes if no panic occurs
}
// TestLogf_ArrayTypes tests logging of array types
func TestLogf_ArrayTypes(t *testing.T) {
logArray := Logf[[5]int]("Array: %v")
arr := [5]int{1, 2, 3, 4, 5}
logArray(arr)(t)()
// Test passes if no panic occurs
}
// TestLogf_ChannelTypes tests logging of channel types
func TestLogf_ChannelTypes(t *testing.T) {
logChan := Logf[chan int]("Channel: %v")
ch := make(chan int, 1)
logChan(ch)(t)()
close(ch)
// Test passes if no panic occurs
}
// TestLogf_FunctionTypes tests logging of function types
func TestLogf_FunctionTypes(t *testing.T) {
logFunc := Logf[func() int]("Function: %v")
fn := func() int { return 42 }
logFunc(fn)(t)()
// Test passes if no panic occurs
}

152
v2/assert/monoid.go Normal file
View File

@@ -0,0 +1,152 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"testing"
"github.com/IBM/fp-go/v2/boolean"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/reader"
)
// ApplicativeMonoid returns a [monoid.Monoid] for combining test assertion [Reader]s.
//
// This monoid combines multiple test assertions using logical AND (conjunction) semantics,
// meaning all assertions must pass for the combined assertion to pass. It leverages the
// applicative structure of Reader to execute multiple assertions with the same testing.T
// context and combines their boolean results using boolean.MonoidAll (logical AND).
//
// The monoid provides:
// - Concat: Combines two assertions such that both must pass (logical AND)
// - Empty: Returns an assertion that always passes (identity element)
//
// This is particularly useful for:
// - Composing multiple test assertions into a single assertion
// - Building complex test conditions from simpler ones
// - Creating reusable assertion combinators
// - Implementing test assertion DSLs
//
// # Monoid Laws
//
// The returned monoid satisfies the standard monoid laws:
//
// 1. Associativity:
// Concat(Concat(a1, a2), a3) ≡ Concat(a1, Concat(a2, a3))
//
// 2. Left Identity:
// Concat(Empty(), a) ≡ a
//
// 3. Right Identity:
// Concat(a, Empty()) ≡ a
//
// # Returns
//
// - A [monoid.Monoid][Reader] that combines assertions using logical AND
//
// # Example - Basic Usage
//
// func TestUserValidation(t *testing.T) {
// user := User{Name: "Alice", Age: 30, Email: "alice@example.com"}
// m := assert.ApplicativeMonoid()
//
// // Combine multiple assertions
// assertion := m.Concat(
// assert.Equal("Alice")(user.Name),
// m.Concat(
// assert.Equal(30)(user.Age),
// assert.StringNotEmpty(user.Email),
// ),
// )
//
// // Execute combined assertion
// assertion(t) // All three assertions must pass
// }
//
// # Example - Building Reusable Validators
//
// func TestWithReusableValidators(t *testing.T) {
// m := assert.ApplicativeMonoid()
//
// // Create a reusable validator
// validateUser := func(u User) assert.Reader {
// return m.Concat(
// assert.StringNotEmpty(u.Name),
// m.Concat(
// assert.True(u.Age > 0),
// assert.StringContains("@")(u.Email),
// ),
// )
// }
//
// user := User{Name: "Bob", Age: 25, Email: "bob@test.com"}
// validateUser(user)(t)
// }
//
// # Example - Using Empty for Identity
//
// func TestEmptyIdentity(t *testing.T) {
// m := assert.ApplicativeMonoid()
// assertion := assert.Equal(42)(42)
//
// // Empty is the identity - these are equivalent
// result1 := m.Concat(m.Empty(), assertion)(t)
// result2 := m.Concat(assertion, m.Empty())(t)
// result3 := assertion(t)
// // All three produce the same result
// }
//
// # Example - Combining with AllOf
//
// func TestCombiningWithAllOf(t *testing.T) {
// // ApplicativeMonoid provides the underlying mechanism for AllOf
// arr := []int{1, 2, 3, 4, 5}
//
// // These are conceptually equivalent:
// m := assert.ApplicativeMonoid()
// manual := m.Concat(
// assert.ArrayNotEmpty(arr),
// m.Concat(
// assert.ArrayLength[int](5)(arr),
// assert.ArrayContains(3)(arr),
// ),
// )
//
// // AllOf uses ApplicativeMonoid internally
// convenient := assert.AllOf([]assert.Reader{
// assert.ArrayNotEmpty(arr),
// assert.ArrayLength[int](5)(arr),
// assert.ArrayContains(3)(arr),
// })
//
// manual(t)
// convenient(t)
// }
//
// # Related Functions
//
// - [AllOf]: Convenient wrapper for combining multiple assertions using this monoid
// - [boolean.MonoidAll]: The underlying boolean monoid (logical AND with true as identity)
// - [reader.ApplicativeMonoid]: Generic applicative monoid for Reader types
//
// # References
//
// - Haskell Monoid: https://hackage.haskell.org/package/base/docs/Data-Monoid.html
// - Applicative Functors: https://hackage.haskell.org/package/base/docs/Control-Applicative.html
// - Boolean Monoid (All): https://hackage.haskell.org/package/base/docs/Data-Monoid.html#t:All
func ApplicativeMonoid() monoid.Monoid[Reader] {
return reader.ApplicativeMonoid[*testing.T](boolean.MonoidAll)
}

454
v2/assert/monoid_test.go Normal file
View File

@@ -0,0 +1,454 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"testing"
)
// TestApplicativeMonoid_Empty tests that Empty returns an assertion that always passes
func TestApplicativeMonoid_Empty(t *testing.T) {
m := ApplicativeMonoid()
empty := m.Empty()
result := empty(t)
if !result {
t.Error("Expected Empty() to return an assertion that always passes")
}
}
// TestApplicativeMonoid_Concat_BothPass tests that Concat returns true when both assertions pass
func TestApplicativeMonoid_Concat_BothPass(t *testing.T) {
m := ApplicativeMonoid()
assertion1 := Equal(42)(42)
assertion2 := Equal("hello")("hello")
combined := m.Concat(assertion1, assertion2)
result := combined(t)
if !result {
t.Error("Expected Concat to pass when both assertions pass")
}
}
// TestApplicativeMonoid_Concat_FirstFails tests that Concat returns false when first assertion fails
func TestApplicativeMonoid_Concat_FirstFails(t *testing.T) {
mockT := &testing.T{}
m := ApplicativeMonoid()
assertion1 := Equal(42)(43) // This will fail
assertion2 := Equal("hello")("hello")
combined := m.Concat(assertion1, assertion2)
result := combined(mockT)
if result {
t.Error("Expected Concat to fail when first assertion fails")
}
}
// TestApplicativeMonoid_Concat_SecondFails tests that Concat returns false when second assertion fails
func TestApplicativeMonoid_Concat_SecondFails(t *testing.T) {
mockT := &testing.T{}
m := ApplicativeMonoid()
assertion1 := Equal(42)(42)
assertion2 := Equal("hello")("world") // This will fail
combined := m.Concat(assertion1, assertion2)
result := combined(mockT)
if result {
t.Error("Expected Concat to fail when second assertion fails")
}
}
// TestApplicativeMonoid_Concat_BothFail tests that Concat returns false when both assertions fail
func TestApplicativeMonoid_Concat_BothFail(t *testing.T) {
mockT := &testing.T{}
m := ApplicativeMonoid()
assertion1 := Equal(42)(43) // This will fail
assertion2 := Equal("hello")("world") // This will fail
combined := m.Concat(assertion1, assertion2)
result := combined(mockT)
if result {
t.Error("Expected Concat to fail when both assertions fail")
}
}
// TestApplicativeMonoid_LeftIdentity tests the left identity law: Concat(Empty(), a) = a
func TestApplicativeMonoid_LeftIdentity(t *testing.T) {
m := ApplicativeMonoid()
assertion := Equal(42)(42)
// Concat(Empty(), assertion) should behave the same as assertion
combined := m.Concat(m.Empty(), assertion)
result1 := assertion(t)
result2 := combined(t)
if result1 != result2 {
t.Error("Left identity law violated: Concat(Empty(), a) should equal a")
}
}
// TestApplicativeMonoid_RightIdentity tests the right identity law: Concat(a, Empty()) = a
func TestApplicativeMonoid_RightIdentity(t *testing.T) {
m := ApplicativeMonoid()
assertion := Equal(42)(42)
// Concat(assertion, Empty()) should behave the same as assertion
combined := m.Concat(assertion, m.Empty())
result1 := assertion(t)
result2 := combined(t)
if result1 != result2 {
t.Error("Right identity law violated: Concat(a, Empty()) should equal a")
}
}
// TestApplicativeMonoid_Associativity tests the associativity law: Concat(Concat(a, b), c) = Concat(a, Concat(b, c))
func TestApplicativeMonoid_Associativity(t *testing.T) {
m := ApplicativeMonoid()
a1 := Equal(1)(1)
a2 := Equal(2)(2)
a3 := Equal(3)(3)
// Concat(Concat(a1, a2), a3)
left := m.Concat(m.Concat(a1, a2), a3)
// Concat(a1, Concat(a2, a3))
right := m.Concat(a1, m.Concat(a2, a3))
result1 := left(t)
result2 := right(t)
if result1 != result2 {
t.Error("Associativity law violated: Concat(Concat(a, b), c) should equal Concat(a, Concat(b, c))")
}
}
// TestApplicativeMonoid_AssociativityWithFailure tests associativity when assertions fail
func TestApplicativeMonoid_AssociativityWithFailure(t *testing.T) {
mockT := &testing.T{}
m := ApplicativeMonoid()
a1 := Equal(1)(1)
a2 := Equal(2)(3) // This will fail
a3 := Equal(3)(3)
// Concat(Concat(a1, a2), a3)
left := m.Concat(m.Concat(a1, a2), a3)
// Concat(a1, Concat(a2, a3))
right := m.Concat(a1, m.Concat(a2, a3))
result1 := left(mockT)
result2 := right(mockT)
if result1 != result2 {
t.Error("Associativity law violated even with failures")
}
if result1 || result2 {
t.Error("Expected both to fail when one assertion fails")
}
}
// TestApplicativeMonoid_ComplexAssertions tests combining complex assertions
func TestApplicativeMonoid_ComplexAssertions(t *testing.T) {
m := ApplicativeMonoid()
arr := []int{1, 2, 3, 4, 5}
mp := map[string]int{"a": 1, "b": 2}
arrayAssertions := m.Concat(
ArrayNotEmpty(arr),
m.Concat(
ArrayLength[int](5)(arr),
ArrayContains(3)(arr),
),
)
mapAssertions := m.Concat(
RecordNotEmpty(mp),
RecordLength[string, int](2)(mp),
)
combined := m.Concat(arrayAssertions, mapAssertions)
result := combined(t)
if !result {
t.Error("Expected complex combined assertions to pass")
}
}
// TestApplicativeMonoid_ComplexAssertionsWithFailure tests complex assertions when one fails
func TestApplicativeMonoid_ComplexAssertionsWithFailure(t *testing.T) {
mockT := &testing.T{}
m := ApplicativeMonoid()
arr := []int{1, 2, 3}
mp := map[string]int{"a": 1, "b": 2}
arrayAssertions := m.Concat(
ArrayNotEmpty(arr),
m.Concat(
ArrayLength[int](5)(arr), // This will fail - array has 3 elements, not 5
ArrayContains(3)(arr),
),
)
mapAssertions := m.Concat(
RecordNotEmpty(mp),
RecordLength[string, int](2)(mp),
)
combined := m.Concat(arrayAssertions, mapAssertions)
result := combined(mockT)
if result {
t.Error("Expected complex combined assertions to fail when one assertion fails")
}
}
// TestApplicativeMonoid_MultipleConcat tests chaining multiple Concat operations
func TestApplicativeMonoid_MultipleConcat(t *testing.T) {
m := ApplicativeMonoid()
a1 := Equal(1)(1)
a2 := Equal(2)(2)
a3 := Equal(3)(3)
a4 := Equal(4)(4)
combined := m.Concat(
m.Concat(a1, a2),
m.Concat(a3, a4),
)
result := combined(t)
if !result {
t.Error("Expected multiple Concat operations to pass when all assertions pass")
}
}
// TestApplicativeMonoid_WithStringAssertions tests combining string assertions
func TestApplicativeMonoid_WithStringAssertions(t *testing.T) {
m := ApplicativeMonoid()
str := "hello world"
combined := m.Concat(
StringNotEmpty(str),
StringLength[any, any](11)(str),
)
result := combined(t)
if !result {
t.Error("Expected string assertions to pass")
}
}
// TestApplicativeMonoid_WithBooleanAssertions tests combining boolean assertions
func TestApplicativeMonoid_WithBooleanAssertions(t *testing.T) {
m := ApplicativeMonoid()
combined := m.Concat(
Equal(true)(true),
m.Concat(
Equal(false)(false),
Equal(true)(true),
),
)
result := combined(t)
if !result {
t.Error("Expected boolean assertions to pass")
}
}
// TestApplicativeMonoid_WithErrorAssertions tests combining error assertions
func TestApplicativeMonoid_WithErrorAssertions(t *testing.T) {
m := ApplicativeMonoid()
combined := m.Concat(
NoError(nil),
Equal("test")("test"),
)
result := combined(t)
if !result {
t.Error("Expected error assertions to pass")
}
}
// TestApplicativeMonoid_EmptyWithMultipleConcat tests Empty with multiple Concat operations
func TestApplicativeMonoid_EmptyWithMultipleConcat(t *testing.T) {
m := ApplicativeMonoid()
assertion := Equal(42)(42)
// Multiple Empty values should still act as identity
combined := m.Concat(
m.Empty(),
m.Concat(
assertion,
m.Empty(),
),
)
result1 := assertion(t)
result2 := combined(t)
if result1 != result2 {
t.Error("Multiple Empty values should still act as identity")
}
}
// TestApplicativeMonoid_OnlyEmpty tests using only Empty values
func TestApplicativeMonoid_OnlyEmpty(t *testing.T) {
m := ApplicativeMonoid()
// Concat of Empty values should still be Empty (identity)
combined := m.Concat(m.Empty(), m.Empty())
result := combined(t)
if !result {
t.Error("Expected Concat of Empty values to pass")
}
}
// TestApplicativeMonoid_RealWorldExample tests a realistic use case
func TestApplicativeMonoid_RealWorldExample(t *testing.T) {
type User struct {
Name string
Age int
Email string
}
m := ApplicativeMonoid()
validateUser := func(u User) Reader {
return m.Concat(
StringNotEmpty(u.Name),
m.Concat(
That(func(age int) bool { return age > 0 })(u.Age),
m.Concat(
That(func(age int) bool { return age < 150 })(u.Age),
That(func(email string) bool {
for _, ch := range email {
if ch == '@' {
return true
}
}
return false
})(u.Email),
),
),
)
}
validUser := User{Name: "Alice", Age: 30, Email: "alice@example.com"}
result := validateUser(validUser)(t)
if !result {
t.Error("Expected valid user to pass all validations")
}
}
// TestApplicativeMonoid_RealWorldExampleWithFailure tests a realistic use case with failure
func TestApplicativeMonoid_RealWorldExampleWithFailure(t *testing.T) {
mockT := &testing.T{}
type User struct {
Name string
Age int
Email string
}
m := ApplicativeMonoid()
validateUser := func(u User) Reader {
return m.Concat(
StringNotEmpty(u.Name),
m.Concat(
That(func(age int) bool { return age > 0 })(u.Age),
m.Concat(
That(func(age int) bool { return age < 150 })(u.Age),
That(func(email string) bool {
for _, ch := range email {
if ch == '@' {
return true
}
}
return false
})(u.Email),
),
),
)
}
invalidUser := User{Name: "Bob", Age: 200, Email: "bob@test.com"} // Age > 150
result := validateUser(invalidUser)(mockT)
if result {
t.Error("Expected invalid user to fail validation")
}
}
// TestApplicativeMonoid_IntegrationWithAllOf demonstrates relationship with AllOf
func TestApplicativeMonoid_IntegrationWithAllOf(t *testing.T) {
m := ApplicativeMonoid()
arr := []int{1, 2, 3, 4, 5}
// Using ApplicativeMonoid directly
manualCombination := m.Concat(
ArrayNotEmpty(arr),
m.Concat(
ArrayLength[int](5)(arr),
ArrayContains(3)(arr),
),
)
// Using AllOf (which uses ApplicativeMonoid internally)
allOfCombination := AllOf([]Reader{
ArrayNotEmpty(arr),
ArrayLength[int](5)(arr),
ArrayContains(3)(arr),
})
result1 := manualCombination(t)
result2 := allOfCombination(t)
if result1 != result2 {
t.Error("Expected manual combination and AllOf to produce same result")
}
if !result1 || !result2 {
t.Error("Expected both combinations to pass")
}
}

650
v2/assert/traverse.go Normal file
View File

@@ -0,0 +1,650 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"testing"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/reader"
)
// TraverseArray transforms an array of values into a test suite by applying a function
// that generates named test cases for each element.
//
// This function enables data-driven testing where you have a collection of test inputs
// and want to run a named subtest for each one. It follows the functional programming
// pattern of "traverse" - transforming a collection while preserving structure and
// accumulating effects (in this case, test execution).
//
// The function takes each element of the array, applies the provided function to generate
// a [Pair] of (test name, test assertion), and runs each as a separate subtest using
// Go's t.Run. All subtests must pass for the overall test to pass.
//
// # Parameters
//
// - f: A function that takes a value of type T and returns a [Pair] containing:
// - Head: The test name (string) for the subtest
// - Tail: The test assertion ([Reader]) to execute
//
// # Returns
//
// - A [Kleisli] function that takes an array of T and returns a [Reader] that:
// - Executes each element as a named subtest
// - Returns true only if all subtests pass
// - Provides proper test isolation and reporting via t.Run
//
// # Use Cases
//
// - Data-driven testing with multiple test cases
// - Parameterized tests where each parameter gets its own subtest
// - Testing collections where each element needs validation
// - Property-based testing with generated test data
//
// # Example - Basic Data-Driven Testing
//
// func TestMathOperations(t *testing.T) {
// type TestCase struct {
// Input int
// Expected int
// }
//
// testCases := []TestCase{
// {Input: 2, Expected: 4},
// {Input: 3, Expected: 9},
// {Input: 4, Expected: 16},
// }
//
// square := func(n int) int { return n * n }
//
// traverse := assert.TraverseArray(func(tc TestCase) assert.Pair[string, assert.Reader] {
// name := fmt.Sprintf("square(%d)=%d", tc.Input, tc.Expected)
// assertion := assert.Equal(tc.Expected)(square(tc.Input))
// return pair.MakePair(name, assertion)
// })
//
// traverse(testCases)(t)
// }
//
// # Example - String Validation
//
// func TestStringValidation(t *testing.T) {
// inputs := []string{"hello", "world", "test"}
//
// traverse := assert.TraverseArray(func(s string) assert.Pair[string, assert.Reader] {
// return pair.MakePair(
// fmt.Sprintf("validate_%s", s),
// assert.AllOf([]assert.Reader{
// assert.StringNotEmpty(s),
// assert.That(func(str string) bool { return len(str) > 0 })(s),
// }),
// )
// })
//
// traverse(inputs)(t)
// }
//
// # Example - Complex Object Testing
//
// func TestUsers(t *testing.T) {
// type User struct {
// Name string
// Age int
// Email string
// }
//
// users := []User{
// {Name: "Alice", Age: 30, Email: "alice@example.com"},
// {Name: "Bob", Age: 25, Email: "bob@example.com"},
// }
//
// traverse := assert.TraverseArray(func(u User) assert.Pair[string, assert.Reader] {
// return pair.MakePair(
// fmt.Sprintf("user_%s", u.Name),
// assert.AllOf([]assert.Reader{
// assert.StringNotEmpty(u.Name),
// assert.That(func(age int) bool { return age > 0 })(u.Age),
// assert.That(func(email string) bool {
// return len(email) > 0 && strings.Contains(email, "@")
// })(u.Email),
// }),
// )
// })
//
// traverse(users)(t)
// }
//
// # Comparison with RunAll
//
// TraverseArray and [RunAll] serve similar purposes but differ in their approach:
//
// - TraverseArray: Generates test cases from an array of data
//
// - Input: Array of values + function to generate test cases
//
// - Use when: You have test data and need to generate test cases from it
//
// - RunAll: Executes pre-defined named test cases
//
// - Input: Map of test names to assertions
//
// - Use when: You have already defined test cases with names
//
// # Related Functions
//
// - [SequenceSeq2]: Similar but works with Go iterators (Seq2) instead of arrays
// - [RunAll]: Executes a map of named test cases
// - [AllOf]: Combines multiple assertions without subtests
//
// # References
//
// - Haskell traverse: https://hackage.haskell.org/package/base/docs/Data-Traversable.html#v:traverse
// - Go subtests: https://go.dev/blog/subtests
func TraverseArray[T any](f func(T) Pair[string, Reader]) Kleisli[[]T] {
return func(ts []T) Reader {
return func(t *testing.T) bool {
ok := true
for _, src := range ts {
test := f(src)
res := t.Run(pair.Head(test), func(t *testing.T) {
pair.Tail(test)(t)
})
ok = ok && res
}
return ok
}
}
}
// SequenceSeq2 executes a sequence of named test cases provided as a Go iterator.
//
// This function takes a [Seq2] iterator that yields (name, assertion) pairs and
// executes each as a separate subtest using Go's t.Run. It's similar to [TraverseArray]
// but works directly with Go's iterator protocol (introduced in Go 1.23) rather than
// requiring an array.
//
// The function iterates through all test cases, running each as a named subtest.
// All subtests must pass for the overall test to pass. This provides proper test
// isolation and clear reporting of which specific test cases fail.
//
// # Parameters
//
// - s: A [Seq2] iterator that yields pairs of:
// - Key: Test name (string) for the subtest
// - Value: Test assertion ([Reader]) to execute
//
// # Returns
//
// - A [Reader] that:
// - Executes each test case as a named subtest
// - Returns true only if all subtests pass
// - Provides proper test isolation via t.Run
//
// # Use Cases
//
// - Working with iterator-based test data
// - Lazy evaluation of test cases
// - Integration with Go 1.23+ iterator patterns
// - Memory-efficient testing of large test suites
//
// # Example - Basic Usage with Iterator
//
// func TestWithIterator(t *testing.T) {
// // Create an iterator of test cases
// testCases := func(yield func(string, assert.Reader) bool) {
// if !yield("test_addition", assert.Equal(4)(2+2)) {
// return
// }
// if !yield("test_subtraction", assert.Equal(1)(3-2)) {
// return
// }
// if !yield("test_multiplication", assert.Equal(6)(2*3)) {
// return
// }
// }
//
// assert.SequenceSeq2(testCases)(t)
// }
//
// # Example - Generated Test Cases
//
// func TestGeneratedCases(t *testing.T) {
// // Generate test cases on the fly
// generateTests := func(yield func(string, assert.Reader) bool) {
// for i := 1; i <= 5; i++ {
// name := fmt.Sprintf("test_%d", i)
// assertion := assert.Equal(i*i)(i * i)
// if !yield(name, assertion) {
// return
// }
// }
// }
//
// assert.SequenceSeq2(generateTests)(t)
// }
//
// # Example - Filtering Test Cases
//
// func TestFilteredCases(t *testing.T) {
// type TestCase struct {
// Name string
// Input int
// Expected int
// Skip bool
// }
//
// allCases := []TestCase{
// {Name: "test1", Input: 2, Expected: 4, Skip: false},
// {Name: "test2", Input: 3, Expected: 9, Skip: true},
// {Name: "test3", Input: 4, Expected: 16, Skip: false},
// }
//
// // Create iterator that filters out skipped tests
// activeTests := func(yield func(string, assert.Reader) bool) {
// for _, tc := range allCases {
// if !tc.Skip {
// assertion := assert.Equal(tc.Expected)(tc.Input * tc.Input)
// if !yield(tc.Name, assertion) {
// return
// }
// }
// }
// }
//
// assert.SequenceSeq2(activeTests)(t)
// }
//
// # Comparison with TraverseArray
//
// SequenceSeq2 and [TraverseArray] serve similar purposes but differ in their input:
//
// - SequenceSeq2: Works with iterators (Seq2)
//
// - Input: Iterator yielding (name, assertion) pairs
//
// - Use when: Working with Go 1.23+ iterators or lazy evaluation
//
// - Memory: More efficient for large test suites (lazy evaluation)
//
// - TraverseArray: Works with arrays
//
// - Input: Array of values + transformation function
//
// - Use when: You have an array of test data
//
// - Memory: All test data must be in memory
//
// # Comparison with RunAll
//
// SequenceSeq2 and [RunAll] are very similar:
//
// - SequenceSeq2: Takes an iterator (Seq2)
// - RunAll: Takes a map[string]Reader
//
// Both execute named test cases as subtests. Choose based on your data structure:
// use SequenceSeq2 for iterators, RunAll for maps.
//
// # Related Functions
//
// - [TraverseArray]: Similar but works with arrays instead of iterators
// - [RunAll]: Executes a map of named test cases
// - [AllOf]: Combines multiple assertions without subtests
//
// # References
//
// - Go iterators: https://go.dev/blog/range-functions
// - Go subtests: https://go.dev/blog/subtests
// - Haskell sequence: https://hackage.haskell.org/package/base/docs/Data-Traversable.html#v:sequence
func SequenceSeq2[T any](s Seq2[string, Reader]) Reader {
return func(t *testing.T) bool {
ok := true
for name, test := range s {
res := t.Run(name, func(t *testing.T) {
test(t)
})
ok = ok && res
}
return ok
}
}
// TraverseRecord transforms a map of values into a test suite by applying a function
// that generates test assertions for each map entry.
//
// This function enables data-driven testing where you have a map of test data and want
// to run a named subtest for each entry. The map keys become test names, and the function
// transforms each value into a test assertion. It follows the functional programming
// pattern of "traverse" - transforming a collection while preserving structure and
// accumulating effects (in this case, test execution).
//
// The function takes each key-value pair from the map, applies the provided function to
// generate a [Reader] assertion, and runs each as a separate subtest using Go's t.Run.
// All subtests must pass for the overall test to pass.
//
// # Parameters
//
// - f: A [Kleisli] function that takes a value of type T and returns a [Reader] assertion
//
// # Returns
//
// - A [Kleisli] function that takes a map[string]T and returns a [Reader] that:
// - Executes each map entry as a named subtest (using the key as the test name)
// - Returns true only if all subtests pass
// - Provides proper test isolation and reporting via t.Run
//
// # Use Cases
//
// - Data-driven testing with named test cases in a map
// - Testing configuration maps where keys are meaningful names
// - Validating collections where natural keys exist
// - Property-based testing with named scenarios
//
// # Example - Basic Configuration Testing
//
// func TestConfigurations(t *testing.T) {
// configs := map[string]int{
// "timeout": 30,
// "maxRetries": 3,
// "bufferSize": 1024,
// }
//
// validatePositive := assert.That(func(n int) bool { return n > 0 })
//
// traverse := assert.TraverseRecord(validatePositive)
// traverse(configs)(t)
// }
//
// # Example - User Validation
//
// func TestUserMap(t *testing.T) {
// type User struct {
// Name string
// Age int
// }
//
// users := map[string]User{
// "alice": {Name: "Alice", Age: 30},
// "bob": {Name: "Bob", Age: 25},
// "carol": {Name: "Carol", Age: 35},
// }
//
// validateUser := func(u User) assert.Reader {
// return assert.AllOf([]assert.Reader{
// assert.StringNotEmpty(u.Name),
// assert.That(func(age int) bool { return age > 0 && age < 150 })(u.Age),
// })
// }
//
// traverse := assert.TraverseRecord(validateUser)
// traverse(users)(t)
// }
//
// # Example - API Endpoint Testing
//
// func TestEndpoints(t *testing.T) {
// type Endpoint struct {
// Path string
// Method string
// }
//
// endpoints := map[string]Endpoint{
// "get_users": {Path: "/api/users", Method: "GET"},
// "create_user": {Path: "/api/users", Method: "POST"},
// "delete_user": {Path: "/api/users/:id", Method: "DELETE"},
// }
//
// validateEndpoint := func(e Endpoint) assert.Reader {
// return assert.AllOf([]assert.Reader{
// assert.StringNotEmpty(e.Path),
// assert.That(func(path string) bool {
// return strings.HasPrefix(path, "/api/")
// })(e.Path),
// assert.That(func(method string) bool {
// return method == "GET" || method == "POST" ||
// method == "PUT" || method == "DELETE"
// })(e.Method),
// })
// }
//
// traverse := assert.TraverseRecord(validateEndpoint)
// traverse(endpoints)(t)
// }
//
// # Comparison with TraverseArray
//
// TraverseRecord and [TraverseArray] serve similar purposes but differ in their input:
//
// - TraverseRecord: Works with maps (records)
//
// - Input: Map with string keys + transformation function
//
// - Use when: You have named test data in a map
//
// - Test names: Derived from map keys
//
// - TraverseArray: Works with arrays
//
// - Input: Array of values + function that generates names and assertions
//
// - Use when: You have sequential test data
//
// - Test names: Generated by the transformation function
//
// # Comparison with SequenceRecord
//
// TraverseRecord and [SequenceRecord] are closely related:
//
// - TraverseRecord: Transforms values into assertions
//
// - Input: map[string]T + function T -> Reader
//
// - Use when: You need to transform data before asserting
//
// - SequenceRecord: Executes pre-defined assertions
//
// - Input: map[string]Reader
//
// - Use when: Assertions are already defined
//
// # Related Functions
//
// - [SequenceRecord]: Similar but takes pre-defined assertions
// - [TraverseArray]: Similar but works with arrays
// - [RunAll]: Alias for SequenceRecord
//
// # References
//
// - Haskell traverse: https://hackage.haskell.org/package/base/docs/Data-Traversable.html#v:traverse
// - Go subtests: https://go.dev/blog/subtests
func TraverseRecord[T any](f Kleisli[T]) Kleisli[map[string]T] {
return func(m map[string]T) Reader {
return func(t *testing.T) bool {
ok := true
for name, src := range m {
res := t.Run(name, func(t *testing.T) {
f(src)(t)
})
ok = ok && res
}
return ok
}
}
}
// SequenceRecord executes a map of named test cases as subtests.
//
// This function takes a map where keys are test names and values are test assertions
// ([Reader]), and executes each as a separate subtest using Go's t.Run. It's the
// record (map) equivalent of [SequenceSeq2] and is actually aliased as [RunAll] for
// convenience.
//
// The function iterates through all map entries, running each as a named subtest.
// All subtests must pass for the overall test to pass. This provides proper test
// isolation and clear reporting of which specific test cases fail.
//
// # Parameters
//
// - m: A map[string]Reader where:
// - Keys: Test names (strings) for the subtests
// - Values: Test assertions ([Reader]) to execute
//
// # Returns
//
// - A [Reader] that:
// - Executes each map entry as a named subtest
// - Returns true only if all subtests pass
// - Provides proper test isolation via t.Run
//
// # Use Cases
//
// - Executing a collection of pre-defined named test cases
// - Organizing related tests in a map structure
// - Running multiple assertions with descriptive names
// - Building test suites programmatically
//
// # Example - Basic Named Tests
//
// func TestMathOperations(t *testing.T) {
// tests := map[string]assert.Reader{
// "addition": assert.Equal(4)(2 + 2),
// "subtraction": assert.Equal(1)(3 - 2),
// "multiplication": assert.Equal(6)(2 * 3),
// "division": assert.Equal(2)(6 / 3),
// }
//
// assert.SequenceRecord(tests)(t)
// }
//
// # Example - String Validation Suite
//
// func TestStringValidations(t *testing.T) {
// testString := "hello world"
//
// tests := map[string]assert.Reader{
// "not_empty": assert.StringNotEmpty(testString),
// "correct_length": assert.StringLength[any, any](11)(testString),
// "has_space": assert.That(func(s string) bool {
// return strings.Contains(s, " ")
// })(testString),
// "lowercase": assert.That(func(s string) bool {
// return s == strings.ToLower(s)
// })(testString),
// }
//
// assert.SequenceRecord(tests)(t)
// }
//
// # Example - Complex Object Validation
//
// func TestUserValidation(t *testing.T) {
// type User struct {
// Name string
// Age int
// Email string
// }
//
// user := User{Name: "Alice", Age: 30, Email: "alice@example.com"}
//
// tests := map[string]assert.Reader{
// "name_not_empty": assert.StringNotEmpty(user.Name),
// "age_positive": assert.That(func(age int) bool { return age > 0 })(user.Age),
// "age_reasonable": assert.That(func(age int) bool { return age < 150 })(user.Age),
// "email_valid": assert.That(func(email string) bool {
// return strings.Contains(email, "@") && strings.Contains(email, ".")
// })(user.Email),
// }
//
// assert.SequenceRecord(tests)(t)
// }
//
// # Example - Array Validation Suite
//
// func TestArrayValidations(t *testing.T) {
// numbers := []int{1, 2, 3, 4, 5}
//
// tests := map[string]assert.Reader{
// "not_empty": assert.ArrayNotEmpty(numbers),
// "correct_length": assert.ArrayLength[int](5)(numbers),
// "contains_three": assert.ArrayContains(3)(numbers),
// "all_positive": assert.That(func(arr []int) bool {
// for _, n := range arr {
// if n <= 0 {
// return false
// }
// }
// return true
// })(numbers),
// }
//
// assert.SequenceRecord(tests)(t)
// }
//
// # Comparison with TraverseRecord
//
// SequenceRecord and [TraverseRecord] are closely related:
//
// - SequenceRecord: Executes pre-defined assertions
//
// - Input: map[string]Reader (assertions already created)
//
// - Use when: You have already defined test cases with assertions
//
// - TraverseRecord: Transforms values into assertions
//
// - Input: map[string]T + function T -> Reader
//
// - Use when: You need to transform data before asserting
//
// # Comparison with SequenceSeq2
//
// SequenceRecord and [SequenceSeq2] serve similar purposes but differ in their input:
//
// - SequenceRecord: Works with maps
//
// - Input: map[string]Reader
//
// - Use when: You have named test cases in a map
//
// - Iteration order: Non-deterministic (map iteration)
//
// - SequenceSeq2: Works with iterators
//
// - Input: Seq2[string, Reader]
//
// - Use when: You have test cases in an iterator
//
// - Iteration order: Deterministic (iterator order)
//
// # Note on Map Iteration Order
//
// Go maps have non-deterministic iteration order. If test execution order matters,
// consider using [SequenceSeq2] with an iterator that provides deterministic ordering,
// or use [TraverseArray] with a slice of test cases.
//
// # Related Functions
//
// - [RunAll]: Alias for SequenceRecord
// - [TraverseRecord]: Similar but transforms values into assertions
// - [SequenceSeq2]: Similar but works with iterators
// - [TraverseArray]: Similar but works with arrays
//
// # References
//
// - Go subtests: https://go.dev/blog/subtests
// - Haskell sequence: https://hackage.haskell.org/package/base/docs/Data-Traversable.html#v:sequence
func SequenceRecord(m map[string]Reader) Reader {
return TraverseRecord(reader.Ask[Reader]())(m)
}

960
v2/assert/traverse_test.go Normal file
View File

@@ -0,0 +1,960 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"fmt"
"testing"
"github.com/IBM/fp-go/v2/pair"
)
// TestTraverseArray_EmptyArray tests that TraverseArray handles empty arrays correctly
func TestTraverseArray_EmptyArray(t *testing.T) {
traverse := TraverseArray(func(n int) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("test_%d", n),
Equal(n)(n),
)
})
result := traverse([]int{})(t)
if !result {
t.Error("Expected TraverseArray to pass with empty array")
}
}
// TestTraverseArray_SingleElement tests TraverseArray with a single element
func TestTraverseArray_SingleElement(t *testing.T) {
traverse := TraverseArray(func(n int) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("test_%d", n),
Equal(n*2)(n*2),
)
})
result := traverse([]int{5})(t)
if !result {
t.Error("Expected TraverseArray to pass with single element")
}
}
// TestTraverseArray_MultipleElements tests TraverseArray with multiple passing elements
func TestTraverseArray_MultipleElements(t *testing.T) {
traverse := TraverseArray(func(n int) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("square_%d", n),
Equal(n*n)(n*n),
)
})
result := traverse([]int{1, 2, 3, 4, 5})(t)
if !result {
t.Error("Expected TraverseArray to pass with all passing elements")
}
}
// TestTraverseArray_WithFailure tests that TraverseArray fails when one element fails
func TestTraverseArray_WithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
traverse := TraverseArray(func(n int) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("test_%d", n),
Equal(10)(n), // Will fail for all except 10
)
})
// Run in a subtest - we expect the subtests to fail, so t.Run returns false
result := traverse([]int{1, 2, 3})(t)
// The traverse should return false because assertions fail
if result {
t.Error("Expected traverse to return false when elements don't match")
}
}
// TestTraverseArray_MixedResults tests TraverseArray with some passing and some failing
func TestTraverseArray_MixedResults(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
traverse := TraverseArray(func(n int) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("is_even_%d", n),
Equal(0)(n%2), // Only passes for even numbers
)
})
result := traverse([]int{2, 3, 4})(t) // 3 is odd, should fail
// The traverse should return false because one assertion fails
if result {
t.Error("Expected traverse to return false when some elements fail")
}
}
// TestTraverseArray_StringData tests TraverseArray with string data
func TestTraverseArray_StringData(t *testing.T) {
words := []string{"hello", "world", "test"}
traverse := TraverseArray(func(s string) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("validate_%s", s),
AllOf([]Reader{
StringNotEmpty(s),
That(func(str string) bool { return len(str) > 0 })(s),
}),
)
})
result := traverse(words)(t)
if !result {
t.Error("Expected TraverseArray to pass with valid strings")
}
}
// TestTraverseArray_ComplexObjects tests TraverseArray with complex objects
func TestTraverseArray_ComplexObjects(t *testing.T) {
type User struct {
Name string
Age int
}
users := []User{
{Name: "Alice", Age: 30},
{Name: "Bob", Age: 25},
{Name: "Charlie", Age: 35},
}
traverse := TraverseArray(func(u User) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("user_%s", u.Name),
AllOf([]Reader{
StringNotEmpty(u.Name),
That(func(age int) bool { return age > 0 && age < 150 })(u.Age),
}),
)
})
result := traverse(users)(t)
if !result {
t.Error("Expected TraverseArray to pass with valid users")
}
}
// TestTraverseArray_ComplexObjectsWithFailure tests TraverseArray with invalid complex objects
func TestTraverseArray_ComplexObjectsWithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
type User struct {
Name string
Age int
}
users := []User{
{Name: "Alice", Age: 30},
{Name: "", Age: 25}, // Invalid: empty name
{Name: "Charlie", Age: 35},
}
traverse := TraverseArray(func(u User) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("user_%s", u.Name),
AllOf([]Reader{
StringNotEmpty(u.Name),
That(func(age int) bool { return age > 0 })(u.Age),
}),
)
})
result := traverse(users)(t)
// The traverse should return false because one user is invalid
if result {
t.Error("Expected traverse to return false with invalid user")
}
}
// TestTraverseArray_DataDrivenTesting demonstrates data-driven testing pattern
func TestTraverseArray_DataDrivenTesting(t *testing.T) {
type TestCase struct {
Input int
Expected int
}
testCases := []TestCase{
{Input: 2, Expected: 4},
{Input: 3, Expected: 9},
{Input: 4, Expected: 16},
{Input: 5, Expected: 25},
}
square := func(n int) int { return n * n }
traverse := TraverseArray(func(tc TestCase) Pair[string, Reader] {
return pair.MakePair(
fmt.Sprintf("square(%d)=%d", tc.Input, tc.Expected),
Equal(tc.Expected)(square(tc.Input)),
)
})
result := traverse(testCases)(t)
if !result {
t.Error("Expected all test cases to pass")
}
}
// TestSequenceSeq2_EmptySequence tests that SequenceSeq2 handles empty sequences correctly
func TestSequenceSeq2_EmptySequence(t *testing.T) {
emptySeq := func(yield func(string, Reader) bool) {
// Empty - yields nothing
}
result := SequenceSeq2[Reader](emptySeq)(t)
if !result {
t.Error("Expected SequenceSeq2 to pass with empty sequence")
}
}
// TestSequenceSeq2_SingleTest tests SequenceSeq2 with a single test
func TestSequenceSeq2_SingleTest(t *testing.T) {
singleSeq := func(yield func(string, Reader) bool) {
yield("test_one", Equal(42)(42))
}
result := SequenceSeq2[Reader](singleSeq)(t)
if !result {
t.Error("Expected SequenceSeq2 to pass with single test")
}
}
// TestSequenceSeq2_MultipleTests tests SequenceSeq2 with multiple passing tests
func TestSequenceSeq2_MultipleTests(t *testing.T) {
multiSeq := func(yield func(string, Reader) bool) {
if !yield("test_addition", Equal(4)(2+2)) {
return
}
if !yield("test_subtraction", Equal(1)(3-2)) {
return
}
if !yield("test_multiplication", Equal(6)(2*3)) {
return
}
}
result := SequenceSeq2[Reader](multiSeq)(t)
if !result {
t.Error("Expected SequenceSeq2 to pass with all passing tests")
}
}
// TestSequenceSeq2_WithFailure tests that SequenceSeq2 fails when one test fails
func TestSequenceSeq2_WithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
failSeq := func(yield func(string, Reader) bool) {
if !yield("test_pass", Equal(4)(2+2)) {
return
}
if !yield("test_fail", Equal(5)(2+2)) { // This will fail
return
}
if !yield("test_pass2", Equal(6)(2*3)) {
return
}
}
result := SequenceSeq2[Reader](failSeq)(t)
// The sequence should return false because one test fails
if result {
t.Error("Expected sequence to return false when one test fails")
}
}
// TestSequenceSeq2_GeneratedTests tests SequenceSeq2 with generated test cases
func TestSequenceSeq2_GeneratedTests(t *testing.T) {
generateTests := func(yield func(string, Reader) bool) {
for i := 1; i <= 5; i++ {
name := fmt.Sprintf("test_%d", i)
assertion := Equal(i * i)(i * i)
if !yield(name, assertion) {
return
}
}
}
result := SequenceSeq2[Reader](generateTests)(t)
if !result {
t.Error("Expected all generated tests to pass")
}
}
// TestSequenceSeq2_StringTests tests SequenceSeq2 with string assertions
func TestSequenceSeq2_StringTests(t *testing.T) {
stringSeq := func(yield func(string, Reader) bool) {
if !yield("test_hello", StringNotEmpty("hello")) {
return
}
if !yield("test_world", StringNotEmpty("world")) {
return
}
if !yield("test_length", StringLength[any, any](5)("hello")) {
return
}
}
result := SequenceSeq2[Reader](stringSeq)(t)
if !result {
t.Error("Expected all string tests to pass")
}
}
// TestSequenceSeq2_ArrayTests tests SequenceSeq2 with array assertions
func TestSequenceSeq2_ArrayTests(t *testing.T) {
arr := []int{1, 2, 3, 4, 5}
arraySeq := func(yield func(string, Reader) bool) {
if !yield("test_not_empty", ArrayNotEmpty(arr)) {
return
}
if !yield("test_length", ArrayLength[int](5)(arr)) {
return
}
if !yield("test_contains", ArrayContains(3)(arr)) {
return
}
}
result := SequenceSeq2[Reader](arraySeq)(t)
if !result {
t.Error("Expected all array tests to pass")
}
}
// TestSequenceSeq2_ComplexAssertions tests SequenceSeq2 with complex combined assertions
func TestSequenceSeq2_ComplexAssertions(t *testing.T) {
type User struct {
Name string
Age int
Email string
}
user := User{Name: "Alice", Age: 30, Email: "alice@example.com"}
userSeq := func(yield func(string, Reader) bool) {
if !yield("test_name", StringNotEmpty(user.Name)) {
return
}
if !yield("test_age", That(func(age int) bool { return age > 0 && age < 150 })(user.Age)) {
return
}
if !yield("test_email", That(func(email string) bool {
for _, ch := range email {
if ch == '@' {
return true
}
}
return false
})(user.Email)) {
return
}
}
result := SequenceSeq2[Reader](userSeq)(t)
if !result {
t.Error("Expected all user validation tests to pass")
}
}
// TestSequenceSeq2_EarlyTermination tests that SequenceSeq2 respects early termination
func TestSequenceSeq2_EarlyTermination(t *testing.T) {
executionCount := 0
earlyTermSeq := func(yield func(string, Reader) bool) {
executionCount++
if !yield("test_1", Equal(1)(1)) {
return
}
executionCount++
if !yield("test_2", Equal(2)(2)) {
return
}
executionCount++
// This should execute even though we don't check the return
yield("test_3", Equal(3)(3))
executionCount++
}
SequenceSeq2[Reader](earlyTermSeq)(t)
// All iterations should execute since we're not terminating early
if executionCount != 4 {
t.Errorf("Expected 4 executions, got %d", executionCount)
}
}
// TestSequenceSeq2_WithMapConversion demonstrates converting a map to Seq2
func TestSequenceSeq2_WithMapConversion(t *testing.T) {
testMap := map[string]Reader{
"test_addition": Equal(4)(2 + 2),
"test_multiplication": Equal(6)(2 * 3),
"test_subtraction": Equal(1)(3 - 2),
}
// Convert map to Seq2
mapSeq := func(yield func(string, Reader) bool) {
for name, assertion := range testMap {
if !yield(name, assertion) {
return
}
}
}
result := SequenceSeq2[Reader](mapSeq)(t)
if !result {
t.Error("Expected all map-based tests to pass")
}
}
// TestTraverseArray_vs_SequenceSeq2 demonstrates the relationship between the two functions
func TestTraverseArray_vs_SequenceSeq2(t *testing.T) {
type TestCase struct {
Name string
Input int
Expected int
}
testCases := []TestCase{
{Name: "test_1", Input: 2, Expected: 4},
{Name: "test_2", Input: 3, Expected: 9},
{Name: "test_3", Input: 4, Expected: 16},
}
// Using TraverseArray
traverseResult := TraverseArray(func(tc TestCase) Pair[string, Reader] {
return pair.MakePair(tc.Name, Equal(tc.Expected)(tc.Input*tc.Input))
})(testCases)(t)
// Using SequenceSeq2
seqResult := SequenceSeq2[Reader](func(yield func(string, Reader) bool) {
for _, tc := range testCases {
if !yield(tc.Name, Equal(tc.Expected)(tc.Input*tc.Input)) {
return
}
}
})(t)
if traverseResult != seqResult {
t.Error("Expected TraverseArray and SequenceSeq2 to produce same result")
}
if !traverseResult || !seqResult {
t.Error("Expected both approaches to pass")
}
}
// TestTraverseRecord_EmptyMap tests that TraverseRecord handles empty maps correctly
func TestTraverseRecord_EmptyMap(t *testing.T) {
traverse := TraverseRecord(func(n int) Reader {
return Equal(n)(n)
})
result := traverse(map[string]int{})(t)
if !result {
t.Error("Expected TraverseRecord to pass with empty map")
}
}
// TestTraverseRecord_SingleEntry tests TraverseRecord with a single map entry
func TestTraverseRecord_SingleEntry(t *testing.T) {
traverse := TraverseRecord(func(n int) Reader {
return Equal(n * 2)(n * 2)
})
result := traverse(map[string]int{"test_5": 5})(t)
if !result {
t.Error("Expected TraverseRecord to pass with single entry")
}
}
// TestTraverseRecord_MultipleEntries tests TraverseRecord with multiple passing entries
func TestTraverseRecord_MultipleEntries(t *testing.T) {
traverse := TraverseRecord(func(n int) Reader {
return Equal(n * n)(n * n)
})
result := traverse(map[string]int{
"square_1": 1,
"square_2": 2,
"square_3": 3,
"square_4": 4,
"square_5": 5,
})(t)
if !result {
t.Error("Expected TraverseRecord to pass with all passing entries")
}
}
// TestTraverseRecord_WithFailure tests that TraverseRecord fails when one entry fails
func TestTraverseRecord_WithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
traverse := TraverseRecord(func(n int) Reader {
return Equal(10)(n) // Will fail for all except 10
})
result := traverse(map[string]int{
"test_1": 1,
"test_2": 2,
"test_3": 3,
})(t)
// The traverse should return false because entries don't match
if result {
t.Error("Expected traverse to return false when entries don't match")
}
}
// TestTraverseRecord_MixedResults tests TraverseRecord with some passing and some failing
func TestTraverseRecord_MixedResults(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
traverse := TraverseRecord(func(n int) Reader {
return Equal(0)(n % 2) // Only passes for even numbers
})
result := traverse(map[string]int{
"even_2": 2,
"odd_3": 3,
"even_4": 4,
})(t)
// The traverse should return false because some entries fail
if result {
t.Error("Expected traverse to return false when some entries fail")
}
}
// TestTraverseRecord_StringData tests TraverseRecord with string data
func TestTraverseRecord_StringData(t *testing.T) {
words := map[string]string{
"greeting": "hello",
"world": "world",
"test": "test",
}
traverse := TraverseRecord(func(s string) Reader {
return AllOf([]Reader{
StringNotEmpty(s),
That(func(str string) bool { return len(str) > 0 })(s),
})
})
result := traverse(words)(t)
if !result {
t.Error("Expected TraverseRecord to pass with valid strings")
}
}
// TestTraverseRecord_ComplexObjects tests TraverseRecord with complex objects
func TestTraverseRecord_ComplexObjects(t *testing.T) {
type User struct {
Name string
Age int
}
users := map[string]User{
"alice": {Name: "Alice", Age: 30},
"bob": {Name: "Bob", Age: 25},
"charlie": {Name: "Charlie", Age: 35},
}
traverse := TraverseRecord(func(u User) Reader {
return AllOf([]Reader{
StringNotEmpty(u.Name),
That(func(age int) bool { return age > 0 && age < 150 })(u.Age),
})
})
result := traverse(users)(t)
if !result {
t.Error("Expected TraverseRecord to pass with valid users")
}
}
// TestTraverseRecord_ComplexObjectsWithFailure tests TraverseRecord with invalid complex objects
func TestTraverseRecord_ComplexObjectsWithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
type User struct {
Name string
Age int
}
users := map[string]User{
"alice": {Name: "Alice", Age: 30},
"invalid": {Name: "", Age: 25}, // Invalid: empty name
"charlie": {Name: "Charlie", Age: 35},
}
traverse := TraverseRecord(func(u User) Reader {
return AllOf([]Reader{
StringNotEmpty(u.Name),
That(func(age int) bool { return age > 0 })(u.Age),
})
})
result := traverse(users)(t)
// The traverse should return false because one user is invalid
if result {
t.Error("Expected traverse to return false with invalid user")
}
}
// TestTraverseRecord_ConfigurationTesting demonstrates configuration testing pattern
func TestTraverseRecord_ConfigurationTesting(t *testing.T) {
configs := map[string]int{
"timeout": 30,
"maxRetries": 3,
"bufferSize": 1024,
}
validatePositive := That(func(n int) bool { return n > 0 })
traverse := TraverseRecord(validatePositive)
result := traverse(configs)(t)
if !result {
t.Error("Expected all configuration values to be positive")
}
}
// TestTraverseRecord_APIEndpointTesting demonstrates API endpoint testing pattern
func TestTraverseRecord_APIEndpointTesting(t *testing.T) {
type Endpoint struct {
Path string
Method string
}
endpoints := map[string]Endpoint{
"get_users": {Path: "/api/users", Method: "GET"},
"create_user": {Path: "/api/users", Method: "POST"},
"delete_user": {Path: "/api/users/:id", Method: "DELETE"},
}
validateEndpoint := func(e Endpoint) Reader {
return AllOf([]Reader{
StringNotEmpty(e.Path),
That(func(path string) bool {
return len(path) > 0 && path[0] == '/'
})(e.Path),
That(func(method string) bool {
return method == "GET" || method == "POST" ||
method == "PUT" || method == "DELETE"
})(e.Method),
})
}
traverse := TraverseRecord(validateEndpoint)
result := traverse(endpoints)(t)
if !result {
t.Error("Expected all endpoints to be valid")
}
}
// TestSequenceRecord_EmptyMap tests that SequenceRecord handles empty maps correctly
func TestSequenceRecord_EmptyMap(t *testing.T) {
result := SequenceRecord(map[string]Reader{})(t)
if !result {
t.Error("Expected SequenceRecord to pass with empty map")
}
}
// TestSequenceRecord_SingleTest tests SequenceRecord with a single test
func TestSequenceRecord_SingleTest(t *testing.T) {
tests := map[string]Reader{
"test_one": Equal(42)(42),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected SequenceRecord to pass with single test")
}
}
// TestSequenceRecord_MultipleTests tests SequenceRecord with multiple passing tests
func TestSequenceRecord_MultipleTests(t *testing.T) {
tests := map[string]Reader{
"test_addition": Equal(4)(2 + 2),
"test_subtraction": Equal(1)(3 - 2),
"test_multiplication": Equal(6)(2 * 3),
"test_division": Equal(2)(6 / 3),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected SequenceRecord to pass with all passing tests")
}
}
// TestSequenceRecord_WithFailure tests that SequenceRecord fails when one test fails
func TestSequenceRecord_WithFailure(t *testing.T) {
t.Skip("Skipping test that intentionally creates failing subtests")
tests := map[string]Reader{
"test_pass": Equal(4)(2 + 2),
"test_fail": Equal(5)(2 + 2), // This will fail
"test_pass2": Equal(6)(2 * 3),
}
result := SequenceRecord(tests)(t)
// The sequence should return false because one test fails
if result {
t.Error("Expected sequence to return false when one test fails")
}
}
// TestSequenceRecord_StringTests tests SequenceRecord with string assertions
func TestSequenceRecord_StringTests(t *testing.T) {
testString := "hello world"
tests := map[string]Reader{
"not_empty": StringNotEmpty(testString),
"correct_length": StringLength[any, any](11)(testString),
"has_space": That(func(s string) bool {
for _, ch := range s {
if ch == ' ' {
return true
}
}
return false
})(testString),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all string tests to pass")
}
}
// TestSequenceRecord_ArrayTests tests SequenceRecord with array assertions
func TestSequenceRecord_ArrayTests(t *testing.T) {
arr := []int{1, 2, 3, 4, 5}
tests := map[string]Reader{
"not_empty": ArrayNotEmpty(arr),
"correct_length": ArrayLength[int](5)(arr),
"contains_three": ArrayContains(3)(arr),
"all_positive": That(func(arr []int) bool {
for _, n := range arr {
if n <= 0 {
return false
}
}
return true
})(arr),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all array tests to pass")
}
}
// TestSequenceRecord_ComplexAssertions tests SequenceRecord with complex combined assertions
func TestSequenceRecord_ComplexAssertions(t *testing.T) {
type User struct {
Name string
Age int
Email string
}
user := User{Name: "Alice", Age: 30, Email: "alice@example.com"}
tests := map[string]Reader{
"name_not_empty": StringNotEmpty(user.Name),
"age_positive": That(func(age int) bool { return age > 0 })(user.Age),
"age_reasonable": That(func(age int) bool { return age < 150 })(user.Age),
"email_valid": That(func(email string) bool {
hasAt := false
hasDot := false
for _, ch := range email {
if ch == '@' {
hasAt = true
}
if ch == '.' {
hasDot = true
}
}
return hasAt && hasDot
})(user.Email),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all user validation tests to pass")
}
}
// TestSequenceRecord_MathOperations demonstrates basic math operations testing
func TestSequenceRecord_MathOperations(t *testing.T) {
tests := map[string]Reader{
"addition": Equal(4)(2 + 2),
"subtraction": Equal(1)(3 - 2),
"multiplication": Equal(6)(2 * 3),
"division": Equal(2)(6 / 3),
"modulo": Equal(1)(7 % 3),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all math operations to pass")
}
}
// TestSequenceRecord_BooleanTests tests SequenceRecord with boolean assertions
func TestSequenceRecord_BooleanTests(t *testing.T) {
tests := map[string]Reader{
"true_is_true": Equal(true)(true),
"false_is_false": Equal(false)(false),
"not_true": Equal(false)(!true),
"not_false": Equal(true)(!false),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all boolean tests to pass")
}
}
// TestSequenceRecord_ErrorTests tests SequenceRecord with error assertions
func TestSequenceRecord_ErrorTests(t *testing.T) {
tests := map[string]Reader{
"no_error": NoError(nil),
"equal_value": Equal("test")("test"),
"not_empty": StringNotEmpty("hello"),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected all error tests to pass")
}
}
// TestTraverseRecord_vs_SequenceRecord demonstrates the relationship between the two functions
func TestTraverseRecord_vs_SequenceRecord(t *testing.T) {
type TestCase struct {
Input int
Expected int
}
testData := map[string]TestCase{
"test_1": {Input: 2, Expected: 4},
"test_2": {Input: 3, Expected: 9},
"test_3": {Input: 4, Expected: 16},
}
// Using TraverseRecord
traverseResult := TraverseRecord(func(tc TestCase) Reader {
return Equal(tc.Expected)(tc.Input * tc.Input)
})(testData)(t)
// Using SequenceRecord (manually creating the map)
tests := make(map[string]Reader)
for name, tc := range testData {
tests[name] = Equal(tc.Expected)(tc.Input * tc.Input)
}
seqResult := SequenceRecord(tests)(t)
if traverseResult != seqResult {
t.Error("Expected TraverseRecord and SequenceRecord to produce same result")
}
if !traverseResult || !seqResult {
t.Error("Expected both approaches to pass")
}
}
// TestSequenceRecord_WithAllOf demonstrates combining SequenceRecord with AllOf
func TestSequenceRecord_WithAllOf(t *testing.T) {
arr := []int{1, 2, 3, 4, 5}
tests := map[string]Reader{
"array_validations": AllOf([]Reader{
ArrayNotEmpty(arr),
ArrayLength[int](5)(arr),
ArrayContains(3)(arr),
}),
"element_checks": AllOf([]Reader{
That(func(a []int) bool { return a[0] == 1 })(arr),
That(func(a []int) bool { return a[4] == 5 })(arr),
}),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected combined assertions to pass")
}
}
// TestTraverseRecord_ConfigValidation demonstrates real-world configuration validation
func TestTraverseRecord_ConfigValidation(t *testing.T) {
type Config struct {
Value int
Min int
Max int
}
configs := map[string]Config{
"timeout": {Value: 30, Min: 1, Max: 60},
"maxRetries": {Value: 3, Min: 1, Max: 10},
"bufferSize": {Value: 1024, Min: 512, Max: 4096},
}
validateConfig := func(c Config) Reader {
return AllOf([]Reader{
That(func(val int) bool { return val >= c.Min })(c.Value),
That(func(val int) bool { return val <= c.Max })(c.Value),
})
}
traverse := TraverseRecord(validateConfig)
result := traverse(configs)(t)
if !result {
t.Error("Expected all configurations to be within valid ranges")
}
}
// TestSequenceRecord_RealWorldExample demonstrates a realistic use case
func TestSequenceRecord_RealWorldExample(t *testing.T) {
type Response struct {
StatusCode int
Body string
}
response := Response{StatusCode: 200, Body: `{"status":"ok"}`}
tests := map[string]Reader{
"status_ok": Equal(200)(response.StatusCode),
"body_not_empty": StringNotEmpty(response.Body),
"body_is_json": That(func(s string) bool {
return len(s) > 0 && s[0] == '{' && s[len(s)-1] == '}'
})(response.Body),
}
result := SequenceRecord(tests)(t)
if !result {
t.Error("Expected response validation to pass")
}
}

View File

@@ -1,11 +1,32 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package assert
import (
"iter"
"testing"
"github.com/IBM/fp-go/v2/context/readerio"
"github.com/IBM/fp-go/v2/context/readerioresult"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/optics/lens"
"github.com/IBM/fp-go/v2/optics/optional"
"github.com/IBM/fp-go/v2/optics/prism"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/predicate"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/result"
@@ -13,23 +34,506 @@ import (
type (
// Result represents a computation that may fail with an error.
//
// This is an alias for [result.Result][T], which encapsulates either a successful
// value of type T or an error. It's commonly used in test assertions to represent
// operations that might fail, allowing for functional error handling without exceptions.
//
// A Result can be in one of two states:
// - Success: Contains a value of type T
// - Failure: Contains an error
//
// This type is particularly useful in testing scenarios where you need to:
// - Test functions that return results
// - Chain operations that might fail
// - Handle errors functionally
//
// Example:
//
// func TestResultHandling(t *testing.T) {
// successResult := result.Of[int](42)
// assert.Success(successResult)(t) // Passes
//
// failureResult := result.Error[int](errors.New("failed"))
// assert.Failure(failureResult)(t) // Passes
// }
//
// See also:
// - [Success]: Asserts a Result is successful
// - [Failure]: Asserts a Result contains an error
// - [result.Result]: The underlying Result type
Result[T any] = result.Result[T]
// Reader represents a test assertion that depends on a testing.T context and returns a boolean.
// Reader represents a test assertion that depends on a [testing.T] context and returns a boolean.
//
// This is the core type for all assertions in this package. It's an alias for
// [reader.Reader][*testing.T, bool], which is a function that takes a testing context
// and produces a boolean result indicating whether the assertion passed.
//
// The Reader pattern enables:
// - Composable assertions that can be combined using functional operators
// - Deferred execution - assertions are defined but not executed until applied to a test
// - Reusable assertion logic that can be applied to multiple tests
// - Functional composition of complex test conditions
//
// All assertion functions in this package return a Reader, which must be applied
// to a *testing.T to execute the assertion:
//
// assertion := assert.Equal(42)(result) // Creates a Reader
// assertion(t) // Executes the assertion
//
// Readers can be composed using functions like [AllOf], [ApplicativeMonoid], or
// functional operators from the reader package.
//
// Example:
//
// func TestReaderComposition(t *testing.T) {
// // Create individual assertions
// assertion1 := assert.Equal(42)(42)
// assertion2 := assert.StringNotEmpty("hello")
//
// // Combine them
// combined := assert.AllOf([]assert.Reader{assertion1, assertion2})
//
// // Execute the combined assertion
// combined(t)
// }
//
// See also:
// - [Kleisli]: Function that produces a Reader from a value
// - [AllOf]: Combines multiple Readers
// - [ApplicativeMonoid]: Monoid for combining Readers
Reader = reader.Reader[*testing.T, bool]
// Kleisli represents a function that produces a test assertion Reader from a value of type T.
// Kleisli represents a function that produces a test assertion [Reader] from a value of type T.
//
// This is an alias for [reader.Reader][T, Reader], which is a function that takes a value
// of type T and returns a Reader (test assertion). This pattern is fundamental to the
// "data last" principle used throughout this package.
//
// Kleisli functions enable:
// - Partial application of assertions - configure the expected value first, apply actual value later
// - Reusable assertion builders that can be applied to different values
// - Functional composition of assertion pipelines
// - Point-free style programming with assertions
//
// Most assertion functions in this package return a Kleisli, which must be applied
// to the actual value being tested, and then to a *testing.T:
//
// kleisli := assert.Equal(42) // Kleisli[int] - expects an int
// reader := kleisli(result) // Reader - assertion ready to execute
// reader(t) // Execute the assertion
//
// Or more concisely:
//
// assert.Equal(42)(result)(t)
//
// Example:
//
// func TestKleisliPattern(t *testing.T) {
// // Create a reusable assertion for positive numbers
// isPositive := assert.That(func(n int) bool { return n > 0 })
//
// // Apply it to different values
// isPositive(42)(t) // Passes
// isPositive(100)(t) // Passes
// // isPositive(-5)(t) would fail
//
// // Can be used with Local for property testing
// type User struct { Age int }
// checkAge := assert.Local(func(u User) int { return u.Age })(isPositive)
// checkAge(User{Age: 25})(t) // Passes
// }
//
// See also:
// - [Reader]: The assertion type produced by Kleisli
// - [Local]: Focuses a Kleisli on a property of a larger structure
Kleisli[T any] = reader.Reader[T, Reader]
// Predicate represents a function that tests a value of type T and returns a boolean.
//
// This is an alias for [predicate.Predicate][T], which is a simple function that
// takes a value and returns true or false based on some condition. Predicates are
// used with the [That] function to create custom assertions.
//
// Predicates enable:
// - Custom validation logic for any type
// - Reusable test conditions
// - Composition of complex validation rules
// - Integration with functional programming patterns
//
// Example:
//
// func TestPredicates(t *testing.T) {
// // Simple predicate
// isEven := func(n int) bool { return n%2 == 0 }
// assert.That(isEven)(42)(t) // Passes
//
// // String predicate
// hasPrefix := func(s string) bool { return strings.HasPrefix(s, "test") }
// assert.That(hasPrefix)("test_file.go")(t) // Passes
//
// // Complex predicate
// isValidEmail := func(s string) bool {
// return strings.Contains(s, "@") && strings.Contains(s, ".")
// }
// assert.That(isValidEmail)("user@example.com")(t) // Passes
// }
//
// See also:
// - [That]: Creates an assertion from a Predicate
// - [predicate.Predicate]: The underlying predicate type
Predicate[T any] = predicate.Predicate[T]
// Lens is a functional reference to a subpart of a data structure.
//
// This is an alias for [lens.Lens][S, T], which provides a composable way to focus
// on a specific field within a larger structure. Lenses enable getting and setting
// values in nested data structures in a functional, immutable way.
//
// In the context of testing, lenses are used with [LocalL] to focus assertions
// on specific properties of complex objects without manually extracting those properties.
//
// A Lens[S, T] focuses on a value of type T within a structure of type S.
//
// Example:
//
// func TestLensUsage(t *testing.T) {
// type Address struct { City string }
// type User struct { Name string; Address Address }
//
// // Define lenses (typically generated)
// addressLens := lens.Lens[User, Address]{...}
// cityLens := lens.Lens[Address, string]{...}
//
// // Compose lenses to focus on nested field
// userCityLens := lens.Compose(addressLens, cityLens)
//
// // Use with LocalL to assert on nested property
// user := User{Name: "Alice", Address: Address{City: "NYC"}}
// assert.LocalL(userCityLens)(assert.Equal("NYC"))(user)(t)
// }
//
// See also:
// - [LocalL]: Uses a Lens to focus assertions on a property
// - [lens.Lens]: The underlying lens type
// - [Optional]: Similar but for values that may not exist
Lens[S, T any] = lens.Lens[S, T]
// Optional is an optic that focuses on a value that may or may not be present.
//
// This is an alias for [optional.Optional][S, T], which is similar to a [Lens] but
// handles cases where the focused value might not exist. Optionals are useful for
// working with nullable fields, optional properties, or values that might be absent.
//
// In testing, Optionals are used with [FromOptional] to create assertions that
// verify whether an optional value is present and, if so, whether it satisfies
// certain conditions.
//
// An Optional[S, T] focuses on an optional value of type T within a structure of type S.
//
// Example:
//
// func TestOptionalUsage(t *testing.T) {
// type Config struct { Timeout *int }
//
// // Define optional (typically generated)
// timeoutOptional := optional.Optional[Config, int]{...}
//
// // Test when value is present
// config1 := Config{Timeout: ptr(30)}
// assert.FromOptional(timeoutOptional)(
// assert.Equal(30),
// )(config1)(t) // Passes
//
// // Test when value is absent
// config2 := Config{Timeout: nil}
// // FromOptional would fail because value is not present
// }
//
// See also:
// - [FromOptional]: Creates assertions for optional values
// - [optional.Optional]: The underlying optional type
// - [Lens]: Similar but for values that always exist
Optional[S, T any] = optional.Optional[S, T]
// Prism is an optic that focuses on a case of a sum type.
//
// This is an alias for [prism.Prism][S, T], which provides a way to focus on one
// variant of a sum type (like Result, Option, Either, etc.). Prisms enable pattern
// matching and extraction of values from sum types in a functional way.
//
// In testing, Prisms are used with [FromPrism] to create assertions that verify
// whether a value matches a specific case and, if so, whether the contained value
// satisfies certain conditions.
//
// A Prism[S, T] focuses on a value of type T that may be contained within a sum type S.
//
// Example:
//
// func TestPrismUsage(t *testing.T) {
// // Prism for extracting success value from Result
// successPrism := prism.Success[int]()
//
// // Test successful result
// successResult := result.Of[int](42)
// assert.FromPrism(successPrism)(
// assert.Equal(42),
// )(successResult)(t) // Passes
//
// // Prism for extracting error from Result
// failurePrism := prism.Failure[int]()
//
// // Test failed result
// failureResult := result.Error[int](errors.New("failed"))
// assert.FromPrism(failurePrism)(
// assert.Error,
// )(failureResult)(t) // Passes
// }
//
// See also:
// - [FromPrism]: Creates assertions for prism-focused values
// - [prism.Prism]: The underlying prism type
// - [Optional]: Similar but for optional values
Prism[S, T any] = prism.Prism[S, T]
// ReaderIOResult represents a context-aware, IO-based computation that may fail.
//
// This is an alias for [readerioresult.ReaderIOResult][A], which combines three
// computational effects:
// - Reader: Depends on a context (like context.Context)
// - IO: Performs side effects (like file I/O, network calls)
// - Result: May fail with an error
//
// In testing, ReaderIOResult is used with [FromReaderIOResult] to convert
// context-aware, effectful computations into test assertions. This is useful
// when your test assertions need to:
// - Access a context for cancellation or deadlines
// - Perform IO operations (database queries, API calls, file access)
// - Handle potential errors gracefully
//
// Example:
//
// func TestReaderIOResult(t *testing.T) {
// // Create a ReaderIOResult that performs IO and may fail
// checkDatabase := func(ctx context.Context) func() result.Result[assert.Reader] {
// return func() result.Result[assert.Reader] {
// // Perform database check with context
// if err := db.PingContext(ctx); err != nil {
// return result.Error[assert.Reader](err)
// }
// return result.Of[assert.Reader](assert.NoError(nil))
// }
// }
//
// // Convert to Reader and execute
// assertion := assert.FromReaderIOResult(checkDatabase)
// assertion(t)
// }
//
// See also:
// - [FromReaderIOResult]: Converts ReaderIOResult to Reader
// - [ReaderIO]: Similar but without error handling
// - [readerioresult.ReaderIOResult]: The underlying type
ReaderIOResult[A any] = readerioresult.ReaderIOResult[A]
// ReaderIO represents a context-aware, IO-based computation.
//
// This is an alias for [readerio.ReaderIO][A], which combines two computational effects:
// - Reader: Depends on a context (like context.Context)
// - IO: Performs side effects (like logging, metrics)
//
// In testing, ReaderIO is used with [FromReaderIO] to convert context-aware,
// effectful computations into test assertions. This is useful when your test
// assertions need to:
// - Access a context for cancellation or deadlines
// - Perform IO operations that don't fail (or handle failures internally)
// - Integrate with context-aware utilities
//
// Example:
//
// func TestReaderIO(t *testing.T) {
// // Create a ReaderIO that performs IO
// logAndCheck := func(ctx context.Context) func() assert.Reader {
// return func() assert.Reader {
// // Log with context
// logger.InfoContext(ctx, "Running test")
// // Return assertion
// return assert.Equal(42)(computeValue())
// }
// }
//
// // Convert to Reader and execute
// assertion := assert.FromReaderIO(logAndCheck)
// assertion(t)
// }
//
// See also:
// - [FromReaderIO]: Converts ReaderIO to Reader
// - [ReaderIOResult]: Similar but with error handling
// - [readerio.ReaderIO]: The underlying type
ReaderIO[A any] = readerio.ReaderIO[A]
// Seq2 represents a Go iterator that yields key-value pairs.
//
// This is an alias for [iter.Seq2][K, A], which is Go's standard iterator type
// introduced in Go 1.23. It represents a sequence of key-value pairs that can be
// iterated over using a for-range loop.
//
// In testing, Seq2 is used with [SequenceSeq2] to execute a sequence of named
// test cases provided as an iterator. This enables:
// - Lazy evaluation of test cases
// - Memory-efficient testing of large test suites
// - Integration with Go's iterator patterns
// - Dynamic generation of test cases
//
// Example:
//
// func TestSeq2Usage(t *testing.T) {
// // Create an iterator of test cases
// testCases := func(yield func(string, assert.Reader) bool) {
// if !yield("test_addition", assert.Equal(4)(2+2)) {
// return
// }
// if !yield("test_multiplication", assert.Equal(6)(2*3)) {
// return
// }
// }
//
// // Execute all test cases
// assert.SequenceSeq2[assert.Reader](testCases)(t)
// }
//
// See also:
// - [SequenceSeq2]: Executes a Seq2 of test cases
// - [TraverseArray]: Similar but for arrays
// - [iter.Seq2]: The underlying iterator type
Seq2[K, A any] = iter.Seq2[K, A]
// Pair represents a tuple of two values with potentially different types.
//
// This is an alias for [pair.Pair][L, R], which holds two values: a "head" (or "left")
// of type L and a "tail" (or "right") of type R. Pairs are useful for grouping
// related values together without defining a custom struct.
//
// In testing, Pairs are used with [TraverseArray] to associate test names with
// their corresponding assertions. Each element in the array is transformed into
// a Pair[string, Reader] where the string is the test name and the Reader is
// the assertion to execute.
//
// Example:
//
// func TestPairUsage(t *testing.T) {
// type TestCase struct {
// Input int
// Expected int
// }
//
// testCases := []TestCase{
// {Input: 2, Expected: 4},
// {Input: 3, Expected: 9},
// }
//
// // Transform each test case into a named assertion
// traverse := assert.TraverseArray(func(tc TestCase) assert.Pair[string, assert.Reader] {
// name := fmt.Sprintf("square(%d)=%d", tc.Input, tc.Expected)
// assertion := assert.Equal(tc.Expected)(tc.Input * tc.Input)
// return pair.MakePair(name, assertion)
// })
//
// traverse(testCases)(t)
// }
//
// See also:
// - [TraverseArray]: Uses Pairs to create named test cases
// - [pair.Pair]: The underlying pair type
// - [pair.MakePair]: Creates a Pair
// - [pair.Head]: Extracts the first value
// - [pair.Tail]: Extracts the second value
Pair[L, R any] = pair.Pair[L, R]
// Void represents the absence of a meaningful value, similar to unit type in functional programming.
//
// This is an alias for [function.Void], which is used to represent operations that don't
// return a meaningful value but may perform side effects. In the context of testing, Void
// is used with IO operations that perform actions without producing a result.
//
// Void is conceptually similar to:
// - Unit type in functional languages (Haskell's (), Scala's Unit)
// - void in languages like C/Java (but as a value, not just a type)
// - Empty struct{} in Go (but with clearer semantic meaning)
//
// Example:
//
// func TestWithSideEffect(t *testing.T) {
// // An IO operation that logs but returns Void
// logOperation := func() function.Void {
// log.Println("Test executed")
// return function.Void{}
// }
//
// // Execute the operation
// logOperation()
// }
//
// See also:
// - [IO]: Wraps side-effecting operations
// - [function.Void]: The underlying void type
Void = function.Void
// IO represents a side-effecting computation that produces a value of type A.
//
// This is an alias for [io.IO][A], which encapsulates operations that perform side effects
// (like I/O operations, logging, or state mutations) and return a value. IO is a lazy
// computation - it describes an effect but doesn't execute it until explicitly run.
//
// In testing, IO is used to:
// - Defer execution of side effects until needed
// - Compose multiple side-effecting operations
// - Maintain referential transparency in test setup
// - Separate effect description from effect execution
//
// An IO[A] is essentially a function `func() A` that:
// - Encapsulates a side effect
// - Returns a value of type A when executed
// - Can be composed with other IO operations
//
// Example:
//
// func TestIOOperation(t *testing.T) {
// // Define an IO operation that reads a file
// readConfig := func() io.IO[string] {
// return func() string {
// data, _ := os.ReadFile("config.txt")
// return string(data)
// }
// }
//
// // The IO is not executed yet - it's just a description
// configIO := readConfig()
//
// // Execute the IO to get the result
// config := configIO()
// assert.StringNotEmpty(config)(t)
// }
//
// Example with composition:
//
// func TestIOComposition(t *testing.T) {
// // Chain multiple IO operations
// pipeline := io.Map(
// func(s string) int { return len(s) },
// )(readFileIO)
//
// // Execute the composed operation
// length := pipeline()
// assert.That(func(n int) bool { return n > 0 })(length)(t)
// }
//
// See also:
// - [ReaderIO]: Combines Reader and IO effects
// - [ReaderIOResult]: Adds error handling to ReaderIO
// - [io.IO]: The underlying IO type
// - [Void]: Represents operations without meaningful return values
IO[A any] = io.IO[A]
)

View File

@@ -452,7 +452,7 @@ func TapEitherK[A, B any](f either.Kleisli[error, A, B]) Operator[A, A] {
// Returns a function that chains Option-returning functions into ReaderIOResult.
//
//go:inline
func ChainOptionK[A, B any](onNone func() error) func(option.Kleisli[A, B]) Operator[A, B] {
func ChainOptionK[A, B any](onNone Lazy[error]) func(option.Kleisli[A, B]) Operator[A, B] {
return RIOR.ChainOptionK[context.Context, A, B](onNone)
}
@@ -800,7 +800,7 @@ func FromReaderResult[A any](ma ReaderResult[A]) ReaderIOResult[A] {
}
//go:inline
func FromReaderOption[A any](onNone func() error) Kleisli[ReaderOption[context.Context, A], A] {
func FromReaderOption[A any](onNone Lazy[error]) Kleisli[ReaderOption[context.Context, A], A] {
return RIOR.FromReaderOption[context.Context, A](onNone)
}
@@ -895,17 +895,17 @@ func TapReaderIOK[A, B any](f readerio.Kleisli[A, B]) Operator[A, A] {
}
//go:inline
func ChainReaderOptionK[A, B any](onNone func() error) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, B] {
func ChainReaderOptionK[A, B any](onNone Lazy[error]) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, B] {
return RIOR.ChainReaderOptionK[context.Context, A, B](onNone)
}
//go:inline
func ChainFirstReaderOptionK[A, B any](onNone func() error) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, A] {
func ChainFirstReaderOptionK[A, B any](onNone Lazy[error]) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, A] {
return RIOR.ChainFirstReaderOptionK[context.Context, A, B](onNone)
}
//go:inline
func TapReaderOptionK[A, B any](onNone func() error) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, A] {
func TapReaderOptionK[A, B any](onNone Lazy[error]) func(readeroption.Kleisli[context.Context, A, B]) Operator[A, A] {
return RIOR.TapReaderOptionK[context.Context, A, B](onNone)
}

View File

@@ -87,8 +87,8 @@ var (
// assembleProviders constructs the provider map for item and non-item providers
assembleProviders = F.Flow3(
A.Partition(isItemProvider),
T.Map2(collectProviders, collectItemProviders),
T.Tupled2(mergeProviders.Concat),
pair.BiMap(collectProviders, collectItemProviders),
pair.Paired(mergeProviders.Concat),
)
)

351
v2/either/filterable.go Normal file
View File

@@ -0,0 +1,351 @@
// Copyright (c) 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package either provides implementations of the Either type and related operations.
//
// This package implements several Fantasy Land algebraic structures:
// - Filterable: https://github.com/fantasyland/fantasy-land#filterable
//
// The Filterable specification defines operations for filtering and partitioning
// data structures based on predicates and mapping functions.
package either
import (
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
)
// Partition separates an [Either] value into a [Pair] based on a predicate function.
// It returns a function that takes an Either and produces a Pair of Either values,
// where the first element contains values that fail the predicate and the second
// contains values that pass the predicate.
//
// This function implements the Filterable specification's partition operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is Left, both elements of the resulting Pair will be the same Left value
// - If the input is Right and the predicate returns true, the result is (Left(empty), Right(value))
// - If the input is Right and the predicate returns false, the result is (Right(value), Left(empty))
//
// This function is useful for separating Either values into two categories based on
// a condition, commonly used in filtering operations where you want to keep track of
// both the values that pass and fail a test.
//
// Parameters:
// - p: A predicate function that tests values of type A
// - empty: The default Left value to use when creating Left instances for partitioning
//
// Returns:
//
// A function that takes an Either[E, A] and returns a Pair where:
// - First element: Either values that fail the predicate (or original Left)
// - Second element: Either values that pass the predicate (or original Left)
//
// Example:
//
// import (
// E "github.com/IBM/fp-go/v2/either"
// N "github.com/IBM/fp-go/v2/number"
// P "github.com/IBM/fp-go/v2/pair"
// )
//
// // Partition positive and non-positive numbers
// isPositive := N.MoreThan(0)
// partition := E.Partition(isPositive, "not positive")
//
// // Right value that passes predicate
// result1 := partition(E.Right[string](5))
// // result1 = Pair(Left("not positive"), Right(5))
// left1, right1 := P.Unpack(result1)
// // left1 = Left("not positive"), right1 = Right(5)
//
// // Right value that fails predicate
// result2 := partition(E.Right[string](-3))
// // result2 = Pair(Right(-3), Left("not positive"))
// left2, right2 := P.Unpack(result2)
// // left2 = Right(-3), right2 = Left("not positive")
//
// // Left value passes through unchanged in both positions
// result3 := partition(E.Left[int]("error"))
// // result3 = Pair(Left("error"), Left("error"))
// left3, right3 := P.Unpack(result3)
// // left3 = Left("error"), right3 = Left("error")
func Partition[E, A any](p Predicate[A], empty E) func(Either[E, A]) Pair[Either[E, A], Either[E, A]] {
l := Left[A](empty)
return func(e Either[E, A]) Pair[Either[E, A], Either[E, A]] {
if e.isLeft {
return pair.Of(e)
}
if p(e.r) {
return pair.MakePair(l, e)
}
return pair.MakePair(e, l)
}
}
// Filter creates a filtering operation for [Either] values based on a predicate function.
// It returns a function that takes an Either and produces an Either, where Right values
// that fail the predicate are converted to Left values with the provided empty value.
//
// This function implements the Filterable specification's filter operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is Left, it passes through unchanged
// - If the input is Right and the predicate returns true, the Right value passes through unchanged
// - If the input is Right and the predicate returns false, it's converted to Left(empty)
//
// This function is useful for conditional validation or filtering of Either values,
// where you want to reject Right values that don't meet certain criteria by converting
// them to Left values with a default error.
//
// Parameters:
// - p: A predicate function that tests values of type A
// - empty: The default Left value to use when filtering out Right values that fail the predicate
//
// Returns:
//
// An Operator function that takes an Either[E, A] and returns an Either[E, A] where:
// - Left values pass through unchanged
// - Right values that pass the predicate remain as Right
// - Right values that fail the predicate become Left(empty)
//
// Example:
//
// import (
// E "github.com/IBM/fp-go/v2/either"
// N "github.com/IBM/fp-go/v2/number"
// )
//
// // Filter to keep only positive numbers
// isPositive := N.MoreThan(0)
// filterPositive := E.Filter(isPositive, "not positive")
//
// // Right value that passes predicate - remains Right
// result1 := filterPositive(E.Right[string](5))
// // result1 = Right(5)
//
// // Right value that fails predicate - becomes Left
// result2 := filterPositive(E.Right[string](-3))
// // result2 = Left("not positive")
//
// // Left value passes through unchanged
// result3 := filterPositive(E.Left[int]("original error"))
// // result3 = Left("original error")
//
// // Chaining filters
// isEven := func(n int) bool { return n%2 == 0 }
// filterEven := E.Filter(isEven, "not even")
//
// // Apply multiple filters in sequence
// result4 := filterEven(filterPositive(E.Right[string](4)))
// // result4 = Right(4) - passes both filters
//
// result5 := filterEven(filterPositive(E.Right[string](3)))
// // result5 = Left("not even") - passes first, fails second
func Filter[E, A any](p Predicate[A], empty E) Operator[E, A, A] {
l := Left[A](empty)
return func(e Either[E, A]) Either[E, A] {
if e.isLeft || p(e.r) {
return e
}
return l
}
}
// FilterMap combines filtering and mapping operations for [Either] values using an [Option]-returning function.
// It returns a function that takes an Either[E, A] and produces an Either[E, B], where Right values
// are transformed by applying the function f. If f returns Some(B), the result is Right(B). If f returns
// None, the result is Left(empty).
//
// This function implements the Filterable specification's filterMap operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is Left, it passes through with its error value preserved as Left[B]
// - If the input is Right and f returns Some(B), the result is Right(B)
// - If the input is Right and f returns None, the result is Left(empty)
//
// This function is useful for operations that combine validation/filtering with transformation,
// such as parsing strings to numbers (where invalid strings result in None), or extracting
// optional fields from structures.
//
// Parameters:
// - f: An Option Kleisli function that transforms values of type A to Option[B]
// - empty: The default Left value to use when f returns None
//
// Returns:
//
// An Operator function that takes an Either[E, A] and returns an Either[E, B] where:
// - Left values pass through with error preserved
// - Right values are transformed by f: Some(B) becomes Right(B), None becomes Left(empty)
//
// Example:
//
// import (
// E "github.com/IBM/fp-go/v2/either"
// O "github.com/IBM/fp-go/v2/option"
// "strconv"
// )
//
// // Parse string to int, filtering out invalid values
// parseInt := func(s string) O.Option[int] {
// if n, err := strconv.Atoi(s); err == nil {
// return O.Some(n)
// }
// return O.None[int]()
// }
// filterMapInt := E.FilterMap(parseInt, "invalid number")
//
// // Valid number string - transforms to Right(int)
// result1 := filterMapInt(E.Right[string]("42"))
// // result1 = Right(42)
//
// // Invalid number string - becomes Left
// result2 := filterMapInt(E.Right[string]("abc"))
// // result2 = Left("invalid number")
//
// // Left value passes through with error preserved
// result3 := filterMapInt(E.Left[string]("original error"))
// // result3 = Left("original error")
//
// // Extract optional field from struct
// type Person struct {
// Name string
// Email O.Option[string]
// }
// extractEmail := func(p Person) O.Option[string] { return p.Email }
// filterMapEmail := E.FilterMap(extractEmail, "no email")
//
// result4 := filterMapEmail(E.Right[string](Person{Name: "Alice", Email: O.Some("alice@example.com")}))
// // result4 = Right("alice@example.com")
//
// result5 := filterMapEmail(E.Right[string](Person{Name: "Bob", Email: O.None[string]()}))
// // result5 = Left("no email")
func FilterMap[E, A, B any](f option.Kleisli[A, B], empty E) Operator[E, A, B] {
l := Left[B](empty)
return func(e Either[E, A]) Either[E, B] {
if e.isLeft {
return Left[B](e.l)
}
if b, ok := option.Unwrap(f(e.r)); ok {
return Right[E](b)
}
return l
}
}
// PartitionMap separates and transforms an [Either] value into a [Pair] of Either values using a mapping function.
// It returns a function that takes an Either[E, A] and produces a Pair of Either values, where the mapping
// function f transforms the Right value into Either[B, C]. The result is partitioned based on whether f
// produces a Left or Right value.
//
// This function implements the Filterable specification's partitionMap operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is Left, both elements of the resulting Pair will be Left with the original error
// - If the input is Right and f returns Left(B), the result is (Right(B), Left(empty))
// - If the input is Right and f returns Right(C), the result is (Left(empty), Right(C))
//
// This function is useful for operations that need to categorize and transform values simultaneously,
// such as separating valid and invalid data while applying different transformations to each category.
//
// Parameters:
// - f: A Kleisli function that transforms values of type A to Either[B, C]
// - empty: The default error value to use when creating Left instances for partitioning
//
// Returns:
//
// A function that takes an Either[E, A] and returns a Pair[Either[E, B], Either[E, C]] where:
// - If input is Left: (Left(original_error), Left(original_error))
// - If f returns Left(B): (Right(B), Left(empty))
// - If f returns Right(C): (Left(empty), Right(C))
//
// Example:
//
// import (
// E "github.com/IBM/fp-go/v2/either"
// P "github.com/IBM/fp-go/v2/pair"
// )
//
// // Classify and transform numbers: negative -> error message, positive -> squared value
// classifyNumber := func(n int) E.Either[string, int] {
// if n < 0 {
// return E.Left[int]("negative: " + strconv.Itoa(n))
// }
// return E.Right[string](n * n)
// }
// partitionMap := E.PartitionMap(classifyNumber, "not classified")
//
// // Positive number - goes to right side as squared value
// result1 := partitionMap(E.Right[string](5))
// // result1 = Pair(Left("not classified"), Right(25))
// left1, right1 := P.Unpack(result1)
// // left1 = Left("not classified"), right1 = Right(25)
//
// // Negative number - goes to left side with error message
// result2 := partitionMap(E.Right[string](-3))
// // result2 = Pair(Right("negative: -3"), Left("not classified"))
// left2, right2 := P.Unpack(result2)
// // left2 = Right("negative: -3"), right2 = Left("not classified")
//
// // Original Left value - appears in both positions
// result3 := partitionMap(E.Left[int]("original error"))
// // result3 = Pair(Left("original error"), Left("original error"))
// left3, right3 := P.Unpack(result3)
// // left3 = Left("original error"), right3 = Left("original error")
//
// // Validate and transform user input
// type ValidationError struct{ Field, Message string }
// type User struct{ Name string; Age int }
//
// validateUser := func(input map[string]string) E.Either[ValidationError, User] {
// name, hasName := input["name"]
// ageStr, hasAge := input["age"]
// if !hasName {
// return E.Left[User](ValidationError{"name", "missing"})
// }
// if !hasAge {
// return E.Left[User](ValidationError{"age", "missing"})
// }
// age, err := strconv.Atoi(ageStr)
// if err != nil {
// return E.Left[User](ValidationError{"age", "invalid"})
// }
// return E.Right[ValidationError](User{name, age})
// }
// partitionUsers := E.PartitionMap(validateUser, ValidationError{"", "not processed"})
//
// validInput := map[string]string{"name": "Alice", "age": "30"}
// result4 := partitionUsers(E.Right[string](validInput))
// // result4 = Pair(Left(ValidationError{"", "not processed"}), Right(User{"Alice", 30}))
//
// invalidInput := map[string]string{"name": "Bob"}
// result5 := partitionUsers(E.Right[string](invalidInput))
// // result5 = Pair(Right(ValidationError{"age", "missing"}), Left(ValidationError{"", "not processed"}))
func PartitionMap[E, A, B, C any](f Kleisli[B, A, C], empty E) func(Either[E, A]) Pair[Either[E, B], Either[E, C]] {
return func(e Either[E, A]) Pair[Either[E, B], Either[E, C]] {
if e.isLeft {
return pair.MakePair(Left[B](e.l), Left[C](e.l))
}
res := f(e.r)
if res.isLeft {
return pair.MakePair(Right[E](res.l), Left[C](empty))
}
return pair.MakePair(Left[B](empty), Right[E](res.r))
}
}

1433
v2/either/filterable_test.go Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -21,6 +21,7 @@ import (
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/lens"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/predicate"
"github.com/IBM/fp-go/v2/reader"
)
@@ -53,4 +54,6 @@ type (
// Predicate represents a function that tests a value of type A and returns a boolean.
// It's commonly used for filtering and conditional operations.
Predicate[A any] = predicate.Predicate[A]
Pair[L, R any] = pair.Pair[L, R]
)

View File

@@ -466,6 +466,11 @@ func Chain[A, B any](f func(A) Seq[B]) Operator[A, B] {
return F.Bind2nd(MonadChain[A, B], f)
}
//go:inline
func FlatMap[A, B any](f func(A) Seq[B]) Operator[A, B] {
return Chain(f)
}
// Flatten flattens a sequence of sequences into a single sequence.
//
// RxJS Equivalent: [mergeAll] - https://rxjs.dev/api/operators/mergeAll

158
v2/iterator/iter/option.go Normal file
View File

@@ -0,0 +1,158 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package iter
import (
"github.com/IBM/fp-go/v2/option"
)
// MonadChainOptionK chains a function that returns an Option into a sequence,
// filtering out None values and unwrapping Some values.
//
// This is useful for operations that may or may not produce a value for each element
// in the sequence. Only the successful (Some) results are included in the output sequence,
// while None values are filtered out.
//
// This is the monadic form that takes the sequence as the first parameter.
//
// RxJS Equivalent: [concatMap] combined with [filter] - https://rxjs.dev/api/operators/concatMap
//
// Type parameters:
// - A: The element type of the input sequence
// - B: The element type of the output sequence (wrapped in Option by the function)
//
// Parameters:
// - as: The input sequence to transform
// - f: A function that takes an element and returns an Option[B]
//
// Returns:
//
// A new sequence containing only the unwrapped Some values
//
// Example:
//
// import (
// "strconv"
// F "github.com/IBM/fp-go/v2/function"
// O "github.com/IBM/fp-go/v2/option"
// I "github.com/IBM/fp-go/v2/iterator/iter"
// )
//
// // Parse strings to integers, filtering out invalid ones
// parseNum := func(s string) O.Option[int] {
// if n, err := strconv.Atoi(s); err == nil {
// return O.Some(n)
// }
// return O.None[int]()
// }
//
// seq := I.From("1", "invalid", "2", "3", "bad")
// result := I.MonadChainOptionK(seq, parseNum)
// // yields: 1, 2, 3 (invalid strings are filtered out)
func MonadChainOptionK[A, B any](as Seq[A], f option.Kleisli[A, B]) Seq[B] {
return MonadFilterMap(as, f)
}
// ChainOptionK returns an operator that chains a function returning an Option into a sequence,
// filtering out None values and unwrapping Some values.
//
// This is the curried version of [MonadChainOptionK], useful for function composition
// and creating reusable transformations.
//
// RxJS Equivalent: [concatMap] combined with [filter] - https://rxjs.dev/api/operators/concatMap
//
// Type parameters:
// - A: The element type of the input sequence
// - B: The element type of the output sequence (wrapped in Option by the function)
//
// Parameters:
// - f: A function that takes an element and returns an Option[B]
//
// Returns:
//
// An Operator that transforms Seq[A] to Seq[B], filtering out None values
//
// Example:
//
// import (
// "strconv"
// F "github.com/IBM/fp-go/v2/function"
// O "github.com/IBM/fp-go/v2/option"
// I "github.com/IBM/fp-go/v2/iterator/iter"
// )
//
// // Create a reusable parser operator
// parsePositive := I.ChainOptionK(func(x int) O.Option[int] {
// if x > 0 {
// return O.Some(x)
// }
// return O.None[int]()
// })
//
// result := F.Pipe1(
// I.From(-1, 2, -3, 4, 5),
// parsePositive,
// )
// // yields: 2, 4, 5 (negative numbers are filtered out)
//
//go:inline
func ChainOptionK[A, B any](f option.Kleisli[A, B]) Operator[A, B] {
return FilterMap(f)
}
// FlatMapOptionK is an alias for [ChainOptionK].
//
// This provides a more familiar name for developers coming from other functional
// programming languages or libraries where "flatMap" is the standard terminology
// for the monadic bind operation.
//
// Type parameters:
// - A: The element type of the input sequence
// - B: The element type of the output sequence (wrapped in Option by the function)
//
// Parameters:
// - f: A function that takes an element and returns an Option[B]
//
// Returns:
//
// An Operator that transforms Seq[A] to Seq[B], filtering out None values
//
// Example:
//
// import (
// F "github.com/IBM/fp-go/v2/function"
// O "github.com/IBM/fp-go/v2/option"
// I "github.com/IBM/fp-go/v2/iterator/iter"
// )
//
// // Validate and transform data
// validateAge := I.FlatMapOptionK(func(age int) O.Option[string] {
// if age >= 18 && age <= 120 {
// return O.Some(fmt.Sprintf("Valid age: %d", age))
// }
// return O.None[string]()
// })
//
// result := F.Pipe1(
// I.From(15, 25, 150, 30),
// validateAge,
// )
// // yields: "Valid age: 25", "Valid age: 30"
//
//go:inline
func FlatMapOptionK[A, B any](f option.Kleisli[A, B]) Operator[A, B] {
return ChainOptionK(f)
}

View File

@@ -0,0 +1,387 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package iter
import (
"fmt"
"slices"
"strconv"
"testing"
A "github.com/IBM/fp-go/v2/array"
F "github.com/IBM/fp-go/v2/function"
O "github.com/IBM/fp-go/v2/option"
"github.com/stretchr/testify/assert"
)
// TestMonadChainOptionK_AllSome tests MonadChainOptionK when all values produce Some
func TestMonadChainOptionK_AllSome(t *testing.T) {
// Function that always returns Some
double := func(x int) O.Option[int] {
return O.Some(x * 2)
}
seq := From(1, 2, 3, 4, 5)
result := MonadChainOptionK(seq, double)
values := slices.Collect(result)
expected := A.From(2, 4, 6, 8, 10)
assert.Equal(t, expected, values)
}
// TestMonadChainOptionK_AllNone tests MonadChainOptionK when all values produce None
func TestMonadChainOptionK_AllNone(t *testing.T) {
// Function that always returns None
alwaysNone := func(x int) O.Option[int] {
return O.None[int]()
}
seq := From(1, 2, 3, 4, 5)
result := MonadChainOptionK(seq, alwaysNone)
values := slices.Collect(result)
assert.Empty(t, values)
}
// TestMonadChainOptionK_MixedSomeNone tests MonadChainOptionK with mixed Some and None
func TestMonadChainOptionK_MixedSomeNone(t *testing.T) {
// Function that returns Some for even numbers, None for odd
evenOnly := func(x int) O.Option[int] {
if x%2 == 0 {
return O.Some(x)
}
return O.None[int]()
}
seq := From(1, 2, 3, 4, 5, 6)
result := MonadChainOptionK(seq, evenOnly)
values := slices.Collect(result)
expected := A.From(2, 4, 6)
assert.Equal(t, expected, values)
}
// TestMonadChainOptionK_ParseStrings tests parsing strings to integers
func TestMonadChainOptionK_ParseStrings(t *testing.T) {
// Parse strings to integers, returning None for invalid strings
parseNum := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
seq := From("1", "invalid", "2", "3", "bad", "4")
result := MonadChainOptionK(seq, parseNum)
values := slices.Collect(result)
expected := A.From(1, 2, 3, 4)
assert.Equal(t, expected, values)
}
// TestMonadChainOptionK_EmptySequence tests MonadChainOptionK with empty sequence
func TestMonadChainOptionK_EmptySequence(t *testing.T) {
double := func(x int) O.Option[int] {
return O.Some(x * 2)
}
seq := From[int]()
result := MonadChainOptionK(seq, double)
values := slices.Collect(result)
assert.Empty(t, values)
}
// TestMonadChainOptionK_TypeTransformation tests transforming types
func TestMonadChainOptionK_TypeTransformation(t *testing.T) {
// Convert integers to strings, only for positive numbers
positiveToString := func(x int) O.Option[string] {
if x > 0 {
return O.Some(fmt.Sprintf("num_%d", x))
}
return O.None[string]()
}
seq := From(-2, -1, 0, 1, 2, 3)
result := MonadChainOptionK(seq, positiveToString)
values := slices.Collect(result)
expected := A.From("num_1", "num_2", "num_3")
assert.Equal(t, expected, values)
}
// TestMonadChainOptionK_ComplexType tests with complex types
func TestMonadChainOptionK_ComplexType(t *testing.T) {
type Person struct {
Name string
Age int
}
// Extract age only for adults
getAdultAge := func(p Person) O.Option[int] {
if p.Age >= 18 {
return O.Some(p.Age)
}
return O.None[int]()
}
seq := From(
Person{"Alice", 25},
Person{"Bob", 15},
Person{"Charlie", 30},
Person{"David", 12},
)
result := MonadChainOptionK(seq, getAdultAge)
values := slices.Collect(result)
expected := A.From(25, 30)
assert.Equal(t, expected, values)
}
// TestChainOptionK_BasicUsage tests ChainOptionK basic functionality
func TestChainOptionK_BasicUsage(t *testing.T) {
// Create a reusable operator
parsePositive := ChainOptionK(func(x int) O.Option[int] {
if x > 0 {
return O.Some(x)
}
return O.None[int]()
})
seq := From(-1, 2, -3, 4, 5, -6)
result := parsePositive(seq)
values := slices.Collect(result)
expected := A.From(2, 4, 5)
assert.Equal(t, expected, values)
}
// TestChainOptionK_WithPipe tests ChainOptionK in a pipeline
func TestChainOptionK_WithPipe(t *testing.T) {
// Validate and transform in a pipeline
validateRange := ChainOptionK(func(x int) O.Option[int] {
if x >= 0 && x <= 100 {
return O.Some(x)
}
return O.None[int]()
})
result := F.Pipe2(
From(-10, 20, 150, 50, 200, 75),
validateRange,
Map(func(x int) int { return x * 2 }),
)
values := slices.Collect(result)
expected := A.From(40, 100, 150)
assert.Equal(t, expected, values)
}
// TestChainOptionK_Composition tests composing multiple ChainOptionK operations
func TestChainOptionK_Composition(t *testing.T) {
// First filter: only positive
onlyPositive := ChainOptionK(func(x int) O.Option[int] {
if x > 0 {
return O.Some(x)
}
return O.None[int]()
})
// Second filter: only even
onlyEven := ChainOptionK(func(x int) O.Option[int] {
if x%2 == 0 {
return O.Some(x)
}
return O.None[int]()
})
result := F.Pipe2(
From(-2, -1, 0, 1, 2, 3, 4, 5, 6),
onlyPositive,
onlyEven,
)
values := slices.Collect(result)
expected := A.From(2, 4, 6)
assert.Equal(t, expected, values)
}
// TestChainOptionK_StringParsing tests parsing with ChainOptionK
func TestChainOptionK_StringParsing(t *testing.T) {
// Create a reusable string parser
parseInt := ChainOptionK(func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
})
result := F.Pipe1(
From("10", "abc", "20", "xyz", "30"),
parseInt,
)
values := slices.Collect(result)
expected := A.From(10, 20, 30)
assert.Equal(t, expected, values)
}
// TestFlatMapOptionK_Equivalence tests that FlatMapOptionK is equivalent to ChainOptionK
func TestFlatMapOptionK_Equivalence(t *testing.T) {
validate := func(x int) O.Option[int] {
if x >= 0 && x <= 10 {
return O.Some(x)
}
return O.None[int]()
}
seq := From(-5, 0, 5, 10, 15)
// Using ChainOptionK
result1 := ChainOptionK(validate)(seq)
values1 := slices.Collect(result1)
// Using FlatMapOptionK
result2 := FlatMapOptionK(validate)(seq)
values2 := slices.Collect(result2)
// Both should produce the same result
assert.Equal(t, values1, values2)
assert.Equal(t, A.From(0, 5, 10), values1)
}
// TestFlatMapOptionK_WithMap tests FlatMapOptionK combined with Map
func TestFlatMapOptionK_WithMap(t *testing.T) {
// Validate age and convert to category
validateAge := FlatMapOptionK(func(age int) O.Option[string] {
if age >= 18 && age <= 120 {
return O.Some(fmt.Sprintf("Valid age: %d", age))
}
return O.None[string]()
})
result := F.Pipe1(
From(15, 25, 150, 30, 200),
validateAge,
)
values := slices.Collect(result)
expected := A.From("Valid age: 25", "Valid age: 30")
assert.Equal(t, expected, values)
}
// TestChainOptionK_LookupOperation tests using ChainOptionK for lookup operations
func TestChainOptionK_LookupOperation(t *testing.T) {
// Simulate a lookup table
lookup := map[string]int{
"one": 1,
"two": 2,
"three": 3,
}
lookupValue := ChainOptionK(func(key string) O.Option[int] {
if val, ok := lookup[key]; ok {
return O.Some(val)
}
return O.None[int]()
})
result := F.Pipe1(
From("one", "invalid", "two", "missing", "three"),
lookupValue,
)
values := slices.Collect(result)
expected := A.From(1, 2, 3)
assert.Equal(t, expected, values)
}
// TestMonadChainOptionK_EarlyTermination tests that iteration stops when yield returns false
func TestMonadChainOptionK_EarlyTermination(t *testing.T) {
callCount := 0
countCalls := func(x int) O.Option[int] {
callCount++
return O.Some(x)
}
seq := From(1, 2, 3, 4, 5)
result := MonadChainOptionK(seq, countCalls)
// Collect only first 3 elements
collected := make([]int, 0)
for v := range result {
collected = append(collected, v)
if len(collected) >= 3 {
break
}
}
// Should have called the function only 3 times due to early termination
assert.Equal(t, 3, callCount)
assert.Equal(t, A.From(1, 2, 3), collected)
}
// TestChainOptionK_WithReduce tests ChainOptionK with reduction
func TestChainOptionK_WithReduce(t *testing.T) {
// Parse and sum valid numbers
parseInt := ChainOptionK(func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
})
result := F.Pipe1(
From("10", "invalid", "20", "bad", "30"),
parseInt,
)
sum := MonadReduce(result, func(acc, x int) int {
return acc + x
}, 0)
assert.Equal(t, 60, sum)
}
// TestFlatMapOptionK_NestedOptions tests FlatMapOptionK with nested option handling
func TestFlatMapOptionK_NestedOptions(t *testing.T) {
type Result struct {
Value int
Valid bool
}
// Extract value only if valid
extractValid := FlatMapOptionK(func(r Result) O.Option[int] {
if r.Valid {
return O.Some(r.Value)
}
return O.None[int]()
})
seq := From(
Result{10, true},
Result{20, false},
Result{30, true},
Result{40, false},
Result{50, true},
)
result := F.Pipe1(seq, extractValid)
values := slices.Collect(result)
expected := A.From(10, 30, 50)
assert.Equal(t, expected, values)
}

99
v2/llms.txt Normal file
View File

@@ -0,0 +1,99 @@
# fp-go
> A comprehensive functional programming library for Go, bringing type-safe monads, functors, applicatives, optics, and composable abstractions inspired by fp-ts and Haskell to the Go ecosystem. Created by IBM, licensed under Apache-2.0.
fp-go v2 requires Go 1.24+ and leverages generic type aliases for a cleaner API.
Key concepts: `Option` for nullable values, `Either`/`Result` for error handling, `IO` for lazy side effects, `Reader` for dependency injection, `IOResult` for effectful error handling, `ReaderIOResult` for the full monad stack, and `Optics` (lens, prism, traversal, iso) for immutable data manipulation.
## Core Documentation
- [API Reference (pkg.go.dev)](https://pkg.go.dev/github.com/IBM/fp-go/v2): Complete API documentation for all packages
- [README](https://github.com/IBM/fp-go/blob/main/v2/README.md): Overview, quick start, installation, and migration guide from v1 to v2
- [Design Decisions](https://github.com/IBM/fp-go/blob/main/v2/DESIGN.md): Key design principles and patterns
- [Functional I/O Guide](https://github.com/IBM/fp-go/blob/main/v2/FUNCTIONAL_IO.md): Understanding Context, errors, and the Reader pattern for I/O operations
- [Idiomatic vs Standard Comparison](https://github.com/IBM/fp-go/blob/main/v2/IDIOMATIC_COMPARISON.md): Performance comparison and when to use each approach
- [Optics README](https://github.com/IBM/fp-go/blob/main/v2/optics/README.md): Guide to lens, prism, optional, and traversal optics
## Standard Packages (struct-based)
- [option](https://pkg.go.dev/github.com/IBM/fp-go/v2/option): Option monad — represent optional values without nil
- [either](https://pkg.go.dev/github.com/IBM/fp-go/v2/either): Either monad — type-safe error handling with Left/Right values
- [result](https://pkg.go.dev/github.com/IBM/fp-go/v2/result): Result monad — simplified Either with `error` as Left type (recommended for error handling)
- [io](https://pkg.go.dev/github.com/IBM/fp-go/v2/io): IO monad — lazy evaluation and side effect management
- [iooption](https://pkg.go.dev/github.com/IBM/fp-go/v2/iooption): IOOption — IO combined with Option
- [ioeither](https://pkg.go.dev/github.com/IBM/fp-go/v2/ioeither): IOEither — IO combined with Either for effectful error handling
- [ioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/ioresult): IOResult — IO combined with Result (recommended over IOEither)
- [reader](https://pkg.go.dev/github.com/IBM/fp-go/v2/reader): Reader monad — dependency injection pattern
- [readeroption](https://pkg.go.dev/github.com/IBM/fp-go/v2/readeroption): ReaderOption — Reader combined with Option
- [readeriooption](https://pkg.go.dev/github.com/IBM/fp-go/v2/readeriooption): ReaderIOOption — Reader + IO + Option
- [readerioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/readerioresult): ReaderIOResult — Reader + IO + Result for complex workflows
- [readerioeither](https://pkg.go.dev/github.com/IBM/fp-go/v2/readerioeither): ReaderIOEither — Reader + IO + Either
- [statereaderioeither](https://pkg.go.dev/github.com/IBM/fp-go/v2/statereaderioeither): StateReaderIOEither — State + Reader + IO + Either
## Idiomatic Packages (tuple-based, high performance)
- [idiomatic/option](https://pkg.go.dev/github.com/IBM/fp-go/v2/idiomatic/option): Option using native Go `(value, bool)` tuples
- [idiomatic/result](https://pkg.go.dev/github.com/IBM/fp-go/v2/idiomatic/result): Result using native Go `(value, error)` tuples
- [idiomatic/ioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/idiomatic/ioresult): IOResult using `func() (value, error)`
- [idiomatic/readerresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/idiomatic/readerresult): ReaderResult with tuple-based results
- [idiomatic/readerioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/idiomatic/readerioresult): ReaderIOResult with tuple-based results
## Context Packages (context.Context specializations)
- [context/readerioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/context/readerioresult): ReaderIOResult specialized for context.Context
- [context/readerioresult/http](https://pkg.go.dev/github.com/IBM/fp-go/v2/context/readerioresult/http): Functional HTTP client utilities
- [context/readerioresult/http/builder](https://pkg.go.dev/github.com/IBM/fp-go/v2/context/readerioresult/http/builder): Functional HTTP request builder
- [context/statereaderioresult](https://pkg.go.dev/github.com/IBM/fp-go/v2/context/statereaderioresult): State + Reader + IO + Result for context.Context
## Optics
- [optics](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics): Core optics package
- [optics/lens](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/lens): Lenses for focusing on fields in product types
- [optics/prism](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/prism): Prisms for focusing on variants in sum types
- [optics/iso](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/iso): Isomorphisms for bidirectional transformations
- [optics/optional](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/optional): Optionals for values that may not exist
- [optics/traversal](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/traversal): Traversals for focusing on multiple values
- [optics/codec](https://pkg.go.dev/github.com/IBM/fp-go/v2/optics/codec): Codecs for encoding/decoding with validation
## Utility Packages
- [array](https://pkg.go.dev/github.com/IBM/fp-go/v2/array): Functional array/slice operations (map, filter, fold, etc.)
- [record](https://pkg.go.dev/github.com/IBM/fp-go/v2/record): Functional operations for maps
- [function](https://pkg.go.dev/github.com/IBM/fp-go/v2/function): Function composition, pipe, flow, curry, identity
- [pair](https://pkg.go.dev/github.com/IBM/fp-go/v2/pair): Strongly-typed pair/tuple data structure
- [tuple](https://pkg.go.dev/github.com/IBM/fp-go/v2/tuple): Type-safe heterogeneous tuples
- [predicate](https://pkg.go.dev/github.com/IBM/fp-go/v2/predicate): Predicate combinators (and, or, not, etc.)
- [endomorphism](https://pkg.go.dev/github.com/IBM/fp-go/v2/endomorphism): Endomorphism operations (compose, chain)
- [eq](https://pkg.go.dev/github.com/IBM/fp-go/v2/eq): Type-safe equality comparisons
- [ord](https://pkg.go.dev/github.com/IBM/fp-go/v2/ord): Total ordering type class
- [semigroup](https://pkg.go.dev/github.com/IBM/fp-go/v2/semigroup): Semigroup algebraic structure
- [monoid](https://pkg.go.dev/github.com/IBM/fp-go/v2/monoid): Monoid algebraic structure
- [number](https://pkg.go.dev/github.com/IBM/fp-go/v2/number): Algebraic structures for numeric types
- [string](https://pkg.go.dev/github.com/IBM/fp-go/v2/string): Functional string utilities
- [boolean](https://pkg.go.dev/github.com/IBM/fp-go/v2/boolean): Functional boolean utilities
- [bytes](https://pkg.go.dev/github.com/IBM/fp-go/v2/bytes): Functional byte slice utilities
- [json](https://pkg.go.dev/github.com/IBM/fp-go/v2/json): Functional JSON encoding/decoding
- [lazy](https://pkg.go.dev/github.com/IBM/fp-go/v2/lazy): Lazy evaluation without side effects
- [identity](https://pkg.go.dev/github.com/IBM/fp-go/v2/identity): Identity monad
- [retry](https://pkg.go.dev/github.com/IBM/fp-go/v2/retry): Retry policies with configurable backoff
- [tailrec](https://pkg.go.dev/github.com/IBM/fp-go/v2/tailrec): Trampoline for tail-call optimization
- [di](https://pkg.go.dev/github.com/IBM/fp-go/v2/di): Dependency injection utilities
- [effect](https://pkg.go.dev/github.com/IBM/fp-go/v2/effect): Functional effect system
- [circuitbreaker](https://pkg.go.dev/github.com/IBM/fp-go/v2/circuitbreaker): Circuit breaker error types
- [builder](https://pkg.go.dev/github.com/IBM/fp-go/v2/builder): Generic builder pattern with validation
## Code Samples
- [samples/builder](https://github.com/IBM/fp-go/tree/main/v2/samples/builder): Functional builder pattern example
- [samples/http](https://github.com/IBM/fp-go/tree/main/v2/samples/http): HTTP client examples
- [samples/lens](https://github.com/IBM/fp-go/tree/main/v2/samples/lens): Optics/lens examples
- [samples/mostly-adequate](https://github.com/IBM/fp-go/tree/main/v2/samples/mostly-adequate): Examples adapted from "Mostly Adequate Guide to Functional Programming"
- [samples/tuples](https://github.com/IBM/fp-go/tree/main/v2/samples/tuples): Tuple usage examples
## Optional
- [Source Code](https://github.com/IBM/fp-go): GitHub repository
- [Issues](https://github.com/IBM/fp-go/issues): Bug reports and feature requests
- [Go Report Card](https://goreportcard.com/report/github.com/IBM/fp-go/v2): Code quality report
- [Coverage](https://coveralls.io/github/IBM/fp-go?branch=main): Test coverage report

View File

@@ -13,6 +13,50 @@
// See the License for the specific language governing permissions and
// limitations under the License.
// Package monoid provides an implementation of the Monoid algebraic structure.
//
// # Monoid
//
// A Monoid is an algebraic structure that extends [Semigroup] by adding an identity element.
// It consists of:
// - A type A
// - An associative binary operation Concat: (A, A) → A
// - An identity element Empty: () → A
//
// # Laws
//
// A Monoid must satisfy the following laws:
//
// 1. Associativity (from Semigroup):
// Concat(Concat(x, y), z) = Concat(x, Concat(y, z))
//
// 2. Left Identity:
// Concat(Empty(), x) = x
//
// 3. Right Identity:
// Concat(x, Empty()) = x
//
// # Common Examples
//
// - Integer addition: Concat = (+), Empty = 0
// - Integer multiplication: Concat = (*), Empty = 1
// - String concatenation: Concat = (++), Empty = ""
// - List concatenation: Concat = (++), Empty = []
// - Boolean AND: Concat = (&&), Empty = true
// - Boolean OR: Concat = (||), Empty = false
// - Function composition: Concat = (∘), Empty = id
//
// # References
//
// - Haskell Data.Monoid: https://hackage.haskell.org/package/base/docs/Data-Monoid.html
// - Fantasy Land Monoid: https://github.com/fantasyland/fantasy-land#monoid
// - Semigroup: https://github.com/IBM/fp-go/v2/semigroup
//
// # Related Concepts
//
// - [Semigroup]: A Monoid without the identity element requirement
// - Magma: A set with a binary operation (no laws required)
// - Group: A Monoid where every element has an inverse
package monoid
import (
@@ -21,20 +65,31 @@ import (
// Monoid represents an algebraic structure with an associative binary operation and an identity element.
//
// A Monoid extends Semigroup by adding an identity element (Empty) that satisfies:
// A Monoid extends [Semigroup] by adding an identity element (Empty) that satisfies:
// - Left identity: Concat(Empty(), x) = x
// - Right identity: Concat(x, Empty()) = x
//
// The Monoid must also satisfy the associativity law from Semigroup:
// - Associativity: Concat(Concat(x, y), z) = Concat(x, Concat(y, z))
//
// Common examples:
// # Methods
//
// - Concat(x, y A) A: Inherited from Semigroup, combines two values associatively
// - Empty() A: Returns the identity element for the monoid
//
// # Common Examples
//
// - Integer addition with 0 as identity
// - Integer multiplication with 1 as identity
// - String concatenation with "" as identity
// - List concatenation with [] as identity
// - Boolean AND with true as identity
// - Boolean OR with false as identity
//
// # References
//
// - Haskell Monoid typeclass: https://hackage.haskell.org/package/base/docs/Data-Monoid.html#t:Monoid
// - Fantasy Land Monoid specification: https://github.com/fantasyland/fantasy-land#monoid
type Monoid[A any] interface {
S.Semigroup[A]
Empty() A
@@ -58,16 +113,22 @@ func (m monoid[A]) Empty() A {
// The provided concat function must be associative, and the empty element must
// satisfy the identity laws (left and right identity).
//
// Parameters:
// - c: An associative binary operation func(A, A) A
// - e: The identity element of type A
// This is the primary constructor for creating custom monoid instances. It's the
// equivalent of defining a Monoid instance in Haskell or implementing the Fantasy Land
// Monoid specification.
//
// Returns:
// - A Monoid[A] instance
// # Parameters
//
// Example:
// - c: An associative binary operation func(A, A) A (equivalent to Haskell's mappend or <>)
// - e: The identity element of type A (equivalent to Haskell's mempty)
//
// // Integer addition monoid
// # Returns
//
// - A [Monoid][A] instance
//
// # Example
//
// // Integer addition monoid (Sum in Haskell)
// addMonoid := MakeMonoid(
// func(a, b int) int { return a + b },
// 0, // identity element
@@ -81,6 +142,11 @@ func (m monoid[A]) Empty() A {
// "", // identity element
// )
// result := stringMonoid.Concat("Hello", " World") // "Hello World"
//
// # References
//
// - Haskell Monoid instance: https://hackage.haskell.org/package/base/docs/Data-Monoid.html#t:Monoid
// - Fantasy Land Monoid.empty: https://github.com/fantasyland/fantasy-land#monoid
func MakeMonoid[A any](c func(A, A) A, e A) Monoid[A] {
return monoid[A]{c: c, e: e}
}
@@ -91,13 +157,18 @@ func MakeMonoid[A any](c func(A, A) A, e A) Monoid[A] {
// operation in the opposite order. This is useful for operations that are
// not commutative.
//
// Parameters:
// This corresponds to the Dual newtype wrapper in Haskell's Data.Monoid, which
// provides a Monoid instance with reversed operation order.
//
// # Parameters
//
// - m: The monoid to reverse
//
// Returns:
// - A new Monoid[A] with reversed operation order
// # Returns
//
// Example:
// - A new [Monoid][A] with reversed operation order
//
// # Example
//
// // Subtraction monoid (not commutative)
// subMonoid := MakeMonoid(
@@ -116,6 +187,10 @@ func MakeMonoid[A any](c func(A, A) A, e A) Monoid[A] {
// )
// reversed := Reverse(stringMonoid)
// result := reversed.Concat("Hello", "World") // "WorldHello"
//
// # References
//
// - Haskell Data.Monoid.Dual: https://hackage.haskell.org/package/base/docs/Data-Monoid.html#t:Dual
func Reverse[A any](m Monoid[A]) Monoid[A] {
return MakeMonoid(S.Reverse(m).Concat, m.Empty())
}
@@ -125,13 +200,19 @@ func Reverse[A any](m Monoid[A]) Monoid[A] {
// This is useful when you need to use a monoid in a context that only requires
// a semigroup (associative binary operation without identity).
//
// Parameters:
// Since every Monoid is also a Semigroup (Monoid extends Semigroup), this conversion
// is always safe. This reflects the mathematical relationship where monoids form a
// subset of semigroups.
//
// # Parameters
//
// - m: The monoid to convert
//
// Returns:
// - A Semigroup[A] that uses the same Concat operation
// # Returns
//
// Example:
// - A [Semigroup][A] that uses the same Concat operation
//
// # Example
//
// addMonoid := MakeMonoid(
// func(a, b int) int { return a + b },
@@ -139,6 +220,11 @@ func Reverse[A any](m Monoid[A]) Monoid[A] {
// )
// sg := ToSemigroup(addMonoid)
// result := sg.Concat(5, 3) // 8 (identity not available)
//
// # References
//
// - Haskell Semigroup: https://hackage.haskell.org/package/base/docs/Data-Semigroup.html
// - Fantasy Land Semigroup: https://github.com/fantasyland/fantasy-land#semigroup
func ToSemigroup[A any](m Monoid[A]) S.Semigroup[A] {
return S.Semigroup[A](m)
}

480
v2/optics/codec/alt.go Normal file
View File

@@ -0,0 +1,480 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package codec
import (
"fmt"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/codec/validate"
"github.com/IBM/fp-go/v2/reader"
)
// validateAlt creates a validation function that tries the first codec's validation,
// and if it fails, tries the second codec's validation as a fallback.
//
// This is an internal helper function that implements the Alternative pattern for
// codec validation. It combines two codec validators using the validate.Alt operation,
// which provides error recovery and fallback logic.
//
// # Type Parameters
//
// - A: The target type that both codecs decode to
// - O: The output type that both codecs encode to
// - I: The input type that both codecs decode from
//
// # Parameters
//
// - first: The primary codec whose validation is tried first
// - second: A lazy codec that serves as the fallback. It's only evaluated if the
// first validation fails.
//
// # Returns
//
// A Validate[I, A] function that tries the first codec's validation, falling back
// to the second if needed. If both fail, errors from both are aggregated.
//
// # Behavior
//
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
//
// # Notes
//
// - The second codec is lazily evaluated for efficiency
// - This function is used internally by MonadAlt and Alt
// - The validation context is threaded through both validators
// - Errors are accumulated using the validation error monoid
func validateAlt[A, O, I any](
first Type[A, O, I],
second Lazy[Type[A, O, I]],
) Validate[I, A] {
return F.Pipe1(
first.Validate,
validate.Alt(F.Pipe1(
second,
lazy.Map(F.Flip(reader.Curry(Type[A, O, I].Validate))),
)),
)
}
// MonadAlt creates a new codec that tries the first codec, and if it fails during
// validation, tries the second codec as a fallback.
//
// This function implements the Alternative typeclass pattern for codecs, enabling
// "try this codec, or else try that codec" logic. It's particularly useful for:
// - Handling multiple valid input formats
// - Providing backward compatibility with legacy formats
// - Implementing graceful degradation in parsing
// - Supporting union types or polymorphic data
//
// The resulting codec uses the first codec's encoder and combines both validators
// using the Alternative pattern. If both validations fail, errors from both are
// aggregated for comprehensive error reporting.
//
// # Type Parameters
//
// - A: The target type that both codecs decode to
// - O: The output type that both codecs encode to
// - I: The input type that both codecs decode from
//
// # Parameters
//
// - first: The primary codec to try first. Its encoder is used for the result.
// - second: A lazy codec that serves as the fallback. It's only evaluated if the
// first validation fails.
//
// # Returns
//
// A new Type[A, O, I] that combines both codecs with Alternative semantics.
//
// # Behavior
//
// **Validation**:
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
//
// **Encoding**:
// - Always uses the first codec's encoder
// - This assumes both codecs encode to the same output format
//
// **Type Checking**:
// - Uses the generic Is[A]() type checker
// - Validates that values are of type A
//
// # Example: Multiple Input Formats
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec"
// )
//
// // Accept integers as either strings or numbers
// intFromString := codec.IntFromString()
// intFromNumber := codec.Int()
//
// // Try parsing as string first, fall back to number
// flexibleInt := codec.MonadAlt(
// intFromString,
// func() codec.Type[int, any, any] { return intFromNumber },
// )
//
// // Can now decode both "42" and 42
// result1 := flexibleInt.Decode("42") // Success(42)
// result2 := flexibleInt.Decode(42) // Success(42)
//
// # Example: Backward Compatibility
//
// // Support both old and new configuration formats
// newConfigCodec := codec.Struct(/* new format */)
// oldConfigCodec := codec.Struct(/* old format */)
//
// // Try new format first, fall back to old format
// configCodec := codec.MonadAlt(
// newConfigCodec,
// func() codec.Type[Config, any, any] { return oldConfigCodec },
// )
//
// // Automatically handles both formats
// config := configCodec.Decode(input)
//
// # Example: Error Aggregation
//
// // Both validations will fail for invalid input
// result := flexibleInt.Decode("not a number")
// // Result contains errors from both string and number parsing attempts
//
// # Notes
//
// - The second codec is lazily evaluated for efficiency
// - First success short-circuits evaluation (second not called)
// - Errors are aggregated when both fail
// - The resulting codec's name is "Alt[<first codec name>]"
// - Both codecs must have compatible input and output types
// - The first codec's encoder is always used
//
// # See Also
//
// - Alt: The curried, point-free version
// - validate.MonadAlt: The underlying validation operation
// - Either: For codecs that decode to Either[L, R] types
func MonadAlt[A, O, I any](first Type[A, O, I], second Lazy[Type[A, O, I]]) Type[A, O, I] {
return MakeType(
fmt.Sprintf("Alt[%s]", first.Name()),
Is[A](),
validateAlt(first, second),
first.Encode,
)
}
// Alt creates an operator that adds alternative fallback logic to a codec.
//
// This is the curried, point-free version of MonadAlt. It returns a function that
// can be applied to codecs to add fallback behavior. This style is particularly
// useful for building codec transformation pipelines using function composition.
//
// Alt implements the Alternative typeclass pattern, enabling "try this codec, or
// else try that codec" logic in a composable way.
//
// # Type Parameters
//
// - A: The target type that both codecs decode to
// - O: The output type that both codecs encode to
// - I: The input type that both codecs decode from
//
// # Parameters
//
// - second: A lazy codec that serves as the fallback. It's only evaluated if the
// first codec's validation fails.
//
// # Returns
//
// An Operator[A, A, O, I] that transforms codecs by adding alternative fallback logic.
// This operator can be applied to any Type[A, O, I] to create a new codec with
// fallback behavior.
//
// # Behavior
//
// When the returned operator is applied to a codec:
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
//
// # Example: Point-Free Style
//
// import (
// F "github.com/IBM/fp-go/v2/function"
// "github.com/IBM/fp-go/v2/optics/codec"
// )
//
// // Create a reusable fallback operator
// withNumberFallback := codec.Alt(func() codec.Type[int, any, any] {
// return codec.Int()
// })
//
// // Apply it to different codecs
// flexibleInt1 := withNumberFallback(codec.IntFromString())
// flexibleInt2 := withNumberFallback(codec.IntFromHex())
//
// # Example: Pipeline Composition
//
// // Build a codec pipeline with multiple fallbacks
// flexibleCodec := F.Pipe2(
// primaryCodec,
// codec.Alt(func() codec.Type[T, O, I] { return fallback1 }),
// codec.Alt(func() codec.Type[T, O, I] { return fallback2 }),
// )
// // Tries primary, then fallback1, then fallback2
//
// # Example: Reusable Transformations
//
// // Create a transformation that adds JSON fallback
// withJSONFallback := codec.Alt(func() codec.Type[Config, string, string] {
// return codec.JSONCodec[Config]()
// })
//
// // Apply to multiple codecs
// yamlWithFallback := withJSONFallback(yamlCodec)
// tomlWithFallback := withJSONFallback(tomlCodec)
//
// # Notes
//
// - This is the point-free style version of MonadAlt
// - Useful for building transformation pipelines with F.Pipe
// - The second codec is lazily evaluated for efficiency
// - First success short-circuits evaluation
// - Errors are aggregated when both fail
// - Can be composed with other codec operators
//
// # See Also
//
// - MonadAlt: The direct application version
// - validate.Alt: The underlying validation operation
// - F.Pipe: For composing multiple operators
func Alt[A, O, I any](second Lazy[Type[A, O, I]]) Operator[A, A, O, I] {
return F.Bind2nd(MonadAlt, second)
}
// AltMonoid creates a Monoid instance for Type[A, O, I] using alternative semantics
// with a provided zero/default codec.
//
// This function creates a monoid where:
// 1. The first successful codec wins (no result combination)
// 2. If the first fails during validation, the second is tried as a fallback
// 3. If both fail, errors are aggregated
// 4. The provided zero codec serves as the identity element
//
// Unlike other monoid patterns, AltMonoid does NOT combine successful results - it always
// returns the first success. This makes it ideal for building fallback chains with default
// codecs, configuration loading from multiple sources, and parser combinators with alternatives.
//
// # Type Parameters
//
// - A: The target type that all codecs decode to
// - O: The output type that all codecs encode to
// - I: The input type that all codecs decode from
//
// # Parameters
//
// - zero: A lazy Type[A, O, I] that serves as the identity element. This is typically
// a codec that always succeeds with a default value, but can also be a failing
// codec if no default is appropriate.
//
// # Returns
//
// A Monoid[Type[A, O, I]] that combines codecs using alternative semantics where
// the first success wins.
//
// # Behavior Details
//
// The AltMonoid implements a "first success wins" strategy:
//
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
// - **Concat with Empty**: The zero codec is used as fallback
// - **Encoding**: Always uses the first codec's encoder
//
// # Example: Configuration Loading with Fallbacks
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec"
// "github.com/IBM/fp-go/v2/array"
// )
//
// // Create a monoid with a default configuration
// m := codec.AltMonoid(func() codec.Type[Config, string, string] {
// return codec.MakeType(
// "DefaultConfig",
// codec.Is[Config](),
// func(s string) codec.Decode[codec.Context, Config] {
// return func(c codec.Context) codec.Validation[Config] {
// return validation.Success(defaultConfig)
// }
// },
// encodeConfig,
// )
// })
//
// // Define codecs for different sources
// fileCodec := loadFromFile("config.json")
// envCodec := loadFromEnv()
// defaultCodec := m.Empty()
//
// // Try file, then env, then default
// configCodec := array.MonadFold(
// []codec.Type[Config, string, string]{fileCodec, envCodec, defaultCodec},
// m.Empty(),
// m.Concat,
// )
//
// // Load configuration - tries each source in order
// result := configCodec.Decode(input)
//
// # Example: Parser with Multiple Formats
//
// // Create a monoid for parsing dates in multiple formats
// m := codec.AltMonoid(func() codec.Type[time.Time, string, string] {
// return codec.Date(time.RFC3339) // default format
// })
//
// // Define parsers for different date formats
// iso8601 := codec.Date("2006-01-02")
// usFormat := codec.Date("01/02/2006")
// euroFormat := codec.Date("02/01/2006")
//
// // Combine: try ISO 8601, then US, then European, then RFC3339
// flexibleDate := m.Concat(
// m.Concat(
// m.Concat(iso8601, usFormat),
// euroFormat,
// ),
// m.Empty(),
// )
//
// // Can parse any of these formats
// result1 := flexibleDate.Decode("2024-03-15") // ISO 8601
// result2 := flexibleDate.Decode("03/15/2024") // US format
// result3 := flexibleDate.Decode("15/03/2024") // European format
//
// # Example: Integer Parsing with Default
//
// // Create a monoid with default value of 0
// m := codec.AltMonoid(func() codec.Type[int, string, string] {
// return codec.MakeType(
// "DefaultZero",
// codec.Is[int](),
// func(s string) codec.Decode[codec.Context, int] {
// return func(c codec.Context) codec.Validation[int] {
// return validation.Success(0)
// }
// },
// strconv.Itoa,
// )
// })
//
// // Try parsing as int, fall back to 0
// intOrZero := m.Concat(codec.IntFromString(), m.Empty())
//
// result1 := intOrZero.Decode("42") // Success(42)
// result2 := intOrZero.Decode("invalid") // Success(0) - uses default
//
// # Example: Error Aggregation
//
// // Both codecs fail - errors are aggregated
// m := codec.AltMonoid(func() codec.Type[int, string, string] {
// return codec.MakeType(
// "NoDefault",
// codec.Is[int](),
// func(s string) codec.Decode[codec.Context, int] {
// return func(c codec.Context) codec.Validation[int] {
// return validation.FailureWithMessage[int](s, "no default available")(c)
// }
// },
// strconv.Itoa,
// )
// })
//
// failing1 := codec.MakeType(
// "Failing1",
// codec.Is[int](),
// func(s string) codec.Decode[codec.Context, int] {
// return func(c codec.Context) codec.Validation[int] {
// return validation.FailureWithMessage[int](s, "error 1")(c)
// }
// },
// strconv.Itoa,
// )
//
// failing2 := codec.MakeType(
// "Failing2",
// codec.Is[int](),
// func(s string) codec.Decode[codec.Context, int] {
// return func(c codec.Context) codec.Validation[int] {
// return validation.FailureWithMessage[int](s, "error 2")(c)
// }
// },
// strconv.Itoa,
// )
//
// combined := m.Concat(failing1, failing2)
// result := combined.Decode("input")
// // result contains errors: "error 1", "error 2", and "no default available"
//
// # Monoid Laws
//
// AltMonoid satisfies the monoid laws:
//
// 1. **Left Identity**: m.Concat(m.Empty(), codec) ≡ codec
// 2. **Right Identity**: m.Concat(codec, m.Empty()) ≡ codec (tries codec first, falls back to zero)
// 3. **Associativity**: m.Concat(m.Concat(a, b), c) ≡ m.Concat(a, m.Concat(b, c))
//
// Note: Due to the "first success wins" behavior, right identity means the zero is only
// used if the codec fails.
//
// # Use Cases
//
// - Configuration loading with multiple sources (file, env, default)
// - Parsing data in multiple formats with fallbacks
// - API versioning (try v2, fall back to v1, then default)
// - Content negotiation (try JSON, then XML, then plain text)
// - Validation with default values
// - Parser combinators with alternative branches
//
// # Notes
//
// - The zero codec is lazily evaluated, only when needed
// - First success short-circuits evaluation (subsequent codecs not tried)
// - Error aggregation ensures all validation failures are reported
// - Encoding always uses the first codec's encoder
// - This follows the alternative functor laws
//
// # See Also
//
// - MonadAlt: The underlying alternative operation for two codecs
// - Alt: The curried version for pipeline composition
// - validate.AltMonoid: The validation-level alternative monoid
// - decode.AltMonoid: The decode-level alternative monoid
func AltMonoid[A, O, I any](zero Lazy[Type[A, O, I]]) Monoid[Type[A, O, I]] {
return monoid.AltMonoid(
zero,
MonadAlt[A, O, I],
)
}

921
v2/optics/codec/alt_test.go Normal file
View File

@@ -0,0 +1,921 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package codec
import (
"fmt"
"strconv"
"testing"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// TestMonadAltBasicFunctionality tests the basic behavior of MonadAlt
func TestMonadAltBasicFunctionality(t *testing.T) {
t.Run("uses first codec when it succeeds", func(t *testing.T) {
// Create two codecs that both work with strings
stringCodec := Id[string]()
// Create another string codec that only accepts uppercase
uppercaseOnly := MakeType(
"UppercaseOnly",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
for _, r := range s {
if r >= 'a' && r <= 'z' {
return validation.FailureWithMessage[string](s, "must be uppercase")(c)
}
}
return validation.Success(s)
}
},
F.Identity[string],
)
// Create alt codec that tries uppercase first, then any string
altCodec := MonadAlt(
uppercaseOnly,
func() Type[string, string, string] { return stringCodec },
)
// Test with uppercase string - should succeed with first codec
result := altCodec.Decode("HELLO")
assert.True(t, either.IsRight(result), "should successfully decode with first codec")
value := either.GetOrElse(reader.Of[validation.Errors, string](""))(result)
assert.Equal(t, "HELLO", value)
})
t.Run("falls back to second codec when first fails", func(t *testing.T) {
// Create a codec that only accepts positive integers
positiveInt := MakeType(
"PositiveInt",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
if i <= 0 {
return validation.FailureWithMessage[int](i, "must be positive")(c)
}
return validation.Success(i)
}
},
F.Identity[int],
)
// Create a codec that accepts any integer (with same input type)
anyInt := MakeType(
"AnyInt",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(i)
}
},
F.Identity[int],
)
// Create alt codec
altCodec := MonadAlt(
positiveInt,
func() Type[int, int, int] { return anyInt },
)
// Test with negative number - first fails, second succeeds
result := altCodec.Decode(-5)
assert.True(t, either.IsRight(result), "should successfully decode with second codec")
value := either.GetOrElse(reader.Of[validation.Errors, int](0))(result)
assert.Equal(t, -5, value)
})
t.Run("aggregates errors when both codecs fail", func(t *testing.T) {
// Create two codecs that will both fail
positiveInt := MakeType(
"PositiveInt",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
if i <= 0 {
return validation.FailureWithMessage[int](i, "must be positive")(c)
}
return validation.Success(i)
}
},
F.Identity[int],
)
evenInt := MakeType(
"EvenInt",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
if i%2 != 0 {
return validation.FailureWithMessage[int](i, "must be even")(c)
}
return validation.Success(i)
}
},
F.Identity[int],
)
// Create alt codec
altCodec := MonadAlt(
positiveInt,
func() Type[int, int, int] { return evenInt },
)
// Test with -3 (negative and odd) - both should fail
result := altCodec.Decode(-3)
assert.True(t, either.IsLeft(result), "should fail when both codecs fail")
errors := either.MonadFold(result,
F.Identity[validation.Errors],
func(int) validation.Errors { return nil },
)
require.NotNil(t, errors)
// Should have errors from both validation attempts
assert.GreaterOrEqual(t, len(errors), 2, "should have errors from both codecs")
})
}
// TestMonadAltNaming tests that the codec name is correctly generated
func TestMonadAltNaming(t *testing.T) {
t.Run("generates correct name", func(t *testing.T) {
stringCodec := Id[string]()
anotherStringCodec := Id[string]()
altCodec := MonadAlt(
stringCodec,
func() Type[string, string, string] { return anotherStringCodec },
)
assert.Equal(t, "Alt[string]", altCodec.Name())
})
}
// TestMonadAltEncoding tests that encoding uses the first codec's encoder
func TestMonadAltEncoding(t *testing.T) {
t.Run("uses first codec's encoder", func(t *testing.T) {
// Create a codec that encodes ints as strings with prefix
prefixedInt := MakeType(
"PrefixedInt",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
var n int
_, err := fmt.Sscanf(s, "NUM:%d", &n)
if err != nil {
return validation.FailureWithError[int](s, "expected NUM:n format")(err)(c)
}
return validation.Success(n)
}
},
func(n int) string {
return fmt.Sprintf("NUM:%d", n)
},
)
// Create a standard int from string codec
standardInt := IntFromString()
// Create alt codec
altCodec := MonadAlt(
prefixedInt,
func() Type[int, string, string] { return standardInt },
)
// Encode should use first codec's encoder
encoded := altCodec.Encode(42)
assert.Equal(t, "NUM:42", encoded)
})
}
// TestAltOperator tests the curried Alt function
func TestAltOperator(t *testing.T) {
t.Run("creates reusable operator", func(t *testing.T) {
// Create a fallback operator that accepts any string
withStringFallback := Alt(func() Type[string, string, string] {
return Id[string]()
})
// Create a codec that only accepts "hello"
helloOnly := MakeType(
"HelloOnly",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
if s != "hello" {
return validation.FailureWithMessage[string](s, "must be 'hello'")(c)
}
return validation.Success(s)
}
},
F.Identity[string],
)
// Apply fallback to the codec
altCodec := withStringFallback(helloOnly)
// Test that it works
result1 := altCodec.Decode("hello")
assert.True(t, either.IsRight(result1))
result2 := altCodec.Decode("world")
assert.True(t, either.IsRight(result2))
})
t.Run("works in pipeline with F.Pipe", func(t *testing.T) {
// Create a codec pipeline with multiple fallbacks
baseCodec := MakeType(
"StrictInt",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
if s != "42" {
return validation.FailureWithMessage[int](s, "must be exactly '42'")(c)
}
return validation.Success(42)
}
},
strconv.Itoa,
)
fallback1 := MakeType(
"Fallback1",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
if s != "100" {
return validation.FailureWithMessage[int](s, "must be exactly '100'")(c)
}
return validation.Success(100)
}
},
strconv.Itoa,
)
fallback2 := MakeType(
"AnyInt",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
n, err := strconv.Atoi(s)
if err != nil {
return validation.FailureWithError[int](s, "not an integer")(err)(c)
}
return validation.Success(n)
}
},
strconv.Itoa,
)
// Build pipeline with multiple alternatives
pipeline := F.Pipe2(
baseCodec,
Alt(func() Type[int, string, string] { return fallback1 }),
Alt(func() Type[int, string, string] { return fallback2 }),
)
// Test with "42" - should use base codec
result1 := pipeline.Decode("42")
assert.True(t, either.IsRight(result1))
value1 := either.GetOrElse(reader.Of[validation.Errors, int](0))(result1)
assert.Equal(t, 42, value1)
// Test with "100" - should use fallback1
result2 := pipeline.Decode("100")
assert.True(t, either.IsRight(result2))
value2 := either.GetOrElse(reader.Of[validation.Errors, int](0))(result2)
assert.Equal(t, 100, value2)
// Test with "999" - should use fallback2
result3 := pipeline.Decode("999")
assert.True(t, either.IsRight(result3))
value3 := either.GetOrElse(reader.Of[validation.Errors, int](0))(result3)
assert.Equal(t, 999, value3)
})
}
// TestAltLazyEvaluation tests that the second codec is only evaluated when needed
func TestAltLazyEvaluation(t *testing.T) {
t.Run("does not evaluate second codec when first succeeds", func(t *testing.T) {
evaluated := false
stringCodec := Id[string]()
altCodec := MonadAlt(
stringCodec,
func() Type[string, string, string] {
evaluated = true
return Id[string]()
},
)
// Decode with first codec succeeding
result := altCodec.Decode("hello")
assert.True(t, either.IsRight(result))
// Second codec should not have been evaluated
assert.False(t, evaluated, "second codec should not be evaluated when first succeeds")
})
t.Run("evaluates second codec when first fails", func(t *testing.T) {
evaluated := false
// Create a codec that always fails
failingCodec := MakeType(
"Failing",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
return validation.FailureWithMessage[string](s, "always fails")(c)
}
},
F.Identity[string],
)
altCodec := MonadAlt(
failingCodec,
func() Type[string, string, string] {
evaluated = true
return Id[string]()
},
)
// Decode with first codec failing
result := altCodec.Decode("hello")
assert.True(t, either.IsRight(result))
// Second codec should have been evaluated
assert.True(t, evaluated, "second codec should be evaluated when first fails")
})
}
// TestAltWithComplexTypes tests Alt with more complex codec scenarios
func TestAltWithComplexTypes(t *testing.T) {
t.Run("works with string length validation", func(t *testing.T) {
// Create codec that accepts strings of length 5
length5 := MakeType(
"Length5",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
if len(s) != 5 {
return validation.FailureWithMessage[string](s, "must be length 5")(c)
}
return validation.Success(s)
}
},
F.Identity[string],
)
// Create codec that accepts any string
anyString := Id[string]()
// Create alt codec
altCodec := MonadAlt(
length5,
func() Type[string, string, string] { return anyString },
)
// Test with length 5 - should use first codec
result1 := altCodec.Decode("hello")
assert.True(t, either.IsRight(result1))
// Test with different length - should fall back to second codec
result2 := altCodec.Decode("hi")
assert.True(t, either.IsRight(result2))
})
}
// TestAltTypeChecking tests that type checking works correctly
func TestAltTypeChecking(t *testing.T) {
t.Run("type checking uses generic Is", func(t *testing.T) {
stringCodec := Id[string]()
anotherStringCodec := Id[string]()
altCodec := MonadAlt(
stringCodec,
func() Type[string, string, string] { return anotherStringCodec },
)
// Test Is with valid type
result1 := altCodec.Is("hello")
assert.True(t, either.IsRight(result1))
// Test Is with invalid type
result2 := altCodec.Is(42)
assert.True(t, either.IsLeft(result2))
})
}
// TestAltRoundTrip tests encoding and decoding round trips
func TestAltRoundTrip(t *testing.T) {
t.Run("round-trip with first codec", func(t *testing.T) {
stringCodec := Id[string]()
anotherStringCodec := Id[string]()
altCodec := MonadAlt(
stringCodec,
func() Type[string, string, string] { return anotherStringCodec },
)
original := "hello"
// Decode
decodeResult := altCodec.Decode(original)
require.True(t, either.IsRight(decodeResult))
decoded := either.GetOrElse(reader.Of[validation.Errors, string](""))(decodeResult)
// Encode
encoded := altCodec.Encode(decoded)
// Verify
assert.Equal(t, original, encoded)
})
t.Run("round-trip with second codec", func(t *testing.T) {
// Create a codec that only accepts "hello"
helloOnly := MakeType(
"HelloOnly",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
if s != "hello" {
return validation.FailureWithMessage[string](s, "must be 'hello'")(c)
}
return validation.Success(s)
}
},
F.Identity[string],
)
anyString := Id[string]()
altCodec := MonadAlt(
helloOnly,
func() Type[string, string, string] { return anyString },
)
original := "world"
// Decode (will use second codec)
decodeResult := altCodec.Decode(original)
require.True(t, either.IsRight(decodeResult))
decoded := either.GetOrElse(reader.Of[validation.Errors, string](""))(decodeResult)
// Encode (uses first codec's encoder, which is identity)
encoded := altCodec.Encode(decoded)
// Verify
assert.Equal(t, original, encoded)
})
}
// TestAltErrorMessages tests that error messages are informative
func TestAltErrorMessages(t *testing.T) {
t.Run("provides detailed error context", func(t *testing.T) {
// Create two codecs with specific error messages
codec1 := MakeType(
"Codec1",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](i, "codec1 error")(c)
}
},
F.Identity[int],
)
codec2 := MakeType(
"Codec2",
Is[int](),
func(i int) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](i, "codec2 error")(c)
}
},
F.Identity[int],
)
altCodec := MonadAlt(
codec1,
func() Type[int, int, int] { return codec2 },
)
result := altCodec.Decode(42)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[validation.Errors],
func(int) validation.Errors { return nil },
)
require.NotNil(t, errors)
require.GreaterOrEqual(t, len(errors), 2)
// Check that both error messages are present
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
hasCodec1Error := false
hasCodec2Error := false
for _, msg := range messages {
if msg == "codec1 error" {
hasCodec1Error = true
}
if msg == "codec2 error" {
hasCodec2Error = true
}
}
assert.True(t, hasCodec1Error, "should have error from first codec")
assert.True(t, hasCodec2Error, "should have error from second codec")
})
}
// TestAltMonoid tests the AltMonoid function
func TestAltMonoid(t *testing.T) {
t.Run("with default value as zero", func(t *testing.T) {
// Create a monoid with a default value of 0
m := AltMonoid(func() Type[int, string, string] {
return MakeType(
"DefaultZero",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(0)
}
},
strconv.Itoa,
)
})
// Create codecs
intFromString := IntFromString()
failing := MakeType(
"Failing",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](s, "always fails")(c)
}
},
strconv.Itoa,
)
t.Run("first success wins", func(t *testing.T) {
// Combine two successful codecs - first should win
codec1 := MakeType(
"Returns10",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(10)
}
},
strconv.Itoa,
)
codec2 := MakeType(
"Returns20",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(20)
}
},
strconv.Itoa,
)
combined := m.Concat(codec1, codec2)
result := combined.Decode("input")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, int](0))(result)
assert.Equal(t, 10, value, "first success should win")
})
t.Run("falls back to second when first fails", func(t *testing.T) {
combined := m.Concat(failing, intFromString)
result := combined.Decode("42")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, int](0))(result)
assert.Equal(t, 42, value)
})
t.Run("uses zero when both fail", func(t *testing.T) {
combined := m.Concat(failing, m.Empty())
result := combined.Decode("invalid")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, int](-1))(result)
assert.Equal(t, 0, value, "should use default zero value")
})
})
t.Run("with failing zero", func(t *testing.T) {
// Create a monoid with a failing zero
m := AltMonoid(func() Type[int, string, string] {
return MakeType(
"NoDefault",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](s, "no default available")(c)
}
},
strconv.Itoa,
)
})
failing1 := MakeType(
"Failing1",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](s, "error 1")(c)
}
},
strconv.Itoa,
)
failing2 := MakeType(
"Failing2",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.FailureWithMessage[int](s, "error 2")(c)
}
},
strconv.Itoa,
)
t.Run("aggregates all errors when all fail", func(t *testing.T) {
combined := m.Concat(m.Concat(failing1, failing2), m.Empty())
result := combined.Decode("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[validation.Errors],
func(int) validation.Errors { return nil },
)
require.NotNil(t, errors)
// Should have errors from all three: failing1, failing2, and zero
assert.GreaterOrEqual(t, len(errors), 3)
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
hasError1 := false
hasError2 := false
hasNoDefault := false
for _, msg := range messages {
if msg == "error 1" {
hasError1 = true
}
if msg == "error 2" {
hasError2 = true
}
if msg == "no default available" {
hasNoDefault = true
}
}
assert.True(t, hasError1, "should have error from failing1")
assert.True(t, hasError2, "should have error from failing2")
assert.True(t, hasNoDefault, "should have error from zero")
})
})
t.Run("chaining multiple fallbacks", func(t *testing.T) {
m := AltMonoid(func() Type[string, string, string] {
return MakeType(
"Default",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
return validation.Success("default")
}
},
F.Identity[string],
)
})
primary := MakeType(
"Primary",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
if s == "primary" {
return validation.Success("from primary")
}
return validation.FailureWithMessage[string](s, "not primary")(c)
}
},
F.Identity[string],
)
secondary := MakeType(
"Secondary",
Is[string](),
func(s string) Decode[Context, string] {
return func(c Context) Validation[string] {
if s == "secondary" {
return validation.Success("from secondary")
}
return validation.FailureWithMessage[string](s, "not secondary")(c)
}
},
F.Identity[string],
)
// Chain: try primary, then secondary, then default
combined := m.Concat(m.Concat(primary, secondary), m.Empty())
t.Run("uses primary when it succeeds", func(t *testing.T) {
result := combined.Decode("primary")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, string](""))(result)
assert.Equal(t, "from primary", value)
})
t.Run("uses secondary when primary fails", func(t *testing.T) {
result := combined.Decode("secondary")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, string](""))(result)
assert.Equal(t, "from secondary", value)
})
t.Run("uses default when both fail", func(t *testing.T) {
result := combined.Decode("other")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, string](""))(result)
assert.Equal(t, "default", value)
})
})
t.Run("satisfies monoid laws", func(t *testing.T) {
m := AltMonoid(func() Type[int, string, string] {
return MakeType(
"DefaultZero",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(0)
}
},
strconv.Itoa,
)
})
codec1 := MakeType(
"Codec1",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(10)
}
},
strconv.Itoa,
)
codec2 := MakeType(
"Codec2",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(20)
}
},
strconv.Itoa,
)
codec3 := MakeType(
"Codec3",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(30)
}
},
strconv.Itoa,
)
t.Run("left identity", func(t *testing.T) {
// m.Concat(m.Empty(), codec) should behave like codec
// But with AltMonoid, if codec fails, it falls back to empty
combined := m.Concat(m.Empty(), codec1)
result := combined.Decode("input")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, int](-1))(result)
// Empty (0) comes first, so it wins
assert.Equal(t, 0, value)
})
t.Run("right identity", func(t *testing.T) {
// m.Concat(codec, m.Empty()) tries codec first, falls back to empty
combined := m.Concat(codec1, m.Empty())
result := combined.Decode("input")
assert.True(t, either.IsRight(result))
value := either.GetOrElse(reader.Of[validation.Errors, int](-1))(result)
assert.Equal(t, 10, value, "codec1 should win")
})
t.Run("associativity", func(t *testing.T) {
// For AltMonoid, first success wins
left := m.Concat(m.Concat(codec1, codec2), codec3)
right := m.Concat(codec1, m.Concat(codec2, codec3))
resultLeft := left.Decode("input")
resultRight := right.Decode("input")
assert.True(t, either.IsRight(resultLeft))
assert.True(t, either.IsRight(resultRight))
valueLeft := either.GetOrElse(reader.Of[validation.Errors, int](-1))(resultLeft)
valueRight := either.GetOrElse(reader.Of[validation.Errors, int](-1))(resultRight)
// Both should return 10 (first success)
assert.Equal(t, valueLeft, valueRight)
assert.Equal(t, 10, valueLeft)
})
})
t.Run("encoding uses first codec", func(t *testing.T) {
m := AltMonoid(func() Type[int, string, string] {
return MakeType(
"Default",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(0)
}
},
func(n int) string { return "DEFAULT" },
)
})
codec1 := MakeType(
"Codec1",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(42)
}
},
func(n int) string { return fmt.Sprintf("FIRST:%d", n) },
)
codec2 := MakeType(
"Codec2",
Is[int](),
func(s string) Decode[Context, int] {
return func(c Context) Validation[int] {
return validation.Success(100)
}
},
func(n int) string { return fmt.Sprintf("SECOND:%d", n) },
)
combined := m.Concat(codec1, codec2)
// Encoding should use first codec's encoder
encoded := combined.Encode(42)
assert.Equal(t, "FIRST:42", encoded)
})
}

View File

@@ -1,9 +1,10 @@
package decode
import (
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/internal/readert"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/readereither"
)
// Of creates a Decode that always succeeds with the given value.
@@ -14,7 +15,82 @@ import (
// decoder := decode.Of[string](42)
// result := decoder("any input") // Always returns validation.Success(42)
func Of[I, A any](a A) Decode[I, A] {
return reader.Of[I](validation.Of(a))
return readereither.Of[I, Errors](a)
}
// Left creates a Decode that always fails with the given validation errors.
// This is the dual of Of - while Of lifts a success value, Left lifts failure errors
// into the Decode context.
//
// Left is useful for:
// - Creating decoders that represent known failure states
// - Short-circuiting decode pipelines with specific errors
// - Building custom validation error responses
// - Testing error handling paths
//
// The returned decoder ignores its input and always returns a validation failure
// containing the provided errors. This makes it the identity element for the
// Alt/OrElse operations when used as a fallback.
//
// Type signature: func(Errors) Decode[I, A]
// - Takes validation errors
// - Returns a decoder that always fails with those errors
// - The decoder ignores its input of type I
// - The failure type A can be any type (phantom type)
//
// Example - Creating a failing decoder:
//
// failDecoder := decode.Left[string, int](validation.Errors{
// &validation.ValidationError{
// Value: nil,
// Messsage: "operation not supported",
// },
// })
// result := failDecoder("any input") // Always fails with the error
//
// Example - Short-circuiting with specific errors:
//
// validateAge := func(age int) Decode[map[string]any, int] {
// if age < 0 {
// return decode.Left[map[string]any, int](validation.Errors{
// &validation.ValidationError{
// Value: age,
// Context: validation.Context{{Key: "age", Type: "int"}},
// Messsage: "age cannot be negative",
// },
// })
// }
// return decode.Of[map[string]any](age)
// }
//
// Example - Building error responses:
//
// notFoundError := decode.Left[string, User](validation.Errors{
// &validation.ValidationError{
// Messsage: "user not found",
// },
// })
//
// decoder := decode.MonadAlt(
// tryFindUser,
// func() Decode[string, User] { return notFoundError },
// )
//
// Example - Testing error paths:
//
// // Create a decoder that always fails for testing
// alwaysFails := decode.Left[string, int](validation.Errors{
// &validation.ValidationError{Messsage: "test error"},
// })
//
// // Test error recovery logic
// recovered := decode.OrElse(func(errs Errors) Decode[string, int] {
// return decode.Of[string](0) // recover with default
// })(alwaysFails)
//
// result := recovered("input") // Success(0)
func Left[I, A any](err Errors) Decode[I, A] {
return readereither.Left[I, A](err)
}
// MonadChain sequences two decode operations, passing the result of the first to the second.
@@ -50,6 +126,60 @@ func Chain[I, A, B any](f Kleisli[I, A, B]) Operator[I, A, B] {
)
}
// ChainLeft transforms the error channel of a decoder, enabling error recovery and context addition.
// This is the left-biased monadic chain operation that operates on validation failures.
//
// **Key behaviors**:
// - Success values pass through unchanged - the handler is never called
// - On failure, the handler receives the errors and can recover or add context
// - When the handler also fails, **both original and new errors are aggregated**
// - The handler returns a Decode[I, A], giving it access to the original input
//
// **Error Aggregation**: Unlike standard Either operations, when the transformation function
// returns a failure, both the original errors AND the new errors are combined using the
// Errors monoid. This ensures no validation errors are lost.
//
// Use cases:
// - Adding contextual information to validation errors
// - Recovering from specific error conditions
// - Transforming error messages while preserving original errors
// - Implementing conditional recovery based on error types
//
// Example - Error recovery:
//
// failingDecoder := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "not found"},
// })
// }
//
// recoverFromNotFound := ChainLeft(func(errs Errors) Decode[string, int] {
// for _, err := range errs {
// if err.Messsage == "not found" {
// return Of[string](0) // recover with default
// }
// }
// return func(input string) Validation[int] {
// return either.Left[int](errs)
// }
// })
//
// decoder := recoverFromNotFound(failingDecoder)
// result := decoder("input") // Success(0) - recovered from failure
//
// Example - Adding context:
//
// addContext := ChainLeft(func(errs Errors) Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {
// Context: validation.Context{{Key: "user", Type: "User"}, {Key: "age", Type: "int"}},
// Messsage: "failed to decode user age",
// },
// })
// }
// })
// // Result will contain BOTH original error and context error
func ChainLeft[I, A any](f Kleisli[I, Errors, A]) Operator[I, A, A] {
return readert.Chain[Decode[I, A]](
validation.ChainLeft,
@@ -57,6 +187,147 @@ func ChainLeft[I, A any](f Kleisli[I, Errors, A]) Operator[I, A, A] {
)
}
// MonadChainLeft transforms the error channel of a decoder, enabling error recovery and context addition.
// This is the uncurried version of ChainLeft, taking both the decoder and the transformation function directly.
//
// **Key behaviors**:
// - Success values pass through unchanged - the handler is never called
// - On failure, the handler receives the errors and can recover or add context
// - When the handler also fails, **both original and new errors are aggregated**
// - The handler returns a Decode[I, A], giving it access to the original input
//
// **Error Aggregation**: Unlike standard Either operations, when the transformation function
// returns a failure, both the original errors AND the new errors are combined using the
// Errors monoid. This ensures no validation errors are lost.
//
// This function is the direct, uncurried form of ChainLeft. Use ChainLeft when you need
// a curried operator for composition pipelines, and use MonadChainLeft when you have both
// the decoder and transformation function available at once.
//
// Use cases:
// - Adding contextual information to validation errors
// - Recovering from specific error conditions
// - Transforming error messages while preserving original errors
// - Implementing conditional recovery based on error types
//
// Example - Error recovery:
//
// failingDecoder := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "not found"},
// })
// }
//
// recoverFromNotFound := func(errs Errors) Decode[string, int] {
// for _, err := range errs {
// if err.Messsage == "not found" {
// return Of[string](0) // recover with default
// }
// }
// return func(input string) Validation[int] {
// return either.Left[int](errs)
// }
// }
//
// decoder := MonadChainLeft(failingDecoder, recoverFromNotFound)
// result := decoder("input") // Success(0) - recovered from failure
//
// Example - Adding context:
//
// addContext := func(errs Errors) Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {
// Context: validation.Context{{Key: "user", Type: "User"}, {Key: "age", Type: "int"}},
// Messsage: "failed to decode user age",
// },
// })
// }
// }
//
// decoder := MonadChainLeft(failingDecoder, addContext)
// result := decoder("abc")
// // Result will contain BOTH original error and context error
//
// Example - Comparison with ChainLeft:
//
// // MonadChainLeft - direct application
// result1 := MonadChainLeft(decoder, handler)("input")
//
// // ChainLeft - curried for pipelines
// result2 := ChainLeft(handler)(decoder)("input")
//
// // Both produce identical results
func MonadChainLeft[I, A any](fa Decode[I, A], f Kleisli[I, Errors, A]) Decode[I, A] {
return readert.MonadChain(
validation.MonadChainLeft,
fa,
f,
)
}
// OrElse provides fallback decoding logic when the primary decoder fails.
// This is an alias for ChainLeft with a more semantic name for fallback scenarios.
//
// **OrElse is exactly the same as ChainLeft** - they are aliases with identical implementations
// and behavior. The choice between them is purely about code readability and semantic intent:
// - Use **OrElse** when emphasizing fallback/alternative decoding logic
// - Use **ChainLeft** when emphasizing technical error channel transformation
//
// **Key behaviors** (identical to ChainLeft):
// - Success values pass through unchanged - the handler is never called
// - On failure, the handler receives the errors and can provide an alternative
// - When the handler also fails, **both original and new errors are aggregated**
// - The handler returns a Decode[I, A], giving it access to the original input
//
// The name "OrElse" reads naturally in code: "try this decoder, or else try this alternative."
// This makes it ideal for expressing fallback logic and default values.
//
// Use cases:
// - Providing default values when decoding fails
// - Trying alternative decoding strategies
// - Implementing fallback chains with multiple alternatives
// - Input-dependent recovery (using access to original input)
//
// Example - Simple fallback:
//
// primaryDecoder := func(input string) Validation[int] {
// n, err := strconv.Atoi(input)
// if err != nil {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "not a valid integer"},
// })
// }
// return validation.Of(n)
// }
//
// withDefault := OrElse(func(errs Errors) Decode[string, int] {
// return Of[string](0) // default to 0 if decoding fails
// })
//
// decoder := withDefault(primaryDecoder)
// result1 := decoder("42") // Success(42)
// result2 := decoder("abc") // Success(0) - fallback
//
// Example - Input-dependent fallback:
//
// smartDefault := OrElse(func(errs Errors) Decode[string, int] {
// return func(input string) Validation[int] {
// // Access original input to determine appropriate default
// if strings.Contains(input, "http") {
// return validation.Of(80)
// }
// if strings.Contains(input, "https") {
// return validation.Of(443)
// }
// return validation.Of(8080)
// }
// })
//
// decoder := smartDefault(decodePort)
// result1 := decoder("http-server") // Success(80)
// result2 := decoder("https-server") // Success(443)
// result3 := decoder("other") // Success(8080)
func OrElse[I, A any](f Kleisli[I, Errors, A]) Operator[I, A, A] {
return ChainLeft(f)
}
@@ -138,3 +409,155 @@ func Ap[B, I, A any](fa Decode[I, A]) Operator[I, func(A) B, B] {
fa,
)
}
// MonadAlt provides alternative/fallback decoding with error aggregation.
// This is the Alternative pattern's core operation that tries the first decoder,
// and if it fails, tries the second decoder as a fallback.
//
// **Key behaviors**:
// - If first succeeds: returns the first result (second is never evaluated)
// - If first fails and second succeeds: returns the second result
// - If both fail: **aggregates errors from both decoders**
//
// **Error Aggregation**: Unlike simple fallback patterns, when both decoders fail,
// MonadAlt combines ALL errors from both attempts using the Errors monoid. This ensures
// complete visibility into why all alternatives failed, which is crucial for debugging
// and providing comprehensive error messages to users.
//
// The name "Alt" comes from the Alternative type class in functional programming,
// which represents computations with a notion of choice and failure.
//
// Use cases:
// - Trying multiple decoding strategies for the same input
// - Providing fallback decoders when primary decoder fails
// - Building validation pipelines with multiple alternatives
// - Implementing "try this, or else try that" logic
//
// Example - Simple fallback:
//
// primaryDecoder := func(input string) Validation[int] {
// n, err := strconv.Atoi(input)
// if err != nil {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "not a valid integer"},
// })
// }
// return validation.Of(n)
// }
//
// fallbackDecoder := func() Decode[string, int] {
// return func(input string) Validation[int] {
// // Try parsing as float and converting to int
// f, err := strconv.ParseFloat(input, 64)
// if err != nil {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "not a valid number"},
// })
// }
// return validation.Of(int(f))
// }
// }
//
// decoder := MonadAlt(primaryDecoder, fallbackDecoder)
// result1 := decoder("42") // Success(42) - primary succeeds
// result2 := decoder("42.5") // Success(42) - fallback succeeds
// result3 := decoder("abc") // Failures with both errors aggregated
//
// Example - Multiple alternatives:
//
// decoder1 := parseAsJSON
// decoder2 := func() Decode[string, Config] { return parseAsYAML }
// decoder3 := func() Decode[string, Config] { return parseAsINI }
//
// // Try JSON, then YAML, then INI
// decoder := MonadAlt(MonadAlt(decoder1, decoder2), decoder3)
// // If all fail, errors from all three attempts are aggregated
//
// Example - Error aggregation:
//
// failing1 := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Messsage: "primary decoder failed"},
// })
// }
// failing2 := func() Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Messsage: "fallback decoder failed"},
// })
// }
// }
//
// decoder := MonadAlt(failing1, failing2)
// result := decoder("input")
// // Result contains BOTH errors: ["primary decoder failed", "fallback decoder failed"]
func MonadAlt[I, A any](first Decode[I, A], second Lazy[Decode[I, A]]) Decode[I, A] {
return MonadChainLeft(first, function.Ignore1of1[Errors](second))
}
// Alt creates an operator that provides alternative/fallback decoding with error aggregation.
// This is the curried version of MonadAlt, useful for composition pipelines.
//
// **Key behaviors** (identical to MonadAlt):
// - If first succeeds: returns the first result (second is never evaluated)
// - If first fails and second succeeds: returns the second result
// - If both fail: **aggregates errors from both decoders**
//
// The Alt operator enables building reusable fallback chains that can be applied
// to different decoders. It reads naturally in pipelines: "apply this decoder,
// with this alternative if it fails."
//
// Use cases:
// - Creating reusable fallback strategies
// - Building decoder combinators with alternatives
// - Composing multiple fallback layers
// - Implementing retry logic with different strategies
//
// Example - Creating a reusable fallback:
//
// // Create an operator that falls back to a default value
// withDefault := Alt(func() Decode[string, int] {
// return Of[string](0)
// })
//
// // Apply to any decoder
// decoder1 := withDefault(parseInteger)
// decoder2 := withDefault(parseFromJSON)
//
// result1 := decoder1("42") // Success(42)
// result2 := decoder1("abc") // Success(0) - fallback
//
// Example - Composing multiple alternatives:
//
// tryYAML := Alt(func() Decode[string, Config] { return parseAsYAML })
// tryINI := Alt(func() Decode[string, Config] { return parseAsINI })
// useDefault := Alt(func() Decode[string, Config] {
// return Of[string](defaultConfig)
// })
//
// // Build a pipeline: try JSON, then YAML, then INI, then default
// decoder := useDefault(tryINI(tryYAML(parseAsJSON)))
//
// Example - Error aggregation in pipeline:
//
// failing1 := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{{Messsage: "error 1"}})
// }
// failing2 := func() Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{{Messsage: "error 2"}})
// }
// }
// failing3 := func() Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{{Messsage: "error 3"}})
// }
// }
//
// // Chain multiple alternatives
// decoder := Alt(failing3)(Alt(failing2)(failing1))
// result := decoder("input")
// // Result contains ALL errors: ["error 1", "error 2", "error 3"]
func Alt[I, A any](second Lazy[Decode[I, A]]) Operator[I, A, A] {
return ChainLeft(function.Ignore1of1[Errors](second))
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,368 @@
package decode
import "github.com/IBM/fp-go/v2/monoid"
// ApplicativeMonoid creates a Monoid instance for Decode[I, A] given a Monoid for A.
// This allows combining decoders where both the decoded values and validation errors
// are combined according to their respective monoid operations.
//
// The resulting monoid enables:
// - Combining multiple decoders that produce monoidal values
// - Accumulating validation errors when any decoder fails
// - Building complex decoders from simpler ones through composition
//
// **Behavior**:
// - Empty: Returns a decoder that always succeeds with the empty value from the inner monoid
// - Concat: Combines two decoders:
// - Both succeed: Combines decoded values using the inner monoid
// - Any fails: Accumulates all validation errors using the Errors monoid
//
// This is particularly useful for:
// - Aggregating results from multiple independent decoders
// - Building decoders that combine partial results
// - Validating and combining configuration from multiple sources
// - Parallel validation with result accumulation
//
// Example - Combining string decoders:
//
// import S "github.com/IBM/fp-go/v2/string"
//
// // Create a monoid for decoders that produce strings
// m := ApplicativeMonoid[map[string]any](S.Monoid)
//
// decoder1 := func(data map[string]any) Validation[string] {
// if name, ok := data["firstName"].(string); ok {
// return validation.Of(name)
// }
// return either.Left[string](validation.Errors{
// {Messsage: "missing firstName"},
// })
// }
//
// decoder2 := func(data map[string]any) Validation[string] {
// if name, ok := data["lastName"].(string); ok {
// return validation.Of(" " + name)
// }
// return either.Left[string](validation.Errors{
// {Messsage: "missing lastName"},
// })
// }
//
// // Combine decoders - will concatenate strings if both succeed
// combined := m.Concat(decoder1, decoder2)
// result := combined(map[string]any{
// "firstName": "John",
// "lastName": "Doe",
// }) // Success("John Doe")
//
// Example - Error accumulation:
//
// // If any decoder fails, errors are accumulated
// result := combined(map[string]any{}) // Failures with both error messages
//
// Example - Numeric aggregation:
//
// import N "github.com/IBM/fp-go/v2/number"
//
// intMonoid := monoid.MakeMonoid(N.Add[int], 0)
// m := ApplicativeMonoid[string](intMonoid)
//
// decoder1 := func(input string) Validation[int] {
// return validation.Of(10)
// }
// decoder2 := func(input string) Validation[int] {
// return validation.Of(32)
// }
//
// combined := m.Concat(decoder1, decoder2)
// result := combined("input") // Success(42) - values are added
func ApplicativeMonoid[I, A any](m Monoid[A]) Monoid[Decode[I, A]] {
return monoid.ApplicativeMonoid(
Of[I, A],
MonadMap[I, A, Endomorphism[A]],
MonadAp[A, I, A],
m,
)
}
// AlternativeMonoid creates a Monoid instance for Decode[I, A] using the Alternative pattern.
// This combines applicative error-accumulation behavior with alternative fallback behavior,
// allowing you to both accumulate errors and provide fallback alternatives when combining decoders.
//
// The Alternative pattern provides two key operations:
// - Applicative operations (Of, Map, Ap): accumulate errors when combining decoders
// - Alternative operation (Alt): provide fallback when a decoder fails
//
// This monoid is particularly useful when you want to:
// - Try multiple decoding strategies and fall back to alternatives
// - Combine successful values using the provided monoid
// - Accumulate all errors from failed attempts
// - Build decoding pipelines with fallback logic
//
// **Behavior**:
// - Empty: Returns a decoder that always succeeds with the empty value from the inner monoid
// - Concat: Combines two decoders using both applicative and alternative semantics:
// - If first succeeds and second succeeds: combines decoded values using inner monoid
// - If first fails: tries second as fallback (alternative behavior)
// - If both fail: **accumulates all errors from both decoders**
//
// **Error Aggregation**: When both decoders fail, all validation errors from both attempts
// are combined using the Errors monoid. This provides complete visibility into why all
// alternatives failed, which is essential for debugging and user feedback.
//
// Type Parameters:
// - I: The input type being decoded
// - A: The output type after successful decoding
//
// Parameters:
// - m: The monoid for combining successful decoded values of type A
//
// Returns:
//
// A Monoid[Decode[I, A]] that combines applicative and alternative behaviors
//
// Example - Combining successful decoders:
//
// import S "github.com/IBM/fp-go/v2/string"
//
// m := AlternativeMonoid[string](S.Monoid)
//
// decoder1 := func(input string) Validation[string] {
// return validation.Of("Hello")
// }
// decoder2 := func(input string) Validation[string] {
// return validation.Of(" World")
// }
//
// combined := m.Concat(decoder1, decoder2)
// result := combined("input")
// // Result: Success("Hello World") - values combined using string monoid
//
// Example - Fallback behavior:
//
// m := AlternativeMonoid[string](S.Monoid)
//
// failing := func(input string) Validation[string] {
// return either.Left[string](validation.Errors{
// {Value: input, Messsage: "primary failed"},
// })
// }
// fallback := func(input string) Validation[string] {
// return validation.Of("fallback value")
// }
//
// combined := m.Concat(failing, fallback)
// result := combined("input")
// // Result: Success("fallback value") - second decoder used as fallback
//
// Example - Error accumulation when both fail:
//
// m := AlternativeMonoid[string](S.Monoid)
//
// failing1 := func(input string) Validation[string] {
// return either.Left[string](validation.Errors{
// {Value: input, Messsage: "error 1"},
// })
// }
// failing2 := func(input string) Validation[string] {
// return either.Left[string](validation.Errors{
// {Value: input, Messsage: "error 2"},
// })
// }
//
// combined := m.Concat(failing1, failing2)
// result := combined("input")
// // Result: Failures with accumulated errors: ["error 1", "error 2"]
//
// Example - Building decoder with multiple fallbacks:
//
// import N "github.com/IBM/fp-go/v2/number"
//
// m := AlternativeMonoid[string](N.MonoidSum[int]())
//
// // Try to parse from different formats
// parseJSON := func(input string) Validation[int] { /* ... */ }
// parseYAML := func(input string) Validation[int] { /* ... */ }
// parseINI := func(input string) Validation[int] { /* ... */ }
//
// // Combine with fallback chain
// decoder := m.Concat(m.Concat(parseJSON, parseYAML), parseINI)
// // Uses first successful parser, or accumulates all errors if all fail
//
// Example - Combining multiple configuration sources:
//
// type Config struct{ Port int }
// configMonoid := monoid.MakeMonoid(
// func(a, b Config) Config {
// if b.Port != 0 { return b }
// return a
// },
// Config{Port: 0},
// )
//
// m := AlternativeMonoid[map[string]any](configMonoid)
//
// fromEnv := func(data map[string]any) Validation[Config] { /* ... */ }
// fromFile := func(data map[string]any) Validation[Config] { /* ... */ }
// fromDefault := func(data map[string]any) Validation[Config] {
// return validation.Of(Config{Port: 8080})
// }
//
// // Try env, then file, then default
// decoder := m.Concat(m.Concat(fromEnv, fromFile), fromDefault)
// // Returns first successful config, or all errors if all fail
func AlternativeMonoid[I, A any](m Monoid[A]) Monoid[Decode[I, A]] {
return monoid.AlternativeMonoid(
Of[I, A],
MonadMap[I, A, func(A) A],
MonadAp[A, I, A],
MonadAlt[I, A],
m,
)
}
// AltMonoid creates a Monoid instance for Decode[I, A] using the Alt (alternative) operation.
// This monoid provides a way to combine decoders with fallback behavior, where the second
// decoder is used as an alternative if the first one fails.
//
// The Alt operation implements the "try first, fallback to second" pattern, which is useful
// for decoding scenarios where you want to attempt multiple decoding strategies in sequence
// and use the first one that succeeds.
//
// **Behavior**:
// - Empty: Returns the provided zero value (a lazy computation that produces a Decode[I, A])
// - Concat: Combines two decoders using Alt semantics:
// - If first succeeds: returns the first result (second is never evaluated)
// - If first fails: tries the second decoder as fallback
// - If both fail: **aggregates errors from both decoders**
//
// **Error Aggregation**: When both decoders fail, all validation errors from both attempts
// are combined using the Errors monoid. This ensures complete visibility into why all
// alternatives failed.
//
// This is different from [AlternativeMonoid] in that:
// - AltMonoid uses a custom zero value (provided by the user)
// - AlternativeMonoid derives the zero from an inner monoid
// - AltMonoid is simpler and only provides fallback behavior
// - AlternativeMonoid combines applicative and alternative behaviors
//
// Type Parameters:
// - I: The input type being decoded
// - A: The output type after successful decoding
//
// Parameters:
// - zero: A lazy computation that produces the identity/empty Decode[I, A].
// This is typically a decoder that always succeeds with a default value, or could be
// a decoder that always fails representing "no decoding attempted"
//
// Returns:
//
// A Monoid[Decode[I, A]] that combines decoders with fallback behavior
//
// Example - Using default value as zero:
//
// m := AltMonoid(func() Decode[string, int] {
// return Of[string](0)
// })
//
// failing := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "failed"},
// })
// }
// succeeding := func(input string) Validation[int] {
// return validation.Of(42)
// }
//
// combined := m.Concat(failing, succeeding)
// result := combined("input")
// // Result: Success(42) - falls back to second decoder
//
// empty := m.Empty()
// result2 := empty("input")
// // Result: Success(0) - the provided zero value
//
// Example - Chaining multiple fallbacks:
//
// m := AltMonoid(func() Decode[string, Config] {
// return Of[string](defaultConfig)
// })
//
// primary := parseFromPrimarySource // Fails
// secondary := parseFromSecondarySource // Fails
// tertiary := parseFromTertiarySource // Succeeds
//
// // Chain fallbacks
// decoder := m.Concat(m.Concat(primary, secondary), tertiary)
// result := decoder("input")
// // Result: Success from tertiary - uses first successful decoder
//
// Example - Error aggregation when all fail:
//
// m := AltMonoid(func() Decode[string, int] {
// return func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Messsage: "no default available"},
// })
// }
// })
//
// failing1 := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "error 1"},
// })
// }
// failing2 := func(input string) Validation[int] {
// return either.Left[int](validation.Errors{
// {Value: input, Messsage: "error 2"},
// })
// }
//
// combined := m.Concat(failing1, failing2)
// result := combined("input")
// // Result: Failures with accumulated errors: ["error 1", "error 2"]
//
// Example - Building a decoder pipeline with fallbacks:
//
// m := AltMonoid(func() Decode[string, Config] {
// return Of[string](defaultConfig)
// })
//
// // Try multiple decoding sources in order
// decoders := []Decode[string, Config]{
// loadFromFile("config.json"), // Try file first
// loadFromEnv, // Then environment
// loadFromRemote("api.example.com"), // Then remote API
// }
//
// // Fold using the monoid to get first successful config
// result := array.MonoidFold(m)(decoders)
// // Result: First successful config, or defaultConfig if all fail
//
// Example - Comparing with AlternativeMonoid:
//
// // AltMonoid - simple fallback with custom zero
// altM := AltMonoid(func() Decode[string, int] {
// return Of[string](0)
// })
//
// // AlternativeMonoid - combines values when both succeed
// import N "github.com/IBM/fp-go/v2/number"
// altMonoid := AlternativeMonoid[string](N.MonoidSum[int]())
//
// decoder1 := Of[string](10)
// decoder2 := Of[string](32)
//
// // AltMonoid: returns first success (10)
// result1 := altM.Concat(decoder1, decoder2)("input")
// // Result: Success(10)
//
// // AlternativeMonoid: combines both successes (10 + 32 = 42)
// result2 := altMonoid.Concat(decoder1, decoder2)("input")
// // Result: Success(42)
func AltMonoid[I, A any](zero Lazy[Decode[I, A]]) Monoid[Decode[I, A]] {
return monoid.AltMonoid(
zero,
MonadAlt[I, A],
)
}

View File

@@ -0,0 +1,970 @@
package decode
import (
"testing"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
MO "github.com/IBM/fp-go/v2/monoid"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/optics/codec/validation"
S "github.com/IBM/fp-go/v2/string"
"github.com/stretchr/testify/assert"
)
func TestApplicativeMonoid(t *testing.T) {
t.Run("with string monoid", func(t *testing.T) {
m := ApplicativeMonoid[string](S.Monoid)
t.Run("empty returns decoder that succeeds with empty string", func(t *testing.T) {
empty := m.Empty()
result := empty("any input")
assert.Equal(t, validation.Of(""), result)
})
t.Run("concat combines successful decoders", func(t *testing.T) {
decoder1 := Of[string]("Hello")
decoder2 := Of[string](" World")
combined := m.Concat(decoder1, decoder2)
result := combined("input")
assert.Equal(t, validation.Of("Hello World"), result)
})
t.Run("concat with failure returns failure", func(t *testing.T) {
decoder1 := Of[string]("Hello")
decoder2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "decode failed"},
})
}
combined := m.Concat(decoder1, decoder2)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.Len(t, errors, 1)
assert.Equal(t, "decode failed", errors[0].Messsage)
})
t.Run("concat accumulates all errors from both failures", func(t *testing.T) {
decoder1 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
decoder2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
combined := m.Concat(decoder1, decoder2)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.Len(t, errors, 2)
messages := []string{errors[0].Messsage, errors[1].Messsage}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
t.Run("concat with empty preserves decoder", func(t *testing.T) {
decoder := Of[string]("test")
empty := m.Empty()
result1 := m.Concat(decoder, empty)("input")
result2 := m.Concat(empty, decoder)("input")
val1 := either.MonadFold(result1,
func(Errors) string { return "" },
F.Identity[string],
)
val2 := either.MonadFold(result2,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "test", val1)
assert.Equal(t, "test", val2)
})
})
t.Run("with int addition monoid", func(t *testing.T) {
intMonoid := MO.MakeMonoid(
func(a, b int) int { return a + b },
0,
)
m := ApplicativeMonoid[string](intMonoid)
t.Run("empty returns decoder with zero", func(t *testing.T) {
empty := m.Empty()
result := empty("input")
value := either.MonadFold(result,
func(Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
})
t.Run("concat adds decoded values", func(t *testing.T) {
decoder1 := Of[string](10)
decoder2 := Of[string](32)
combined := m.Concat(decoder1, decoder2)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
})
t.Run("multiple concat operations", func(t *testing.T) {
decoder1 := Of[string](1)
decoder2 := Of[string](2)
decoder3 := Of[string](3)
decoder4 := Of[string](4)
combined := m.Concat(m.Concat(m.Concat(decoder1, decoder2), decoder3), decoder4)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value)
})
})
t.Run("with map input type", func(t *testing.T) {
m := ApplicativeMonoid[map[string]any](S.Monoid)
t.Run("combines decoders with different inputs", func(t *testing.T) {
decoder1 := func(data map[string]any) Validation[string] {
if name, ok := data["firstName"].(string); ok {
return validation.Of(name)
}
return either.Left[string](validation.Errors{
{Messsage: "missing firstName"},
})
}
decoder2 := func(data map[string]any) Validation[string] {
if name, ok := data["lastName"].(string); ok {
return validation.Of(" " + name)
}
return either.Left[string](validation.Errors{
{Messsage: "missing lastName"},
})
}
combined := m.Concat(decoder1, decoder2)
// Test success case
result1 := combined(map[string]any{
"firstName": "John",
"lastName": "Doe",
})
value1 := either.MonadFold(result1,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "John Doe", value1)
// Test failure case - both fields missing
result2 := combined(map[string]any{})
assert.True(t, either.IsLeft(result2))
errors := either.MonadFold(result2,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.Len(t, errors, 2)
})
})
}
func TestMonoidLaws(t *testing.T) {
t.Run("ApplicativeMonoid satisfies monoid laws", func(t *testing.T) {
m := ApplicativeMonoid[string](S.Monoid)
decoder1 := Of[string]("a")
decoder2 := Of[string]("b")
t.Run("left identity", func(t *testing.T) {
// empty + a = a
result := m.Concat(m.Empty(), decoder1)("input")
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("right identity", func(t *testing.T) {
// a + empty = a
result := m.Concat(decoder1, m.Empty())("input")
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("associativity", func(t *testing.T) {
decoder3 := Of[string]("c")
// (a + b) + c = a + (b + c)
left := m.Concat(m.Concat(decoder1, decoder2), decoder3)("input")
right := m.Concat(decoder1, m.Concat(decoder2, decoder3))("input")
leftVal := either.MonadFold(left,
func(Errors) string { return "" },
F.Identity[string],
)
rightVal := either.MonadFold(right,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "abc", leftVal)
assert.Equal(t, "abc", rightVal)
})
})
}
func TestApplicativeMonoidWithFailures(t *testing.T) {
m := ApplicativeMonoid[string](S.Monoid)
t.Run("failure propagates through concat", func(t *testing.T) {
decoder1 := Of[string]("a")
decoder2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error"},
})
}
decoder3 := Of[string]("c")
combined := m.Concat(m.Concat(decoder1, decoder2), decoder3)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.Len(t, errors, 1)
})
t.Run("multiple failures accumulate", func(t *testing.T) {
decoder1 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
decoder2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
decoder3 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 3"},
})
}
combined := m.Concat(m.Concat(decoder1, decoder2), decoder3)
result := combined("input")
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.Len(t, errors, 3)
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
assert.Contains(t, messages, "error 3")
})
}
func TestApplicativeMonoidEdgeCases(t *testing.T) {
t.Run("with custom struct monoid", func(t *testing.T) {
type Counter struct{ Count int }
counterMonoid := MO.MakeMonoid(
func(a, b Counter) Counter { return Counter{Count: a.Count + b.Count} },
Counter{Count: 0},
)
m := ApplicativeMonoid[string](counterMonoid)
decoder1 := Of[string](Counter{Count: 5})
decoder2 := Of[string](Counter{Count: 10})
combined := m.Concat(decoder1, decoder2)
result := combined("input")
value := either.MonadFold(result,
func(Errors) Counter { return Counter{} },
F.Identity[Counter],
)
assert.Equal(t, 15, value.Count)
})
t.Run("empty concat empty", func(t *testing.T) {
m := ApplicativeMonoid[string](S.Monoid)
combined := m.Concat(m.Empty(), m.Empty())
result := combined("input")
value := either.MonadFold(result,
func(Errors) string { return "ERROR" },
F.Identity[string],
)
assert.Equal(t, "", value)
})
t.Run("with different input types", func(t *testing.T) {
intMonoid := MO.MakeMonoid(
func(a, b int) int { return a + b },
0,
)
m := ApplicativeMonoid[int](intMonoid)
decoder1 := func(input int) Validation[int] {
return validation.Of(input * 2)
}
decoder2 := func(input int) Validation[int] {
return validation.Of(input + 10)
}
combined := m.Concat(decoder1, decoder2)
result := combined(5)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
// (5 * 2) + (5 + 10) = 10 + 15 = 25
assert.Equal(t, 25, value)
})
}
func TestApplicativeMonoidRealWorldScenarios(t *testing.T) {
t.Run("combining configuration from multiple sources", func(t *testing.T) {
type Config struct {
Host string
Port int
}
// Monoid that combines configs (last non-empty wins for strings, sum for ints)
configMonoid := MO.MakeMonoid(
func(a, b Config) Config {
host := a.Host
if b.Host != "" {
host = b.Host
}
return Config{
Host: host,
Port: a.Port + b.Port,
}
},
Config{Host: "", Port: 0},
)
m := ApplicativeMonoid[map[string]any](configMonoid)
decoder1 := func(data map[string]any) Validation[Config] {
if host, ok := data["host"].(string); ok {
return validation.Of(Config{Host: host, Port: 0})
}
return either.Left[Config](validation.Errors{
{Messsage: "missing host"},
})
}
decoder2 := func(data map[string]any) Validation[Config] {
if port, ok := data["port"].(int); ok {
return validation.Of(Config{Host: "", Port: port})
}
return either.Left[Config](validation.Errors{
{Messsage: "missing port"},
})
}
combined := m.Concat(decoder1, decoder2)
// Success case
result := combined(map[string]any{
"host": "localhost",
"port": 8080,
})
config := either.MonadFold(result,
func(Errors) Config { return Config{} },
F.Identity[Config],
)
assert.Equal(t, "localhost", config.Host)
assert.Equal(t, 8080, config.Port)
})
t.Run("aggregating validation results", func(t *testing.T) {
intMonoid := MO.MakeMonoid(
func(a, b int) int { return a + b },
0,
)
m := ApplicativeMonoid[string](intMonoid)
// Decoder that extracts and validates a number
makeDecoder := func(value int, shouldFail bool) Decode[string, int] {
return func(input string) Validation[int] {
if shouldFail {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "validation failed"},
})
}
return validation.Of(value)
}
}
// All succeed - values are summed
decoder1 := makeDecoder(10, false)
decoder2 := makeDecoder(20, false)
decoder3 := makeDecoder(12, false)
combined := m.Concat(m.Concat(decoder1, decoder2), decoder3)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
// Some fail - errors are accumulated
decoder4 := makeDecoder(10, true)
decoder5 := makeDecoder(20, true)
combinedFail := m.Concat(decoder4, decoder5)
resultFail := combinedFail("input")
assert.True(t, either.IsLeft(resultFail))
errors := either.MonadFold(resultFail,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.Len(t, errors, 2)
})
}
// TestAlternativeMonoid tests the AlternativeMonoid function
func TestAlternativeMonoid(t *testing.T) {
t.Run("with string monoid", func(t *testing.T) {
m := AlternativeMonoid[string](S.Monoid)
t.Run("empty returns decoder that succeeds with empty string", func(t *testing.T) {
empty := m.Empty()
result := empty("input")
assert.Equal(t, validation.Of(""), result)
})
t.Run("concat combines successful decoders using monoid", func(t *testing.T) {
decoder1 := Of[string]("Hello")
decoder2 := Of[string](" World")
combined := m.Concat(decoder1, decoder2)
result := combined("input")
assert.Equal(t, validation.Of("Hello World"), result)
})
t.Run("concat uses second as fallback when first fails", func(t *testing.T) {
failing := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "first failed"},
})
}
succeeding := Of[string]("fallback")
combined := m.Concat(failing, succeeding)
result := combined("input")
assert.Equal(t, validation.Of("fallback"), result)
})
t.Run("concat aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
failing2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
combined := m.Concat(failing1, failing2)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both decoders")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
t.Run("concat with empty preserves decoder", func(t *testing.T) {
decoder := Of[string]("test")
empty := m.Empty()
result1 := m.Concat(decoder, empty)("input")
result2 := m.Concat(empty, decoder)("input")
val1 := either.MonadFold(result1,
func(Errors) string { return "" },
F.Identity[string],
)
val2 := either.MonadFold(result2,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "test", val1)
assert.Equal(t, "test", val2)
})
})
t.Run("with int addition monoid", func(t *testing.T) {
intMonoid := MO.MakeMonoid(
func(a, b int) int { return a + b },
0,
)
m := AlternativeMonoid[string](intMonoid)
t.Run("empty returns decoder with zero", func(t *testing.T) {
empty := m.Empty()
result := empty("input")
value := either.MonadFold(result,
func(Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
})
t.Run("concat combines decoded values when both succeed", func(t *testing.T) {
decoder1 := Of[string](10)
decoder2 := Of[string](32)
combined := m.Concat(decoder1, decoder2)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
})
t.Run("concat uses fallback when first fails", func(t *testing.T) {
failing := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
succeeding := Of[string](42)
combined := m.Concat(failing, succeeding)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
})
t.Run("multiple concat operations", func(t *testing.T) {
decoder1 := Of[string](1)
decoder2 := Of[string](2)
decoder3 := Of[string](3)
decoder4 := Of[string](4)
combined := m.Concat(m.Concat(m.Concat(decoder1, decoder2), decoder3), decoder4)
result := combined("input")
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value)
})
})
t.Run("satisfies monoid laws", func(t *testing.T) {
m := AlternativeMonoid[string](S.Monoid)
decoder1 := Of[string]("a")
decoder2 := Of[string]("b")
decoder3 := Of[string]("c")
t.Run("left identity", func(t *testing.T) {
result := m.Concat(m.Empty(), decoder1)("input")
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("right identity", func(t *testing.T) {
result := m.Concat(decoder1, m.Empty())("input")
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("associativity", func(t *testing.T) {
left := m.Concat(m.Concat(decoder1, decoder2), decoder3)("input")
right := m.Concat(decoder1, m.Concat(decoder2, decoder3))("input")
leftVal := either.MonadFold(left,
func(Errors) string { return "" },
F.Identity[string],
)
rightVal := either.MonadFold(right,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "abc", leftVal)
assert.Equal(t, "abc", rightVal)
})
})
t.Run("error aggregation with multiple failures", func(t *testing.T) {
m := AlternativeMonoid[string](S.Monoid)
failing1 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
failing2 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
failing3 := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 3"},
})
}
combined := m.Concat(m.Concat(failing1, failing2), failing3)
result := combined("input")
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 3, "Should aggregate errors from all decoders")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
assert.Contains(t, messages, "error 3")
})
}
// TestAltMonoid tests the AltMonoid function
func TestAltMonoid(t *testing.T) {
t.Run("with default value as zero", func(t *testing.T) {
m := AltMonoid(func() Decode[string, int] {
return Of[string](0)
})
t.Run("empty returns the provided zero decoder", func(t *testing.T) {
empty := m.Empty()
result := empty("input")
assert.Equal(t, validation.Of(0), result)
})
t.Run("concat returns first decoder when it succeeds", func(t *testing.T) {
decoder1 := Of[string](42)
decoder2 := Of[string](100)
combined := m.Concat(decoder1, decoder2)
result := combined("input")
assert.Equal(t, validation.Of(42), result)
})
t.Run("concat uses second as fallback when first fails", func(t *testing.T) {
failing := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
succeeding := Of[string](42)
combined := m.Concat(failing, succeeding)
result := combined("input")
assert.Equal(t, validation.Of(42), result)
})
t.Run("concat aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
failing2 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
combined := m.Concat(failing1, failing2)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both decoders")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
})
t.Run("with failing zero", func(t *testing.T) {
m := AltMonoid(func() Decode[string, int] {
return func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Messsage: "no default available"},
})
}
})
t.Run("empty returns the failing zero decoder", func(t *testing.T) {
empty := m.Empty()
result := empty("input")
assert.True(t, either.IsLeft(result))
})
t.Run("concat with all failures aggregates errors", func(t *testing.T) {
failing1 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
failing2 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
combined := m.Concat(failing1, failing2)
result := combined("input")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors")
})
})
t.Run("chaining multiple fallbacks", func(t *testing.T) {
m := AltMonoid(func() Decode[string, string] {
return Of[string]("default")
})
primary := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "primary failed"},
})
}
secondary := func(input string) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "secondary failed"},
})
}
tertiary := Of[string]("tertiary value")
combined := m.Concat(m.Concat(primary, secondary), tertiary)
result := combined("input")
assert.Equal(t, validation.Of("tertiary value"), result)
})
t.Run("satisfies monoid laws", func(t *testing.T) {
m := AltMonoid(func() Decode[string, int] {
return Of[string](0)
})
decoder1 := Of[string](1)
decoder2 := Of[string](2)
decoder3 := Of[string](3)
t.Run("left identity", func(t *testing.T) {
result := m.Concat(m.Empty(), decoder1)("input")
value := either.MonadFold(result,
func(Errors) int { return -1 },
F.Identity[int],
)
// With AltMonoid, first success wins, so empty (0) is returned
assert.Equal(t, 0, value)
})
t.Run("right identity", func(t *testing.T) {
result := m.Concat(decoder1, m.Empty())("input")
value := either.MonadFold(result,
func(Errors) int { return -1 },
F.Identity[int],
)
// First decoder succeeds, so 1 is returned
assert.Equal(t, 1, value)
})
t.Run("associativity", func(t *testing.T) {
// For AltMonoid, first success wins
left := m.Concat(m.Concat(decoder1, decoder2), decoder3)("input")
right := m.Concat(decoder1, m.Concat(decoder2, decoder3))("input")
leftVal := either.MonadFold(left,
func(Errors) int { return -1 },
F.Identity[int],
)
rightVal := either.MonadFold(right,
func(Errors) int { return -1 },
F.Identity[int],
)
// Both should return 1 (first success)
assert.Equal(t, 1, leftVal)
assert.Equal(t, 1, rightVal)
})
})
t.Run("difference from AlternativeMonoid", func(t *testing.T) {
// AltMonoid - first success wins
altM := AltMonoid(func() Decode[string, int] {
return Of[string](0)
})
// AlternativeMonoid - combines successes
altMonoid := AlternativeMonoid[string](N.MonoidSum[int]())
decoder1 := Of[string](10)
decoder2 := Of[string](32)
// AltMonoid: returns first success (10)
result1 := altM.Concat(decoder1, decoder2)("input")
value1 := either.MonadFold(result1,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value1, "AltMonoid returns first success")
// AlternativeMonoid: combines both successes (10 + 32 = 42)
result2 := altMonoid.Concat(decoder1, decoder2)("input")
value2 := either.MonadFold(result2,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value2, "AlternativeMonoid combines successes")
})
t.Run("error aggregation with context", func(t *testing.T) {
m := AltMonoid(func() Decode[string, int] {
return Of[string](0)
})
failing1 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{
Value: input,
Messsage: "parse error",
Context: validation.Context{{Key: "field", Type: "int"}},
},
})
}
failing2 := func(input string) Validation[int] {
return either.Left[int](validation.Errors{
{
Value: input,
Messsage: "validation error",
Context: validation.Context{{Key: "value", Type: "int"}},
},
})
}
combined := m.Concat(failing1, failing2)
result := combined("abc")
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should have errors from both decoders")
// Verify that errors with context are present
hasParseError := false
hasValidationError := false
for _, err := range errors {
if err.Messsage == "parse error" {
hasParseError = true
assert.NotNil(t, err.Context)
}
if err.Messsage == "validation error" {
hasValidationError = true
assert.NotNil(t, err.Context)
}
}
assert.True(t, hasParseError, "Should have parse error")
assert.True(t, hasValidationError, "Should have validation error")
})
}

View File

@@ -17,11 +17,60 @@ package decode
import (
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
)
type (
// Errors is a collection of validation errors that occurred during decoding.
// This is an alias for validation.Errors, which is []*ValidationError.
//
// Errors accumulates multiple validation failures, allowing decoders to report
// all problems at once rather than failing on the first error. This is particularly
// useful for form validation, API request validation, and configuration parsing
// where users benefit from seeing all issues simultaneously.
//
// The Errors type forms a Semigroup and Monoid, enabling:
// - Concatenation: Combining errors from multiple decoders
// - Accumulation: Collecting errors through applicative operations
// - Empty value: An empty slice representing no errors (success)
//
// Each error in the collection is a *ValidationError containing:
// - Value: The actual value that failed validation
// - Context: The path to the value in nested structures
// - Message: Human-readable error description
// - Cause: Optional underlying error
//
// Example:
//
// // Multiple validation failures
// errors := Errors{
// &validation.ValidationError{
// Value: "",
// Context: []validation.ContextEntry{{Key: "name"}},
// Messsage: "name is required",
// },
// &validation.ValidationError{
// Value: "invalid@",
// Context: []validation.ContextEntry{{Key: "email"}},
// Messsage: "invalid email format",
// },
// }
//
// // Create a failed validation with these errors
// result := validation.Failures[User](errors)
//
// // Errors can be combined using the monoid
// moreErrors := Errors{
// &validation.ValidationError{
// Value: -1,
// Context: []validation.ContextEntry{{Key: "age"}},
// Messsage: "age must be positive",
// },
// }
// allErrors := append(errors, moreErrors...)
Errors = validation.Errors
// Validation represents the result of a validation operation that may contain
@@ -219,4 +268,79 @@ type (
// LetL(nameLens, normalize),
// )
Endomorphism[A any] = endomorphism.Endomorphism[A]
// Monoid represents an algebraic structure with an associative binary operation
// and an identity element. This is an alias for monoid.Monoid[A].
//
// A Monoid[A] consists of:
// - Concat: func(A, A) A - An associative binary operation
// - Empty: func() A - An identity element
//
// In the decode context, monoids are used to combine multiple decoders or
// validation results. The most common use case is combining validation errors
// from multiple decoders using the Errors monoid.
//
// Properties:
// - Associativity: Concat(Concat(a, b), c) == Concat(a, Concat(b, c))
// - Identity: Concat(Empty(), a) == a == Concat(a, Empty())
//
// Common monoid instances:
// - Errors: Combines validation errors from multiple sources
// - Array: Concatenates arrays of decoded values
// - String: Concatenates strings
//
// Example:
//
// // Combine validation errors from multiple decoders
// errorsMonoid := validation.GetMonoid[int]()
//
// // Decode multiple fields and combine errors
// result1 := decodeField1(data) // Validation[string]
// result2 := decodeField2(data) // Validation[int]
//
// // If both fail, errors are combined using the monoid
// combined := errorsMonoid.Concat(result1, result2)
//
// // The monoid's Empty() provides a successful validation with no errors
// empty := errorsMonoid.Empty() // Success with no value
Monoid[A any] = monoid.Monoid[A]
// Lazy represents a deferred computation that produces a value of type A.
// This is an alias for lazy.Lazy[A], which is func() A.
//
// In the decode context, Lazy is used to defer expensive computations or
// recursive decoder definitions until they are actually needed. This is
// particularly important for:
// - Recursive data structures (e.g., trees, linked lists)
// - Expensive default values
// - Breaking circular dependencies in decoder definitions
//
// A Lazy[A] is simply a function that takes no arguments and returns A.
// The computation is only executed when the function is called, allowing
// for lazy evaluation and recursive definitions.
//
// Example:
//
// // Define a recursive decoder for a tree structure
// type Tree struct {
// Value int
// Children []Tree
// }
//
// // Use Lazy to break the circular dependency
// var decodeTree Decode[map[string]any, Tree]
// decodeTree = func(data map[string]any) Validation[Tree] {
// // Lazy evaluation allows referencing decodeTree within itself
// childrenDecoder := Array(Lazy(func() Decode[map[string]any, Tree] {
// return decodeTree
// }))
// // ... rest of decoder implementation
// }
//
// // Lazy default value that's only computed if needed
// expensiveDefault := Lazy(func() Config {
// // This computation only runs if the decode fails
// return computeExpensiveDefaultConfig()
// })
Lazy[A any] = lazy.Lazy[A]
)

View File

@@ -18,11 +18,10 @@ package codec
import (
"fmt"
"github.com/IBM/fp-go/v2/array"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/optics/codec/validate"
"github.com/IBM/fp-go/v2/optics/codec/validation"
)
// encodeEither creates an encoder for Either[A, B] values.
@@ -151,28 +150,20 @@ func validateEither[A, B, O, I any](
rightItem Type[B, O, I],
) Validate[I, either.Either[A, B]] {
return func(i I) Decode[Context, either.Either[A, B]] {
valRight := rightItem.Validate(i)
valLeft := leftItem.Validate(i)
valRight := F.Pipe1(
rightItem.Validate,
validate.Map[I, B](either.Right[A]),
)
return func(ctx Context) Validation[either.Either[A, B]] {
valLeft := F.Pipe1(
leftItem.Validate,
validate.Map[I, A](either.Left[B]),
)
resRight := valRight(ctx)
return either.Fold(
func(rightErrors validate.Errors) Validation[either.Either[A, B]] {
resLeft := valLeft(ctx)
return either.Fold(
func(leftErrors validate.Errors) Validation[either.Either[A, B]] {
return validation.Failures[either.Either[A, B]](array.Concat(leftErrors)(rightErrors))
},
F.Flow2(either.Left[B, A], validation.Of),
)(resLeft)
},
F.Flow2(either.Right[A, B], validation.Of),
)(resRight)
}
}
return F.Pipe1(
valRight,
validate.Alt(lazy.Of(valLeft)),
)
}
// Either creates a codec for Either[A, B] values.
@@ -265,12 +256,9 @@ func Either[A, B, O, I any](
leftItem Type[A, O, I],
rightItem Type[B, O, I],
) Type[either.Either[A, B], O, I] {
name := fmt.Sprintf("Either[%s, %s]", leftItem.Name(), rightItem.Name())
isEither := Is[either.Either[A, B]]()
return MakeType(
name,
isEither,
fmt.Sprintf("Either[%s, %s]", leftItem.Name(), rightItem.Name()),
Is[either.Either[A, B]](),
validateEither(leftItem, rightItem),
encodeEither(leftItem, rightItem),
)

View File

@@ -342,6 +342,27 @@ func TestEitherErrorAccumulation(t *testing.T) {
require.NotNil(t, errors)
// Should have errors from both string and int validation attempts
assert.NotEmpty(t, errors)
assert.GreaterOrEqual(t, len(errors), 2, "Should have at least 2 errors (one from Right validation, one from Left validation)")
// Verify we have errors from both validation attempts
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
// Check that we have errors related to both validations
hasIntError := false
hasStringError := false
for _, msg := range messages {
if msg == "expected integer string" || msg == "must be positive" {
hasIntError = true
}
if msg == "must not be empty" {
hasStringError = true
}
}
assert.True(t, hasIntError, "Should have error from integer validation (Right branch)")
assert.True(t, hasStringError, "Should have error from string validation (Left branch)")
})
}

View File

@@ -4,6 +4,7 @@ import (
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/internal/formatting"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/codec/decode"
"github.com/IBM/fp-go/v2/optics/codec/validate"
"github.com/IBM/fp-go/v2/optics/codec/validation"
@@ -40,6 +41,27 @@ type (
// Codec combines a Decoder and an Encoder for bidirectional transformations.
// It can decode input I to type A and encode type A to output O.
//
// This is a simple struct that pairs a decoder with an encoder, providing
// the basic building blocks for bidirectional data transformation. Unlike
// the Type interface, Codec is a concrete struct without validation context
// or type checking capabilities.
//
// Type Parameters:
// - I: The input type to decode from
// - O: The output type to encode to
// - A: The intermediate type (decoded to, encoded from)
//
// Fields:
// - Decode: A decoder that transforms I to A
// - Encode: An encoder that transforms A to O
//
// Example:
// A Codec[string, string, int] can decode strings to integers and
// encode integers back to strings.
//
// Note: For most use cases, prefer using the Type interface which provides
// additional validation and type checking capabilities.
Codec[I, O, A any] struct {
Decode decoder.Decoder[I, A]
Encode encoder.Encoder[O, A]
@@ -55,16 +77,82 @@ type (
// Validate is a function that validates input I to produce type A.
// It takes an input and returns a Reader that depends on the validation Context.
//
// The Validate type is the core validation abstraction, defined as:
// Reader[I, Decode[Context, A]]
//
// This means:
// 1. It takes an input of type I
// 2. Returns a Reader that depends on validation Context
// 3. That Reader produces a Validation[A] (Either[Errors, A])
//
// This layered structure allows validators to:
// - Access the input value
// - Track validation context (path in nested structures)
// - Accumulate multiple validation errors
// - Compose with other validators
//
// Example:
// A Validate[string, int] takes a string and returns a context-aware
// function that validates and converts it to an integer.
Validate[I, A any] = validate.Validate[I, A]
// Decode is a function that decodes input I to type A with validation.
// It returns a Validation result directly.
//
// The Decode type is defined as:
// Reader[I, Validation[A]]
//
// This is simpler than Validate as it doesn't require explicit context passing.
// The context is typically created automatically when the decoder is invoked.
//
// Decode is used when:
// - You don't need to manually manage validation context
// - You want a simpler API for basic validation
// - You're working at the top level of validation
//
// Example:
// A Decode[string, int] takes a string and returns a Validation[int]
// which is Either[Errors, int].
Decode[I, A any] = decode.Decode[I, A]
// Encode is a function that encodes type A to output O.
//
// Encode is simply a Reader[A, O], which is a function from A to O.
// Encoders are pure functions with no error handling - they assume
// the input is valid.
//
// Encoding is the inverse of decoding:
// - Decoding: I -> Validation[A] (may fail)
// - Encoding: A -> O (always succeeds)
//
// Example:
// An Encode[int, string] takes an integer and returns its string
// representation.
Encode[A, O any] = Reader[A, O]
// Decoder is an interface for types that can decode and validate input.
//
// A Decoder transforms input of type I into a validated value of type A,
// providing detailed error information when validation fails. It supports
// both context-aware validation (via Validate) and direct decoding (via Decode).
//
// Type Parameters:
// - I: The input type to decode from
// - A: The target type to decode to
//
// Methods:
// - Name(): Returns a descriptive name for this decoder (used in error messages)
// - Validate(I): Returns a context-aware validation function that can track
// the path through nested structures
// - Decode(I): Directly decodes input to a Validation result with a fresh context
//
// The Validate method is more flexible as it returns a Reader that can be called
// with different contexts, while Decode is a convenience method that creates a
// new context automatically.
//
// Example:
// A Decoder[string, int] can decode strings to integers with validation.
Decoder[I, A any] interface {
Name() string
Validate(I) Decode[Context, A]
@@ -72,13 +160,76 @@ type (
}
// Encoder is an interface for types that can encode values.
//
// An Encoder transforms values of type A into output format O. This is the
// inverse operation of decoding, allowing bidirectional transformations.
//
// Type Parameters:
// - A: The source type to encode from
// - O: The output type to encode to
//
// Methods:
// - Encode(A): Transforms a value of type A into output format O
//
// Encoders are pure functions with no validation or error handling - they
// assume the input is valid. Validation should be performed during decoding.
//
// Example:
// An Encoder[int, string] can encode integers to their string representation.
Encoder[A, O any] interface {
// Encode transforms a value of type A into output format O.
Encode(A) O
}
// Type is a bidirectional codec that combines encoding, decoding, validation,
// and type checking capabilities. It represents a complete specification of
// how to work with a particular type.
//
// Type is the central abstraction in the codec package, providing:
// - Decoding: Transform input I to validated type A
// - Encoding: Transform type A to output O
// - Validation: Context-aware validation with detailed error reporting
// - Type Checking: Runtime type verification via Is()
// - Formatting: Human-readable type descriptions via Name()
//
// Type Parameters:
// - A: The target type (what we decode to and encode from)
// - O: The output type (what we encode to)
// - I: The input type (what we decode from)
//
// Common patterns:
// - Type[A, A, A]: Identity codec (no transformation)
// - Type[A, string, string]: String-based serialization
// - Type[A, any, any]: Generic codec accepting any input/output
// - Type[A, JSON, JSON]: JSON codec
//
// Methods:
// - Name(): Returns the codec's descriptive name
// - Validate(I): Returns context-aware validation function
// - Decode(I): Decodes input with automatic context creation
// - Encode(A): Encodes value to output format
// - AsDecoder(): Returns this Type as a Decoder interface
// - AsEncoder(): Returns this Type as an Encoder interface
// - Is(any): Checks if a value can be converted to type A
//
// Example usage:
// intCodec := codec.Int() // Type[int, int, any]
// stringCodec := codec.String() // Type[string, string, any]
// intFromString := codec.IntFromString() // Type[int, string, string]
//
// // Decode
// result := intFromString.Decode("42") // Validation[int]
//
// // Encode
// str := intFromString.Encode(42) // "42"
//
// // Type check
// isInt := intCodec.Is(42) // Right(42)
// notInt := intCodec.Is("42") // Left(error)
//
// Composition:
// Types can be composed using operators like Alt, Map, Chain, and Pipe
// to build complex codecs from simpler ones.
Type[A, O, I any] interface {
Formattable
Decoder[I, A]
@@ -99,6 +250,92 @@ type (
// contain a value of type A. It provides a way to preview and review values.
Prism[S, A any] = prism.Prism[S, A]
// Refinement represents the concept that B is a specialized type of A
// Refinement represents the concept that B is a specialized type of A.
// It's an alias for Prism[A, B], providing a semantic name for type refinement operations.
//
// A refinement allows you to:
// - Preview: Try to extract a B from an A (may fail if A is not a B)
// - Review: Inject a B back into an A
//
// This is useful for working with subtypes, validated types, or constrained types.
//
// Example:
// - Refinement[int, PositiveInt] - refines int to positive integers only
// - Refinement[string, NonEmptyString] - refines string to non-empty strings
// - Refinement[any, User] - refines any to User type
Refinement[A, B any] = Prism[A, B]
// Kleisli represents a Kleisli arrow in the codec context.
// It's a function that takes a value of type A and returns a codec Type[B, O, I].
//
// This is the fundamental building block for codec transformations and compositions.
// Kleisli arrows allow you to:
// - Chain codec operations
// - Build dependent codecs (where the next codec depends on the previous result)
// - Create codec pipelines
//
// Type Parameters:
// - A: The input type to the function
// - B: The target type that the resulting codec decodes to
// - O: The output type that the resulting codec encodes to
// - I: The input type that the resulting codec decodes from
//
// Example:
// A Kleisli[string, int, string, string] takes a string and returns a codec
// that can decode strings to ints and encode ints to strings.
Kleisli[A, B, O, I any] = Reader[A, Type[B, O, I]]
// Operator is a specialized Kleisli arrow that transforms codecs.
// It takes a codec Type[A, O, I] and returns a new codec Type[B, O, I].
//
// Operators are the primary way to build codec transformation pipelines.
// They enable functional composition of codec transformations using F.Pipe.
//
// Type Parameters:
// - A: The source type that the input codec decodes to
// - B: The target type that the output codec decodes to
// - O: The output type (same for both input and output codecs)
// - I: The input type (same for both input and output codecs)
//
// Common operators include:
// - Map: Transforms the decoded value
// - Chain: Sequences dependent codec operations
// - Alt: Provides alternative fallback codecs
// - Refine: Adds validation constraints
//
// Example:
// An Operator[int, PositiveInt, int, any] transforms a codec that decodes
// to int into a codec that decodes to PositiveInt (with validation).
//
// Usage with F.Pipe:
// codec := F.Pipe2(
// baseCodec,
// operator1, // Operator[A, B, O, I]
// operator2, // Operator[B, C, O, I]
// )
Operator[A, B, O, I any] = Kleisli[Type[A, O, I], B, O, I]
// Monoid represents an algebraic structure with an associative binary operation
// and an identity element.
//
// A Monoid[A] provides:
// - Empty(): Returns the identity element
// - Concat(A, A): Combines two values associatively
//
// Monoid laws:
// 1. Left Identity: Concat(Empty(), a) = a
// 2. Right Identity: Concat(a, Empty()) = a
// 3. Associativity: Concat(Concat(a, b), c) = Concat(a, Concat(b, c))
//
// In the codec context, monoids are used to:
// - Combine multiple codecs with specific semantics
// - Build codec chains with fallback behavior (AltMonoid)
// - Aggregate validation results (ApplicativeMonoid)
// - Compose codec transformations
//
// Example monoids for codecs:
// - AltMonoid: First success wins (alternative semantics)
// - ApplicativeMonoid: Combines successful results using inner monoid
// - AlternativeMonoid: Combines applicative and alternative behaviors
Monoid[A any] = monoid.Monoid[A]
)

View File

@@ -0,0 +1,135 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package validate
import (
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/readerresult"
)
// FromReaderResult converts a ReaderResult into a Validate.
//
// This function bridges the gap between simple error-based validation (ReaderResult)
// and the more sophisticated validation framework that supports error accumulation
// and detailed context tracking.
//
// # Type Parameters
//
// - I: The input type that the validator will receive
// - A: The output type that the validator will produce on success
//
// # Parameters
//
// - r: A ReaderResult[I, A] which is readerresult.ReaderResult[I, A]
// This represents a computation that:
// 1. Takes an input of type I
// 2. Returns Either[error, A] (success with A or failure with error)
//
// # Returns
//
// - Validate[I, A]: A validator that:
// 1. Takes an input of type I
// 2. Takes a validation Context (path through nested structures)
// 3. Returns Validation[A] (Either[Errors, A])
//
// # Behavior
//
// The conversion follows this logic:
//
// 1. Success case: If the ReaderResult succeeds with value A:
// - Wraps the value in validation.Success[A]
// - Returns a validator that always succeeds with that value
//
// 2. Failure case: If the ReaderResult fails with an error:
// - Creates a validation.ValidationError with:
// - The input value that caused the failure
// - The current validation context (path information)
// - A generic message "unable to decode"
// - The original error as the cause
// - Returns a validator that fails with this detailed error
//
// # Error Handling
//
// The function enhances simple error handling by:
// - Converting a single error into a structured validation.ValidationError
// - Preserving the original error as the cause (accessible via Unwrap())
// - Adding context information about where the error occurred
// - Making the error compatible with the validation framework's error accumulation
//
// # Example Usage
//
// Basic conversion:
//
// // A simple ReaderResult that parses an integer
// parseIntRR := result.Eitherize1(strconv.Atoi)
//
// // Convert to Validate
// validateInt := FromReaderResult[string, int](parseIntRR)
//
// // Use the validator
// result := validateInt("42")(nil) // Success(42)
// result := validateInt("abc")(nil) // Failure with ValidationError
//
// Integration with validation pipeline:
//
// // Combine with other validators
// validatePositiveInt := F.Pipe1(
// FromReaderResult[string, int](parseIntRR),
// Chain(func(n int) Validate[string, int] {
// if n > 0 {
// return Of[string](n)
// }
// return func(input string) Reader[Context, Validation[int]] {
// return validation.FailureWithMessage[int](n, "must be positive")
// }
// }),
// )
//
// # Implementation Details
//
// The function uses a functional composition approach:
//
// 1. readerresult.Map: Transforms successful results
// - Wraps the success value in validation.Success
// - Lifts it into a Reader context with reader.Of
//
// 2. readerresult.GetOrElse: Handles failures
// - Uses reader.Asks to access the validation context
// - Creates a validation.ValidationError with validation.FailureWithError
// - Uses reader.Local to adapt the context type
//
// # See Also
//
// - Validate: The target validation type
// - ReaderResult: The source type
// - validation.Success: Creates successful validations
// - validation.FailureWithError: Creates validation failures with cause
// - Context: Validation context for error reporting
func FromReaderResult[I, A any](r ReaderResult[I, A]) Validate[I, A] {
return F.Pipe2(
r,
readerresult.Map[I](F.Flow2(
validation.Success[A],
reader.Of[Context],
)),
readerresult.GetOrElse(F.Pipe1(
reader.Asks(F.Flip(F.Bind2nd(validation.FailureWithError[A], "unable to decode"))),
reader.Map[error](reader.Local[Decode[Context, A]](F.ToAny[I])),
)),
)
}

View File

@@ -0,0 +1,484 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package validate
import (
"errors"
"fmt"
"strconv"
"testing"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// TestFromReaderResult_Success tests that FromReaderResult correctly converts
// a successful ReaderResult into a successful Validate
func TestFromReaderResult_Success(t *testing.T) {
t.Run("converts successful ReaderResult with integer", func(t *testing.T) {
// Create a ReaderResult that always succeeds
successRR := func(input int) result.Result[string] {
return result.Of(fmt.Sprintf("value: %d", input))
}
// Convert to Validate
validator := FromReaderResult[int, string](successRR)
// Execute the validator
validationResult := validator(42)(nil)
// Verify success
assert.Equal(t, validation.Success("value: 42"), validationResult)
})
t.Run("converts successful ReaderResult with string input", func(t *testing.T) {
// Create a ReaderResult that parses a string to int
parseIntRR := result.Eitherize1(strconv.Atoi)
// Convert to Validate
validator := FromReaderResult[string, int](parseIntRR)
// Execute with valid input
validationResult := validator("123")(nil)
// Verify success
assert.Equal(t, validation.Success(123), validationResult)
})
t.Run("converts successful ReaderResult with complex type", func(t *testing.T) {
type User struct {
Name string
Age int
}
// Create a ReaderResult that creates a User
createUserRR := func(input string) result.Result[User] {
return result.Of(User{Name: input, Age: 25})
}
// Convert to Validate
validator := FromReaderResult[string, User](createUserRR)
// Execute the validator
validationResult := validator("Alice")(nil)
// Verify success
assert.Equal(t, validation.Success(User{Name: "Alice", Age: 25}), validationResult)
})
t.Run("preserves success with empty context", func(t *testing.T) {
successRR := func(input int) result.Result[int] {
return result.Of(input * 2)
}
validator := FromReaderResult[int, int](successRR)
validationResult := validator(21)(Context{})
assert.Equal(t, validation.Success(42), validationResult)
})
t.Run("preserves success with non-empty context", func(t *testing.T) {
successRR := func(input string) result.Result[string] {
return result.Of(input + " processed")
}
validator := FromReaderResult[string, string](successRR)
ctx := Context{
{Key: "user", Type: "User"},
{Key: "name", Type: "string"},
}
validationResult := validator("test")(ctx)
assert.Equal(t, validation.Success("test processed"), validationResult)
})
}
// TestFromReaderResult_Failure tests that FromReaderResult correctly converts
// a failed ReaderResult into a failed Validate with proper error information
func TestFromReaderResult_Failure(t *testing.T) {
t.Run("converts failed ReaderResult to validation error", func(t *testing.T) {
expectedErr := errors.New("parse error")
// Create a ReaderResult that always fails
failureRR := func(input string) result.Result[int] {
return result.Left[int](expectedErr)
}
// Convert to Validate
validator := FromReaderResult[string, int](failureRR)
// Execute the validator
validationResult := validator("invalid")(nil)
// Verify failure
assert.True(t, either.IsLeft(validationResult))
errors := either.MonadFold(validationResult,
F.Identity[Errors],
func(int) Errors { return nil },
)
require.Len(t, errors, 1)
assert.Equal(t, "unable to decode", errors[0].Messsage)
assert.Equal(t, "invalid", errors[0].Value)
assert.Equal(t, expectedErr, errors[0].Cause)
})
t.Run("preserves original error as cause", func(t *testing.T) {
originalErr := fmt.Errorf("original error: %w", errors.New("root cause"))
failureRR := func(input int) result.Result[string] {
return result.Left[string](originalErr)
}
validator := FromReaderResult[int, string](failureRR)
validationResult := validator(42)(nil)
assert.True(t, either.IsLeft(validationResult))
errors := either.MonadFold(validationResult,
F.Identity[Errors],
func(string) Errors { return nil },
)
require.Len(t, errors, 1)
assert.Equal(t, originalErr, errors[0].Cause)
assert.ErrorIs(t, errors[0].Cause, originalErr)
})
t.Run("includes context in validation error", func(t *testing.T) {
failureRR := func(input string) result.Result[int] {
return result.Left[int](errors.New("conversion failed"))
}
validator := FromReaderResult[string, int](failureRR)
ctx := Context{
{Key: "user", Type: "User"},
{Key: "age", Type: "int"},
}
validationResult := validator("abc")(ctx)
assert.True(t, either.IsLeft(validationResult))
errors := either.MonadFold(validationResult,
F.Identity[Errors],
func(int) Errors { return nil },
)
require.Len(t, errors, 1)
assert.Equal(t, ctx, errors[0].Context)
assert.Equal(t, "abc", errors[0].Value)
})
t.Run("handles different error types", func(t *testing.T) {
testCases := []struct {
name string
err error
input string
}{
{
name: "simple error",
err: errors.New("simple error"),
input: "test1",
},
{
name: "formatted error",
err: fmt.Errorf("formatted error: %s", "details"),
input: "test2",
},
{
name: "wrapped error",
err: fmt.Errorf("wrapped: %w", errors.New("inner")),
input: "test3",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
failureRR := func(input string) result.Result[int] {
return result.Left[int](tc.err)
}
validator := FromReaderResult[string, int](failureRR)
validationResult := validator(tc.input)(nil)
assert.True(t, either.IsLeft(validationResult))
errors := either.MonadFold(validationResult,
F.Identity[Errors],
func(int) Errors { return nil },
)
require.Len(t, errors, 1)
assert.Equal(t, tc.err, errors[0].Cause)
assert.Equal(t, tc.input, errors[0].Value)
})
}
})
}
// TestFromReaderResult_Integration tests FromReaderResult in combination with
// other validation operations
func TestFromReaderResult_Integration(t *testing.T) {
t.Run("chains with other validators", func(t *testing.T) {
// Parse string to int
parseIntRR := result.Eitherize1(strconv.Atoi)
// Validate positive
validatePositive := func(n int) Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
if n > 0 {
return validation.Success(n)
}
return validation.FailureWithMessage[int](n, "must be positive")(ctx)
}
}
}
// Combine validators
validator := F.Pipe1(
FromReaderResult[string, int](parseIntRR),
Chain(validatePositive),
)
// Test with valid positive number
result1 := validator("42")(nil)
assert.True(t, either.IsRight(result1))
// Test with valid negative number (should fail positive check)
result2 := validator("-5")(nil)
assert.True(t, either.IsLeft(result2))
// Test with invalid string (should fail parsing)
result3 := validator("abc")(nil)
assert.True(t, either.IsLeft(result3))
})
t.Run("maps successful result", func(t *testing.T) {
parseIntRR := result.Eitherize1(strconv.Atoi)
// Convert and map to double the value
validator := F.Pipe1(
FromReaderResult[string, int](parseIntRR),
Map[string, int, int](func(n int) int { return n * 2 }),
)
validationResult := validator("21")(nil)
assert.Equal(t, validation.Success(42), validationResult)
})
t.Run("composes with Do and Bind", func(t *testing.T) {
type State struct {
parsed int
valid bool
}
parseIntRR := result.Eitherize1(strconv.Atoi)
validator := F.Pipe2(
Do[string](State{}),
Bind(func(p int) func(State) State {
return func(s State) State { s.parsed = p; return s }
}, func(s State) Validate[string, int] {
return FromReaderResult[string, int](parseIntRR)
}),
Let[string](func(v bool) func(State) State {
return func(s State) State { s.valid = v; return s }
}, func(s State) bool {
return s.parsed > 0
}),
)
result := validator("42")(nil)
assert.Equal(t, validation.Success(State{parsed: 42, valid: true}), result)
})
}
// TestFromReaderResult_EdgeCases tests edge cases and boundary conditions
func TestFromReaderResult_EdgeCases(t *testing.T) {
t.Run("handles nil context", func(t *testing.T) {
successRR := func(input int) result.Result[int] {
return result.Of(input)
}
validator := FromReaderResult[int, int](successRR)
validationResult := validator(42)(nil)
assert.True(t, either.IsRight(validationResult))
})
t.Run("handles empty input", func(t *testing.T) {
identityRR := func(input string) result.Result[string] {
return result.Of(input)
}
validator := FromReaderResult[string, string](identityRR)
validationResult := validator("")(nil)
assert.Equal(t, validation.Success(""), validationResult)
})
t.Run("handles zero values", func(t *testing.T) {
identityRR := func(input int) result.Result[int] {
return result.Of(input)
}
validator := FromReaderResult[int, int](identityRR)
validationResult := validator(0)(nil)
assert.Equal(t, validation.Success(0), validationResult)
})
t.Run("handles pointer types", func(t *testing.T) {
type Data struct {
Value int
}
createDataRR := func(input int) result.Result[*Data] {
return result.Of(&Data{Value: input})
}
validator := FromReaderResult[int, *Data](createDataRR)
validationResult := validator(42)(nil)
assert.True(t, either.IsRight(validationResult))
data := either.MonadFold(validationResult,
func(Errors) *Data { return nil },
F.Identity[*Data],
)
require.NotNil(t, data)
assert.Equal(t, 42, data.Value)
})
t.Run("handles slice types", func(t *testing.T) {
splitRR := func(input string) result.Result[[]string] {
if input == "" {
return result.Left[[]string](errors.New("empty input"))
}
return result.Of([]string{input, input})
}
validator := FromReaderResult[string, []string](splitRR)
validationResult := validator("test")(nil)
assert.Equal(t, validation.Success([]string{"test", "test"}), validationResult)
})
t.Run("handles map types", func(t *testing.T) {
createMapRR := func(input string) result.Result[map[string]int] {
return result.Of(map[string]int{input: len(input)})
}
validator := FromReaderResult[string, map[string]int](createMapRR)
validationResult := validator("hello")(nil)
assert.Equal(t, validation.Success(map[string]int{"hello": 5}), validationResult)
})
}
// TestFromReaderResult_TypeSafety tests that the function maintains type safety
func TestFromReaderResult_TypeSafety(t *testing.T) {
t.Run("maintains input type", func(t *testing.T) {
// This test verifies that the input type is preserved
intToStringRR := func(input int) result.Result[string] {
return result.Of(fmt.Sprintf("%d", input))
}
validator := FromReaderResult[int, string](intToStringRR)
// This should compile and work correctly
validationResult := validator(42)(nil)
assert.Equal(t, validation.Success("42"), validationResult)
})
t.Run("maintains output type", func(t *testing.T) {
// This test verifies that the output type is preserved
stringToIntRR := result.Eitherize1(strconv.Atoi)
validator := FromReaderResult[string, int](stringToIntRR)
validationResult := validator("42")(nil)
// The result should be Validation[int]
assert.Equal(t, validation.Success(42), validationResult)
})
t.Run("works with different type combinations", func(t *testing.T) {
type Input struct{ Value string }
type Output struct{ Result int }
transformRR := result.Eitherize1(func(input Input) (Output, error) {
val, err := strconv.Atoi(input.Value)
if err != nil {
return Output{}, err
}
return Output{Result: val}, nil
})
validator := FromReaderResult[Input, Output](transformRR)
validationResult := validator(Input{Value: "42"})(nil)
assert.Equal(t, validation.Success(Output{Result: 42}), validationResult)
})
}
// BenchmarkFromReaderResult_Success benchmarks the success path
func BenchmarkFromReaderResult_Success(b *testing.B) {
successRR := func(input int) result.Result[int] {
return result.Of(input * 2)
}
validator := FromReaderResult[int, int](successRR)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = validator(42)(nil)
}
}
// BenchmarkFromReaderResult_Failure benchmarks the failure path
func BenchmarkFromReaderResult_Failure(b *testing.B) {
failureRR := func(input int) result.Result[int] {
return result.Left[int](errors.New("error"))
}
validator := FromReaderResult[int, int](failureRR)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = validator(42)(nil)
}
}
// BenchmarkFromReaderResult_WithContext benchmarks with context
func BenchmarkFromReaderResult_WithContext(b *testing.B) {
successRR := func(input int) result.Result[int] {
return result.Of(input * 2)
}
validator := FromReaderResult[int, int](successRR)
ctx := Context{
{Key: "user", Type: "User"},
{Key: "age", Type: "int"},
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = validator(42)(ctx)
}
}
// Made with Bob

View File

@@ -0,0 +1,661 @@
package validate
import (
"testing"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
"github.com/stretchr/testify/assert"
)
// TestMonadChainLeft tests the MonadChainLeft function
func TestMonadChainLeft(t *testing.T) {
t.Run("transforms failures while preserving successes", func(t *testing.T) {
// Create a failing validator
failingValidator := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "validation failed"},
})
}
}
// Handler that recovers from specific errors
handler := func(errs Errors) Validate[string, int] {
for _, err := range errs {
if err.Messsage == "validation failed" {
return Of[string, int](0) // recover with default
}
}
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](errs)
}
}
}
validator := MonadChainLeft(failingValidator, handler)
res := validator("input")(nil)
assert.Equal(t, validation.Of(0), res, "Should recover from failure")
})
t.Run("preserves success values unchanged", func(t *testing.T) {
successValidator := Of[string, int](42)
handler := func(errs Errors) Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Messsage: "should not be called"},
})
}
}
}
validator := MonadChainLeft(successValidator, handler)
res := validator("input")(nil)
assert.Equal(t, validation.Of(42), res, "Success should pass through unchanged")
})
t.Run("aggregates errors when transformation also fails", func(t *testing.T) {
failingValidator := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "original error"},
})
}
}
handler := func(errs Errors) Validate[string, string] {
return func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Messsage: "additional error"},
})
}
}
}
validator := MonadChainLeft(failingValidator, handler)
res := validator("input")(nil)
assert.True(t, either.IsLeft(res))
errors := either.MonadFold(res,
reader.Ask[Errors](),
func(string) Errors { return nil },
)
assert.Len(t, errors, 2, "Should aggregate both errors")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "original error")
assert.Contains(t, messages, "additional error")
})
t.Run("adds context to errors", func(t *testing.T) {
failingValidator := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "invalid format"},
})
}
}
addContext := func(errs Errors) Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{
Context: validation.Context{{Key: "user", Type: "User"}, {Key: "age", Type: "int"}},
Messsage: "failed to validate user age",
},
})
}
}
}
validator := MonadChainLeft(failingValidator, addContext)
res := validator("abc")(nil)
assert.True(t, either.IsLeft(res))
errors := either.MonadFold(res,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
assert.Len(t, errors, 2, "Should have both original and context errors")
})
t.Run("works with different input types", func(t *testing.T) {
type Config struct {
Port int
}
failingValidator := func(cfg Config) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: cfg.Port, Messsage: "invalid port"},
})
}
}
handler := func(errs Errors) Validate[Config, string] {
return Of[Config, string]("default-value")
}
validator := MonadChainLeft(failingValidator, handler)
res := validator(Config{Port: 9999})(nil)
assert.Equal(t, validation.Of("default-value"), res)
})
t.Run("handler can access original input", func(t *testing.T) {
failingValidator := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "parse failed"},
})
}
}
handler := func(errs Errors) Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
// Handler can use the original input to make decisions
if input == "special" {
return validation.Of(999)
}
return validation.Of(0)
}
}
}
validator := MonadChainLeft(failingValidator, handler)
res1 := validator("special")(nil)
assert.Equal(t, validation.Of(999), res1)
res2 := validator("other")(nil)
assert.Equal(t, validation.Of(0), res2)
})
t.Run("is equivalent to ChainLeft", func(t *testing.T) {
failingValidator := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error"},
})
}
}
handler := func(errs Errors) Validate[string, int] {
return Of[string, int](42)
}
// MonadChainLeft - direct application
result1 := MonadChainLeft(failingValidator, handler)("input")(nil)
// ChainLeft - curried for pipelines
result2 := ChainLeft(handler)(failingValidator)("input")(nil)
assert.Equal(t, result1, result2, "MonadChainLeft and ChainLeft should produce identical results")
})
t.Run("chains multiple error transformations", func(t *testing.T) {
failingValidator := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error1"},
})
}
}
handler1 := func(errs Errors) Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Messsage: "error2"},
})
}
}
}
handler2 := func(errs Errors) Validate[string, int] {
// Check if we can recover
for _, err := range errs {
if err.Messsage == "error1" {
return Of[string, int](100) // recover
}
}
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](errs)
}
}
}
// Chain handlers
validator := MonadChainLeft(MonadChainLeft(failingValidator, handler1), handler2)
res := validator("input")(nil)
// Should recover because error1 is present
assert.Equal(t, validation.Of(100), res)
})
t.Run("does not call handler on success", func(t *testing.T) {
successValidator := Of[string, int](42)
handlerCalled := false
handler := func(errs Errors) Validate[string, int] {
handlerCalled = true
return Of[string, int](0)
}
validator := MonadChainLeft(successValidator, handler)
res := validator("input")(nil)
assert.Equal(t, validation.Of(42), res)
assert.False(t, handlerCalled, "Handler should not be called on success")
})
}
// TestMonadAlt tests the MonadAlt function
func TestMonadAlt(t *testing.T) {
t.Run("returns first validator when it succeeds", func(t *testing.T) {
validator1 := Of[string, int](42)
validator2 := func() Validate[string, int] {
return Of[string, int](100)
}
result := MonadAlt(validator1, validator2)("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("returns second validator when first fails", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "first failed"},
})
}
}
fallback := func() Validate[string, int] {
return Of[string, int](42)
}
result := MonadAlt(failing, fallback)("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
result := MonadAlt(failing1, failing2)("input")(nil)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both validators")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1", "Should contain error from first validator")
assert.Contains(t, messages, "error 2", "Should contain error from second validator")
})
t.Run("does not evaluate second validator when first succeeds", func(t *testing.T) {
validator1 := Of[string, int](42)
evaluated := false
validator2 := func() Validate[string, int] {
evaluated = true
return Of[string, int](100)
}
result := MonadAlt(validator1, validator2)("input")(nil)
assert.Equal(t, validation.Of(42), result)
assert.False(t, evaluated, "Second validator should not be evaluated")
})
t.Run("works with different types", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
}
fallback := func() Validate[string, string] {
return Of[string, string]("fallback")
}
result := MonadAlt(failing, fallback)("input")(nil)
assert.Equal(t, validation.Of("fallback"), result)
})
t.Run("chains multiple alternatives", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
succeeding := func() Validate[string, int] {
return Of[string, int](42)
}
// Chain: try failing1, then failing2, then succeeding
result := MonadAlt(MonadAlt(failing1, failing2), succeeding)("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("works with complex input types", func(t *testing.T) {
type Config struct {
Port int
}
failing := func(cfg Config) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: cfg.Port, Messsage: "invalid port"},
})
}
}
fallback := func() Validate[Config, string] {
return Of[Config, string]("default")
}
result := MonadAlt(failing, fallback)(Config{Port: 9999})(nil)
assert.Equal(t, validation.Of("default"), result)
})
t.Run("preserves error context", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{
Value: input,
Messsage: "parse error",
Context: validation.Context{{Key: "field", Type: "int"}},
},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{
Value: input,
Messsage: "validation error",
Context: validation.Context{{Key: "value", Type: "int"}},
},
})
}
}
}
result := MonadAlt(failing1, failing2)("abc")(nil)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should have errors from both validators")
// Verify that errors with context are present
hasParseError := false
hasValidationError := false
for _, err := range errors {
if err.Messsage == "parse error" {
hasParseError = true
assert.NotNil(t, err.Context)
}
if err.Messsage == "validation error" {
hasValidationError = true
assert.NotNil(t, err.Context)
}
}
assert.True(t, hasParseError, "Should have parse error")
assert.True(t, hasValidationError, "Should have validation error")
})
}
// TestAlt tests the Alt function
func TestAlt(t *testing.T) {
t.Run("returns first validator when it succeeds", func(t *testing.T) {
validator1 := Of[string, int](42)
validator2 := func() Validate[string, int] {
return Of[string, int](100)
}
withAlt := Alt(validator2)
result := withAlt(validator1)("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("returns second validator when first fails", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "first failed"},
})
}
}
fallback := func() Validate[string, int] {
return Of[string, int](42)
}
withAlt := Alt(fallback)
result := withAlt(failing)("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
withAlt := Alt(failing2)
result := withAlt(failing1)("input")(nil)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both validators")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
t.Run("does not evaluate second validator when first succeeds", func(t *testing.T) {
validator1 := Of[string, int](42)
evaluated := false
validator2 := func() Validate[string, int] {
evaluated = true
return Of[string, int](100)
}
withAlt := Alt(validator2)
result := withAlt(validator1)("input")(nil)
assert.Equal(t, validation.Of(42), result)
assert.False(t, evaluated, "Second validator should not be evaluated")
})
t.Run("can be used in pipelines", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
succeeding := func() Validate[string, int] {
return Of[string, int](42)
}
// Use F.Pipe to chain alternatives
validator := F.Pipe2(
failing1,
Alt(failing2),
Alt(succeeding),
)
result := validator("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("is equivalent to MonadAlt", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error"},
})
}
}
fallback := func() Validate[string, int] {
return Of[string, int](42)
}
// Alt - curried for pipelines
result1 := Alt(fallback)(failing)("input")(nil)
// MonadAlt - direct application
result2 := MonadAlt(failing, fallback)("input")(nil)
assert.Equal(t, result1, result2, "Alt and MonadAlt should produce identical results")
})
}
// TestMonadAltAndAltEquivalence tests that MonadAlt and Alt are equivalent
func TestMonadAltAndAltEquivalence(t *testing.T) {
t.Run("both produce same results for success", func(t *testing.T) {
validator1 := Of[string, int](42)
validator2 := func() Validate[string, int] {
return Of[string, int](100)
}
resultMonadAlt := MonadAlt(validator1, validator2)("input")(nil)
resultAlt := Alt(validator2)(validator1)("input")(nil)
assert.Equal(t, resultMonadAlt, resultAlt)
})
t.Run("both produce same results for fallback", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
}
fallback := func() Validate[string, int] {
return Of[string, int](42)
}
resultMonadAlt := MonadAlt(failing, fallback)("input")(nil)
resultAlt := Alt(fallback)(failing)("input")(nil)
assert.Equal(t, resultMonadAlt, resultAlt)
})
t.Run("both produce same results for error aggregation", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
resultMonadAlt := MonadAlt(failing1, failing2)("input")(nil)
resultAlt := Alt(failing2)(failing1)("input")(nil)
// Both should fail
assert.True(t, either.IsLeft(resultMonadAlt))
assert.True(t, either.IsLeft(resultAlt))
// Both should have same errors
errorsMonadAlt := either.MonadFold(resultMonadAlt,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
errorsAlt := either.MonadFold(resultAlt,
reader.Ask[Errors](),
func(int) Errors { return nil },
)
assert.Equal(t, len(errorsMonadAlt), len(errorsAlt))
})
}

View File

@@ -122,3 +122,268 @@ func ApplicativeMonoid[I, A any](m Monoid[A]) Monoid[Validate[I, A]] {
m,
)
}
// AlternativeMonoid creates a Monoid instance for Validate[I, A] that combines both
// applicative and alternative semantics.
//
// This function creates a monoid that:
// 1. When both validators succeed: Combines their results using the provided monoid operation
// 2. When one validator fails: Uses the successful validator's result (alternative behavior)
// 3. When both validators fail: Aggregates all errors from both validators
//
// This is a hybrid approach that combines:
// - ApplicativeMonoid: Combines successful results using the monoid operation
// - AltMonoid: Provides fallback behavior when validators fail
//
// # Type Parameters
//
// - I: The input type that validators accept
// - A: The output type that validators produce (must have a Monoid instance)
//
// # Parameters
//
// - m: A Monoid[A] that defines how to combine values of type A
//
// # Returns
//
// A Monoid[Validate[I, A]] that combines validators using both applicative and alternative semantics.
//
// # Behavior Details
//
// The AlternativeMonoid differs from ApplicativeMonoid in how it handles mixed success/failure:
//
// - **Both succeed**: Results are combined using the monoid operation (like ApplicativeMonoid)
// - **First succeeds, second fails**: Returns the first result (alternative fallback)
// - **First fails, second succeeds**: Returns the second result (alternative fallback)
// - **Both fail**: Aggregates errors from both validators
//
// # Example: String Concatenation with Fallback
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// "github.com/IBM/fp-go/v2/optics/codec/validation"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// m := validate.AlternativeMonoid[string, string](S.Monoid)
//
// // Both succeed - results are concatenated
// validator1 := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.Success("Hello")
// }
// }
// validator2 := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.Success(" World")
// }
// }
// combined := m.Concat(validator1, validator2)
// result := combined("input")(nil)
// // result is validation.Success("Hello World")
//
// # Example: Fallback Behavior
//
// // First fails, second succeeds - uses second result
// failing := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.FailureWithMessage[string](input, "first failed")(ctx)
// }
// }
// succeeding := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.Success("fallback")
// }
// }
// combined := m.Concat(failing, succeeding)
// result := combined("input")(nil)
// // result is validation.Success("fallback")
//
// # Example: Error Aggregation
//
// // Both fail - errors are aggregated
// failing1 := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.FailureWithMessage[string](input, "error 1")(ctx)
// }
// }
// failing2 := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.FailureWithMessage[string](input, "error 2")(ctx)
// }
// }
// combined := m.Concat(failing1, failing2)
// result := combined("input")(nil)
// // result contains both "error 1" and "error 2"
//
// # Comparison with Other Monoids
//
// - **ApplicativeMonoid**: Always combines results when both succeed, fails if either fails
// - **AlternativeMonoid**: Combines results when both succeed, provides fallback when one fails
// - **AltMonoid**: Always uses first success, never combines results
//
// # Use Cases
//
// - Validation with fallback strategies and result combination
// - Building validators that accumulate results but provide alternatives
// - Configuration loading with multiple sources and merging
// - Data aggregation with error recovery
//
// # Notes
//
// - Both validators receive the same input value I
// - The empty element of the monoid serves as the identity for the Concat operation
// - Error aggregation ensures no validation failures are lost
// - This follows both applicative and alternative functor laws
//
// # See Also
//
// - ApplicativeMonoid: For pure applicative combination without fallback
// - AltMonoid: For pure alternative behavior without result combination
// - MonadAlt: The underlying alternative operation
func AlternativeMonoid[I, A any](m Monoid[A]) Monoid[Validate[I, A]] {
return monoid.AlternativeMonoid(
Of[I, A],
MonadMap[I, A, func(A) A],
MonadAp[A, I, A],
MonadAlt[I, A],
m,
)
}
// AltMonoid creates a Monoid instance for Validate[I, A] using alternative semantics
// with a provided zero/default validator.
//
// This function creates a monoid where:
// 1. The first successful validator wins (no result combination)
// 2. If the first fails, the second is tried as a fallback
// 3. If both fail, errors are aggregated
// 4. The provided zero validator serves as the identity element
//
// Unlike AlternativeMonoid, AltMonoid does NOT combine successful results - it always
// returns the first success. This makes it ideal for fallback chains and default values.
//
// # Type Parameters
//
// - I: The input type that validators accept
// - A: The output type that validators produce
//
// # Parameters
//
// - zero: A lazy Validate[I, A] that serves as the identity element. This is typically
// a validator that always succeeds with a default value, but can also be a failing
// validator if no default is appropriate.
//
// # Returns
//
// A Monoid[Validate[I, A]] that combines validators using alternative semantics where
// the first success wins.
//
// # Behavior Details
//
// The AltMonoid implements a "first success wins" strategy:
//
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
// - **Concat with Empty**: The zero validator is used as fallback
//
// # Example: Default Value Fallback
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// )
//
// // Create a monoid with a default value of 0
// m := validate.AltMonoid(func() validate.Validate[string, int] {
// return validate.Of[string, int](0)
// })
//
// // First validator succeeds - returns 42, second is not evaluated
// validator1 := validate.Of[string, int](42)
// validator2 := validate.Of[string, int](100)
// combined := m.Concat(validator1, validator2)
// result := combined("input")(nil)
// // result is validation.Success(42)
//
// # Example: Fallback Chain
//
// // Try primary, then fallback, then default
// m := validate.AltMonoid(func() validate.Validate[string, string] {
// return validate.Of[string, string]("default")
// })
//
// primary := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.FailureWithMessage[string](input, "primary failed")(ctx)
// }
// }
// secondary := func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// return validation.Success("secondary value")
// }
// }
//
// // Chain: try primary, then secondary, then default
// combined := m.Concat(m.Concat(primary, secondary), m.Empty())
// result := combined("input")(nil)
// // result is validation.Success("secondary value")
//
// # Example: Error Aggregation
//
// // Both fail - errors are aggregated
// m := validate.AltMonoid(func() validate.Validate[string, int] {
// return func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return validation.FailureWithMessage[int](input, "no default")(ctx)
// }
// }
// })
//
// failing1 := func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return validation.FailureWithMessage[int](input, "error 1")(ctx)
// }
// }
// failing2 := func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return validation.FailureWithMessage[int](input, "error 2")(ctx)
// }
// }
//
// combined := m.Concat(failing1, failing2)
// result := combined("input")(nil)
// // result contains both "error 1" and "error 2"
//
// # Comparison with Other Monoids
//
// - **ApplicativeMonoid**: Combines results when both succeed using monoid operation
// - **AlternativeMonoid**: Combines results when both succeed, provides fallback when one fails
// - **AltMonoid**: First success wins, never combines results (pure alternative)
//
// # Use Cases
//
// - Configuration loading with fallback sources (try file, then env, then default)
// - Validation with default values
// - Parser combinators with alternative branches
// - Error recovery with multiple strategies
//
// # Notes
//
// - The zero validator is lazily evaluated, only when needed
// - First success short-circuits evaluation (second validator not called)
// - Error aggregation ensures all validation failures are reported
// - This follows the alternative functor laws
//
// # See Also
//
// - AlternativeMonoid: For combining results when both succeed
// - ApplicativeMonoid: For pure applicative combination
// - MonadAlt: The underlying alternative operation
// - Alt: The curried version for pipeline composition
func AltMonoid[I, A any](zero Lazy[Validate[I, A]]) Monoid[Validate[I, A]] {
return monoid.AltMonoid(
zero,
MonadAlt[I, A],
)
}

View File

@@ -1,475 +1,397 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package validate
import (
"testing"
E "github.com/IBM/fp-go/v2/either"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
MO "github.com/IBM/fp-go/v2/monoid"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/optics/codec/validation"
S "github.com/IBM/fp-go/v2/string"
"github.com/stretchr/testify/assert"
)
var (
intAddMonoid = N.MonoidSum[int]()
strMonoid = S.Monoid
)
// TestAlternativeMonoid tests the AlternativeMonoid function
func TestAlternativeMonoid(t *testing.T) {
t.Run("with string monoid", func(t *testing.T) {
m := AlternativeMonoid[string, string](S.Monoid)
// Helper function to create a successful validator
func successValidator[I, A any](value A) Validate[I, A] {
return func(input I) Reader[validation.Context, validation.Validation[A]] {
return func(ctx validation.Context) validation.Validation[A] {
return validation.Success(value)
}
}
}
t.Run("empty returns validator that succeeds with empty string", func(t *testing.T) {
empty := m.Empty()
result := empty("input")(nil)
// Helper function to create a failing validator
func failureValidator[I, A any](message string) Validate[I, A] {
return func(input I) Reader[validation.Context, validation.Validation[A]] {
return validation.FailureWithMessage[A](input, message)
}
}
assert.Equal(t, validation.Of(""), result)
})
// Helper function to create a validator that uses the input
func inputDependentValidator[A any](f func(A) A) Validate[A, A] {
return func(input A) Reader[validation.Context, validation.Validation[A]] {
return func(ctx validation.Context) validation.Validation[A] {
return validation.Success(f(input))
}
}
}
t.Run("concat combines successful validators using monoid", func(t *testing.T) {
validator1 := Of[string, string]("Hello")
validator2 := Of[string, string](" World")
// TestApplicativeMonoid_EmptyElement tests the empty element of the monoid
func TestApplicativeMonoid_EmptyElement(t *testing.T) {
t.Run("int addition monoid", func(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
empty := m.Empty()
combined := m.Concat(validator1, validator2)
result := combined("input")(nil)
result := empty("test")(nil)
assert.Equal(t, validation.Of("Hello World"), result)
})
assert.Equal(t, validation.Of(0), result)
})
t.Run("string concatenation monoid", func(t *testing.T) {
m := ApplicativeMonoid[int](strMonoid)
empty := m.Empty()
result := empty(42)(nil)
assert.Equal(t, validation.Of(""), result)
})
}
// TestApplicativeMonoid_ConcatSuccesses tests concatenating two successful validators
func TestApplicativeMonoid_ConcatSuccesses(t *testing.T) {
t.Run("int addition", func(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](5)
v2 := successValidator[string](3)
combined := m.Concat(v1, v2)
result := combined("input")(nil)
assert.Equal(t, validation.Of(8), result)
})
t.Run("string concatenation", func(t *testing.T) {
m := ApplicativeMonoid[int](strMonoid)
v1 := successValidator[int]("Hello")
v2 := successValidator[int](" World")
combined := m.Concat(v1, v2)
result := combined(42)(nil)
assert.Equal(t, validation.Of("Hello World"), result)
})
}
// TestApplicativeMonoid_ConcatWithFailure tests concatenating validators where one fails
func TestApplicativeMonoid_ConcatWithFailure(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
t.Run("left failure", func(t *testing.T) {
v1 := failureValidator[string, int]("left error")
v2 := successValidator[string](5)
combined := m.Concat(v1, v2)
result := combined("input")(nil)
assert.True(t, E.IsLeft(result))
_, errors := E.Unwrap(result)
assert.Len(t, errors, 1)
assert.Equal(t, "left error", errors[0].Messsage)
})
t.Run("right failure", func(t *testing.T) {
v1 := successValidator[string](5)
v2 := failureValidator[string, int]("right error")
combined := m.Concat(v1, v2)
result := combined("input")(nil)
assert.True(t, E.IsLeft(result))
_, errors := E.Unwrap(result)
assert.Len(t, errors, 1)
assert.Equal(t, "right error", errors[0].Messsage)
})
t.Run("both failures", func(t *testing.T) {
v1 := failureValidator[string, int]("left error")
v2 := failureValidator[string, int]("right error")
combined := m.Concat(v1, v2)
result := combined("input")(nil)
assert.True(t, E.IsLeft(result))
_, errors := E.Unwrap(result)
// Note: The current implementation returns the first error encountered
assert.GreaterOrEqual(t, len(errors), 1)
// At least one of the errors should be present
hasError := false
for _, err := range errors {
if err.Messsage == "left error" || err.Messsage == "right error" {
hasError = true
break
t.Run("concat uses second as fallback when first fails", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "first failed"},
})
}
}
}
assert.True(t, hasError, "Should contain at least one validation error")
})
}
succeeding := Of[string, string]("fallback")
// TestApplicativeMonoid_LeftIdentity tests the left identity law
func TestApplicativeMonoid_LeftIdentity(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
combined := m.Concat(failing, succeeding)
result := combined("input")(nil)
v := successValidator[string](42)
assert.Equal(t, validation.Of("fallback"), result)
})
// empty <> v == v
combined := m.Concat(m.Empty(), v)
resultCombined := combined("test")(nil)
resultOriginal := v("test")(nil)
assert.Equal(t, resultOriginal, resultCombined)
}
// TestApplicativeMonoid_RightIdentity tests the right identity law
func TestApplicativeMonoid_RightIdentity(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v := successValidator[string](42)
// v <> empty == v
combined := m.Concat(v, m.Empty())
resultCombined := combined("test")(nil)
resultOriginal := v("test")(nil)
assert.Equal(t, resultOriginal, resultCombined)
}
// TestApplicativeMonoid_Associativity tests the associativity law
func TestApplicativeMonoid_Associativity(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](1)
v2 := successValidator[string](2)
v3 := successValidator[string](3)
// (v1 <> v2) <> v3 == v1 <> (v2 <> v3)
left := m.Concat(m.Concat(v1, v2), v3)
right := m.Concat(v1, m.Concat(v2, v3))
resultLeft := left("test")(nil)
resultRight := right("test")(nil)
assert.Equal(t, resultRight, resultLeft)
// Both should equal 6
assert.Equal(t, validation.Of(6), resultLeft)
}
// TestApplicativeMonoid_AssociativityWithFailures tests associativity with failures
func TestApplicativeMonoid_AssociativityWithFailures(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](1)
v2 := failureValidator[string, int]("error 2")
v3 := successValidator[string](3)
// (v1 <> v2) <> v3 == v1 <> (v2 <> v3)
left := m.Concat(m.Concat(v1, v2), v3)
right := m.Concat(v1, m.Concat(v2, v3))
resultLeft := left("test")(nil)
resultRight := right("test")(nil)
// Both should fail with the same error
assert.True(t, E.IsLeft(resultLeft))
assert.True(t, E.IsLeft(resultRight))
_, errorsLeft := E.Unwrap(resultLeft)
_, errorsRight := E.Unwrap(resultRight)
assert.Len(t, errorsLeft, 1)
assert.Len(t, errorsRight, 1)
assert.Equal(t, "error 2", errorsLeft[0].Messsage)
assert.Equal(t, "error 2", errorsRight[0].Messsage)
}
// TestApplicativeMonoid_MultipleValidators tests combining multiple validators
func TestApplicativeMonoid_MultipleValidators(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](10)
v2 := successValidator[string](20)
v3 := successValidator[string](30)
v4 := successValidator[string](40)
// Chain multiple concat operations
combined := m.Concat(
m.Concat(
m.Concat(v1, v2),
v3,
),
v4,
)
result := combined("test")(nil)
assert.Equal(t, validation.Of(100), result)
}
// TestApplicativeMonoid_InputDependent tests validators that depend on input
func TestApplicativeMonoid_InputDependent(t *testing.T) {
m := ApplicativeMonoid[int](intAddMonoid)
// Validator that doubles the input
v1 := inputDependentValidator(N.Mul(2))
// Validator that adds 10 to the input
v2 := inputDependentValidator(N.Add(10))
combined := m.Concat(v1, v2)
result := combined(5)(nil)
// (5 * 2) + (5 + 10) = 10 + 15 = 25
assert.Equal(t, validation.Of(25), result)
}
// TestApplicativeMonoid_ContextPropagation tests that context is properly propagated
func TestApplicativeMonoid_ContextPropagation(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
// Create a validator that captures the context
var capturedContext validation.Context
v1 := func(input string) Reader[validation.Context, validation.Validation[int]] {
return func(ctx validation.Context) validation.Validation[int] {
capturedContext = ctx
return validation.Success(5)
}
}
v2 := successValidator[string](3)
combined := m.Concat(v1, v2)
// Create a context with some entries
ctx := validation.Context{
{Key: "field1", Type: "int"},
{Key: "field2", Type: "string"},
}
result := combined("test")(ctx)
assert.True(t, E.IsRight(result))
assert.Equal(t, ctx, capturedContext)
}
// TestApplicativeMonoid_ErrorAccumulation tests that errors are accumulated
func TestApplicativeMonoid_ErrorAccumulation(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := failureValidator[string, int]("error 1")
v2 := failureValidator[string, int]("error 2")
v3 := failureValidator[string, int]("error 3")
combined := m.Concat(m.Concat(v1, v2), v3)
result := combined("test")(nil)
assert.True(t, E.IsLeft(result))
_, errors := E.Unwrap(result)
// Note: The current implementation returns the first error encountered
// At least one error should be present
assert.GreaterOrEqual(t, len(errors), 1)
hasError := false
for _, err := range errors {
if err.Messsage == "error 1" || err.Messsage == "error 2" || err.Messsage == "error 3" {
hasError = true
break
}
}
assert.True(t, hasError, "Should contain at least one validation error")
}
// TestApplicativeMonoid_MixedSuccessFailure tests mixing successes and failures
func TestApplicativeMonoid_MixedSuccessFailure(t *testing.T) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](10)
v2 := failureValidator[string, int]("error in v2")
v3 := successValidator[string](20)
v4 := failureValidator[string, int]("error in v4")
combined := m.Concat(
m.Concat(
m.Concat(v1, v2),
v3,
),
v4,
)
result := combined("test")(nil)
assert.True(t, E.IsLeft(result))
_, errors := E.Unwrap(result)
// Note: The current implementation returns the first error encountered
// At least one error should be present
assert.GreaterOrEqual(t, len(errors), 1)
hasError := false
for _, err := range errors {
if err.Messsage == "error in v2" || err.Messsage == "error in v4" {
hasError = true
break
}
}
assert.True(t, hasError, "Should contain at least one validation error")
}
// TestApplicativeMonoid_DifferentInputTypes tests with different input types
func TestApplicativeMonoid_DifferentInputTypes(t *testing.T) {
t.Run("struct input", func(t *testing.T) {
type Config struct {
Port int
Timeout int
}
m := ApplicativeMonoid[Config](intAddMonoid)
v1 := func(cfg Config) Reader[validation.Context, validation.Validation[int]] {
return func(ctx validation.Context) validation.Validation[int] {
return validation.Success(cfg.Port)
t.Run("concat aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
}
v2 := func(cfg Config) Reader[validation.Context, validation.Validation[int]] {
return func(ctx validation.Context) validation.Validation[int] {
return validation.Success(cfg.Timeout)
failing2 := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
}
combined := m.Concat(v1, v2)
result := combined(Config{Port: 8080, Timeout: 30})(nil)
combined := m.Concat(failing1, failing2)
result := combined("input")(nil)
assert.Equal(t, validation.Of(8110), result) // 8080 + 30
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(string) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both validators")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
t.Run("concat with empty preserves validator", func(t *testing.T) {
validator := Of[string, string]("test")
empty := m.Empty()
result1 := m.Concat(validator, empty)("input")(nil)
result2 := m.Concat(empty, validator)("input")(nil)
val1 := either.MonadFold(result1,
func(Errors) string { return "" },
F.Identity[string],
)
val2 := either.MonadFold(result2,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "test", val1)
assert.Equal(t, "test", val2)
})
})
}
// TestApplicativeMonoid_StringConcatenation tests string concatenation scenarios
func TestApplicativeMonoid_StringConcatenation(t *testing.T) {
m := ApplicativeMonoid[string](strMonoid)
t.Run("build sentence", func(t *testing.T) {
v1 := successValidator[string]("The")
v2 := successValidator[string](" quick")
v3 := successValidator[string](" brown")
v4 := successValidator[string](" fox")
combined := m.Concat(
m.Concat(
m.Concat(v1, v2),
v3,
),
v4,
t.Run("with int addition monoid", func(t *testing.T) {
intMonoid := MO.MakeMonoid(
func(a, b int) int { return a + b },
0,
)
m := AlternativeMonoid[string, int](intMonoid)
result := combined("input")(nil)
t.Run("empty returns validator with zero", func(t *testing.T) {
empty := m.Empty()
result := empty("input")(nil)
assert.Equal(t, validation.Of("The quick brown fox"), result)
value := either.MonadFold(result,
func(Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
})
t.Run("concat combines decoded values when both succeed", func(t *testing.T) {
validator1 := Of[string, int](10)
validator2 := Of[string, int](32)
combined := m.Concat(validator1, validator2)
result := combined("input")(nil)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
})
t.Run("concat uses fallback when first fails", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
}
succeeding := Of[string, int](42)
combined := m.Concat(failing, succeeding)
result := combined("input")(nil)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
})
t.Run("multiple concat operations", func(t *testing.T) {
validator1 := Of[string, int](1)
validator2 := Of[string, int](2)
validator3 := Of[string, int](3)
validator4 := Of[string, int](4)
combined := m.Concat(m.Concat(m.Concat(validator1, validator2), validator3), validator4)
result := combined("input")(nil)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value)
})
})
t.Run("with empty strings", func(t *testing.T) {
v1 := successValidator[string]("Hello")
v2 := successValidator[string]("")
v3 := successValidator[string]("World")
t.Run("satisfies monoid laws", func(t *testing.T) {
m := AlternativeMonoid[string, string](S.Monoid)
combined := m.Concat(m.Concat(v1, v2), v3)
result := combined("input")(nil)
validator1 := Of[string, string]("a")
validator2 := Of[string, string]("b")
validator3 := Of[string, string]("c")
assert.Equal(t, validation.Of("HelloWorld"), result)
t.Run("left identity", func(t *testing.T) {
result := m.Concat(m.Empty(), validator1)("input")(nil)
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("right identity", func(t *testing.T) {
result := m.Concat(validator1, m.Empty())("input")(nil)
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
})
t.Run("associativity", func(t *testing.T) {
left := m.Concat(m.Concat(validator1, validator2), validator3)("input")(nil)
right := m.Concat(validator1, m.Concat(validator2, validator3))("input")(nil)
leftVal := either.MonadFold(left,
func(Errors) string { return "" },
F.Identity[string],
)
rightVal := either.MonadFold(right,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "abc", leftVal)
assert.Equal(t, "abc", rightVal)
})
})
}
// Benchmark tests
func BenchmarkApplicativeMonoid_ConcatSuccesses(b *testing.B) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := successValidator[string](5)
v2 := successValidator[string](3)
combined := m.Concat(v1, v2)
// TestAltMonoid tests the AltMonoid function
func TestAltMonoid(t *testing.T) {
t.Run("with default value as zero", func(t *testing.T) {
m := AltMonoid(func() Validate[string, int] {
return Of[string, int](0)
})
b.ResetTimer()
for range b.N {
_ = combined("test")(nil)
}
}
func BenchmarkApplicativeMonoid_ConcatFailures(b *testing.B) {
m := ApplicativeMonoid[string](intAddMonoid)
v1 := failureValidator[string, int]("error 1")
v2 := failureValidator[string, int]("error 2")
combined := m.Concat(v1, v2)
b.ResetTimer()
for range b.N {
_ = combined("test")(nil)
}
}
func BenchmarkApplicativeMonoid_MultipleConcat(b *testing.B) {
m := ApplicativeMonoid[string](intAddMonoid)
validators := make([]Validate[string, int], 10)
for i := range validators {
validators[i] = successValidator[string](i)
}
// Chain all validators
combined := validators[0]
for i := 1; i < len(validators); i++ {
combined = m.Concat(combined, validators[i])
}
b.ResetTimer()
for range b.N {
_ = combined("test")(nil)
}
t.Run("empty returns the provided zero validator", func(t *testing.T) {
empty := m.Empty()
result := empty("input")(nil)
assert.Equal(t, validation.Of(0), result)
})
t.Run("concat returns first validator when it succeeds", func(t *testing.T) {
validator1 := Of[string, int](42)
validator2 := Of[string, int](100)
combined := m.Concat(validator1, validator2)
result := combined("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("concat uses second as fallback when first fails", func(t *testing.T) {
failing := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "failed"},
})
}
}
succeeding := Of[string, int](42)
combined := m.Concat(failing, succeeding)
result := combined("input")(nil)
assert.Equal(t, validation.Of(42), result)
})
t.Run("concat aggregates errors when both fail", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
combined := m.Concat(failing1, failing2)
result := combined("input")(nil)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors from both validators")
messages := make([]string, len(errors))
for i, err := range errors {
messages[i] = err.Messsage
}
assert.Contains(t, messages, "error 1")
assert.Contains(t, messages, "error 2")
})
})
t.Run("with failing zero", func(t *testing.T) {
m := AltMonoid(func() Validate[string, int] {
return func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Messsage: "no default available"},
})
}
}
})
t.Run("empty returns the failing zero validator", func(t *testing.T) {
empty := m.Empty()
result := empty("input")(nil)
assert.True(t, either.IsLeft(result))
})
t.Run("concat with all failures aggregates errors", func(t *testing.T) {
failing1 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 1"},
})
}
}
failing2 := func(input string) Reader[Context, Validation[int]] {
return func(ctx Context) Validation[int] {
return either.Left[int](validation.Errors{
{Value: input, Messsage: "error 2"},
})
}
}
combined := m.Concat(failing1, failing2)
result := combined("input")(nil)
assert.True(t, either.IsLeft(result))
errors := either.MonadFold(result,
F.Identity[Errors],
func(int) Errors { return nil },
)
assert.GreaterOrEqual(t, len(errors), 2, "Should aggregate errors")
})
})
t.Run("chaining multiple fallbacks", func(t *testing.T) {
m := AltMonoid(func() Validate[string, string] {
return Of[string, string]("default")
})
primary := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "primary failed"},
})
}
}
secondary := func(input string) Reader[Context, Validation[string]] {
return func(ctx Context) Validation[string] {
return either.Left[string](validation.Errors{
{Value: input, Messsage: "secondary failed"},
})
}
}
tertiary := Of[string, string]("tertiary value")
combined := m.Concat(m.Concat(primary, secondary), tertiary)
result := combined("input")(nil)
assert.Equal(t, validation.Of("tertiary value"), result)
})
t.Run("difference from AlternativeMonoid", func(t *testing.T) {
// AltMonoid - first success wins
altM := AltMonoid(func() Validate[string, int] {
return Of[string, int](0)
})
// AlternativeMonoid - combines successes
altMonoid := AlternativeMonoid[string, int](N.MonoidSum[int]())
validator1 := Of[string, int](10)
validator2 := Of[string, int](32)
// AltMonoid: returns first success (10)
result1 := altM.Concat(validator1, validator2)("input")(nil)
value1 := either.MonadFold(result1,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value1, "AltMonoid returns first success")
// AlternativeMonoid: combines both successes (10 + 32 = 42)
result2 := altMonoid.Concat(validator1, validator2)("input")(nil)
value2 := either.MonadFold(result2,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value2, "AlternativeMonoid combines successes")
})
}

View File

@@ -17,13 +17,16 @@ package validate
import (
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/codec/decode"
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/readerresult"
)
type (
ReaderResult[R, A any] = readerresult.ReaderResult[R, A]
// Monoid represents an algebraic structure with an associative binary operation
// and an identity element. Used for combining values of type A.
@@ -271,4 +274,6 @@ type (
// lower := strings.ToLower // Endomorphism[string]
// normalize := compose(trim, lower) // Endomorphism[string]
Endomorphism[A any] = endomorphism.Endomorphism[A]
Lazy[A any] = lazy.Lazy[A]
)

View File

@@ -119,6 +119,7 @@
package validate
import (
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/internal/readert"
"github.com/IBM/fp-go/v2/optics/codec/decode"
"github.com/IBM/fp-go/v2/reader"
@@ -429,6 +430,145 @@ func ChainLeft[I, A any](f Kleisli[I, Errors, A]) Operator[I, A, A] {
)
}
// MonadChainLeft sequences a computation on the failure (Left) channel of a validation.
//
// This is the direct application version of ChainLeft. It operates on the error path
// of validation, allowing you to transform, enrich, or recover from validation failures.
// It's the dual of Chain - while Chain operates on success values, MonadChainLeft
// operates on error values.
//
// # Key Behavior
//
// **Critical difference from standard Either operations**: This validation-specific
// implementation **aggregates errors** using the Errors monoid. When the transformation
// function returns a failure, both the original errors AND the new errors are combined,
// ensuring comprehensive error reporting.
//
// 1. **Success Pass-Through**: If validation succeeds, the handler is never called and
// the success value passes through unchanged.
//
// 2. **Error Recovery**: The handler can recover from failures by returning a successful
// validation, converting Left to Right.
//
// 3. **Error Aggregation**: When the handler also returns a failure, both the original
// errors and the new errors are combined using the Errors monoid.
//
// 4. **Input Access**: The handler returns a Validate[I, A] function, giving it access
// to the original input value I for context-aware error handling.
//
// # Type Parameters
//
// - I: The input type
// - A: The type of the validation result
//
// # Parameters
//
// - fa: The Validate[I, A] to transform
// - f: A Kleisli arrow that takes Errors and returns a Validate[I, A]. This function
// is called only when validation fails, receiving the accumulated errors.
//
// # Returns
//
// A Validate[I, A] that handles error cases according to the provided function.
//
// # Example: Error Recovery
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// "github.com/IBM/fp-go/v2/optics/codec/validation"
// )
//
// // Validator that may fail
// validatePositive := func(n int) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// if n > 0 {
// return validation.Success(n)
// }
// return validation.FailureWithMessage[int](n, "must be positive")(ctx)
// }
// }
//
// // Recover from specific errors with a default value
// withDefault := func(errs validation.Errors) validate.Validate[int, int] {
// for _, err := range errs {
// if err.Messsage == "must be positive" {
// return validate.Of[int](0) // recover with default
// }
// }
// // Propagate other errors
// return func(input int) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return either.Left[int](errs)
// }
// }
// }
//
// validator := validate.MonadChainLeft(validatePositive, withDefault)
// result := validator(-5)(nil)
// // Result: Success(0) - recovered from failure
//
// # Example: Error Context Addition
//
// // Add contextual information to errors
// addContext := func(errs validation.Errors) validate.Validate[string, int] {
// return func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// // Add context error (will be aggregated with original)
// return either.Left[int](validation.Errors{
// {
// Context: validation.Context{{Key: "user", Type: "User"}, {Key: "age", Type: "int"}},
// Messsage: "failed to validate user age",
// },
// })
// }
// }
// }
//
// validator := validate.MonadChainLeft(someValidator, addContext)
// // Errors will include both original error and context
//
// # Example: Input-Dependent Recovery
//
// // Recover with different defaults based on input
// smartDefault := func(errs validation.Errors) validate.Validate[string, int] {
// return func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// // Use input to determine appropriate default
// if strings.Contains(input, "http:") {
// return validation.Success(80)
// }
// if strings.Contains(input, "https:") {
// return validation.Success(443)
// }
// return validation.Success(8080)
// }
// }
// }
//
// validator := validate.MonadChainLeft(parsePort, smartDefault)
//
// # Notes
//
// - Errors are accumulated, not replaced - this ensures no validation failures are lost
// - The handler has access to both the errors and the original input
// - Success values bypass the handler completely
// - This is the direct application version of ChainLeft
// - This enables sophisticated error handling strategies including recovery, enrichment, and transformation
//
// # See Also
//
// - ChainLeft: The curried, point-free version
// - OrElse: Semantic alias for ChainLeft emphasizing fallback logic
// - MonadAlt: Simplified alternative that ignores error details
// - Alt: Curried version of MonadAlt
func MonadChainLeft[I, A any](fa Validate[I, A], f Kleisli[I, Errors, A]) Validate[I, A] {
return readert.MonadChain(
decode.MonadChainLeft,
fa,
f,
)
}
// OrElse provides an alternative validation when the primary validation fails.
//
// This is a semantic alias for ChainLeft with identical behavior. The name "OrElse"
@@ -628,3 +768,218 @@ func Ap[B, I, A any](fa Validate[I, A]) Operator[I, func(A) B, B] {
fa,
)
}
// Alt provides an alternative validator when the primary validator fails.
//
// This is the curried, point-free version of MonadAlt. It creates an operator that
// transforms a validator by adding a fallback alternative. When the first validator
// fails, the second (lazily evaluated) validator is tried. If both fail, errors are
// aggregated.
//
// Alt implements the Alternative typeclass pattern, providing a way to express
// "try this, or else try that" logic in a composable way.
//
// # Type Parameters
//
// - I: The input type
// - A: The type of the validation result
//
// # Parameters
//
// - second: A lazy Validate[I, A] that serves as the fallback. It's only evaluated
// if the first validator fails.
//
// # Returns
//
// An Operator[I, A, A] that transforms validators by adding alternative fallback logic.
//
// # Behavior
//
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
//
// # Example: Fallback Validation
//
// import (
// F "github.com/IBM/fp-go/v2/function"
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// "github.com/IBM/fp-go/v2/optics/codec/validation"
// )
//
// // Primary validator that may fail
// validateFromConfig := func(key string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// // Try to get value from config
// if value, ok := config[key]; ok {
// return validation.Success(value)
// }
// return validation.FailureWithMessage[string](key, "not in config")(ctx)
// }
// }
//
// // Fallback to environment variable
// validateFromEnv := func(key string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// if value := os.Getenv(key); value != "" {
// return validation.Success(value)
// }
// return validation.FailureWithMessage[string](key, "not in env")(ctx)
// }
// }
//
// // Use Alt to add fallback - point-free style
// withFallback := validate.Alt(func() validate.Validate[string, string] {
// return validateFromEnv
// })
//
// validator := withFallback(validateFromConfig)
// result := validator("DATABASE_URL")(nil)
// // Tries config first, falls back to environment variable
//
// # Example: Pipeline with Multiple Alternatives
//
// // Chain multiple alternatives using function composition
// validator := F.Pipe2(
// validateFromDatabase,
// validate.Alt(func() validate.Validate[string, Config] {
// return validateFromCache
// }),
// validate.Alt(func() validate.Validate[string, Config] {
// return validate.Of[string](defaultConfig)
// }),
// )
// // Tries database, then cache, then default
//
// # Notes
//
// - The second validator is lazily evaluated for efficiency
// - First success short-circuits evaluation
// - Errors are aggregated when both fail
// - This is the point-free version of MonadAlt
// - Useful for building validation pipelines with F.Pipe
//
// # See Also
//
// - MonadAlt: The direct application version
// - ChainLeft: The more general error transformation operator
// - OrElse: Semantic alias for ChainLeft
// - AltMonoid: For combining multiple alternatives with monoid structure
func Alt[I, A any](second Lazy[Validate[I, A]]) Operator[I, A, A] {
return ChainLeft(function.Ignore1of1[Errors](second))
}
// MonadAlt provides an alternative validator when the primary validator fails.
//
// This is the direct application version of Alt. It takes two validators and returns
// a new validator that tries the first, and if it fails, tries the second. If both
// fail, errors from both are aggregated.
//
// MonadAlt implements the Alternative typeclass pattern, enabling "try this, or else
// try that" logic with comprehensive error reporting.
//
// # Type Parameters
//
// - I: The input type
// - A: The type of the validation result
//
// # Parameters
//
// - first: The primary Validate[I, A] to try first
// - second: A lazy Validate[I, A] that serves as the fallback. It's only evaluated
// if the first validator fails.
//
// # Returns
//
// A Validate[I, A] that tries the first validator, falling back to the second if needed.
//
// # Behavior
//
// - **First succeeds**: Returns the first result, second is never evaluated
// - **First fails, second succeeds**: Returns the second result
// - **Both fail**: Aggregates errors from both validators
//
// # Example: Configuration with Fallback
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// "github.com/IBM/fp-go/v2/optics/codec/validation"
// )
//
// // Primary validator
// validateFromConfig := func(key string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// if value, ok := config[key]; ok {
// return validation.Success(value)
// }
// return validation.FailureWithMessage[string](key, "not in config")(ctx)
// }
// }
//
// // Fallback validator
// validateFromEnv := func(key string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// if value := os.Getenv(key); value != "" {
// return validation.Success(value)
// }
// return validation.FailureWithMessage[string](key, "not in env")(ctx)
// }
// }
//
// // Combine with MonadAlt
// validator := validate.MonadAlt(
// validateFromConfig,
// func() validate.Validate[string, string] { return validateFromEnv },
// )
// result := validator("DATABASE_URL")(nil)
// // Tries config first, falls back to environment variable
//
// # Example: Multiple Fallbacks
//
// // Chain multiple alternatives
// validator := validate.MonadAlt(
// validate.MonadAlt(
// validateFromDatabase,
// func() validate.Validate[string, Config] { return validateFromCache },
// ),
// func() validate.Validate[string, Config] { return validate.Of[string](defaultConfig) },
// )
// // Tries database, then cache, then default
//
// # Example: Error Aggregation
//
// failing1 := func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return validation.FailureWithMessage[int](input, "error 1")(ctx)
// }
// }
// failing2 := func(input string) validate.Reader[validation.Context, validation.Validation[int]] {
// return func(ctx validation.Context) validation.Validation[int] {
// return validation.FailureWithMessage[int](input, "error 2")(ctx)
// }
// }
//
// validator := validate.MonadAlt(
// failing1,
// func() validate.Validate[string, int] { return failing2 },
// )
// result := validator("input")(nil)
// // result contains both "error 1" and "error 2"
//
// # Notes
//
// - The second validator is lazily evaluated for efficiency
// - First success short-circuits evaluation (second not called)
// - Errors are aggregated when both fail
// - This is equivalent to Alt but with direct application
// - Both validators receive the same input value
//
// # See Also
//
// - Alt: The curried, point-free version
// - MonadChainLeft: The underlying error transformation operation
// - OrElse: Semantic alias for ChainLeft
// - AltMonoid: For combining multiple alternatives with monoid structure
func MonadAlt[I, A any](first Validate[I, A], second Lazy[Validate[I, A]]) Validate[I, A] {
return MonadChainLeft(first, function.Ignore1of1[Errors](second))
}

View File

@@ -474,3 +474,168 @@ func Applicative[A, B any]() applicative.Applicative[A, B, Validation[A], Valida
func OrElse[A any](f Kleisli[Errors, A]) Operator[A, A] {
return ChainLeft(f)
}
// MonadAlt implements the Alternative operation for Validation, providing fallback behavior.
// If the first validation fails, it evaluates and returns the second validation as an alternative.
// If the first validation succeeds, it returns the first validation without evaluating the second.
//
// This is the fundamental operation for the Alt typeclass, enabling "try first, fallback to second"
// semantics. It's particularly useful for:
// - Providing default values when validation fails
// - Trying multiple validation strategies in sequence
// - Building validation pipelines with fallback logic
// - Implementing optional validation with defaults
//
// **Key behavior**: When both validations fail, MonadAlt DOES accumulate errors from both
// validations using the Errors monoid. This is different from standard Either Alt behavior.
// The error accumulation happens through the underlying ChainLeft/chainErrors mechanism.
//
// The second parameter is lazy (Lazy[Validation[A]]) to avoid unnecessary computation when
// the first validation succeeds. The second validation is only evaluated if needed.
//
// Behavior:
// - First succeeds: returns first validation (second is not evaluated)
// - First fails, second succeeds: returns second validation
// - Both fail: aggregates errors from both validations
//
// This is useful for:
// - Fallback values: provide defaults when primary validation fails
// - Alternative strategies: try different validation approaches
// - Optional validation: make validation optional with a default
// - Chaining attempts: try multiple sources until one succeeds
//
// Type Parameters:
// - A: The type of the successful value
//
// Parameters:
// - first: The primary validation to try
// - second: A lazy computation producing the fallback validation (only evaluated if first fails)
//
// Returns:
//
// The first validation if it succeeds, otherwise the second validation
//
// Example - Fallback to default:
//
// primary := parseConfig("config.json") // Fails
// fallback := func() Validation[Config] {
// return Success(defaultConfig)
// }
// result := MonadAlt(primary, fallback)
// // Result: Success(defaultConfig)
//
// Example - First succeeds (second not evaluated):
//
// primary := Success(42)
// fallback := func() Validation[int] {
// panic("never called") // This won't execute
// }
// result := MonadAlt(primary, fallback)
// // Result: Success(42)
//
// Example - Chaining multiple alternatives:
//
// result := MonadAlt(
// parseFromEnv("API_KEY"),
// func() Validation[string] {
// return MonadAlt(
// parseFromFile(".env"),
// func() Validation[string] {
// return Success("default-key")
// },
// )
// },
// )
// // Tries: env var → file → default (uses first that succeeds)
//
// Example - Error accumulation when both fail:
//
// v1 := Failures[int](Errors{
// &ValidationError{Messsage: "error 1"},
// &ValidationError{Messsage: "error 2"},
// })
// v2 := func() Validation[int] {
// return Failures[int](Errors{
// &ValidationError{Messsage: "error 3"},
// })
// }
// result := MonadAlt(v1, v2)
// // Result: Failures with ALL errors ["error 1", "error 2", "error 3"]
// // The errors from v1 are aggregated with errors from v2
func MonadAlt[A any](first Validation[A], second Lazy[Validation[A]]) Validation[A] {
return MonadChainLeft(first, function.Ignore1of1[Errors](second))
}
// Alt is the curried version of [MonadAlt].
// Returns a function that provides fallback behavior for a Validation.
//
// This is useful for creating reusable fallback operators that can be applied
// to multiple validations, or for use in function composition pipelines.
//
// The returned function takes a validation and returns either that validation
// (if successful) or the provided alternative (if the validation fails).
//
// Type Parameters:
// - A: The type of the successful value
//
// Parameters:
// - second: A lazy computation producing the fallback validation
//
// Returns:
//
// A function that takes a Validation[A] and returns a Validation[A] with fallback behavior
//
// Example - Creating a reusable fallback operator:
//
// withDefault := Alt(func() Validation[int] {
// return Success(0)
// })
//
// result1 := withDefault(parseNumber("42")) // Success(42)
// result2 := withDefault(parseNumber("abc")) // Success(0) - fallback
// result3 := withDefault(parseNumber("123")) // Success(123)
//
// Example - Using in a pipeline:
//
// import F "github.com/IBM/fp-go/v2/function"
//
// result := F.Pipe2(
// parseFromEnv("CONFIG_PATH"),
// Alt(func() Validation[string] {
// return parseFromFile("config.json")
// }),
// Alt(func() Validation[string] {
// return Success("./default-config.json")
// }),
// )
// // Tries: env var → file → default path
//
// Example - Combining with Map:
//
// import F "github.com/IBM/fp-go/v2/function"
//
// result := F.Pipe2(
// validatePositive(-5), // Fails
// Alt(func() Validation[int] { return Success(1) }),
// Map(func(x int) int { return x * 2 }),
// )
// // Result: Success(2) - uses fallback value 1, then doubles it
//
// Example - Multiple fallback layers:
//
// primaryFallback := Alt(func() Validation[Config] {
// return loadFromFile("backup.json")
// })
// secondaryFallback := Alt(func() Validation[Config] {
// return Success(defaultConfig)
// })
//
// result := F.Pipe2(
// loadFromFile("config.json"),
// primaryFallback,
// secondaryFallback,
// )
// // Tries: config.json → backup.json → default
func Alt[A any](second Lazy[Validation[A]]) Operator[A, A] {
return ChainLeft(function.Ignore1of1[Errors](second))
}

View File

@@ -52,3 +52,177 @@ func ApplicativeMonoid[A any](m Monoid[A]) Monoid[Validation[A]] {
m,
)
}
// AlternativeMonoid creates a Monoid instance for Validation[A] using the Alternative pattern.
// This combines the applicative error-accumulation behavior with the alternative fallback behavior,
// allowing you to both accumulate errors and provide fallback alternatives.
//
// The Alternative pattern provides two key operations:
// - Applicative operations (Of, Map, Ap): accumulate errors when combining validations
// - Alternative operation (Alt): provide fallback when a validation fails
//
// This monoid is particularly useful when you want to:
// - Try multiple validation strategies and fall back to alternatives
// - Combine successful values using the provided monoid
// - Accumulate all errors from failed attempts
// - Build validation pipelines with fallback logic
//
// The resulting monoid:
// - Empty: Returns a successful validation with the empty value from the inner monoid
// - Concat: Combines two validations using both applicative and alternative semantics:
// - If first succeeds and second succeeds: combines values using inner monoid
// - If first fails: tries second as fallback (alternative behavior)
// - If both fail: accumulates all errors
//
// Type Parameters:
// - A: The type of the successful value
//
// Parameters:
// - m: The monoid for combining successful values of type A
//
// Returns:
//
// A Monoid[Validation[A]] that combines applicative and alternative behaviors
//
// Example - Combining successful validations:
//
// import "github.com/IBM/fp-go/v2/string"
//
// m := AlternativeMonoid(string.Monoid)
// v1 := Success("Hello")
// v2 := Success(" World")
// result := m.Concat(v1, v2)
// // Result: Success("Hello World")
//
// Example - Fallback behavior:
//
// m := AlternativeMonoid(string.Monoid)
// v1 := Failures[string](Errors{&ValidationError{Messsage: "first failed"}})
// v2 := Success("fallback value")
// result := m.Concat(v1, v2)
// // Result: Success("fallback value") - second validation used as fallback
//
// Example - Error accumulation when both fail:
//
// m := AlternativeMonoid(string.Monoid)
// v1 := Failures[string](Errors{&ValidationError{Messsage: "error 1"}})
// v2 := Failures[string](Errors{&ValidationError{Messsage: "error 2"}})
// result := m.Concat(v1, v2)
// // Result: Failures with accumulated errors: ["error 1", "error 2"]
//
// Example - Building validation with fallbacks:
//
// import N "github.com/IBM/fp-go/v2/number"
//
// m := AlternativeMonoid(N.MonoidSum[int]())
//
// // Try to parse from different sources
// fromEnv := parseFromEnv() // Fails
// fromConfig := parseFromConfig() // Succeeds with 42
// fromDefault := Success(0) // Default fallback
//
// result := m.Concat(m.Concat(fromEnv, fromConfig), fromDefault)
// // Result: Success(42) - uses first successful validation
func AlternativeMonoid[A any](m Monoid[A]) Monoid[Validation[A]] {
return M.AlternativeMonoid(
Of[A],
MonadMap[A, func(A) A],
MonadAp[A, A],
MonadAlt[A],
m,
)
}
// AltMonoid creates a Monoid instance for Validation[A] using the Alt (alternative) operation.
// This monoid provides a way to combine validations with fallback behavior, where the second
// validation is used as an alternative if the first one fails.
//
// The Alt operation implements the "try first, fallback to second" pattern, which is useful
// for validation scenarios where you want to attempt multiple validation strategies in sequence
// and use the first one that succeeds.
//
// The resulting monoid:
// - Empty: Returns the provided zero value (a lazy computation that produces a Validation[A])
// - Concat: Combines two validations using Alt semantics:
// - If first succeeds: returns the first validation (ignores second)
// - If first fails: returns the second validation as fallback
//
// This is different from [AlternativeMonoid] in that:
// - AltMonoid uses a custom zero value (provided by the user)
// - AlternativeMonoid derives the zero from an inner monoid
// - AltMonoid is simpler and only provides fallback behavior
// - AlternativeMonoid combines applicative and alternative behaviors
//
// Type Parameters:
// - A: The type of the successful value
//
// Parameters:
// - zero: A lazy computation that produces the identity/empty Validation[A].
// This is typically a successful validation with a default value, or could be
// a failure representing "no validation attempted"
//
// Returns:
//
// A Monoid[Validation[A]] that combines validations with fallback behavior
//
// Example - Using default value as zero:
//
// m := AltMonoid(func() Validation[int] { return Success(0) })
//
// v1 := Failures[int](Errors{&ValidationError{Messsage: "failed"}})
// v2 := Success(42)
//
// result := m.Concat(v1, v2)
// // Result: Success(42) - falls back to second validation
//
// empty := m.Empty()
// // Result: Success(0) - the provided zero value
//
// Example - Chaining multiple fallbacks:
//
// m := AltMonoid(func() Validation[string] {
// return Success("default")
// })
//
// primary := parseFromPrimarySource() // Fails
// secondary := parseFromSecondary() // Fails
// tertiary := parseFromTertiary() // Succeeds with "value"
//
// result := m.Concat(m.Concat(primary, secondary), tertiary)
// // Result: Success("value") - uses first successful validation
//
// Example - All validations fail:
//
// m := AltMonoid(func() Validation[int] {
// return Failures[int](Errors{&ValidationError{Messsage: "no default"}})
// })
//
// v1 := Failures[int](Errors{&ValidationError{Messsage: "error 1"}})
// v2 := Failures[int](Errors{&ValidationError{Messsage: "error 2"}})
//
// result := m.Concat(v1, v2)
// // Result: Failures with errors from v2: ["error 2"]
// // Note: Unlike AlternativeMonoid, errors are NOT accumulated
//
// Example - Building a validation pipeline with fallbacks:
//
// m := AltMonoid(func() Validation[Config] {
// return Success(defaultConfig)
// })
//
// // Try multiple configuration sources in order
// configs := []Validation[Config]{
// loadFromFile("config.json"), // Try file first
// loadFromEnv(), // Then environment
// loadFromRemote("api.example.com"), // Then remote API
// }
//
// // Fold using the monoid to get first successful config
// result := A.MonoidFold(m)(configs)
// // Result: First successful config, or defaultConfig if all fail
func AltMonoid[A any](zero Lazy[Validation[A]]) Monoid[Validation[A]] {
return M.AltMonoid(
zero,
MonadAlt[A],
)
}

View File

@@ -131,17 +131,8 @@ func TestApplicativeMonoid(t *testing.T) {
result1 := m.Concat(v, empty)
result2 := m.Concat(empty, v)
val1 := either.MonadFold(result1,
func(Errors) string { return "" },
F.Identity[string],
)
val2 := either.MonadFold(result2,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "test", val1)
assert.Equal(t, "test", val2)
assert.Equal(t, Of("test"), result1)
assert.Equal(t, Of("test"), result2)
})
})
@@ -156,11 +147,7 @@ func TestApplicativeMonoid(t *testing.T) {
t.Run("empty returns zero", func(t *testing.T) {
empty := m.Empty()
value := either.MonadFold(empty,
func(Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
assert.Equal(t, Of(0), empty)
})
t.Run("concat adds values", func(t *testing.T) {
@@ -169,11 +156,7 @@ func TestApplicativeMonoid(t *testing.T) {
result := m.Concat(v1, v2)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
assert.Equal(t, Of(42), result)
})
t.Run("multiple concat operations", func(t *testing.T) {
@@ -184,11 +167,7 @@ func TestApplicativeMonoid(t *testing.T) {
result := m.Concat(m.Concat(m.Concat(v1, v2), v3), v4)
value := either.MonadFold(result,
func(Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 10, value)
assert.Equal(t, Of(10), result)
})
})
}
@@ -235,21 +214,13 @@ func TestMonoidLaws(t *testing.T) {
t.Run("left identity", func(t *testing.T) {
// empty + a = a
result := m.Concat(m.Empty(), v1)
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
assert.Equal(t, Of("a"), result)
})
t.Run("right identity", func(t *testing.T) {
// a + empty = a
result := m.Concat(v1, m.Empty())
value := either.MonadFold(result,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "a", value)
assert.Equal(t, Of("a"), result)
})
t.Run("associativity", func(t *testing.T) {
@@ -258,17 +229,8 @@ func TestMonoidLaws(t *testing.T) {
left := m.Concat(m.Concat(v1, v2), v3)
right := m.Concat(v1, m.Concat(v2, v3))
leftVal := either.MonadFold(left,
func(Errors) string { return "" },
F.Identity[string],
)
rightVal := either.MonadFold(right,
func(Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "abc", leftVal)
assert.Equal(t, "abc", rightVal)
assert.Equal(t, Of("abc"), left)
assert.Equal(t, Of("abc"), right)
})
})
}
@@ -322,11 +284,7 @@ func TestApplicativeMonoidEdgeCases(t *testing.T) {
result := m.Concat(v1, v2)
value := either.MonadFold(result,
func(Errors) Counter { return Counter{} },
F.Identity[Counter],
)
assert.Equal(t, 15, value.Count)
assert.Equal(t, Of(Counter{Count: 15}), result)
})
t.Run("empty concat empty", func(t *testing.T) {
@@ -334,10 +292,6 @@ func TestApplicativeMonoidEdgeCases(t *testing.T) {
result := m.Concat(m.Empty(), m.Empty())
value := either.MonadFold(result,
func(Errors) string { return "ERROR" },
F.Identity[string],
)
assert.Equal(t, "", value)
assert.Equal(t, Of(""), result)
})
}

View File

@@ -18,6 +18,7 @@ package validation
import (
"github.com/IBM/fp-go/v2/either"
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/result"
@@ -257,4 +258,6 @@ type (
// double := func(x int) int { return x * 2 } // Endomorphism[int]
// result := LetL(lens, double)(Success(21)) // Success(42)
Endomorphism[A any] = endomorphism.Endomorphism[A]
Lazy[A any] = lazy.Lazy[A]
)

View File

@@ -0,0 +1,153 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prism
import (
"fmt"
F "github.com/IBM/fp-go/v2/function"
P "github.com/IBM/fp-go/v2/optics/prism"
)
// Compose creates a Kleisli arrow that composes a prism with an isomorphism.
//
// This function takes a Prism[A, B] and returns a Kleisli arrow that can transform
// any Iso[S, A] into a Prism[S, B]. The resulting prism changes the source type from
// A to S using the bidirectional transformation provided by the isomorphism, while
// maintaining the same focus type B.
//
// The composition works as follows:
// - GetOption: First transforms S to A using the iso's Get, then extracts B from A using the prism's GetOption
// - ReverseGet: First constructs A from B using the prism's ReverseGet, then transforms A to S using the iso's ReverseGet
//
// This is the dual operation of optics/prism/iso.Compose:
// - optics/prism/iso.Compose: Transforms the focus type (A → B) while keeping source type (S) constant
// - optics/iso/prism.Compose: Transforms the source type (A → S) while keeping focus type (B) constant
//
// This is particularly useful when you have a prism that works with one type but you
// need to adapt it to work with a different source type that has a lossless bidirectional
// transformation to the original type.
//
// Type Parameters:
// - S: The new source type after applying the isomorphism
// - A: The original source type of the prism
// - B: The focus type (remains constant through composition)
//
// Parameters:
// - ab: A prism that extracts B from A
//
// Returns:
// - A Kleisli arrow (function) that takes an Iso[S, A] and returns a Prism[S, B]
//
// Laws:
// The composed prism must satisfy the prism laws:
// 1. GetOption(ReverseGet(b)) == Some(b) for all b: B
// 2. If GetOption(s) == Some(a), then GetOption(ReverseGet(a)) == Some(a)
//
// These laws are preserved because:
// - The isomorphism satisfies: ia.ReverseGet(ia.Get(s)) == s and ia.Get(ia.ReverseGet(a)) == a
// - The original prism satisfies the prism laws
//
// Haskell Equivalent:
// This corresponds to the (.) operator for composing optics in Haskell's lens library,
// specifically when composing an Iso with a Prism:
//
// iso . prism :: Iso s a -> Prism a b -> Prism s b
//
// In Haskell's lens library, this is part of the general optic composition mechanism.
// See: https://hackage.haskell.org/package/lens/docs/Control-Lens-Iso.html
//
// Example - Composing with Either prism:
//
// import (
// "github.com/IBM/fp-go/v2/either"
// "github.com/IBM/fp-go/v2/optics/iso"
// "github.com/IBM/fp-go/v2/optics/prism"
// IP "github.com/IBM/fp-go/v2/optics/iso/prism"
// O "github.com/IBM/fp-go/v2/option"
// )
//
// // Create a prism that extracts Right values from Either[error, string]
// rightPrism := prism.FromEither[error, string]()
//
// // Create an isomorphism between []byte and string
// bytesStringIso := iso.MakeIso(
// func(b []byte) string { return string(b) },
// func(s string) []byte { return []byte(s) },
// )
//
// // Compose them to get a prism that works with []byte as source
// bytesPrism := IP.Compose(rightPrism)(bytesStringIso)
//
// // Use the composed prism
// // First converts []byte to string via iso, then extracts Right value
// bytes := []byte("hello")
// either := either.Right[error](string(bytes))
// result := bytesPrism.GetOption(bytes) // Extracts "hello" if Right
//
// // Construct []byte from string
// constructed := bytesPrism.ReverseGet("world")
// // Returns []byte("world") wrapped in Right
//
// Example - Composing with custom types:
//
// type JSON []byte
// type Config struct {
// Host string
// Port int
// }
//
// // Isomorphism between JSON and []byte
// jsonIso := iso.MakeIso(
// func(j JSON) []byte { return []byte(j) },
// func(b []byte) JSON { return JSON(b) },
// )
//
// // Prism that extracts Config from []byte (via JSON parsing)
// configPrism := prism.MakePrism(
// func(b []byte) option.Option[Config] {
// var cfg Config
// if err := json.Unmarshal(b, &cfg); err != nil {
// return option.None[Config]()
// }
// return option.Some(cfg)
// },
// func(cfg Config) []byte {
// b, _ := json.Marshal(cfg)
// return b
// },
// )
//
// // Compose to work with JSON type instead of []byte
// jsonConfigPrism := IP.Compose(configPrism)(jsonIso)
//
// jsonData := JSON(`{"host":"localhost","port":8080}`)
// config := jsonConfigPrism.GetOption(jsonData)
// // config is Some(Config{Host: "localhost", Port: 8080})
//
// See also:
// - github.com/IBM/fp-go/v2/optics/iso for isomorphism operations
// - github.com/IBM/fp-go/v2/optics/prism for prism operations
// - github.com/IBM/fp-go/v2/optics/prism/iso for the dual composition (transforming focus type)
func Compose[S, A, B any](ab Prism[A, B]) P.Kleisli[S, Iso[S, A], B] {
return func(ia Iso[S, A]) Prism[S, B] {
return P.MakePrismWithName(
F.Flow2(ia.Get, ab.GetOption),
F.Flow2(ab.ReverseGet, ia.ReverseGet),
fmt.Sprintf("IsoCompose[%s -> %s]", ia, ab),
)
}
}

View File

@@ -0,0 +1,435 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prism
import (
"encoding/json"
"strconv"
"testing"
E "github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
I "github.com/IBM/fp-go/v2/optics/iso"
P "github.com/IBM/fp-go/v2/optics/prism"
O "github.com/IBM/fp-go/v2/option"
"github.com/stretchr/testify/assert"
)
// TestComposeWithEitherPrism tests composing a prism with an isomorphism using Either
func TestComposeWithEitherPrism(t *testing.T) {
// Create a prism that extracts Right values from Either[error, string]
rightPrism := P.FromEither[error, string]()
// Create an isomorphism between []byte and Either[error, string]
bytesEitherIso := I.MakeIso(
func(b []byte) E.Either[error, string] {
return E.Right[error](string(b))
},
func(e E.Either[error, string]) []byte {
return []byte(E.GetOrElse(func(error) string { return "" })(e))
},
)
// Compose them: Prism[Either, string] with Iso[[]byte, Either] -> Prism[[]byte, string]
bytesPrism := Compose[[]byte](rightPrism)(bytesEitherIso)
t.Run("GetOption extracts string from []byte", func(t *testing.T) {
bytes := []byte("hello")
result := bytesPrism.GetOption(bytes)
assert.True(t, O.IsSome(result))
str := O.GetOrElse(F.Constant(""))(result)
assert.Equal(t, "hello", str)
})
t.Run("ReverseGet constructs []byte from string", func(t *testing.T) {
value := "world"
result := bytesPrism.ReverseGet(value)
assert.Equal(t, []byte("world"), result)
})
t.Run("Round-trip through GetOption and ReverseGet", func(t *testing.T) {
original := "test"
// ReverseGet to create []byte
bytes := bytesPrism.ReverseGet(original)
// GetOption to extract string back
result := bytesPrism.GetOption(bytes)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant(""))(result)
assert.Equal(t, original, extracted)
})
}
// TestComposeWithOptionPrism tests composing a prism with an isomorphism using Option
func TestComposeWithOptionPrism(t *testing.T) {
// Create a prism that extracts Some values from Option[int]
somePrism := P.FromOption[int]()
// Create an isomorphism between string and Option[int]
stringOptionIso := I.MakeIso(
func(s string) O.Option[int] {
i, err := strconv.Atoi(s)
if err != nil {
return O.None[int]()
}
return O.Some(i)
},
func(opt O.Option[int]) string {
return strconv.Itoa(O.GetOrElse(F.Constant(0))(opt))
},
)
// Compose them: Prism[Option, int] with Iso[string, Option] -> Prism[string, int]
stringPrism := Compose[string](somePrism)(stringOptionIso)
t.Run("GetOption extracts int from valid string", func(t *testing.T) {
result := stringPrism.GetOption("42")
assert.True(t, O.IsSome(result))
num := O.GetOrElse(F.Constant(0))(result)
assert.Equal(t, 42, num)
})
t.Run("GetOption returns None for invalid string", func(t *testing.T) {
result := stringPrism.GetOption("invalid")
assert.True(t, O.IsNone(result))
})
t.Run("ReverseGet constructs string from int", func(t *testing.T) {
result := stringPrism.ReverseGet(100)
assert.Equal(t, "100", result)
})
}
// Custom types for testing
type Celsius float64
type Fahrenheit float64
type Temperature interface {
isTemperature()
}
type CelsiusTemp struct {
Value Celsius
}
func (c CelsiusTemp) isTemperature() {}
type FahrenheitTemp struct {
Value Fahrenheit
}
func (f FahrenheitTemp) isTemperature() {}
// TestComposeWithCustomPrism tests composing with custom types
func TestComposeWithCustomPrism(t *testing.T) {
// Prism that extracts Celsius from Temperature
celsiusPrism := P.MakePrism(
func(t Temperature) O.Option[Celsius] {
if ct, ok := t.(CelsiusTemp); ok {
return O.Some(ct.Value)
}
return O.None[Celsius]()
},
func(c Celsius) Temperature {
return CelsiusTemp{Value: c}
},
)
// Isomorphism between Fahrenheit and Temperature
fahrenheitTempIso := I.MakeIso(
func(f Fahrenheit) Temperature {
celsius := Celsius((f - 32) * 5 / 9)
return CelsiusTemp{Value: celsius}
},
func(t Temperature) Fahrenheit {
if ct, ok := t.(CelsiusTemp); ok {
return Fahrenheit(ct.Value*9/5 + 32)
}
return 0
},
)
// Compose: Prism[Temperature, Celsius] with Iso[Fahrenheit, Temperature] -> Prism[Fahrenheit, Celsius]
fahrenheitPrism := Compose[Fahrenheit](celsiusPrism)(fahrenheitTempIso)
t.Run("GetOption extracts Celsius from Fahrenheit", func(t *testing.T) {
fahrenheit := Fahrenheit(68)
result := fahrenheitPrism.GetOption(fahrenheit)
assert.True(t, O.IsSome(result))
celsius := O.GetOrElse(F.Constant(Celsius(0)))(result)
assert.InDelta(t, 20.0, float64(celsius), 0.01)
})
t.Run("ReverseGet constructs Fahrenheit from Celsius", func(t *testing.T) {
celsius := Celsius(20)
result := fahrenheitPrism.ReverseGet(celsius)
assert.InDelta(t, 68.0, float64(result), 0.01)
})
t.Run("Round-trip preserves value", func(t *testing.T) {
original := Celsius(25)
// ReverseGet to create Fahrenheit
fahrenheit := fahrenheitPrism.ReverseGet(original)
// GetOption to extract Celsius back
result := fahrenheitPrism.GetOption(fahrenheit)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant(Celsius(0)))(result)
assert.InDelta(t, float64(original), float64(extracted), 0.01)
})
}
// TestComposeIdentityIso tests composing with an identity isomorphism
func TestComposeIdentityIso(t *testing.T) {
// Prism that extracts Right values
rightPrism := P.FromEither[error, string]()
// Identity isomorphism on Either
idIso := I.Id[E.Either[error, string]]()
// Compose with identity should not change behavior
composedPrism := Compose[E.Either[error, string]](rightPrism)(idIso)
t.Run("Composed prism behaves like original prism", func(t *testing.T) {
either := E.Right[error]("test")
// Original prism
originalResult := rightPrism.GetOption(either)
// Composed prism
composedResult := composedPrism.GetOption(either)
assert.Equal(t, originalResult, composedResult)
})
t.Run("ReverseGet produces same result", func(t *testing.T) {
value := "test"
// Original prism
originalResult := rightPrism.ReverseGet(value)
// Composed prism
composedResult := composedPrism.ReverseGet(value)
assert.Equal(t, originalResult, composedResult)
})
}
// TestComposeChaining tests chaining multiple compositions
func TestComposeChaining(t *testing.T) {
// Prism: extracts Right values from Either[error, int]
rightPrism := P.FromEither[error, int]()
// Iso 1: string to Either[error, int]
stringEitherIso := I.MakeIso(
func(s string) E.Either[error, int] {
i, err := strconv.Atoi(s)
if err != nil {
return E.Left[int](err)
}
return E.Right[error](i)
},
func(e E.Either[error, int]) string {
return strconv.Itoa(E.GetOrElse(func(error) int { return 0 })(e))
},
)
// Iso 2: []byte to string
bytesStringIso := I.MakeIso(
func(b []byte) string { return string(b) },
func(s string) []byte { return []byte(s) },
)
// First composition: Prism[Either, int] with Iso[string, Either] -> Prism[string, int]
step1 := Compose[string](rightPrism)(stringEitherIso)
// Second composition: Prism[string, int] with Iso[[]byte, string] -> Prism[[]byte, int]
step2 := Compose[[]byte](step1)(bytesStringIso)
t.Run("Chained composition extracts correctly", func(t *testing.T) {
bytes := []byte("42")
result := step2.GetOption(bytes)
assert.True(t, O.IsSome(result))
num := O.GetOrElse(F.Constant(0))(result)
assert.Equal(t, 42, num)
})
t.Run("Chained composition ReverseGet works correctly", func(t *testing.T) {
num := 100
result := step2.ReverseGet(num)
assert.Equal(t, []byte("100"), result)
})
}
// TestComposePrismLaws verifies that the composed prism satisfies prism laws
func TestComposePrismLaws(t *testing.T) {
// Create a prism
prism := P.FromEither[error, int]()
// Create an isomorphism from string to Either[error, int]
iso := I.MakeIso(
func(s string) E.Either[error, int] {
i, err := strconv.Atoi(s)
if err != nil {
return E.Left[int](err)
}
return E.Right[error](i)
},
func(e E.Either[error, int]) string {
return strconv.Itoa(E.GetOrElse(func(error) int { return 0 })(e))
},
)
// Compose them
composed := Compose[string](prism)(iso)
t.Run("Law 1: GetOption(ReverseGet(b)) == Some(b)", func(t *testing.T) {
value := 42
// ReverseGet then GetOption should return Some(value)
source := composed.ReverseGet(value)
result := composed.GetOption(source)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant(0))(result)
assert.Equal(t, value, extracted)
})
t.Run("Law 2: If GetOption(s) == Some(a), then GetOption(ReverseGet(a)) == Some(a)", func(t *testing.T) {
source := "100"
// First GetOption
firstResult := composed.GetOption(source)
assert.True(t, O.IsSome(firstResult))
// Extract the value
value := O.GetOrElse(F.Constant(0))(firstResult)
// ReverseGet then GetOption again
reconstructed := composed.ReverseGet(value)
secondResult := composed.GetOption(reconstructed)
assert.True(t, O.IsSome(secondResult))
finalValue := O.GetOrElse(F.Constant(0))(secondResult)
assert.Equal(t, value, finalValue)
})
}
// TestComposeWithJSON tests a practical example with JSON parsing
func TestComposeWithJSON(t *testing.T) {
type Config struct {
Host string `json:"host"`
Port int `json:"port"`
}
// Prism that extracts Config from []byte (via JSON parsing)
configPrism := P.MakePrism(
func(b []byte) O.Option[Config] {
var cfg Config
if err := json.Unmarshal(b, &cfg); err != nil {
return O.None[Config]()
}
return O.Some(cfg)
},
func(cfg Config) []byte {
b, _ := json.Marshal(cfg)
return b
},
)
// Isomorphism between string and []byte
stringBytesIso := I.MakeIso(
func(s string) []byte { return []byte(s) },
func(b []byte) string { return string(b) },
)
// Compose: Prism[[]byte, Config] with Iso[string, []byte] -> Prism[string, Config]
stringConfigPrism := Compose[string](configPrism)(stringBytesIso)
t.Run("GetOption parses valid JSON string", func(t *testing.T) {
jsonStr := `{"host":"localhost","port":8080}`
result := stringConfigPrism.GetOption(jsonStr)
assert.True(t, O.IsSome(result))
cfg := O.GetOrElse(F.Constant(Config{}))(result)
assert.Equal(t, "localhost", cfg.Host)
assert.Equal(t, 8080, cfg.Port)
})
t.Run("GetOption returns None for invalid JSON", func(t *testing.T) {
invalidJSON := `{invalid json}`
result := stringConfigPrism.GetOption(invalidJSON)
assert.True(t, O.IsNone(result))
})
t.Run("ReverseGet creates JSON string from Config", func(t *testing.T) {
cfg := Config{Host: "example.com", Port: 443}
result := stringConfigPrism.ReverseGet(cfg)
// Parse it back to verify
var parsed Config
err := json.Unmarshal([]byte(result), &parsed)
assert.NoError(t, err)
assert.Equal(t, cfg, parsed)
})
}
// TestComposeWithEmptyValues tests edge cases with empty/zero values
func TestComposeWithEmptyValues(t *testing.T) {
// Prism that extracts Right values
prism := P.FromEither[error, []byte]()
// Isomorphism between string and Either[error, []byte]
iso := I.MakeIso(
func(s string) E.Either[error, []byte] {
return E.Right[error]([]byte(s))
},
func(e E.Either[error, []byte]) string {
return string(E.GetOrElse(func(error) []byte { return []byte{} })(e))
},
)
composed := Compose[string](prism)(iso)
t.Run("Empty string is handled correctly", func(t *testing.T) {
result := composed.GetOption("")
assert.True(t, O.IsSome(result))
bytes := O.GetOrElse(F.Constant([]byte("default")))(result)
assert.Equal(t, []byte{}, bytes)
})
t.Run("ReverseGet with empty bytes", func(t *testing.T) {
bytes := []byte{}
result := composed.ReverseGet(bytes)
assert.Equal(t, "", result)
})
}

View File

@@ -0,0 +1,99 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package prism provides utilities for composing prisms with isomorphisms.
//
// This package enables the composition of prisms (optics for sum types) with
// isomorphisms (bidirectional transformations), allowing you to transform the
// source type of a prism using an isomorphism. This is the inverse operation
// of optics/prism/iso, where we transform the focus type instead of the source type.
//
// # Key Concepts
//
// A Prism[S, A] is an optic that focuses on a specific variant within a sum type S,
// extracting values of type A. An Iso[S, A] represents a bidirectional transformation
// between types S and A without loss of information.
//
// When you compose a Prism[A, B] with an Iso[S, A], you get a Prism[S, B] that:
// - Transforms S to A using the isomorphism's Get
// - Extracts values of type B from A (using the prism)
// - Can construct S from B by first using the prism's ReverseGet to get A, then the iso's ReverseGet
//
// # Example Usage
//
// import (
// "github.com/IBM/fp-go/v2/optics/iso"
// "github.com/IBM/fp-go/v2/optics/prism"
// IP "github.com/IBM/fp-go/v2/optics/iso/prism"
// O "github.com/IBM/fp-go/v2/option"
// )
//
// // Create an isomorphism between []byte and string
// bytesStringIso := iso.MakeIso(
// func(b []byte) string { return string(b) },
// func(s string) []byte { return []byte(s) },
// )
//
// // Create a prism that extracts Right values from Either[error, string]
// rightPrism := prism.FromEither[error, string]()
//
// // Compose them to get a prism that works with []byte as source
// bytesPrism := IP.Compose(rightPrism)(bytesStringIso)
//
// // Use the composed prism
// bytes := []byte(`{"status":"ok"}`)
// // First converts bytes to string via iso, then extracts Right value
// result := bytesPrism.GetOption(either.Right[error](string(bytes)))
//
// # Comparison with optics/prism/iso
//
// This package (optics/iso/prism) is the dual of optics/prism/iso:
// - optics/prism/iso: Composes Iso[A, B] with Prism[S, A] → Prism[S, B] (transforms focus type)
// - optics/iso/prism: Composes Prism[A, B] with Iso[S, A] → Prism[S, B] (transforms source type)
//
// # Type Aliases
//
// This package re-exports key types from the iso and prism packages for convenience:
// - Iso[S, A]: An isomorphism between types S and A
// - Prism[S, A]: A prism focusing on type A within sum type S
package prism
import (
I "github.com/IBM/fp-go/v2/optics/iso"
P "github.com/IBM/fp-go/v2/optics/prism"
)
type (
// Iso represents an isomorphism between types S and A.
// It is a bidirectional transformation that converts between two types
// without any loss of information.
//
// Type Parameters:
// - S: The source type
// - A: The target type
//
// See github.com/IBM/fp-go/v2/optics/iso for the full Iso API.
Iso[S, A any] = I.Iso[S, A]
// Prism is an optic used to select part of a sum type (tagged union).
// It provides operations to extract and construct values within sum types.
//
// Type Parameters:
// - S: The source type (sum type)
// - A: The focus type (variant within the sum type)
//
// See github.com/IBM/fp-go/v2/optics/prism for the full Prism API.
Prism[S, A any] = P.Prism[S, A]
)

View File

@@ -0,0 +1,156 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package iso
import (
"fmt"
F "github.com/IBM/fp-go/v2/function"
P "github.com/IBM/fp-go/v2/optics/prism"
O "github.com/IBM/fp-go/v2/option"
)
// Compose creates an operator that composes an isomorphism with a prism.
//
// This function takes an isomorphism Iso[A, B] and returns an operator that can
// transform any Prism[S, A] into a Prism[S, B]. The resulting prism maintains
// the same source type S but changes the focus type from A to B using the
// bidirectional transformation provided by the isomorphism.
//
// The composition works as follows:
// - GetOption: First extracts A from S using the prism, then transforms A to B using the iso's Get
// - ReverseGet: First transforms B to A using the iso's ReverseGet, then constructs S using the prism's ReverseGet
//
// This is particularly useful when you have a prism that focuses on one type but
// you need to work with a different type that has a lossless bidirectional
// transformation to the original type.
//
// Haskell Equivalent:
// This corresponds to the (.) operator for composing optics in Haskell's lens library,
// specifically when composing a Prism with an Iso:
//
// prism . iso :: Prism s a -> Iso a b -> Prism s b
//
// In Haskell's lens library, this is part of the general optic composition mechanism.
// See: https://hackage.haskell.org/package/lens/docs/Control-Lens-Prism.html
//
// Type Parameters:
// - S: The source type (sum type) that the prism operates on
// - A: The original focus type of the prism
// - B: The new focus type after applying the isomorphism
//
// Parameters:
// - ab: An isomorphism between types A and B that defines the bidirectional transformation
//
// Returns:
// - An Operator[S, A, B] that transforms Prism[S, A] into Prism[S, B]
//
// Laws:
// The composed prism must satisfy the prism laws:
// 1. GetOption(ReverseGet(b)) == Some(b) for all b: B
// 2. If GetOption(s) == Some(a), then GetOption(ReverseGet(a)) == Some(a)
//
// These laws are preserved because:
// - The isomorphism satisfies: ab.ReverseGet(ab.Get(a)) == a and ab.Get(ab.ReverseGet(b)) == b
// - The original prism satisfies the prism laws
//
// Example - Composing string/bytes isomorphism with Either prism:
//
// import (
// "github.com/IBM/fp-go/v2/either"
// "github.com/IBM/fp-go/v2/optics/iso"
// "github.com/IBM/fp-go/v2/optics/prism"
// PI "github.com/IBM/fp-go/v2/optics/prism/iso"
// O "github.com/IBM/fp-go/v2/option"
// )
//
// // Create an isomorphism between string and []byte
// stringBytesIso := iso.MakeIso(
// func(s string) []byte { return []byte(s) },
// func(b []byte) string { return string(b) },
// )
//
// // Create a prism that extracts Right values from Either[error, string]
// rightPrism := prism.FromEither[error, string]()
//
// // Compose them to get a prism that works with []byte instead of string
// bytesPrism := PI.Compose(stringBytesIso)(rightPrism)
//
// // Extract bytes from a Right value
// success := either.Right[error]("hello")
// result := bytesPrism.GetOption(success)
// // result is Some([]byte("hello"))
//
// // Extract from a Left value returns None
// failure := either.Left[string](errors.New("error"))
// result = bytesPrism.GetOption(failure)
// // result is None
//
// // Construct an Either from bytes
// constructed := bytesPrism.ReverseGet([]byte("world"))
// // constructed is Right("world")
//
// Example - Composing with custom types:
//
// type Celsius float64
// type Fahrenheit float64
//
// // Isomorphism between Celsius and Fahrenheit
// tempIso := iso.MakeIso(
// func(c Celsius) Fahrenheit { return Fahrenheit(c*9/5 + 32) },
// func(f Fahrenheit) Celsius { return Celsius((f - 32) * 5 / 9) },
// )
//
// // Prism that extracts temperature from a weather report
// type WeatherReport struct {
// Temperature Celsius
// Condition string
// }
// tempPrism := prism.MakePrism(
// func(w WeatherReport) option.Option[Celsius] {
// return option.Some(w.Temperature)
// },
// func(c Celsius) WeatherReport {
// return WeatherReport{Temperature: c}
// },
// )
//
// // Compose to work with Fahrenheit instead
// fahrenheitPrism := PI.Compose(tempIso)(tempPrism)
//
// report := WeatherReport{Temperature: 20, Condition: "sunny"}
// temp := fahrenheitPrism.GetOption(report)
// // temp is Some(68.0) in Fahrenheit
//
// See also:
// - github.com/IBM/fp-go/v2/optics/iso for isomorphism operations
// - github.com/IBM/fp-go/v2/optics/prism for prism operations
// - Operator for the type signature of the returned function
func Compose[S, A, B any](ab Iso[A, B]) Operator[S, A, B] {
return func(pa Prism[S, A]) Prism[S, B] {
return P.MakePrismWithName(
F.Flow2(
pa.GetOption,
O.Map(ab.Get),
),
F.Flow2(
ab.ReverseGet,
pa.ReverseGet,
),
fmt.Sprintf("PrismCompose[%s -> %s]", pa, ab),
)
}
}

View File

@@ -0,0 +1,369 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package iso
import (
"errors"
"strconv"
"testing"
E "github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
I "github.com/IBM/fp-go/v2/optics/iso"
P "github.com/IBM/fp-go/v2/optics/prism"
O "github.com/IBM/fp-go/v2/option"
"github.com/stretchr/testify/assert"
)
// TestComposeWithEitherPrism tests composing an isomorphism with an Either prism
func TestComposeWithEitherPrism(t *testing.T) {
// Create an isomorphism between string and []byte
stringBytesIso := I.MakeIso(
func(s string) []byte { return []byte(s) },
func(b []byte) string { return string(b) },
)
// Create a prism that extracts Right values from Either[error, string]
rightPrism := P.FromEither[error, string]()
// Compose them
bytesPrism := Compose[E.Either[error, string]](stringBytesIso)(rightPrism)
t.Run("GetOption extracts and transforms Right value", func(t *testing.T) {
success := E.Right[error]("hello")
result := bytesPrism.GetOption(success)
assert.True(t, O.IsSome(result))
bytes := O.GetOrElse(F.Constant([]byte{}))(result)
assert.Equal(t, []byte("hello"), bytes)
})
t.Run("GetOption returns None for Left value", func(t *testing.T) {
failure := E.Left[string](errors.New("error"))
result := bytesPrism.GetOption(failure)
assert.True(t, O.IsNone(result))
})
t.Run("ReverseGet constructs Either from transformed value", func(t *testing.T) {
bytes := []byte("world")
result := bytesPrism.ReverseGet(bytes)
assert.True(t, E.IsRight(result))
str := E.GetOrElse(func(error) string { return "" })(result)
assert.Equal(t, "world", str)
})
t.Run("Round-trip through GetOption and ReverseGet", func(t *testing.T) {
// Start with bytes
original := []byte("test")
// ReverseGet to create Either
either := bytesPrism.ReverseGet(original)
// GetOption to extract bytes back
result := bytesPrism.GetOption(either)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant([]byte{}))(result)
assert.Equal(t, original, extracted)
})
}
// TestComposeWithOptionPrism tests composing an isomorphism with an Option prism
func TestComposeWithOptionPrism(t *testing.T) {
// Create an isomorphism between int and string
intStringIso := I.MakeIso(
func(i int) string { return strconv.Itoa(i) },
func(s string) int {
i, _ := strconv.Atoi(s)
return i
},
)
// Create a prism that extracts Some values from Option[int]
somePrism := P.FromOption[int]()
// Compose them
stringPrism := Compose[O.Option[int]](intStringIso)(somePrism)
t.Run("GetOption extracts and transforms Some value", func(t *testing.T) {
some := O.Some(42)
result := stringPrism.GetOption(some)
assert.True(t, O.IsSome(result))
str := O.GetOrElse(F.Constant(""))(result)
assert.Equal(t, "42", str)
})
t.Run("GetOption returns None for None value", func(t *testing.T) {
none := O.None[int]()
result := stringPrism.GetOption(none)
assert.True(t, O.IsNone(result))
})
t.Run("ReverseGet constructs Option from transformed value", func(t *testing.T) {
str := "100"
result := stringPrism.ReverseGet(str)
assert.True(t, O.IsSome(result))
num := O.GetOrElse(F.Constant(0))(result)
assert.Equal(t, 100, num)
})
}
// TestComposeWithCustomPrism tests composing with a custom prism
// Custom types for TestComposeWithCustomPrism
type Celsius float64
type Fahrenheit float64
type Temperature interface {
isTemperature()
}
type CelsiusTemp struct {
Value Celsius
}
func (c CelsiusTemp) isTemperature() {}
type KelvinTemp struct {
Value float64
}
func (k KelvinTemp) isTemperature() {}
func TestComposeWithCustomPrism(t *testing.T) {
// Isomorphism between Celsius and Fahrenheit
tempIso := I.MakeIso(
func(c Celsius) Fahrenheit { return Fahrenheit(c*9/5 + 32) },
func(f Fahrenheit) Celsius { return Celsius((f - 32) * 5 / 9) },
)
// Prism that extracts Celsius from Temperature
celsiusPrism := P.MakePrism(
func(t Temperature) O.Option[Celsius] {
if ct, ok := t.(CelsiusTemp); ok {
return O.Some(ct.Value)
}
return O.None[Celsius]()
},
func(c Celsius) Temperature {
return CelsiusTemp{Value: c}
},
)
// Compose to work with Fahrenheit
fahrenheitPrism := Compose[Temperature](tempIso)(celsiusPrism)
t.Run("GetOption extracts and converts Celsius to Fahrenheit", func(t *testing.T) {
temp := CelsiusTemp{Value: 0}
result := fahrenheitPrism.GetOption(temp)
assert.True(t, O.IsSome(result))
fahrenheit := O.GetOrElse(F.Constant(Fahrenheit(0)))(result)
assert.InDelta(t, 32.0, float64(fahrenheit), 0.01)
})
t.Run("GetOption returns None for non-Celsius temperature", func(t *testing.T) {
temp := KelvinTemp{Value: 273.15}
result := fahrenheitPrism.GetOption(temp)
assert.True(t, O.IsNone(result))
})
t.Run("ReverseGet constructs Temperature from Fahrenheit", func(t *testing.T) {
fahrenheit := Fahrenheit(68)
result := fahrenheitPrism.ReverseGet(fahrenheit)
celsiusTemp, ok := result.(CelsiusTemp)
assert.True(t, ok)
assert.InDelta(t, 20.0, float64(celsiusTemp.Value), 0.01)
})
t.Run("Round-trip preserves value", func(t *testing.T) {
original := Fahrenheit(100)
// ReverseGet to create Temperature
temp := fahrenheitPrism.ReverseGet(original)
// GetOption to extract Fahrenheit back
result := fahrenheitPrism.GetOption(temp)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant(Fahrenheit(0)))(result)
assert.InDelta(t, float64(original), float64(extracted), 0.01)
})
}
// TestComposeIdentityIso tests composing with an identity isomorphism
func TestComposeIdentityIso(t *testing.T) {
// Identity isomorphism (no transformation)
idIso := I.Id[string]()
// Prism that extracts Right values
rightPrism := P.FromEither[error, string]()
// Compose with identity should not change behavior
composedPrism := Compose[E.Either[error, string]](idIso)(rightPrism)
t.Run("Composed prism behaves like original prism", func(t *testing.T) {
success := E.Right[error]("test")
// Original prism
originalResult := rightPrism.GetOption(success)
// Composed prism
composedResult := composedPrism.GetOption(success)
assert.Equal(t, originalResult, composedResult)
})
t.Run("ReverseGet produces same result", func(t *testing.T) {
value := "test"
// Original prism
originalEither := rightPrism.ReverseGet(value)
// Composed prism
composedEither := composedPrism.ReverseGet(value)
assert.Equal(t, originalEither, composedEither)
})
}
// TestComposeChaining tests chaining multiple compositions
func TestComposeChaining(t *testing.T) {
// First isomorphism: int to string
intStringIso := I.MakeIso(
func(i int) string { return strconv.Itoa(i) },
func(s string) int {
i, _ := strconv.Atoi(s)
return i
},
)
// Second isomorphism: string to []byte
stringBytesIso := I.MakeIso(
func(s string) []byte { return []byte(s) },
func(b []byte) string { return string(b) },
)
// Prism that extracts Right values
rightPrism := P.FromEither[error, int]()
// Chain compositions: Either[error, int] -> int -> string -> []byte
step1 := Compose[E.Either[error, int]](intStringIso)(rightPrism) // Prism[Either[error, int], string]
step2 := Compose[E.Either[error, int]](stringBytesIso)(step1) // Prism[Either[error, int], []byte]
t.Run("Chained composition extracts and transforms correctly", func(t *testing.T) {
either := E.Right[error](42)
result := step2.GetOption(either)
assert.True(t, O.IsSome(result))
bytes := O.GetOrElse(F.Constant([]byte{}))(result)
assert.Equal(t, []byte("42"), bytes)
})
t.Run("Chained composition ReverseGet works correctly", func(t *testing.T) {
bytes := []byte("100")
result := step2.ReverseGet(bytes)
assert.True(t, E.IsRight(result))
num := E.GetOrElse(func(error) int { return 0 })(result)
assert.Equal(t, 100, num)
})
}
// TestComposePrismLaws verifies that the composed prism satisfies prism laws
func TestComposePrismLaws(t *testing.T) {
// Create an isomorphism
iso := I.MakeIso(
func(i int) string { return strconv.Itoa(i) },
func(s string) int {
i, _ := strconv.Atoi(s)
return i
},
)
// Create a prism
prism := P.FromEither[error, int]()
// Compose them
composed := Compose[E.Either[error, int]](iso)(prism)
t.Run("Law 1: GetOption(ReverseGet(b)) == Some(b)", func(t *testing.T) {
value := "42"
// ReverseGet then GetOption should return Some(value)
either := composed.ReverseGet(value)
result := composed.GetOption(either)
assert.True(t, O.IsSome(result))
extracted := O.GetOrElse(F.Constant(""))(result)
assert.Equal(t, value, extracted)
})
t.Run("Law 2: If GetOption(s) == Some(a), then GetOption(ReverseGet(a)) == Some(a)", func(t *testing.T) {
either := E.Right[error](100)
// First GetOption
firstResult := composed.GetOption(either)
assert.True(t, O.IsSome(firstResult))
// Extract the value
value := O.GetOrElse(F.Constant(""))(firstResult)
// ReverseGet then GetOption again
reconstructed := composed.ReverseGet(value)
secondResult := composed.GetOption(reconstructed)
assert.True(t, O.IsSome(secondResult))
finalValue := O.GetOrElse(F.Constant(""))(secondResult)
assert.Equal(t, value, finalValue)
})
}
// TestComposeWithEmptyValues tests edge cases with empty/zero values
func TestComposeWithEmptyValues(t *testing.T) {
// Isomorphism that handles empty strings
iso := I.MakeIso(
func(s string) []byte { return []byte(s) },
func(b []byte) string { return string(b) },
)
prism := P.FromEither[error, string]()
composed := Compose[E.Either[error, string]](iso)(prism)
t.Run("Empty string is handled correctly", func(t *testing.T) {
either := E.Right[error]("")
result := composed.GetOption(either)
assert.True(t, O.IsSome(result))
bytes := O.GetOrElse(F.Constant([]byte("default")))(result)
assert.Equal(t, []byte{}, bytes)
})
t.Run("ReverseGet with empty bytes", func(t *testing.T) {
bytes := []byte{}
result := composed.ReverseGet(bytes)
assert.True(t, E.IsRight(result))
str := E.GetOrElse(func(error) string { return "default" })(result)
assert.Equal(t, "", str)
})
}

View File

@@ -0,0 +1,112 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package iso provides utilities for composing isomorphisms with prisms.
//
// This package enables the composition of isomorphisms (bidirectional transformations)
// with prisms (optics for sum types), allowing you to transform the focus type of a prism
// using an isomorphism. This is particularly useful when you need to work with prisms
// that focus on a type that can be bidirectionally converted to another type.
//
// # Key Concepts
//
// An Iso[S, A] represents a bidirectional transformation between types S and A without
// loss of information. A Prism[S, A] is an optic that focuses on a specific variant
// within a sum type S, extracting values of type A.
//
// When you compose an Iso[A, B] with a Prism[S, A], you get a Prism[S, B] that:
// - Extracts values of type A from S (using the prism)
// - Transforms them to type B (using the isomorphism's Get)
// - Can construct S from B by reversing the transformation (using the isomorphism's ReverseGet)
//
// # Example Usage
//
// import (
// "github.com/IBM/fp-go/v2/optics/iso"
// "github.com/IBM/fp-go/v2/optics/prism"
// PI "github.com/IBM/fp-go/v2/optics/prism/iso"
// O "github.com/IBM/fp-go/v2/option"
// )
//
// // Create an isomorphism between string and []byte
// stringBytesIso := iso.MakeIso(
// func(s string) []byte { return []byte(s) },
// func(b []byte) string { return string(b) },
// )
//
// // Create a prism that extracts Right values from Either[error, string]
// rightPrism := prism.FromEither[error, string]()
//
// // Compose them to get a prism that extracts Right values as []byte
// bytesPrism := PI.Compose(stringBytesIso)(rightPrism)
//
// // Use the composed prism
// either := either.Right[error]("hello")
// result := bytesPrism.GetOption(either) // Some([]byte("hello"))
//
// # Type Aliases
//
// This package re-exports key types from the iso and prism packages for convenience:
// - Iso[S, A]: An isomorphism between types S and A
// - Prism[S, A]: A prism focusing on type A within sum type S
// - Operator[S, A, B]: A function that transforms Prism[S, A] to Prism[S, B]
package iso
import (
I "github.com/IBM/fp-go/v2/optics/iso"
P "github.com/IBM/fp-go/v2/optics/prism"
)
type (
// Iso represents an isomorphism between types S and A.
// It is a bidirectional transformation that converts between two types
// without any loss of information.
//
// Type Parameters:
// - S: The source type
// - A: The target type
//
// See github.com/IBM/fp-go/v2/optics/iso for the full Iso API.
Iso[S, A any] = I.Iso[S, A]
// Prism is an optic used to select part of a sum type (tagged union).
// It provides operations to extract and construct values within sum types.
//
// Type Parameters:
// - S: The source type (sum type)
// - A: The focus type (variant within the sum type)
//
// See github.com/IBM/fp-go/v2/optics/prism for the full Prism API.
Prism[S, A any] = P.Prism[S, A]
// Operator represents a function that transforms one prism into another.
// It takes a Prism[S, A] and returns a Prism[S, B], allowing for prism transformations.
//
// This is commonly used with the Compose function to create operators that
// transform the focus type of a prism using an isomorphism.
//
// Type Parameters:
// - S: The source type (remains constant)
// - A: The original focus type
// - B: The new focus type
//
// Example:
//
// // Create an operator that transforms string prisms to []byte prisms
// stringToBytesOp := Compose(stringBytesIso)
// // Apply it to a prism
// bytesPrism := stringToBytesOp(stringPrism)
Operator[S, A, B any] = P.Operator[S, A, B]
)

View File

@@ -23,8 +23,10 @@ import (
"strconv"
"time"
"github.com/IBM/fp-go/v2/array"
"github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
J "github.com/IBM/fp-go/v2/json"
"github.com/IBM/fp-go/v2/option"
S "github.com/IBM/fp-go/v2/string"
)
@@ -322,6 +324,50 @@ func FromEither[E, T any]() Prism[Either[E, T], T] {
return MakePrismWithName(either.ToOption[E, T], either.Of[E, T], "PrismFromEither")
}
// FromResult creates a prism for extracting values from Result types.
// It provides a safe way to work with Result values (which are Either[error, T]),
// focusing on the success case and handling errors gracefully through the Option type.
//
// This is a convenience function that is equivalent to FromEither[error, T]().
//
// The prism's GetOption attempts to extract the success value from a Result.
// If the Result is successful, it returns Some(value); if it's an error, it returns None.
//
// The prism's ReverseGet always succeeds, wrapping a value into a successful Result.
//
// Type Parameters:
// - T: The value type contained in the Result
//
// Returns:
// - A Prism[Result[T], T] that safely extracts success values
//
// Example:
//
// // Create a prism for extracting successful results
// resultPrism := FromResult[int]()
//
// // Extract from successful result
// success := result.Of[int](42)
// value := resultPrism.GetOption(success) // Some(42)
//
// // Extract from error result
// failure := result.Error[int](errors.New("failed"))
// value = resultPrism.GetOption(failure) // None[int]()
//
// // Wrap value into successful Result
// wrapped := resultPrism.ReverseGet(100) // Result containing 100
//
// // Use with Set to update successful results
// setter := Set[Result[int], int](200)
// result := setter(resultPrism)(success) // Result containing 200
// result = setter(resultPrism)(failure) // Error result (unchanged)
//
// Common use cases:
// - Extracting successful values from Result types
// - Filtering out errors in data pipelines
// - Working with fallible operations that return Result
// - Composing with other prisms for complex error handling
//
//go:inline
func FromResult[T any]() Prism[Result[T], T] {
return FromEither[error, T]()
@@ -1261,3 +1307,71 @@ func MakeURLPrisms() URLPrisms {
RawFragment: _prismRawFragment,
}
}
// ParseJSON creates a prism for parsing and marshaling JSON data.
// It provides a safe way to convert between JSON bytes and Go types,
// handling parsing and marshaling errors gracefully through the Option type.
//
// The prism's GetOption attempts to unmarshal JSON bytes into type A.
// If unmarshaling succeeds, it returns Some(A); if it fails (e.g., invalid JSON
// or type mismatch), it returns None.
//
// The prism's ReverseGet marshals a value of type A into JSON bytes.
// If marshaling fails (which is rare), it returns an empty byte slice.
//
// Type Parameters:
// - A: The Go type to unmarshal JSON into
//
// Returns:
// - A Prism[[]byte, A] that safely handles JSON parsing/marshaling
//
// Example:
//
// // Define a struct type
// type Person struct {
// Name string `json:"name"`
// Age int `json:"age"`
// }
//
// // Create a JSON parsing prism
// jsonPrism := ParseJSON[Person]()
//
// // Parse valid JSON
// jsonData := []byte(`{"name":"Alice","age":30}`)
// person := jsonPrism.GetOption(jsonData)
// // Some(Person{Name: "Alice", Age: 30})
//
// // Parse invalid JSON
// invalidJSON := []byte(`{invalid json}`)
// result := jsonPrism.GetOption(invalidJSON) // None[Person]()
//
// // Marshal to JSON
// p := Person{Name: "Bob", Age: 25}
// jsonBytes := jsonPrism.ReverseGet(p)
// // []byte(`{"name":"Bob","age":25}`)
//
// // Use with Set to update JSON data
// newPerson := Person{Name: "Charlie", Age: 35}
// setter := Set[[]byte, Person](newPerson)
// updated := setter(jsonPrism)(jsonData)
// // []byte(`{"name":"Charlie","age":35}`)
//
// Common use cases:
// - Parsing JSON configuration files
// - Working with JSON API responses
// - Validating and transforming JSON data in pipelines
// - Type-safe JSON deserialization
// - Converting between JSON and Go structs
func ParseJSON[A any]() Prism[[]byte, A] {
return MakePrismWithName(
F.Flow2(
J.Unmarshal[A],
either.ToOption[error, A],
),
F.Flow2(
J.Marshal[A],
either.GetOrElse(F.Constant1[error](array.Empty[byte]())),
),
"JSON",
)
}

View File

@@ -16,11 +16,14 @@
package prism
import (
"errors"
"regexp"
"testing"
E "github.com/IBM/fp-go/v2/either"
F "github.com/IBM/fp-go/v2/function"
O "github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
)
@@ -1396,3 +1399,403 @@ func TestNonEmptyStringValidation(t *testing.T) {
assert.Equal(t, []string{"hello", "world", "test"}, nonEmpty)
})
}
// TestFromResult tests the FromResult prism with Result types
func TestFromResult(t *testing.T) {
t.Run("extract from successful result", func(t *testing.T) {
prism := FromResult[int]()
success := result.Of[int](42)
extracted := prism.GetOption(success)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, 42, O.GetOrElse(F.Constant(-1))(extracted))
})
t.Run("extract from error result", func(t *testing.T) {
prism := FromResult[int]()
failure := E.Left[int](errors.New("test error"))
extracted := prism.GetOption(failure)
assert.True(t, O.IsNone(extracted))
})
t.Run("ReverseGet wraps value in successful result", func(t *testing.T) {
prism := FromResult[int]()
wrapped := prism.ReverseGet(100)
// Verify it's a successful result
extracted := prism.GetOption(wrapped)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, 100, O.GetOrElse(F.Constant(-1))(extracted))
})
t.Run("works with string type", func(t *testing.T) {
prism := FromResult[string]()
success := result.Of[string]("hello")
extracted := prism.GetOption(success)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, "hello", O.GetOrElse(F.Constant(""))(extracted))
})
t.Run("works with struct type", func(t *testing.T) {
type Person struct {
Name string
Age int
}
prism := FromResult[Person]()
person := Person{Name: "Alice", Age: 30}
success := result.Of[Person](person)
extracted := prism.GetOption(success)
assert.True(t, O.IsSome(extracted))
result := O.GetOrElse(F.Constant(Person{}))(extracted)
assert.Equal(t, "Alice", result.Name)
assert.Equal(t, 30, result.Age)
})
}
// TestFromResultWithSet tests using Set with FromResult prism
func TestFromResultWithSet(t *testing.T) {
t.Run("set on successful result", func(t *testing.T) {
prism := FromResult[int]()
setter := Set[result.Result[int], int](200)
success := result.Of[int](42)
updated := setter(prism)(success)
// Verify the value was updated
extracted := prism.GetOption(updated)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, 200, O.GetOrElse(F.Constant(-1))(extracted))
})
t.Run("set on error result leaves it unchanged", func(t *testing.T) {
prism := FromResult[int]()
setter := Set[result.Result[int], int](200)
failure := E.Left[int](errors.New("test error"))
updated := setter(prism)(failure)
// Verify it's still an error
extracted := prism.GetOption(updated)
assert.True(t, O.IsNone(extracted))
})
}
// TestFromResultPrismLaws tests that FromResult satisfies prism laws
func TestFromResultPrismLaws(t *testing.T) {
prism := FromResult[int]()
t.Run("law 1: GetOption(ReverseGet(a)) == Some(a)", func(t *testing.T) {
value := 42
wrapped := prism.ReverseGet(value)
extracted := prism.GetOption(wrapped)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, value, O.GetOrElse(F.Constant(-1))(extracted))
})
t.Run("law 2: ReverseGet is consistent", func(t *testing.T) {
value := 42
result1 := prism.ReverseGet(value)
result2 := prism.ReverseGet(value)
// Both should extract the same value
extracted1 := prism.GetOption(result1)
extracted2 := prism.GetOption(result2)
val1 := O.GetOrElse(F.Constant(-1))(extracted1)
val2 := O.GetOrElse(F.Constant(-1))(extracted2)
assert.Equal(t, val1, val2)
})
}
// TestFromResultComposition tests composing FromResult with other prisms
func TestFromResultComposition(t *testing.T) {
t.Run("compose with predicate prism", func(t *testing.T) {
// Create a prism that only matches positive numbers
positivePrism := FromPredicate(func(n int) bool { return n > 0 })
// Compose: Result[int] -> int -> positive int
composed := Compose[result.Result[int]](positivePrism)(FromResult[int]())
// Test with positive number
success := result.Of[int](42)
extracted := composed.GetOption(success)
assert.True(t, O.IsSome(extracted))
assert.Equal(t, 42, O.GetOrElse(F.Constant(-1))(extracted))
// Test with negative number
negativeSuccess := result.Of[int](-5)
extracted = composed.GetOption(negativeSuccess)
assert.True(t, O.IsNone(extracted))
// Test with error
failure := E.Left[int](errors.New("test error"))
extracted = composed.GetOption(failure)
assert.True(t, O.IsNone(extracted))
})
}
// TestParseJSON tests the ParseJSON prism with various JSON data
func TestParseJSON(t *testing.T) {
type Person struct {
Name string `json:"name"`
Age int `json:"age"`
}
t.Run("parse valid JSON", func(t *testing.T) {
prism := ParseJSON[Person]()
jsonData := []byte(`{"name":"Alice","age":30}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "Alice", person.Name)
assert.Equal(t, 30, person.Age)
})
t.Run("parse invalid JSON", func(t *testing.T) {
prism := ParseJSON[Person]()
invalidJSON := []byte(`{invalid json}`)
parsed := prism.GetOption(invalidJSON)
assert.True(t, O.IsNone(parsed))
})
t.Run("parse JSON with missing fields", func(t *testing.T) {
prism := ParseJSON[Person]()
// Missing age field - should use zero value
jsonData := []byte(`{"name":"Bob"}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "Bob", person.Name)
assert.Equal(t, 0, person.Age)
})
t.Run("parse JSON with extra fields", func(t *testing.T) {
prism := ParseJSON[Person]()
// Extra field should be ignored
jsonData := []byte(`{"name":"Charlie","age":25,"extra":"ignored"}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "Charlie", person.Name)
assert.Equal(t, 25, person.Age)
})
t.Run("ReverseGet marshals to JSON", func(t *testing.T) {
prism := ParseJSON[Person]()
person := Person{Name: "David", Age: 35}
jsonBytes := prism.ReverseGet(person)
// Parse it back to verify
parsed := prism.GetOption(jsonBytes)
assert.True(t, O.IsSome(parsed))
result := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "David", result.Name)
assert.Equal(t, 35, result.Age)
})
t.Run("works with primitive types", func(t *testing.T) {
prism := ParseJSON[int]()
jsonData := []byte(`42`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
assert.Equal(t, 42, O.GetOrElse(F.Constant(-1))(parsed))
})
t.Run("works with arrays", func(t *testing.T) {
prism := ParseJSON[[]string]()
jsonData := []byte(`["hello","world","test"]`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
arr := O.GetOrElse(F.Constant([]string{}))(parsed)
assert.Equal(t, []string{"hello", "world", "test"}, arr)
})
t.Run("works with maps", func(t *testing.T) {
prism := ParseJSON[map[string]int]()
jsonData := []byte(`{"a":1,"b":2,"c":3}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
m := O.GetOrElse(F.Constant(map[string]int{}))(parsed)
assert.Equal(t, 1, m["a"])
assert.Equal(t, 2, m["b"])
assert.Equal(t, 3, m["c"])
})
t.Run("works with nested structures", func(t *testing.T) {
type Address struct {
Street string `json:"street"`
City string `json:"city"`
}
type PersonWithAddress struct {
Name string `json:"name"`
Address Address `json:"address"`
}
prism := ParseJSON[PersonWithAddress]()
jsonData := []byte(`{"name":"Eve","address":{"street":"123 Main St","city":"NYC"}}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(PersonWithAddress{}))(parsed)
assert.Equal(t, "Eve", person.Name)
assert.Equal(t, "123 Main St", person.Address.Street)
assert.Equal(t, "NYC", person.Address.City)
})
t.Run("parse empty JSON object", func(t *testing.T) {
prism := ParseJSON[Person]()
jsonData := []byte(`{}`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "", person.Name)
assert.Equal(t, 0, person.Age)
})
t.Run("parse null JSON", func(t *testing.T) {
prism := ParseJSON[*Person]()
jsonData := []byte(`null`)
parsed := prism.GetOption(jsonData)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(&Person{}))(parsed)
assert.Nil(t, person)
})
}
// TestParseJSONWithSet tests using Set with ParseJSON prism
func TestParseJSONWithSet(t *testing.T) {
type Person struct {
Name string `json:"name"`
Age int `json:"age"`
}
t.Run("set updates JSON data", func(t *testing.T) {
prism := ParseJSON[Person]()
originalJSON := []byte(`{"name":"Alice","age":30}`)
newPerson := Person{Name: "Bob", Age: 25}
setter := Set[[]byte, Person](newPerson)
updatedJSON := setter(prism)(originalJSON)
// Parse the updated JSON
parsed := prism.GetOption(updatedJSON)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "Bob", person.Name)
assert.Equal(t, 25, person.Age)
})
t.Run("set on invalid JSON returns original unchanged", func(t *testing.T) {
prism := ParseJSON[Person]()
invalidJSON := []byte(`{invalid}`)
newPerson := Person{Name: "Charlie", Age: 35}
setter := Set[[]byte, Person](newPerson)
result := setter(prism)(invalidJSON)
// Should return original unchanged since it couldn't be parsed
assert.Equal(t, invalidJSON, result)
})
}
// TestParseJSONPrismLaws tests that ParseJSON satisfies prism laws
func TestParseJSONPrismLaws(t *testing.T) {
type Person struct {
Name string `json:"name"`
Age int `json:"age"`
}
prism := ParseJSON[Person]()
t.Run("law 1: GetOption(ReverseGet(a)) == Some(a)", func(t *testing.T) {
person := Person{Name: "Alice", Age: 30}
jsonBytes := prism.ReverseGet(person)
parsed := prism.GetOption(jsonBytes)
assert.True(t, O.IsSome(parsed))
result := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, person.Name, result.Name)
assert.Equal(t, person.Age, result.Age)
})
t.Run("law 2: ReverseGet is consistent", func(t *testing.T) {
person := Person{Name: "Bob", Age: 25}
json1 := prism.ReverseGet(person)
json2 := prism.ReverseGet(person)
// Both should parse to the same value
parsed1 := prism.GetOption(json1)
parsed2 := prism.GetOption(json2)
result1 := O.GetOrElse(F.Constant(Person{}))(parsed1)
result2 := O.GetOrElse(F.Constant(Person{}))(parsed2)
assert.Equal(t, result1.Name, result2.Name)
assert.Equal(t, result1.Age, result2.Age)
})
}
// TestParseJSONComposition tests composing ParseJSON with other prisms
func TestParseJSONComposition(t *testing.T) {
type Person struct {
Name string `json:"name"`
Age int `json:"age"`
}
t.Run("compose with predicate prism", func(t *testing.T) {
// Create a prism that only matches adults (age >= 18)
adultPrism := FromPredicate(func(p Person) bool { return p.Age >= 18 })
// Compose: []byte -> Person -> Adult
composed := Compose[[]byte](adultPrism)(ParseJSON[Person]())
// Test with adult
adultJSON := []byte(`{"name":"Alice","age":30}`)
parsed := composed.GetOption(adultJSON)
assert.True(t, O.IsSome(parsed))
person := O.GetOrElse(F.Constant(Person{}))(parsed)
assert.Equal(t, "Alice", person.Name)
// Test with minor
minorJSON := []byte(`{"name":"Bob","age":15}`)
parsed = composed.GetOption(minorJSON)
assert.True(t, O.IsNone(parsed))
// Test with invalid JSON
invalidJSON := []byte(`{invalid}`)
parsed = composed.GetOption(invalidJSON)
assert.True(t, O.IsNone(parsed))
})
}

View File

@@ -3,7 +3,7 @@ package readerio
import "github.com/IBM/fp-go/v2/io"
//go:inline
func ChainConsumer[R, A any](c Consumer[A]) Operator[R, A, struct{}] {
func ChainConsumer[R, A any](c Consumer[A]) Operator[R, A, Void] {
return ChainIOK[R](io.FromConsumer(c))
}

View File

@@ -18,6 +18,7 @@ package readerio
import (
"github.com/IBM/fp-go/v2/consumer"
"github.com/IBM/fp-go/v2/either"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/predicate"
"github.com/IBM/fp-go/v2/reader"
@@ -66,4 +67,6 @@ type (
// Predicate represents a function that tests a value of type A and returns a boolean.
// It's commonly used for filtering and conditional operations.
Predicate[A any] = predicate.Predicate[A]
Void = function.Void
)

View File

@@ -667,12 +667,12 @@ func FromPredicate[R, E, A any](pred func(A) bool, onFalse func(A) E) func(A) Re
// This is useful for converting a ReaderIOEither into a ReaderIO by handling all cases.
//
//go:inline
func Fold[R, E, A, B any](onLeft func(E) ReaderIO[R, B], onRight func(A) ReaderIO[R, B]) func(ReaderIOEither[R, E, A]) ReaderIO[R, B] {
func Fold[R, E, A, B any](onLeft readerio.Kleisli[R, E, B], onRight func(A) ReaderIO[R, B]) func(ReaderIOEither[R, E, A]) ReaderIO[R, B] {
return eithert.MatchE(readerio.MonadChain[R, either.Either[E, A], B], onLeft, onRight)
}
//go:inline
func MonadFold[R, E, A, B any](ma ReaderIOEither[R, E, A], onLeft func(E) ReaderIO[R, B], onRight func(A) ReaderIO[R, B]) ReaderIO[R, B] {
func MonadFold[R, E, A, B any](ma ReaderIOEither[R, E, A], onLeft readerio.Kleisli[R, E, B], onRight func(A) ReaderIO[R, B]) ReaderIO[R, B] {
return eithert.FoldE(readerio.MonadChain[R, either.Either[E, A], B], ma, onLeft, onRight)
}
@@ -680,7 +680,7 @@ func MonadFold[R, E, A, B any](ma ReaderIOEither[R, E, A], onLeft func(E) Reader
// The default is computed lazily via a ReaderIO.
//
//go:inline
func GetOrElse[R, E, A any](onLeft func(E) ReaderIO[R, A]) func(ReaderIOEither[R, E, A]) ReaderIO[R, A] {
func GetOrElse[R, E, A any](onLeft readerio.Kleisli[R, E, A]) func(ReaderIOEither[R, E, A]) ReaderIO[R, A] {
return eithert.GetOrElse(readerio.MonadChain[R, either.Either[E, A], A], readerio.Of[R, A], onLeft)
}

View File

@@ -1,14 +1,107 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package readerioresult
import (
"github.com/IBM/fp-go/v2/readerioeither"
)
// ChainConsumer chains a consumer (side-effect function) into a ReaderIOResult computation,
// replacing the success value with Void (empty struct).
//
// This is useful for performing side effects (like logging, printing, or writing to a file)
// where you don't need to preserve the original value. The consumer is only executed if the
// computation succeeds; if it fails with an error, the consumer is skipped.
//
// Type parameters:
// - R: The context/environment type
// - A: The value type to consume
//
// Parameters:
// - c: A consumer function that performs a side effect on the value
//
// Returns:
//
// An Operator that executes the consumer and returns Void on success
//
// Example:
//
// import (
// "context"
// "fmt"
// RIO "github.com/IBM/fp-go/v2/readerioresult"
// )
//
// // Log a value and discard it
// logValue := RIO.ChainConsumer[context.Context](func(x int) {
// fmt.Printf("Value: %d\n", x)
// })
//
// computation := F.Pipe1(
// RIO.Of[context.Context](42),
// logValue,
// )
// // Prints "Value: 42" and returns result.Of(struct{}{})
//
//go:inline
func ChainConsumer[R, A any](c Consumer[A]) Operator[R, A, struct{}] {
func ChainConsumer[R, A any](c Consumer[A]) Operator[R, A, Void] {
return readerioeither.ChainConsumer[R, error](c)
}
// ChainFirstConsumer chains a consumer into a ReaderIOResult computation while preserving
// the original value.
//
// This is useful for performing side effects (like logging, printing, or metrics collection)
// where you want to keep the original value for further processing. The consumer is only
// executed if the computation succeeds; if it fails with an error, the consumer is skipped
// and the error is propagated.
//
// Type parameters:
// - R: The context/environment type
// - A: The value type to consume and preserve
//
// Parameters:
// - c: A consumer function that performs a side effect on the value
//
// Returns:
//
// An Operator that executes the consumer and returns the original value on success
//
// Example:
//
// import (
// "context"
// "fmt"
// F "github.com/IBM/fp-go/v2/function"
// N "github.com/IBM/fp-go/v2/number"
// RIO "github.com/IBM/fp-go/v2/readerioresult"
// )
//
// // Log a value but keep it for further processing
// logValue := RIO.ChainFirstConsumer[context.Context](func(x int) {
// fmt.Printf("Processing: %d\n", x)
// })
//
// computation := F.Pipe2(
// RIO.Of[context.Context](10),
// logValue,
// RIO.Map[context.Context](N.Mul(2)),
// )
// // Prints "Processing: 10" and returns result.Of(20)
//
//go:inline
func ChainFirstConsumer[R, A any](c Consumer[A]) Operator[R, A, A] {
return readerioeither.ChainFirstConsumer[R, error](c)

View File

@@ -0,0 +1,360 @@
// Copyright (c) 2023 - 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package readerioresult
import (
"context"
"errors"
"testing"
F "github.com/IBM/fp-go/v2/function"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/result"
S "github.com/IBM/fp-go/v2/string"
"github.com/stretchr/testify/assert"
)
// TestChainConsumer_Success tests that ChainConsumer executes the consumer
// and returns Void when the computation succeeds
func TestChainConsumer_Success(t *testing.T) {
// Track if consumer was called
var consumed int
consumer := func(x int) {
consumed = x
}
// Create a successful computation and chain the consumer
computation := F.Pipe1(
Of[context.Context](42),
ChainConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was called with correct value
assert.Equal(t, 42, consumed)
// Verify result is successful with Void
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
val := result.GetOrElse(func(error) Void { return Void{} })(res)
assert.Equal(t, Void{}, val)
}
}
// TestChainConsumer_Failure tests that ChainConsumer does not execute
// the consumer when the computation fails
func TestChainConsumer_Failure(t *testing.T) {
// Track if consumer was called
consumerCalled := false
consumer := func(x int) {
consumerCalled = true
}
// Create a failing computation
expectedErr := errors.New("test error")
computation := F.Pipe1(
Left[context.Context, int](expectedErr),
ChainConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was NOT called
assert.False(t, consumerCalled)
// Verify result is an error
assert.True(t, result.IsLeft(res))
}
// TestChainConsumer_MultipleOperations tests chaining multiple operations
// with ChainConsumer in a pipeline
func TestChainConsumer_MultipleOperations(t *testing.T) {
// Track consumer calls
var values []int
consumer := func(x int) {
values = append(values, x)
}
// Create a pipeline with multiple operations
computation := F.Pipe2(
Of[context.Context](10),
Map[context.Context](N.Mul(2)),
ChainConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was called with transformed value
assert.Equal(t, []int{20}, values)
// Verify result is successful
assert.True(t, result.IsRight(res))
}
// TestChainFirstConsumer_Success tests that ChainFirstConsumer executes
// the consumer and preserves the original value
func TestChainFirstConsumer_Success(t *testing.T) {
// Track if consumer was called
var consumed int
consumer := func(x int) {
consumed = x
}
// Create a successful computation and chain the consumer
computation := F.Pipe1(
Of[context.Context](42),
ChainFirstConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was called with correct value
assert.Equal(t, 42, consumed)
// Verify result is successful and preserves original value
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
val := result.GetOrElse(func(error) int { return 0 })(res)
assert.Equal(t, 42, val)
}
}
// TestChainFirstConsumer_Failure tests that ChainFirstConsumer does not
// execute the consumer when the computation fails
func TestChainFirstConsumer_Failure(t *testing.T) {
// Track if consumer was called
consumerCalled := false
consumer := func(x int) {
consumerCalled = true
}
// Create a failing computation
expectedErr := errors.New("test error")
computation := F.Pipe1(
Left[context.Context, int](expectedErr),
ChainFirstConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was NOT called
assert.False(t, consumerCalled)
// Verify result is an error
assert.True(t, result.IsLeft(res))
}
// TestChainFirstConsumer_PreservesValue tests that ChainFirstConsumer
// preserves the value for further processing
func TestChainFirstConsumer_PreservesValue(t *testing.T) {
// Track consumer calls
var logged []int
logger := func(x int) {
logged = append(logged, x)
}
// Create a pipeline that logs intermediate values
computation := F.Pipe3(
Of[context.Context](10),
ChainFirstConsumer[context.Context](logger),
Map[context.Context](N.Mul(2)),
ChainFirstConsumer[context.Context](logger),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer was called at each step
assert.Equal(t, []int{10, 20}, logged)
// Verify final result
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
val := result.GetOrElse(func(error) int { return 0 })(res)
assert.Equal(t, 20, val)
}
}
// TestChainFirstConsumer_WithMap tests combining ChainFirstConsumer with Map
func TestChainFirstConsumer_WithMap(t *testing.T) {
// Track intermediate values
var intermediate int
consumer := func(x int) {
intermediate = x
}
// Create a pipeline with logging and transformation
computation := F.Pipe2(
Of[context.Context](5),
ChainFirstConsumer[context.Context](consumer),
Map[context.Context](N.Mul(3)),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer saw original value
assert.Equal(t, 5, intermediate)
// Verify final result is transformed
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
val := result.GetOrElse(func(error) int { return 0 })(res)
assert.Equal(t, 15, val)
}
}
// TestChainConsumer_WithContext tests that consumers work with context
func TestChainConsumer_WithContext(t *testing.T) {
type Config struct {
Multiplier int
}
// Track consumer calls
var consumed int
consumer := func(x int) {
consumed = x
}
// Create a computation that uses context
computation := F.Pipe2(
Of[Config](10),
Map[Config](N.Mul(2)),
ChainConsumer[Config](consumer),
)
// Execute with context
cfg := Config{Multiplier: 3}
res := computation(cfg)()
// Verify consumer was called
assert.Equal(t, 20, consumed)
// Verify result is successful
assert.True(t, result.IsRight(res))
}
// TestChainFirstConsumer_SideEffects tests that ChainFirstConsumer
// can be used for side effects like logging
func TestChainFirstConsumer_SideEffects(t *testing.T) {
// Simulate a logging side effect
var logs []string
logValue := func(x string) {
logs = append(logs, "Processing: "+x)
}
// Create a pipeline with logging
computation := F.Pipe3(
Of[context.Context]("hello"),
ChainFirstConsumer[context.Context](logValue),
Map[context.Context](S.Append(" world")),
ChainFirstConsumer[context.Context](logValue),
)
// Execute the computation
res := computation(context.Background())()
// Verify logs were created
assert.Equal(t, []string{
"Processing: hello",
"Processing: hello world",
}, logs)
// Verify final result
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
val := result.GetOrElse(func(error) string { return "" })(res)
assert.Equal(t, "hello world", val)
}
}
// TestChainConsumer_ComplexType tests consumers with complex types
func TestChainConsumer_ComplexType(t *testing.T) {
type User struct {
Name string
Age int
}
// Track consumed user
var consumedUser *User
consumer := func(u User) {
consumedUser = &u
}
// Create a computation with a complex type
user := User{Name: "Alice", Age: 30}
computation := F.Pipe1(
Of[context.Context](user),
ChainConsumer[context.Context](consumer),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer received the user
assert.NotNil(t, consumedUser)
assert.Equal(t, "Alice", consumedUser.Name)
assert.Equal(t, 30, consumedUser.Age)
// Verify result is successful
assert.True(t, result.IsRight(res))
}
// TestChainFirstConsumer_ComplexType tests ChainFirstConsumer with complex types
func TestChainFirstConsumer_ComplexType(t *testing.T) {
type Product struct {
ID int
Name string
Price float64
}
// Track consumed products
var consumedProducts []Product
consumer := func(p Product) {
consumedProducts = append(consumedProducts, p)
}
// Create a pipeline with complex type
product := Product{ID: 1, Name: "Widget", Price: 9.99}
computation := F.Pipe2(
Of[context.Context](product),
ChainFirstConsumer[context.Context](consumer),
Map[context.Context](func(p Product) Product {
p.Price = p.Price * 1.1 // Apply 10% markup
return p
}),
)
// Execute the computation
res := computation(context.Background())()
// Verify consumer saw original product
assert.Len(t, consumedProducts, 1)
assert.Equal(t, 9.99, consumedProducts[0].Price)
// Verify final result has updated price
assert.True(t, result.IsRight(res))
if result.IsRight(res) {
finalProduct := result.GetOrElse(func(error) Product { return Product{} })(res)
assert.InDelta(t, 10.989, finalProduct.Price, 0.001)
}
}

View File

@@ -25,10 +25,11 @@ import (
"github.com/IBM/fp-go/v2/readerio"
RIOE "github.com/IBM/fp-go/v2/readerioeither"
"github.com/IBM/fp-go/v2/readeroption"
"github.com/IBM/fp-go/v2/result"
)
//go:inline
func FromReaderOption[R, A any](onNone func() error) Kleisli[R, ReaderOption[R, A], A] {
func FromReaderOption[R, A any](onNone Lazy[error]) Kleisli[R, ReaderOption[R, A], A] {
return RIOE.FromReaderOption[R, A](onNone)
}
@@ -113,7 +114,7 @@ func MonadTap[R, A, B any](fa ReaderIOResult[R, A], f Kleisli[R, A, B]) ReaderIO
// The Either is automatically lifted into the ReaderIOResult context.
//
//go:inline
func MonadChainEitherK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, B] {
func MonadChainEitherK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, B] {
return RIOE.MonadChainEitherK(ma, f)
}
@@ -121,7 +122,7 @@ func MonadChainEitherK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]
// The Either is automatically lifted into the ReaderIOResult context.
//
//go:inline
func MonadChainResultK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, B] {
func MonadChainResultK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, B] {
return RIOE.MonadChainEitherK(ma, f)
}
@@ -129,7 +130,7 @@ func MonadChainResultK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]
// This is the curried version of MonadChainEitherK.
//
//go:inline
func ChainEitherK[R, A, B any](f func(A) Result[B]) Operator[R, A, B] {
func ChainEitherK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, B] {
return RIOE.ChainEitherK[R](f)
}
@@ -137,7 +138,7 @@ func ChainEitherK[R, A, B any](f func(A) Result[B]) Operator[R, A, B] {
// This is the curried version of MonadChainEitherK.
//
//go:inline
func ChainResultK[R, A, B any](f func(A) Result[B]) Operator[R, A, B] {
func ChainResultK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, B] {
return RIOE.ChainEitherK[R](f)
}
@@ -145,12 +146,12 @@ func ChainResultK[R, A, B any](f func(A) Result[B]) Operator[R, A, B] {
// Useful for validation or side effects that return Either.
//
//go:inline
func MonadChainFirstEitherK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, A] {
func MonadChainFirstEitherK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, A] {
return RIOE.MonadChainFirstEitherK(ma, f)
}
//go:inline
func MonadTapEitherK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, A] {
func MonadTapEitherK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, A] {
return RIOE.MonadTapEitherK(ma, f)
}
@@ -158,12 +159,12 @@ func MonadTapEitherK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B])
// This is the curried version of MonadChainFirstEitherK.
//
//go:inline
func ChainFirstEitherK[R, A, B any](f func(A) Result[B]) Operator[R, A, A] {
func ChainFirstEitherK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, A] {
return RIOE.ChainFirstEitherK[R](f)
}
//go:inline
func TapEitherK[R, A, B any](f func(A) Result[B]) Operator[R, A, A] {
func TapEitherK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, A] {
return RIOE.TapEitherK[R](f)
}
@@ -171,12 +172,12 @@ func TapEitherK[R, A, B any](f func(A) Result[B]) Operator[R, A, A] {
// Useful for validation or side effects that return Either.
//
//go:inline
func MonadChainFirstResultK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, A] {
func MonadChainFirstResultK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, A] {
return RIOE.MonadChainFirstEitherK(ma, f)
}
//go:inline
func MonadTapResultK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B]) ReaderIOResult[R, A] {
func MonadTapResultK[R, A, B any](ma ReaderIOResult[R, A], f result.Kleisli[A, B]) ReaderIOResult[R, A] {
return RIOE.MonadTapEitherK(ma, f)
}
@@ -184,12 +185,12 @@ func MonadTapResultK[R, A, B any](ma ReaderIOResult[R, A], f func(A) Result[B])
// This is the curried version of MonadChainFirstEitherK.
//
//go:inline
func ChainFirstResultK[R, A, B any](f func(A) Result[B]) Operator[R, A, A] {
func ChainFirstResultK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, A] {
return RIOE.ChainFirstEitherK[R](f)
}
//go:inline
func TapResultK[R, A, B any](f func(A) Result[B]) Operator[R, A, A] {
func TapResultK[R, A, B any](f result.Kleisli[A, B]) Operator[R, A, A] {
return RIOE.TapEitherK[R](f)
}
@@ -230,17 +231,17 @@ func TapReaderK[R, A, B any](f reader.Kleisli[R, A, B]) Operator[R, A, A] {
}
//go:inline
func ChainReaderOptionK[R, A, B any](onNone func() error) func(readeroption.Kleisli[R, A, B]) Operator[R, A, B] {
func ChainReaderOptionK[R, A, B any](onNone Lazy[error]) func(readeroption.Kleisli[R, A, B]) Operator[R, A, B] {
return RIOE.ChainReaderOptionK[R, A, B](onNone)
}
//go:inline
func ChainFirstReaderOptionK[R, A, B any](onNone func() error) func(readeroption.Kleisli[R, A, B]) Operator[R, A, A] {
func ChainFirstReaderOptionK[R, A, B any](onNone Lazy[error]) func(readeroption.Kleisli[R, A, B]) Operator[R, A, A] {
return RIOE.ChainFirstReaderOptionK[R, A, B](onNone)
}
//go:inline
func TapReaderOptionK[R, A, B any](onNone func() error) func(readeroption.Kleisli[R, A, B]) Operator[R, A, A] {
func TapReaderOptionK[R, A, B any](onNone Lazy[error]) func(readeroption.Kleisli[R, A, B]) Operator[R, A, A] {
return RIOE.TapReaderOptionK[R, A, B](onNone)
}
@@ -421,7 +422,7 @@ func TapIOK[R, A, B any](f func(A) IO[B]) Operator[R, A, A] {
// If the Option is None, the provided error function is called to produce the error value.
//
//go:inline
func ChainOptionK[R, A, B any](onNone func() error) func(func(A) Option[B]) Operator[R, A, B] {
func ChainOptionK[R, A, B any](onNone Lazy[error]) func(func(A) Option[B]) Operator[R, A, B] {
return RIOE.ChainOptionK[R, A, B](onNone)
}
@@ -619,7 +620,7 @@ func Asks[R, A any](r Reader[R, A]) ReaderIOResult[R, A] {
// If the Option is None, the provided function is called to produce the error.
//
//go:inline
func FromOption[R, A any](onNone func() error) Kleisli[R, Option[A], A] {
func FromOption[R, A any](onNone Lazy[error]) Kleisli[R, Option[A], A] {
return RIOE.FromOption[R, A](onNone)
}
@@ -635,7 +636,7 @@ func FromPredicate[R, A any](pred func(A) bool, onFalse func(A) error) Kleisli[R
// This is useful for converting a ReaderIOResult into a ReaderIO by handling all cases.
//
//go:inline
func Fold[R, A, B any](onLeft func(error) ReaderIO[R, B], onRight func(A) ReaderIO[R, B]) func(ReaderIOResult[R, A]) ReaderIO[R, B] {
func Fold[R, A, B any](onLeft readerio.Kleisli[R, error, B], onRight func(A) ReaderIO[R, B]) func(ReaderIOResult[R, A]) ReaderIO[R, B] {
return RIOE.Fold(onLeft, onRight)
}
@@ -643,7 +644,7 @@ func Fold[R, A, B any](onLeft func(error) ReaderIO[R, B], onRight func(A) Reader
// The default is computed lazily via a ReaderIO.
//
//go:inline
func GetOrElse[R, A any](onLeft func(error) ReaderIO[R, A]) func(ReaderIOResult[R, A]) ReaderIO[R, A] {
func GetOrElse[R, A any](onLeft readerio.Kleisli[R, error, A]) func(ReaderIOResult[R, A]) ReaderIO[R, A] {
return RIOE.GetOrElse(onLeft)
}
@@ -658,7 +659,7 @@ func OrElse[R, A any](onLeft Kleisli[R, error, A]) Operator[R, A, A] {
// The success value is preserved unchanged.
//
//go:inline
func OrLeft[A, R, E any](onLeft func(error) ReaderIO[R, E]) func(ReaderIOResult[R, A]) RIOE.ReaderIOEither[R, E, A] {
func OrLeft[A, R, E any](onLeft readerio.Kleisli[R, error, E]) func(ReaderIOResult[R, A]) RIOE.ReaderIOEither[R, E, A] {
return RIOE.OrLeft[A](onLeft)
}

View File

@@ -19,6 +19,7 @@ import (
"github.com/IBM/fp-go/v2/consumer"
"github.com/IBM/fp-go/v2/either"
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/ioeither"
"github.com/IBM/fp-go/v2/ioresult"
@@ -122,4 +123,6 @@ type (
// Predicate represents a function that tests a value of type A and returns a boolean.
Predicate[A any] = predicate.Predicate[A]
Void = function.Void
)

262
v2/result/filterable.go Normal file
View File

@@ -0,0 +1,262 @@
// Copyright (c) 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package result provides filterable operations for Result types.
//
// This package implements the Fantasy Land Filterable specification:
// https://github.com/fantasyland/fantasy-land#filterable
//
// Since Result[A] is an alias for Either[error, A], these functions are
// thin wrappers around the corresponding either package functions, specialized
// for the common case where the error type is Go's built-in error interface.
package result
import (
"github.com/IBM/fp-go/v2/either"
"github.com/IBM/fp-go/v2/option"
)
// Partition separates a [Result] value into a [Pair] based on a predicate function.
// It returns a function that takes a Result and produces a Pair of Result values,
// where the first element contains values that fail the predicate and the second
// contains values that pass the predicate.
//
// This function implements the Filterable specification's partition operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is an error (Left), both elements of the resulting Pair will be the same error
// - If the input is Ok (Right) and the predicate returns true, the result is (Err(empty), Ok(value))
// - If the input is Ok (Right) and the predicate returns false, the result is (Ok(value), Err(empty))
//
// Parameters:
// - p: A predicate function that tests values of type A
// - empty: The default error to use when creating error Results for partitioning
//
// Returns:
//
// A function that takes a Result[A] and returns a Pair where:
// - First element: Result values that fail the predicate (or original error)
// - Second element: Result values that pass the predicate (or original error)
//
// Example:
//
// import (
// R "github.com/IBM/fp-go/v2/result"
// N "github.com/IBM/fp-go/v2/number"
// P "github.com/IBM/fp-go/v2/pair"
// "errors"
// )
//
// // Partition positive and non-positive numbers
// isPositive := N.MoreThan(0)
// partition := R.Partition(isPositive, errors.New("not positive"))
//
// // Ok value that passes predicate
// result1 := partition(R.Of(5))
// // result1 = Pair(Err("not positive"), Ok(5))
//
// // Ok value that fails predicate
// result2 := partition(R.Of(-3))
// // result2 = Pair(Ok(-3), Err("not positive"))
//
// // Error passes through unchanged in both positions
// result3 := partition(R.Error[int](errors.New("original error")))
// // result3 = Pair(Err("original error"), Err("original error"))
//
//go:inline
func Partition[A any](p Predicate[A], empty error) func(Result[A]) Pair[Result[A], Result[A]] {
return either.Partition(p, empty)
}
// Filter creates a filtering operation for [Result] values based on a predicate function.
// It returns a function that takes a Result and produces a Result, where Ok values
// that fail the predicate are converted to error Results with the provided error.
//
// This function implements the Filterable specification's filter operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is an error, it passes through unchanged
// - If the input is Ok and the predicate returns true, the Ok value passes through unchanged
// - If the input is Ok and the predicate returns false, it's converted to Err(empty)
//
// Parameters:
// - p: A predicate function that tests values of type A
// - empty: The default error to use when filtering out Ok values that fail the predicate
//
// Returns:
//
// An Operator function that takes a Result[A] and returns a Result[A] where:
// - Error values pass through unchanged
// - Ok values that pass the predicate remain as Ok
// - Ok values that fail the predicate become Err(empty)
//
// Example:
//
// import (
// R "github.com/IBM/fp-go/v2/result"
// N "github.com/IBM/fp-go/v2/number"
// "errors"
// )
//
// // Filter to keep only positive numbers
// isPositive := N.MoreThan(0)
// filterPositive := R.Filter(isPositive, errors.New("not positive"))
//
// // Ok value that passes predicate - remains Ok
// result1 := filterPositive(R.Of(5))
// // result1 = Ok(5)
//
// // Ok value that fails predicate - becomes Err
// result2 := filterPositive(R.Of(-3))
// // result2 = Err("not positive")
//
// // Error passes through unchanged
// result3 := filterPositive(R.Error[int](errors.New("original error")))
// // result3 = Err("original error")
//
// // Chaining filters
// isEven := func(n int) bool { return n%2 == 0 }
// filterEven := R.Filter(isEven, errors.New("not even"))
//
// result4 := filterEven(filterPositive(R.Of(4)))
// // result4 = Ok(4) - passes both filters
//
// result5 := filterEven(filterPositive(R.Of(3)))
// // result5 = Err("not even") - passes first, fails second
//
//go:inline
func Filter[A any](p Predicate[A], empty error) Operator[A, A] {
return either.Filter(p, empty)
}
// FilterMap combines filtering and mapping operations for [Result] values using an [Option]-returning function.
// It returns a function that takes a Result[A] and produces a Result[B], where Ok values
// are transformed by applying the function f. If f returns Some(B), the result is Ok(B). If f returns
// None, the result is Err(empty).
//
// This function implements the Filterable specification's filterMap operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is an error, it passes through with its error value preserved
// - If the input is Ok and f returns Some(B), the result is Ok(B)
// - If the input is Ok and f returns None, the result is Err(empty)
//
// Parameters:
// - f: An Option Kleisli function that transforms values of type A to Option[B]
// - empty: The default error to use when f returns None
//
// Returns:
//
// An Operator function that takes a Result[A] and returns a Result[B] where:
// - Error values pass through with error preserved
// - Ok values are transformed by f: Some(B) becomes Ok(B), None becomes Err(empty)
//
// Example:
//
// import (
// R "github.com/IBM/fp-go/v2/result"
// O "github.com/IBM/fp-go/v2/option"
// "errors"
// "strconv"
// )
//
// // Parse string to int, filtering out invalid values
// parseInt := func(s string) O.Option[int] {
// if n, err := strconv.Atoi(s); err == nil {
// return O.Some(n)
// }
// return O.None[int]()
// }
// filterMapInt := R.FilterMap(parseInt, errors.New("invalid number"))
//
// // Valid number string - transforms to Ok(int)
// result1 := filterMapInt(R.Of("42"))
// // result1 = Ok(42)
//
// // Invalid number string - becomes Err
// result2 := filterMapInt(R.Of("abc"))
// // result2 = Err("invalid number")
//
// // Error passes through with error preserved
// result3 := filterMapInt(R.Error[string](errors.New("original error")))
// // result3 = Err("original error")
//
//go:inline
func FilterMap[A, B any](f option.Kleisli[A, B], empty error) Operator[A, B] {
return either.FilterMap(f, empty)
}
// PartitionMap separates and transforms a [Result] value into a [Pair] of Result values using a mapping function.
// It returns a function that takes a Result[A] and produces a Pair of Result values, where the mapping
// function f transforms the Ok value into Either[B, C]. The result is partitioned based on whether f
// produces a Left or Right value.
//
// This function implements the Filterable specification's partitionMap operation:
// https://github.com/fantasyland/fantasy-land#filterable
//
// The behavior is as follows:
// - If the input is an error, both elements of the resulting Pair will be errors with the original error
// - If the input is Ok and f returns Left(B), the result is (Ok(B), Err(empty))
// - If the input is Ok and f returns Right(C), the result is (Err(empty), Ok(C))
//
// Parameters:
// - f: A Kleisli function that transforms values of type A to Either[B, C]
// - empty: The default error to use when creating error Results for partitioning
//
// Returns:
//
// A function that takes a Result[A] and returns a Pair[Result[B], Result[C]] where:
// - If input is error: (Err(original_error), Err(original_error))
// - If f returns Left(B): (Ok(B), Err(empty))
// - If f returns Right(C): (Err(empty), Ok(C))
//
// Example:
//
// import (
// R "github.com/IBM/fp-go/v2/result"
// E "github.com/IBM/fp-go/v2/either"
// P "github.com/IBM/fp-go/v2/pair"
// "errors"
// "strconv"
// )
//
// // Classify and transform numbers: negative -> error message, positive -> squared value
// classifyNumber := func(n int) E.Either[string, int] {
// if n < 0 {
// return E.Left[int]("negative: " + strconv.Itoa(n))
// }
// return E.Right[string](n * n)
// }
// partitionMap := R.PartitionMap(classifyNumber, errors.New("not classified"))
//
// // Positive number - goes to right side as squared value
// result1 := partitionMap(R.Of(5))
// // result1 = Pair(Err("not classified"), Ok(25))
//
// // Negative number - goes to left side with error message
// result2 := partitionMap(R.Of(-3))
// // result2 = Pair(Ok("negative: -3"), Err("not classified"))
//
// // Original error - appears in both positions
// result3 := partitionMap(R.Error[int](errors.New("original error")))
// // result3 = Pair(Err("original error"), Err("original error"))
//
//go:inline
func PartitionMap[A, B, C any](f either.Kleisli[B, A, C], empty error) func(Result[A]) Pair[Result[B], Result[C]] {
return either.PartitionMap(f, empty)
}

View File

@@ -0,0 +1,689 @@
// Copyright (c) 2025 IBM Corp.
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package result
import (
"errors"
"math"
"strconv"
"testing"
E "github.com/IBM/fp-go/v2/either"
N "github.com/IBM/fp-go/v2/number"
O "github.com/IBM/fp-go/v2/option"
P "github.com/IBM/fp-go/v2/pair"
"github.com/stretchr/testify/assert"
)
func TestPartition(t *testing.T) {
t.Run("Ok value that passes predicate", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
input := Of(5)
// Act
result := partition(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsLeft(left), "left should be error")
assert.True(t, IsRight(right), "right should be Ok")
rightVal, _ := Unwrap(right)
assert.Equal(t, 5, rightVal)
})
t.Run("Ok value that fails predicate", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
input := Of(-3)
// Act
result := partition(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsRight(left), "left should be Ok (failed predicate)")
assert.True(t, IsLeft(right), "right should be error")
leftVal, _ := Unwrap(left)
assert.Equal(t, -3, leftVal)
})
t.Run("Ok value at boundary (zero)", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
input := Of(0)
// Act
result := partition(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsRight(left), "left should be Ok (zero fails predicate)")
assert.True(t, IsLeft(right), "right should be error")
leftVal, _ := Unwrap(left)
assert.Equal(t, 0, leftVal)
})
t.Run("Error passes through unchanged", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
originalError := errors.New("original error")
input := Left[int](originalError)
// Act
result := partition(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsLeft(left), "left should be error")
assert.True(t, IsLeft(right), "right should be error")
_, leftErr := Unwrap(left)
_, rightErr := Unwrap(right)
assert.Equal(t, originalError, leftErr)
assert.Equal(t, originalError, rightErr)
})
t.Run("String predicate - even length strings", func(t *testing.T) {
// Arrange
isEvenLength := func(s string) bool { return len(s)%2 == 0 }
partition := Partition(isEvenLength, errors.New("odd length"))
// Act & Assert - passes predicate
result1 := partition(Of("test"))
left1, right1 := P.Unpack(result1)
assert.True(t, IsLeft(left1))
assert.True(t, IsRight(right1))
rightVal1, _ := Unwrap(right1)
assert.Equal(t, "test", rightVal1)
// Act & Assert - fails predicate
result2 := partition(Of("hello"))
left2, right2 := P.Unpack(result2)
assert.True(t, IsRight(left2))
assert.True(t, IsLeft(right2))
leftVal2, _ := Unwrap(left2)
assert.Equal(t, "hello", leftVal2)
})
t.Run("Complex type predicate - struct field check", func(t *testing.T) {
// Arrange
type Person struct {
Name string
Age int
}
isAdult := func(p Person) bool { return p.Age >= 18 }
partition := Partition(isAdult, errors.New("minor"))
// Act & Assert - adult passes
adult := Person{Name: "Alice", Age: 25}
result1 := partition(Of(adult))
left1, right1 := P.Unpack(result1)
assert.True(t, IsLeft(left1))
assert.True(t, IsRight(right1))
rightVal1, _ := Unwrap(right1)
assert.Equal(t, adult, rightVal1)
// Act & Assert - minor fails
minor := Person{Name: "Bob", Age: 15}
result2 := partition(Of(minor))
left2, right2 := P.Unpack(result2)
assert.True(t, IsRight(left2))
assert.True(t, IsLeft(right2))
leftVal2, _ := Unwrap(left2)
assert.Equal(t, minor, leftVal2)
})
}
func TestFilter(t *testing.T) {
t.Run("Ok value that passes predicate", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
input := Of(5)
// Act
result := filter(input)
// Assert
assert.True(t, IsRight(result), "result should be Ok")
val, _ := Unwrap(result)
assert.Equal(t, 5, val)
})
t.Run("Ok value that fails predicate", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
input := Of(-3)
// Act
result := filter(input)
// Assert
assert.True(t, IsLeft(result), "result should be error")
_, err := Unwrap(result)
assert.Equal(t, "not positive", err.Error())
})
t.Run("Ok value at boundary (zero)", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
input := Of(0)
// Act
result := filter(input)
// Assert
assert.True(t, IsLeft(result), "zero should fail predicate")
_, err := Unwrap(result)
assert.Equal(t, "not positive", err.Error())
})
t.Run("Error passes through unchanged", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
originalError := errors.New("original error")
input := Left[int](originalError)
// Act
result := filter(input)
// Assert
assert.True(t, IsLeft(result), "result should be error")
_, err := Unwrap(result)
assert.Equal(t, originalError, err)
})
t.Run("Chaining multiple filters", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
isEven := func(n int) bool { return n%2 == 0 }
filterPositive := Filter(isPositive, errors.New("not positive"))
filterEven := Filter(isEven, errors.New("not even"))
// Act & Assert - passes both filters
result1 := filterEven(filterPositive(Of(4)))
assert.True(t, IsRight(result1))
val1, _ := Unwrap(result1)
assert.Equal(t, 4, val1)
// Act & Assert - passes first, fails second
result2 := filterEven(filterPositive(Of(3)))
assert.True(t, IsLeft(result2))
_, err2 := Unwrap(result2)
assert.Equal(t, "not even", err2.Error())
// Act & Assert - fails first filter
result3 := filterEven(filterPositive(Of(-2)))
assert.True(t, IsLeft(result3))
_, err3 := Unwrap(result3)
assert.Equal(t, "not positive", err3.Error())
// Act & Assert - error passes through both
originalErr := errors.New("original")
result4 := filterEven(filterPositive(Left[int](originalErr)))
assert.True(t, IsLeft(result4))
_, err4 := Unwrap(result4)
assert.Equal(t, originalErr, err4)
})
t.Run("Filter preserves error", func(t *testing.T) {
// Arrange
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("default error"))
// Act - error with different message
originalError := errors.New("server error")
result := filter(Left[int](originalError))
// Assert - original error preserved
assert.True(t, IsLeft(result))
_, err := Unwrap(result)
assert.Equal(t, originalError, err)
})
}
func TestFilterMap(t *testing.T) {
t.Run("Ok value with Some result", func(t *testing.T) {
// Arrange
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
filterMap := FilterMap(parseInt, errors.New("invalid number"))
input := Of("42")
// Act
result := filterMap(input)
// Assert
assert.True(t, IsRight(result), "result should be Ok")
val, _ := Unwrap(result)
assert.Equal(t, 42, val)
})
t.Run("Ok value with None result", func(t *testing.T) {
// Arrange
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
filterMap := FilterMap(parseInt, errors.New("invalid number"))
input := Of("abc")
// Act
result := filterMap(input)
// Assert
assert.True(t, IsLeft(result), "result should be error")
_, err := Unwrap(result)
assert.Equal(t, "invalid number", err.Error())
})
t.Run("Error passes through", func(t *testing.T) {
// Arrange
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
filterMap := FilterMap(parseInt, errors.New("invalid number"))
originalError := errors.New("original error")
input := Left[string](originalError)
// Act
result := filterMap(input)
// Assert
assert.True(t, IsLeft(result), "result should be error")
_, err := Unwrap(result)
assert.Equal(t, originalError, err)
})
t.Run("Extract optional field from struct", func(t *testing.T) {
// Arrange
type Person struct {
Name string
Email O.Option[string]
}
extractEmail := func(p Person) O.Option[string] { return p.Email }
filterMap := FilterMap(extractEmail, errors.New("no email"))
// Act & Assert - has email
result1 := filterMap(Of(Person{Name: "Alice", Email: O.Some("alice@example.com")}))
assert.True(t, IsRight(result1))
val1, _ := Unwrap(result1)
assert.Equal(t, "alice@example.com", val1)
// Act & Assert - no email
result2 := filterMap(Of(Person{Name: "Bob", Email: O.None[string]()}))
assert.True(t, IsLeft(result2))
_, err2 := Unwrap(result2)
assert.Equal(t, "no email", err2.Error())
})
t.Run("Transform and filter numbers", func(t *testing.T) {
// Arrange
sqrtIfPositive := func(n int) O.Option[float64] {
if n >= 0 {
return O.Some(math.Sqrt(float64(n)))
}
return O.None[float64]()
}
filterMap := FilterMap(sqrtIfPositive, errors.New("negative number"))
// Act & Assert - positive number
result1 := filterMap(Of(16))
assert.True(t, IsRight(result1))
val1, _ := Unwrap(result1)
assert.Equal(t, 4.0, val1)
// Act & Assert - negative number
result2 := filterMap(Of(-4))
assert.True(t, IsLeft(result2))
_, err2 := Unwrap(result2)
assert.Equal(t, "negative number", err2.Error())
// Act & Assert - zero
result3 := filterMap(Of(0))
assert.True(t, IsRight(result3))
val3, _ := Unwrap(result3)
assert.Equal(t, 0.0, val3)
})
t.Run("Chain multiple FilterMap operations", func(t *testing.T) {
// Arrange
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
doubleIfEven := func(n int) O.Option[int] {
if n%2 == 0 {
return O.Some(n * 2)
}
return O.None[int]()
}
filterMap1 := FilterMap(parseInt, errors.New("invalid number"))
filterMap2 := FilterMap(doubleIfEven, errors.New("not even"))
// Act & Assert - valid even number
result1 := filterMap2(filterMap1(Of("4")))
assert.True(t, IsRight(result1))
val1, _ := Unwrap(result1)
assert.Equal(t, 8, val1)
// Act & Assert - valid odd number
result2 := filterMap2(filterMap1(Of("3")))
assert.True(t, IsLeft(result2))
_, err2 := Unwrap(result2)
assert.Equal(t, "not even", err2.Error())
// Act & Assert - invalid number
result3 := filterMap2(filterMap1(Of("abc")))
assert.True(t, IsLeft(result3))
_, err3 := Unwrap(result3)
assert.Equal(t, "invalid number", err3.Error())
})
}
func TestPartitionMap(t *testing.T) {
t.Run("Ok value that maps to Left", func(t *testing.T) {
// Arrange
classifyNumber := func(n int) E.Either[string, int] {
if n < 0 {
return E.Left[int]("negative: " + strconv.Itoa(n))
}
return E.Right[string](n * n)
}
partitionMap := PartitionMap(classifyNumber, errors.New("not classified"))
input := Of(-3)
// Act
result := partitionMap(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsRight(left), "left should be Ok (contains error from f)")
assert.True(t, IsLeft(right), "right should be error")
leftVal, _ := Unwrap(left)
assert.Equal(t, "negative: -3", leftVal)
})
t.Run("Ok value that maps to Right", func(t *testing.T) {
// Arrange
classifyNumber := func(n int) E.Either[string, int] {
if n < 0 {
return E.Left[int]("negative: " + strconv.Itoa(n))
}
return E.Right[string](n * n)
}
partitionMap := PartitionMap(classifyNumber, errors.New("not classified"))
input := Of(5)
// Act
result := partitionMap(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsLeft(left), "left should be error")
assert.True(t, IsRight(right), "right should be Ok (contains value from f)")
rightVal, _ := Unwrap(right)
assert.Equal(t, 25, rightVal)
})
t.Run("Error passes through to both sides", func(t *testing.T) {
// Arrange
classifyNumber := func(n int) E.Either[string, int] {
if n < 0 {
return E.Left[int]("negative")
}
return E.Right[string](n * n)
}
partitionMap := PartitionMap(classifyNumber, errors.New("not classified"))
originalError := errors.New("original error")
input := Left[int](originalError)
// Act
result := partitionMap(input)
left, right := P.Unpack(result)
// Assert
assert.True(t, IsLeft(left), "left should be error")
assert.True(t, IsLeft(right), "right should be error")
_, leftErr := Unwrap(left)
_, rightErr := Unwrap(right)
assert.Equal(t, originalError, leftErr)
assert.Equal(t, originalError, rightErr)
})
t.Run("Validate and transform user input", func(t *testing.T) {
// Arrange
type ValidationError struct {
Field string
Message string
}
type User struct {
Name string
Age int
}
validateUser := func(input map[string]string) E.Either[ValidationError, User] {
name, hasName := input["name"]
ageStr, hasAge := input["age"]
if !hasName {
return E.Left[User](ValidationError{"name", "missing"})
}
if !hasAge {
return E.Left[User](ValidationError{"age", "missing"})
}
age, err := strconv.Atoi(ageStr)
if err != nil {
return E.Left[User](ValidationError{"age", "invalid"})
}
return E.Right[ValidationError](User{name, age})
}
partitionMap := PartitionMap(validateUser, errors.New("not processed"))
// Act & Assert - valid input
validInput := map[string]string{"name": "Alice", "age": "30"}
result1 := partitionMap(Of(validInput))
left1, right1 := P.Unpack(result1)
assert.True(t, IsLeft(left1))
assert.True(t, IsRight(right1))
rightVal1, _ := Unwrap(right1)
assert.Equal(t, User{"Alice", 30}, rightVal1)
// Act & Assert - invalid input (missing age)
invalidInput := map[string]string{"name": "Bob"}
result2 := partitionMap(Of(invalidInput))
left2, right2 := P.Unpack(result2)
assert.True(t, IsRight(left2))
assert.True(t, IsLeft(right2))
leftVal2, _ := Unwrap(left2)
assert.Equal(t, ValidationError{"age", "missing"}, leftVal2)
})
t.Run("Classify strings by length", func(t *testing.T) {
// Arrange
classifyString := func(s string) E.Either[string, int] {
if len(s) < 5 {
return E.Left[int]("too short: " + s)
}
return E.Right[string](len(s))
}
partitionMap := PartitionMap(classifyString, errors.New("not classified"))
// Act & Assert - short string
result1 := partitionMap(Of("hi"))
left1, right1 := P.Unpack(result1)
assert.True(t, IsRight(left1))
assert.True(t, IsLeft(right1))
leftVal1, _ := Unwrap(left1)
assert.Equal(t, "too short: hi", leftVal1)
// Act & Assert - long string
result2 := partitionMap(Of("hello world"))
left2, right2 := P.Unpack(result2)
assert.True(t, IsLeft(left2))
assert.True(t, IsRight(right2))
rightVal2, _ := Unwrap(right2)
assert.Equal(t, 11, rightVal2)
})
}
// Benchmark tests
func BenchmarkPartition(b *testing.B) {
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
input := Of(42)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = partition(input)
}
}
func BenchmarkPartitionError(b *testing.B) {
isPositive := N.MoreThan(0)
partition := Partition(isPositive, errors.New("not positive"))
input := Left[int](errors.New("error"))
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = partition(input)
}
}
func BenchmarkFilter(b *testing.B) {
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
input := Of(42)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = filter(input)
}
}
func BenchmarkFilterError(b *testing.B) {
isPositive := N.MoreThan(0)
filter := Filter(isPositive, errors.New("not positive"))
input := Left[int](errors.New("error"))
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = filter(input)
}
}
func BenchmarkFilterChained(b *testing.B) {
isPositive := N.MoreThan(0)
isEven := func(n int) bool { return n%2 == 0 }
filterPositive := Filter(isPositive, errors.New("not positive"))
filterEven := Filter(isEven, errors.New("not even"))
input := Of(42)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = filterEven(filterPositive(input))
}
}
func BenchmarkFilterMap(b *testing.B) {
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
filterMap := FilterMap(parseInt, errors.New("invalid"))
input := Of("42")
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = filterMap(input)
}
}
func BenchmarkFilterMapError(b *testing.B) {
parseInt := func(s string) O.Option[int] {
if n, err := strconv.Atoi(s); err == nil {
return O.Some(n)
}
return O.None[int]()
}
filterMap := FilterMap(parseInt, errors.New("invalid"))
input := Left[string](errors.New("error"))
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = filterMap(input)
}
}
func BenchmarkPartitionMap(b *testing.B) {
classify := func(n int) E.Either[string, int] {
if n < 0 {
return E.Left[int]("negative")
}
return E.Right[string](n * n)
}
partitionMap := PartitionMap(classify, errors.New("not classified"))
input := Of(42)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = partitionMap(input)
}
}
func BenchmarkPartitionMapError(b *testing.B) {
classify := func(n int) E.Either[string, int] {
if n < 0 {
return E.Left[int]("negative")
}
return E.Right[string](n * n)
}
partitionMap := PartitionMap(classify, errors.New("not classified"))
input := Left[int](errors.New("error"))
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = partitionMap(input)
}
}

View File

@@ -22,6 +22,7 @@ import (
"github.com/IBM/fp-go/v2/monoid"
"github.com/IBM/fp-go/v2/optics/lens"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/predicate"
"github.com/IBM/fp-go/v2/reader"
)
@@ -61,4 +62,6 @@ type (
// Predicate represents a function that tests a value of type A and returns a boolean.
// It's commonly used for filtering and conditional operations.
Predicate[A any] = predicate.Predicate[A]
Pair[L, R any] = pair.Pair[L, R]
)