1
0
mirror of https://github.com/IBM/fp-go.git synced 2026-03-08 13:29:18 +02:00

Compare commits

...

26 Commits

Author SHA1 Message Date
Dr. Carsten Leue
6834f72856 fix: make signature of Local for context more generic, but backwards compatible
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-07 21:02:24 +01:00
Dr. Carsten Leue
8cfb7ef659 fix: logging implementation for context sensitive operations
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-06 23:54:42 +01:00
Dr. Carsten Leue
622c87d734 fix: logging implementation for context sensitive operations
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-06 23:50:54 +01:00
Dr. Carsten Leue
2ce406a410 fix: add context7 badge
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-06 15:03:05 +01:00
Dr. Carsten Leue
3743361b9f fix: context7 at correct location
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-06 14:41:47 +01:00
Dr. Carsten Leue
69d11f0a4b fix: claim context7
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-06 14:39:58 +01:00
Dr. Carsten Leue
e4dd1169c4 fix: recursion in Errors()
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-04 11:12:22 +01:00
Dr. Carsten Leue
1657569f1d Merge branch 'main' of github.com:IBM/fp-go 2026-03-04 10:31:04 +01:00
Dr. Carsten Leue
545876d013 fix: add bool codec
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-04 10:30:55 +01:00
renovate[bot]
9492c5d994 chore(deps): update actions/setup-node action to v6.3.0 (#158)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2026-03-04 09:20:04 +00:00
Dr. Carsten Leue
94b1ea30d1 fix: improved doc
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-02 13:23:59 +01:00
Dr. Carsten Leue
a77d61f632 fix: add Bind for Codec
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-02 13:01:21 +01:00
renovate[bot]
66b2f57d73 fix(deps): update module github.com/urfave/cli/v3 to v3.7.0 (#157)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2026-03-02 08:40:21 +00:00
Dr. Carsten Leue
92eb2a50a2 fix: support MarshalJSON and MarshalText types
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-03-01 22:38:20 +01:00
Dr. Carsten Leue
3df1dca146 fix: better result type for Pipe
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 17:03:12 +01:00
Dr. Carsten Leue
a0132e2e92 fix: parameter order
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 15:08:11 +01:00
Dr. Carsten Leue
c6b342908d doc: better explanation for logger
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 13:52:08 +01:00
Dr. Carsten Leue
962237492f doc: explain Effect
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 13:27:20 +01:00
Dr. Carsten Leue
168a6e1072 fix: add Eitherize to Effect
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 12:55:03 +01:00
Dr. Carsten Leue
4d67b1d254 fix: expose Empty for Codec
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-27 10:52:23 +01:00
Dr. Carsten Leue
77a8cc6b09 fix: implement ApSO
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 18:44:27 +01:00
Dr. Carsten Leue
bc8743fdfc fix: build error
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 18:21:37 +01:00
Dr. Carsten Leue
1837d3f86d fix: add semigroup helpers
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 16:39:05 +01:00
Dr. Carsten Leue
b2d111e8ec fix: more doc and tests
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 14:04:44 +01:00
Dr. Carsten Leue
ae141c85c6 fix: add tests
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 13:40:12 +01:00
Dr. Carsten Leue
1230b4581b doc: add doc links
Signed-off-by: Dr. Carsten Leue <carsten.leue@de.ibm.com>
2026-02-26 10:12:20 +01:00
79 changed files with 9670 additions and 1412 deletions

View File

@@ -134,7 +134,7 @@ jobs:
fetch-depth: 0
- name: Set up Node.js ${{ env.NODE_VERSION }}
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
with:
node-version: ${{ env.NODE_VERSION }}

4
context7.json Normal file
View File

@@ -0,0 +1,4 @@
{
"url": "https://context7.com/ibm/fp-go",
"public_key": "pk_7wJdJRn8zGHxvIYu7eh9h"
}

View File

@@ -151,6 +151,11 @@ func TestFromReaderResult_Success(t *testing.T) {
- Don't manually handle `(value, error)` tuples when helpers exist
- Don't use `either.MonadFold` in tests unless necessary
4. **Use Void Type for Unit Values**
- Use `function.Void` (or `F.Void`) instead of `struct{}`
- Use `function.VOID` (or `F.VOID`) instead of `struct{}{}`
- Example: `Empty[F.Void, F.Void, any](lazy.Of(pair.MakePair(F.VOID, F.VOID)))`
### Error Handling
1. **In Production Code**

View File

@@ -1,6 +1,6 @@
# Functional I/O in Go: Context, Errors, and the Reader Pattern
This document explores how functional programming principles apply to I/O operations in Go, comparing traditional imperative approaches with functional patterns using the `context/readerioresult` and `idiomatic/context/readerresult` packages.
This document explores how functional programming principles apply to I/O operations in Go, comparing traditional imperative approaches with functional patterns using the `context/readerioresult`, `idiomatic/context/readerresult`, and `effect` packages.
## Table of Contents
@@ -10,6 +10,7 @@ This document explores how functional programming principles apply to I/O operat
- [Benefits of the Functional Approach](#benefits-of-the-functional-approach)
- [Side-by-Side Comparison](#side-by-side-comparison)
- [Advanced Patterns](#advanced-patterns)
- [The Effect Package: Higher-Level Abstraction](#the-effect-package-higher-level-abstraction)
- [When to Use Each Approach](#when-to-use-each-approach)
## Why Context in I/O Operations
@@ -775,6 +776,191 @@ func FetchWithRetry(url string, maxRetries int) RIO.ReaderIOResult[[]byte] {
}
```
## The Effect Package: Higher-Level Abstraction
### What is Effect?
The `effect` package provides a higher-level abstraction over `ReaderReaderIOResult`, offering a complete effect system for managing dependencies, errors, and side effects in a composable way. It's inspired by [effect-ts](https://effect.website/) and provides a cleaner API for complex workflows.
### Core Type
```go
// Effect represents an effectful computation that:
// - Requires a context of type C (dependency injection)
// - Can perform I/O operations
// - Can fail with an error
// - Produces a value of type A on success
type Effect[C, A any] = readerreaderioresult.ReaderReaderIOResult[C, A]
```
**Key difference from ReaderIOResult**: Effect adds an additional layer of dependency injection (the `C` type parameter) on top of the runtime `context.Context`, enabling type-safe dependency management.
### When to Use Effect
Use the Effect package when you need:
1. **Type-Safe Dependency Injection**: Your application has typed dependencies (config, services, repositories) that need to be threaded through operations
2. **Complex Workflows**: Multiple services and dependencies need to be composed
3. **Testability**: You want to easily mock dependencies by providing different contexts
4. **Separation of Concerns**: Clear separation between business logic, dependencies, and I/O
### Effect vs ReaderIOResult
```go
// ReaderIOResult - depends only on runtime context
type ReaderIOResult[A any] = func(context.Context) (A, error)
// Effect - depends on typed context C AND runtime context
type Effect[C, A any] = func(C) func(context.Context) (A, error)
```
**ReaderIOResult** is simpler and suitable when you only need runtime context (cancellation, deadlines, request-scoped values).
**Effect** adds typed dependency injection, making it ideal for applications with complex service dependencies.
### Basic Usage
#### Creating Effects
```go
type AppConfig struct {
DatabaseURL string
APIKey string
}
// Create a successful effect
successEffect := effect.Succeed[AppConfig, string]("hello")
// Create a failed effect
failEffect := effect.Fail[AppConfig, string](errors.New("failed"))
// Lift a pure value
pureEffect := effect.Of[AppConfig, int](42)
```
#### Integrating Standard Go Functions
The `Eitherize` function makes it easy to integrate standard Go functions that return `(value, error)`:
```go
type Database struct {
conn *sql.DB
}
// Convert a standard Go function to an Effect using Eitherize
func fetchUser(id int) effect.Effect[Database, User] {
return effect.Eitherize(func(db Database, ctx context.Context) (User, error) {
var user User
err := db.conn.QueryRowContext(ctx, "SELECT * FROM users WHERE id = ?", id).Scan(&user)
return user, err
})
}
// Use Eitherize1 for Kleisli arrows (functions with an additional parameter)
fetchUserKleisli := effect.Eitherize1(func(db Database, ctx context.Context, id int) (User, error) {
var user User
err := db.conn.QueryRowContext(ctx, "SELECT * FROM users WHERE id = ?", id).Scan(&user)
return user, err
})
// fetchUserKleisli has type: func(int) Effect[Database, User]
```
#### Composing Effects
```go
type Services struct {
UserRepo UserRepository
EmailSvc EmailService
}
// Compose multiple effects with typed dependencies
func processUser(id int, newEmail string) effect.Effect[Services, User] {
return F.Pipe3(
// Fetch user from repository
effect.Eitherize(func(svc Services, ctx context.Context) (User, error) {
return svc.UserRepo.GetUser(ctx, id)
}),
// Validate user (pure function lifted into Effect)
effect.ChainEitherK[Services](validateUser),
// Update email
effect.Chain[Services](func(user User) effect.Effect[Services, User] {
return effect.Eitherize(func(svc Services, ctx context.Context) (User, error) {
if err := svc.EmailSvc.SendVerification(ctx, newEmail); err != nil {
return User{}, err
}
return svc.UserRepo.UpdateEmail(ctx, user.ID, newEmail)
})
}),
)
}
```
#### Running Effects
```go
func main() {
// Set up typed dependencies once
services := Services{
UserRepo: &PostgresUserRepo{db: db},
EmailSvc: &SMTPEmailService{host: "smtp.example.com"},
}
// Build the effect pipeline (no execution yet)
userEffect := processUser(42, "new@email.com")
// Provide dependencies - returns a Thunk (ReaderIOResult)
thunk := effect.Provide(services)(userEffect)
// Run synchronously - returns a func(context.Context) (User, error)
readerResult := effect.RunSync(thunk)
// Execute with runtime context
user, err := readerResult(context.Background())
if err != nil {
log.Fatal(err)
}
fmt.Printf("Updated user: %+v\n", user)
}
```
### Comparison: Traditional vs ReaderIOResult vs Effect
| Aspect | Traditional | ReaderIOResult | Effect |
|---|---|---|---|
| Error propagation | Manual | Automatic | Automatic |
| Dependency injection | Function parameters | Closure / `context.Context` | Typed `C` parameter |
| Testability | Requires mocking | Mock `ReaderIOResult` | Provide mock `C` |
| Composability | Low | High | High |
| Type-safe dependencies | No | No | Yes |
| Complexity | Low | Medium | Medium-High |
### Testing with Effect
One of the key benefits of Effect is easy testing through dependency substitution:
```go
func TestProcessUser(t *testing.T) {
// Create mock services
mockServices := Services{
UserRepo: &MockUserRepo{
users: map[int]User{42: {ID: 42, Age: 25, Email: "old@email.com"}},
},
EmailSvc: &MockEmailService{},
}
// Run the effect with mock dependencies
user, err := effect.RunSync(
effect.Provide(mockServices)(processUser(42, "new@email.com")),
)(context.Background())
assert.NoError(t, err)
assert.Equal(t, "new@email.com", user.Email)
}
```
No database or SMTP server needed — just provide mock implementations of the `Services` struct.
## When to Use Each Approach
### Use Traditional Go Style When:
@@ -794,6 +980,17 @@ func FetchWithRetry(url string, maxRetries int) RIO.ReaderIOResult[[]byte] {
5. **Resource management**: Need guaranteed cleanup (Bracket)
6. **Parallel execution**: Need to parallelize operations easily
7. **Type safety**: Want the type system to track I/O effects
8. **Simple dependencies**: Only need runtime `context.Context`, no typed dependencies
### Use Effect When:
1. **Type-safe dependency injection**: Application has typed dependencies (config, services, repositories)
2. **Complex service architectures**: Multiple services need to be composed with clear dependency management
3. **Testability with mocks**: Want to easily substitute dependencies for testing
4. **Separation of concerns**: Need clear separation between business logic, dependencies, and I/O
5. **Large applications**: Building applications where dependency management is critical
6. **Team experience**: Team is comfortable with functional programming and effect systems
7. **Integration with standard Go**: Need to integrate many standard `(value, error)` functions using `Eitherize`
### Use Idiomatic Functional Style (idiomatic/context/readerresult) When:
@@ -803,6 +1000,7 @@ func FetchWithRetry(url string, maxRetries int) RIO.ReaderIOResult[[]byte] {
4. **Go integration**: Want seamless integration with existing Go code
5. **Production services**: Building high-throughput services
6. **Best of both worlds**: Want functional composition with Go's native patterns
7. **Simple dependencies**: Only need runtime `context.Context`, no typed dependencies
## Summary
@@ -814,11 +1012,18 @@ The functional approach to I/O in Go offers significant advantages:
4. **Type Safety**: I/O effects visible in the type system
5. **Lazy Evaluation**: Build pipelines, execute when ready
6. **Context Propagation**: Automatic threading of context
7. **Performance**: Idiomatic version offers 2-10x speedup
7. **Dependency Injection**: Type-safe dependency management with Effect
8. **Performance**: Idiomatic version offers 2-10x speedup
The key insight is that **I/O operations return descriptions of effects** (ReaderIOResult) rather than performing effects immediately. This enables powerful composition patterns while maintaining Go's idiomatic error handling through the `(value, error)` tuple pattern.
The key insight is that **I/O operations return descriptions of effects** rather than performing effects immediately. This enables powerful composition patterns while maintaining Go's idiomatic error handling through the `(value, error)` tuple pattern.
For production Go services, the **idiomatic/context/readerresult** package provides the best balance: full functional programming capabilities with native Go performance and familiar error handling patterns.
### Choosing the Right Abstraction
- **ReaderIOResult**: Best for simple I/O pipelines that only need runtime `context.Context`
- **Effect**: Best for complex applications with typed dependencies and service architectures
- **idiomatic/context/readerresult**: Best for production services needing high performance with functional patterns
For production Go services, the **idiomatic/context/readerresult** package provides the best balance of performance and functional capabilities. For applications with complex dependency management, the **effect** package provides type-safe dependency injection with a clean, composable API.
## Further Reading
@@ -826,4 +1031,6 @@ For production Go services, the **idiomatic/context/readerresult** package provi
- [IDIOMATIC_COMPARISON.md](./IDIOMATIC_COMPARISON.md) - Performance comparison
- [idiomatic/doc.go](./idiomatic/doc.go) - Idiomatic package overview
- [context/readerioresult](./context/readerioresult/) - ReaderIOResult package
- [idiomatic/context/readerresult](./idiomatic/context/readerresult/) - Idiomatic ReaderResult package
- [idiomatic/context/readerresult](./idiomatic/context/readerresult/) - Idiomatic ReaderResult package
- [effect](./effect/) - Effect package for type-safe dependency injection
- [effect-ts](https://effect.website/) - TypeScript effect system that inspired this package

View File

@@ -3,6 +3,7 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/IBM/fp-go/v2.svg)](https://pkg.go.dev/github.com/IBM/fp-go/v2)
[![Coverage Status](https://coveralls.io/repos/github/IBM/fp-go/badge.svg?branch=main&flag=v2)](https://coveralls.io/github/IBM/fp-go?branch=main)
[![Go Report Card](https://goreportcard.com/badge/github.com/IBM/fp-go/v2)](https://goreportcard.com/report/github.com/IBM/fp-go/v2)
[![Context7](https://img.shields.io/badge/context7-docs-blue)](https://context7.com/ibm/fp-go)
**fp-go** is a comprehensive functional programming library for Go, bringing type-safe functional patterns inspired by [fp-ts](https://gcanti.github.io/fp-ts/) to the Go ecosystem. Version 2 leverages [generic type aliases](https://github.com/golang/go/issues/46477) introduced in Go 1.24, providing a more ergonomic and streamlined API.
@@ -461,7 +462,8 @@ func process() IOResult[string] {
- **Result** - Simplified Either with error as left type (recommended for error handling)
- **IO** - Lazy evaluation and side effect management
- **IOOption** - Combine IO with Option for optional values with side effects
- **IOResult** - Combine IO with Result for error handling (recommended over IOEither)
- **IOResult** - Combine IO with Result for error handling (recommended over IOEither when using standard `error` type)
- **Effect** - Composable effects with dependency injection and error handling
- **Reader** - Dependency injection pattern
- **ReaderOption** - Combine Reader with Option for optional values with dependency injection
- **ReaderIOOption** - Combine Reader, IO, and Option for optional values with dependency injection and side effects

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -388,8 +387,8 @@ func generateApplyHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -266,8 +265,8 @@ func generateBindHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -189,8 +188,8 @@ func generateDIHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -148,8 +147,8 @@ func generateEitherHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -18,7 +18,6 @@ package cli
import (
"fmt"
"os"
"time"
)
func writePackage(f *os.File, pkg string) {
@@ -26,6 +25,6 @@ func writePackage(f *os.File, pkg string) {
fmt.Fprintf(f, "package %s\n\n", pkg)
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
}

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -62,8 +61,8 @@ func generateIdentityHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
A "github.com/IBM/fp-go/v2/array"
C "github.com/urfave/cli/v3"
@@ -71,8 +70,8 @@ func generateIOHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
A "github.com/IBM/fp-go/v2/array"
C "github.com/urfave/cli/v3"
@@ -219,8 +218,8 @@ func generateIOEitherHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)
@@ -234,8 +233,7 @@ import (
// some header
fmt.Fprintln(fg, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(fg, "// This file was generated by robots at")
fmt.Fprintf(fg, "// %s\n", time.Now())
fmt.Fprintln(fg, "// This file was generated by robots.")
fmt.Fprintf(fg, "package generic\n\n")

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
A "github.com/IBM/fp-go/v2/array"
C "github.com/urfave/cli/v3"
@@ -76,8 +75,8 @@ func generateIOOptionHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -148,8 +147,8 @@ func generateOptionHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -378,8 +377,8 @@ func generatePipeHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n", pkg)

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -118,8 +117,8 @@ func generateReaderHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)
@@ -131,8 +130,7 @@ import (
// some header
fmt.Fprintln(fg, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(fg, "// This file was generated by robots at")
fmt.Fprintf(fg, "// %s\n", time.Now())
fmt.Fprintln(fg, "// This file was generated by robots.")
fmt.Fprintf(fg, "package generic\n\n")

View File

@@ -21,7 +21,6 @@ import (
"log"
"os"
"path/filepath"
"time"
C "github.com/urfave/cli/v3"
)
@@ -233,8 +232,8 @@ func generateReaderIOEitherHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)
@@ -246,8 +245,7 @@ import (
// some header
fmt.Fprintln(fg, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(fg, "// This file was generated by robots at")
fmt.Fprintf(fg, "// %s\n", time.Now())
fmt.Fprintln(fg, "// This file was generated by robots.")
fmt.Fprintf(fg, "package generic\n\n")

View File

@@ -22,7 +22,6 @@ import (
"os"
"path/filepath"
"strings"
"time"
C "github.com/urfave/cli/v3"
)
@@ -399,8 +398,8 @@ func generateTupleHelpers(filename string, count int) error {
// some header
fmt.Fprintln(f, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(f, "// This file was generated by robots at")
fmt.Fprintf(f, "// %s\n\n", time.Now())
fmt.Fprintln(f, "// This file was generated by robots.")
fmt.Fprintln(f)
fmt.Fprintf(f, "package %s\n\n", pkg)

View File

@@ -13,6 +13,37 @@
// See the License for the specific language governing permissions and
// limitations under the License.
// Package constant provides the Const functor, a phantom type that ignores its second type parameter.
//
// The Const functor is a fundamental building block in functional programming that wraps a value
// of type E while having a phantom type parameter A. This makes it useful for:
// - Accumulating values during traversals (e.g., collecting metadata)
// - Implementing optics (lenses, prisms) where you need to track information
// - Building applicative functors that combine values using a semigroup
//
// # The Const Functor
//
// Const[E, A] wraps a value of type E and has a phantom type parameter A that doesn't affect
// the runtime value. This allows it to participate in functor and applicative operations while
// maintaining the wrapped value unchanged.
//
// # Key Properties
//
// - Map operations ignore the function and preserve the wrapped value
// - Ap operations combine wrapped values using a semigroup
// - The phantom type A allows type-safe composition with other functors
//
// # Example Usage
//
// // Accumulate string values
// c1 := Make[string, int]("hello")
// c2 := Make[string, int]("world")
//
// // Map doesn't change the wrapped value
// mapped := Map[string, int, string](strconv.Itoa)(c1) // Still contains "hello"
//
// // Ap combines values using a semigroup
// combined := Ap[string, int, int](S.Monoid)(c1)(c2) // Contains "helloworld"
package constant
import (
@@ -21,36 +52,209 @@ import (
S "github.com/IBM/fp-go/v2/semigroup"
)
// Const is a functor that wraps a value of type E with a phantom type parameter A.
//
// The Const functor is useful for accumulating values during traversals or implementing
// optics. The type parameter A is phantom - it doesn't affect the runtime value but allows
// the type to participate in functor and applicative operations.
//
// Type Parameters:
// - E: The type of the wrapped value (the actual data)
// - A: The phantom type parameter (not stored, only used for type-level operations)
//
// Example:
//
// // Create a Const that wraps a string
// c := Make[string, int]("metadata")
//
// // The int type parameter is phantom - no int value is stored
// value := Unwrap(c) // "metadata"
type Const[E, A any] struct {
value E
}
// Make creates a Const value wrapping the given value.
//
// This is the primary constructor for Const values. The second type parameter A
// is phantom and must be specified explicitly when needed for type inference.
//
// Type Parameters:
// - E: The type of the value to wrap
// - A: The phantom type parameter
//
// Parameters:
// - e: The value to wrap
//
// Returns:
// - A Const[E, A] wrapping the value
//
// Example:
//
// c := Make[string, int]("hello")
// value := Unwrap(c) // "hello"
func Make[E, A any](e E) Const[E, A] {
return Const[E, A]{value: e}
}
// Unwrap extracts the wrapped value from a Const.
//
// This is the inverse of Make, retrieving the actual value stored in the Const.
//
// Type Parameters:
// - E: The type of the wrapped value
// - A: The phantom type parameter
//
// Parameters:
// - c: The Const to unwrap
//
// Returns:
// - The wrapped value of type E
//
// Example:
//
// c := Make[string, int]("world")
// value := Unwrap(c) // "world"
func Unwrap[E, A any](c Const[E, A]) E {
return c.value
}
// Of creates a Const containing the monoid's empty value, ignoring the input.
//
// This implements the Applicative's "pure" operation for Const. It creates a Const
// wrapping the monoid's identity element, regardless of the input value.
//
// Type Parameters:
// - E: The type of the wrapped value (must have a monoid)
// - A: The input type (ignored)
//
// Parameters:
// - m: The monoid providing the empty value
//
// Returns:
// - A function that ignores its input and returns Const[E, A] with the empty value
//
// Example:
//
// import S "github.com/IBM/fp-go/v2/string"
//
// of := Of[string, int](S.Monoid)
// c := of(42) // Const[string, int] containing ""
// value := Unwrap(c) // ""
func Of[E, A any](m M.Monoid[E]) func(A) Const[E, A] {
return F.Constant1[A](Make[E, A](m.Empty()))
}
// MonadMap applies a function to the phantom type parameter without changing the wrapped value.
//
// This implements the Functor's map operation for Const. Since the type parameter A is phantom,
// the function is never actually called - the wrapped value E remains unchanged.
//
// Type Parameters:
// - E: The type of the wrapped value
// - A: The input phantom type
// - B: The output phantom type
//
// Parameters:
// - fa: The Const to map over
// - _: The function to apply (ignored)
//
// Returns:
// - A Const[E, B] with the same wrapped value
//
// Example:
//
// c := Make[string, int]("hello")
// mapped := MonadMap(c, func(i int) string { return strconv.Itoa(i) })
// // mapped still contains "hello", function was never called
func MonadMap[E, A, B any](fa Const[E, A], _ func(A) B) Const[E, B] {
return Make[E, B](fa.value)
}
// MonadAp combines two Const values using a semigroup.
//
// This implements the Applicative's ap operation for Const. It combines the wrapped
// values from both Const instances using the provided semigroup, ignoring the function
// type in the first argument.
//
// Type Parameters:
// - E: The type of the wrapped values (must have a semigroup)
// - A: The input phantom type
// - B: The output phantom type
//
// Parameters:
// - s: The semigroup for combining wrapped values
//
// Returns:
// - A function that takes two Const values and combines their wrapped values
//
// Example:
//
// import S "github.com/IBM/fp-go/v2/string"
//
// ap := MonadAp[string, int, int](S.Monoid)
// c1 := Make[string, func(int) int]("hello")
// c2 := Make[string, int]("world")
// result := ap(c1, c2) // Const containing "helloworld"
func MonadAp[E, A, B any](s S.Semigroup[E]) func(fab Const[E, func(A) B], fa Const[E, A]) Const[E, B] {
return func(fab Const[E, func(A) B], fa Const[E, A]) Const[E, B] {
return Make[E, B](s.Concat(fab.value, fa.value))
}
}
// Map applies a function to the phantom type parameter without changing the wrapped value.
//
// This is the curried version of MonadMap, providing a more functional programming style.
// The function is never actually called since A is a phantom type.
//
// Type Parameters:
// - E: The type of the wrapped value
// - A: The input phantom type
// - B: The output phantom type
//
// Parameters:
// - f: The function to apply (ignored)
//
// Returns:
// - A function that transforms Const[E, A] to Const[E, B]
//
// Example:
//
// import F "github.com/IBM/fp-go/v2/function"
//
// c := Make[string, int]("data")
// mapped := F.Pipe1(c, Map[string, int, string](strconv.Itoa))
// // mapped still contains "data"
func Map[E, A, B any](f func(A) B) func(fa Const[E, A]) Const[E, B] {
return F.Bind2nd(MonadMap[E, A, B], f)
}
// Ap combines Const values using a semigroup in a curried style.
//
// This is the curried version of MonadAp, providing data-last style for better composition.
// It combines the wrapped values from both Const instances using the provided semigroup.
//
// Type Parameters:
// - E: The type of the wrapped values (must have a semigroup)
// - A: The input phantom type
// - B: The output phantom type
//
// Parameters:
// - s: The semigroup for combining wrapped values
//
// Returns:
// - A curried function for combining Const values
//
// Example:
//
// import (
// F "github.com/IBM/fp-go/v2/function"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// c1 := Make[string, int]("hello")
// c2 := Make[string, func(int) int]("world")
// result := F.Pipe1(c1, Ap[string, int, int](S.Monoid)(c2))
// // result contains "helloworld"
func Ap[E, A, B any](s S.Semigroup[E]) func(fa Const[E, A]) func(fab Const[E, func(A) B]) Const[E, B] {
monadap := MonadAp[E, A, B](s)
return func(fa Const[E, A]) func(fab Const[E, func(A) B]) Const[E, B] {

View File

@@ -16,25 +16,340 @@
package constant
import (
"strconv"
"testing"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/internal/utils"
N "github.com/IBM/fp-go/v2/number"
S "github.com/IBM/fp-go/v2/string"
"github.com/stretchr/testify/assert"
)
func TestMap(t *testing.T) {
fa := Make[string, int]("foo")
assert.Equal(t, fa, F.Pipe1(fa, Map[string](utils.Double)))
// TestMake tests the Make constructor
func TestMake(t *testing.T) {
t.Run("creates Const with string value", func(t *testing.T) {
c := Make[string, int]("hello")
assert.Equal(t, "hello", Unwrap(c))
})
t.Run("creates Const with int value", func(t *testing.T) {
c := Make[int, string](42)
assert.Equal(t, 42, Unwrap(c))
})
t.Run("creates Const with struct value", func(t *testing.T) {
type Config struct {
Name string
Port int
}
cfg := Config{Name: "server", Port: 8080}
c := Make[Config, bool](cfg)
assert.Equal(t, cfg, Unwrap(c))
})
}
// TestUnwrap tests extracting values from Const
func TestUnwrap(t *testing.T) {
t.Run("unwraps string value", func(t *testing.T) {
c := Make[string, int]("world")
value := Unwrap(c)
assert.Equal(t, "world", value)
})
t.Run("unwraps empty string", func(t *testing.T) {
c := Make[string, int]("")
value := Unwrap(c)
assert.Equal(t, "", value)
})
t.Run("unwraps zero value", func(t *testing.T) {
c := Make[int, string](0)
value := Unwrap(c)
assert.Equal(t, 0, value)
})
}
// TestOf tests the Of function
func TestOf(t *testing.T) {
assert.Equal(t, Make[string, int](""), Of[string, int](S.Monoid)(1))
t.Run("creates Const with monoid empty value", func(t *testing.T) {
of := Of[string, int](S.Monoid)
c := of(42)
assert.Equal(t, "", Unwrap(c))
})
t.Run("ignores input value", func(t *testing.T) {
of := Of[string, int](S.Monoid)
c1 := of(1)
c2 := of(100)
assert.Equal(t, Unwrap(c1), Unwrap(c2))
})
t.Run("works with int monoid", func(t *testing.T) {
of := Of[int, string](N.MonoidSum[int]())
c := of("ignored")
assert.Equal(t, 0, Unwrap(c))
})
}
func TestAp(t *testing.T) {
fab := Make[string, int]("bar")
assert.Equal(t, Make[string, int]("foobar"), Ap[string, int, int](S.Monoid)(fab)(Make[string, func(int) int]("foo")))
// TestMap tests the Map function
func TestMap(t *testing.T) {
t.Run("preserves wrapped value", func(t *testing.T) {
fa := Make[string, int]("foo")
result := F.Pipe1(fa, Map[string](utils.Double))
assert.Equal(t, "foo", Unwrap(result))
})
t.Run("changes phantom type", func(t *testing.T) {
fa := Make[string, int]("data")
fb := Map[string, int, string](strconv.Itoa)(fa)
// Value unchanged, but type changed from Const[string, int] to Const[string, string]
assert.Equal(t, "data", Unwrap(fb))
})
t.Run("function is never called", func(t *testing.T) {
called := false
fa := Make[string, int]("test")
fb := Map[string, int, string](func(i int) string {
called = true
return strconv.Itoa(i)
})(fa)
assert.False(t, called, "Map function should not be called")
assert.Equal(t, "test", Unwrap(fb))
})
}
// TestMonadMap tests the MonadMap function
func TestMonadMap(t *testing.T) {
t.Run("preserves wrapped value", func(t *testing.T) {
fa := Make[string, int]("original")
fb := MonadMap(fa, func(i int) string { return strconv.Itoa(i) })
assert.Equal(t, "original", Unwrap(fb))
})
t.Run("works with different types", func(t *testing.T) {
fa := Make[int, string](42)
fb := MonadMap(fa, func(s string) bool { return len(s) > 0 })
assert.Equal(t, 42, Unwrap(fb))
})
}
// TestAp tests the Ap function
func TestAp(t *testing.T) {
t.Run("combines string values", func(t *testing.T) {
fab := Make[string, int]("bar")
fa := Make[string, func(int) int]("foo")
result := Ap[string, int, int](S.Monoid)(fab)(fa)
assert.Equal(t, "foobar", Unwrap(result))
})
t.Run("combines int values with sum", func(t *testing.T) {
fab := Make[int, string](10)
fa := Make[int, func(string) string](5)
result := Ap[int, string, string](N.SemigroupSum[int]())(fab)(fa)
assert.Equal(t, 15, Unwrap(result))
})
t.Run("combines int values with product", func(t *testing.T) {
fab := Make[int, bool](3)
fa := Make[int, func(bool) bool](4)
result := Ap[int, bool, bool](N.SemigroupProduct[int]())(fab)(fa)
assert.Equal(t, 12, Unwrap(result))
})
}
// TestMonadAp tests the MonadAp function
func TestMonadAp(t *testing.T) {
t.Run("combines values using semigroup", func(t *testing.T) {
ap := MonadAp[string, int, int](S.Monoid)
fab := Make[string, func(int) int]("hello")
fa := Make[string, int]("world")
result := ap(fab, fa)
assert.Equal(t, "helloworld", Unwrap(result))
})
t.Run("works with empty strings", func(t *testing.T) {
ap := MonadAp[string, int, int](S.Monoid)
fab := Make[string, func(int) int]("")
fa := Make[string, int]("test")
result := ap(fab, fa)
assert.Equal(t, "test", Unwrap(result))
})
}
// TestMonoid tests the Monoid function
func TestMonoid(t *testing.T) {
t.Run("always returns constant value", func(t *testing.T) {
m := Monoid(42)
assert.Equal(t, 42, m.Concat(1, 2))
assert.Equal(t, 42, m.Concat(100, 200))
assert.Equal(t, 42, m.Empty())
})
t.Run("works with strings", func(t *testing.T) {
m := Monoid("constant")
assert.Equal(t, "constant", m.Concat("a", "b"))
assert.Equal(t, "constant", m.Empty())
})
t.Run("works with structs", func(t *testing.T) {
type Point struct{ X, Y int }
p := Point{X: 1, Y: 2}
m := Monoid(p)
assert.Equal(t, p, m.Concat(Point{X: 3, Y: 4}, Point{X: 5, Y: 6}))
assert.Equal(t, p, m.Empty())
})
t.Run("satisfies monoid laws", func(t *testing.T) {
m := Monoid(10)
// Left identity: Concat(Empty(), x) = x (both return constant)
assert.Equal(t, 10, m.Concat(m.Empty(), 5))
// Right identity: Concat(x, Empty()) = x (both return constant)
assert.Equal(t, 10, m.Concat(5, m.Empty()))
// Associativity: Concat(Concat(x, y), z) = Concat(x, Concat(y, z))
left := m.Concat(m.Concat(1, 2), 3)
right := m.Concat(1, m.Concat(2, 3))
assert.Equal(t, left, right)
assert.Equal(t, 10, left)
})
}
// TestConstFunctorLaws tests functor laws for Const
func TestConstFunctorLaws(t *testing.T) {
t.Run("identity law", func(t *testing.T) {
// map id = id
fa := Make[string, int]("test")
mapped := Map[string, int, int](F.Identity[int])(fa)
assert.Equal(t, Unwrap(fa), Unwrap(mapped))
})
t.Run("composition law", func(t *testing.T) {
// map (g . f) = map g . map f
fa := Make[string, int]("data")
f := func(i int) string { return strconv.Itoa(i) }
g := func(s string) bool { return len(s) > 0 }
// map (g . f)
composed := Map[string, int, bool](func(i int) bool { return g(f(i)) })(fa)
// map g . map f
intermediate := F.Pipe1(fa, Map[string, int, string](f))
chained := Map[string, string, bool](g)(intermediate)
assert.Equal(t, Unwrap(composed), Unwrap(chained))
})
}
// TestConstApplicativeLaws tests applicative laws for Const
func TestConstApplicativeLaws(t *testing.T) {
t.Run("identity law", func(t *testing.T) {
// For Const, ap combines the wrapped values using the semigroup
// ap (of id) v combines empty (from of) with v's value
v := Make[string, int]("value")
ofId := Of[string, func(int) int](S.Monoid)(F.Identity[int])
result := Ap[string, int, int](S.Monoid)(v)(ofId)
// Result combines "" (from Of) with "value" using string monoid
assert.Equal(t, "value", Unwrap(result))
})
t.Run("homomorphism law", func(t *testing.T) {
// ap (of f) (of x) = of (f x)
f := func(i int) string { return strconv.Itoa(i) }
x := 42
ofF := Of[string, func(int) string](S.Monoid)(f)
ofX := Of[string, int](S.Monoid)(x)
left := Ap[string, int, string](S.Monoid)(ofX)(ofF)
right := Of[string, string](S.Monoid)(f(x))
assert.Equal(t, Unwrap(left), Unwrap(right))
})
}
// TestConstEdgeCases tests edge cases
func TestConstEdgeCases(t *testing.T) {
t.Run("empty string values", func(t *testing.T) {
c := Make[string, int]("")
assert.Equal(t, "", Unwrap(c))
mapped := Map[string, int, string](strconv.Itoa)(c)
assert.Equal(t, "", Unwrap(mapped))
})
t.Run("zero values", func(t *testing.T) {
c := Make[int, string](0)
assert.Equal(t, 0, Unwrap(c))
})
t.Run("nil pointer", func(t *testing.T) {
var ptr *int
c := Make[*int, string](ptr)
assert.Nil(t, Unwrap(c))
})
t.Run("multiple map operations", func(t *testing.T) {
c := Make[string, int]("original")
// Chain multiple map operations
step1 := Map[string, int, string](strconv.Itoa)(c)
step2 := Map[string, string, bool](func(s string) bool { return len(s) > 0 })(step1)
result := Map[string, bool, int](func(b bool) int {
if b {
return 1
}
return 0
})(step2)
assert.Equal(t, "original", Unwrap(result))
})
}
// BenchmarkMake benchmarks the Make constructor
func BenchmarkMake(b *testing.B) {
b.ResetTimer()
for b.Loop() {
_ = Make[string, int]("test")
}
}
// BenchmarkUnwrap benchmarks the Unwrap function
func BenchmarkUnwrap(b *testing.B) {
c := Make[string, int]("test")
b.ResetTimer()
for b.Loop() {
_ = Unwrap(c)
}
}
// BenchmarkMap benchmarks the Map function
func BenchmarkMap(b *testing.B) {
c := Make[string, int]("test")
mapFn := Map[string, int, string](strconv.Itoa)
b.ResetTimer()
for b.Loop() {
_ = mapFn(c)
}
}
// BenchmarkAp benchmarks the Ap function
func BenchmarkAp(b *testing.B) {
fab := Make[string, int]("hello")
fa := Make[string, func(int) int]("world")
apFn := Ap[string, int, int](S.Monoid)
b.ResetTimer()
for b.Loop() {
_ = apFn(fab)(fa)
}
}
// BenchmarkMonoid benchmarks the Monoid function
func BenchmarkMonoid(b *testing.B) {
m := Monoid(42)
b.ResetTimer()
for b.Loop() {
_ = m.Concat(1, 2)
}
}

View File

@@ -1,3 +1,18 @@
// 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 constant
import (
@@ -5,7 +20,47 @@ import (
M "github.com/IBM/fp-go/v2/monoid"
)
// Monoid returns a [M.Monoid] that returns a constant value in all operations
// Monoid creates a monoid that always returns a constant value.
//
// This creates a trivial monoid where both the Concat operation and Empty
// always return the same constant value, regardless of inputs. This is useful
// for testing, placeholder implementations, or when you need a monoid instance
// but the actual combining behavior doesn't matter.
//
// # Monoid Laws
//
// The constant monoid satisfies all monoid laws trivially:
// - Associativity: Concat(Concat(x, y), z) = Concat(x, Concat(y, z)) - always returns 'a'
// - Left Identity: Concat(Empty(), x) = x - both return 'a'
// - Right Identity: Concat(x, Empty()) = x - both return 'a'
//
// Type Parameters:
// - A: The type of the constant value
//
// Parameters:
// - a: The constant value to return in all operations
//
// Returns:
// - A Monoid[A] that always returns the constant value
//
// Example:
//
// // Create a monoid that always returns 42
// m := Monoid(42)
// result := m.Concat(1, 2) // 42
// empty := m.Empty() // 42
//
// // Useful for testing or placeholder implementations
// type Config struct {
// Timeout int
// }
// defaultConfig := Monoid(Config{Timeout: 30})
// config := defaultConfig.Concat(Config{Timeout: 10}, Config{Timeout: 20})
// // config is Config{Timeout: 30}
//
// See also:
// - function.Constant2: The underlying constant function
// - M.MakeMonoid: The monoid constructor
func Monoid[A any](a A) M.Monoid[A] {
return M.MakeMonoid(function.Constant2[A, A](a), a)
}

View File

@@ -1,6 +1,7 @@
package readerio
import (
"github.com/IBM/fp-go/v2/function"
RIO "github.com/IBM/fp-go/v2/readerio"
)
@@ -73,3 +74,117 @@ func Bracket[
) ReaderIO[B] {
return RIO.Bracket(acquire, use, release)
}
// WithResource creates a higher-order function that manages a resource lifecycle for any operation.
// It returns a Kleisli arrow that takes a use function and automatically handles resource
// acquisition and cleanup using the bracket pattern.
//
// This is a more composable alternative to Bracket, allowing you to define resource management
// once and reuse it with different use functions. The resource is acquired when the returned
// Kleisli arrow is invoked, used by the provided function, and then released regardless of
// success or failure.
//
// Type Parameters:
// - A: The type of the resource to be managed
// - B: The type of the result produced by the use function
// - ANY: The type returned by the release function (typically ignored)
//
// Parameters:
// - onCreate: A ReaderIO that acquires/creates the resource
// - onRelease: A Kleisli arrow that releases/cleans up the resource
//
// Returns:
// - A Kleisli arrow that takes a use function and returns a ReaderIO managing the full lifecycle
//
// Example with database connection:
//
// // Define resource management once
// withDB := WithResource(
// // Acquire connection
// func(ctx context.Context) IO[*sql.DB] {
// return func() *sql.DB {
// db, _ := sql.Open("postgres", "connection-string")
// return db
// }
// },
// // Release connection
// func(db *sql.DB) ReaderIO[any] {
// return func(ctx context.Context) IO[any] {
// return func() any {
// db.Close()
// return nil
// }
// }
// },
// )
//
// // Reuse with different operations
// queryUsers := withDB(func(db *sql.DB) ReaderIO[[]User] {
// return func(ctx context.Context) IO[[]User] {
// return func() []User {
// // Query users from db
// return users
// }
// }
// })
//
// insertUser := withDB(func(db *sql.DB) ReaderIO[int64] {
// return func(ctx context.Context) IO[int64] {
// return func() int64 {
// // Insert user into db
// return userID
// }
// }
// })
//
// Example with file handling:
//
// withFile := WithResource(
// func(ctx context.Context) IO[*os.File] {
// return func() *os.File {
// f, _ := os.Open("data.txt")
// return f
// }
// },
// func(f *os.File) ReaderIO[any] {
// return func(ctx context.Context) IO[any] {
// return func() any {
// f.Close()
// return nil
// }
// }
// },
// )
//
// // Use for reading
// readContent := withFile(func(f *os.File) ReaderIO[string] {
// return func(ctx context.Context) IO[string] {
// return func() string {
// data, _ := io.ReadAll(f)
// return string(data)
// }
// }
// })
//
// // Use for getting file info
// getSize := withFile(func(f *os.File) ReaderIO[int64] {
// return func(ctx context.Context) IO[int64] {
// return func() int64 {
// info, _ := f.Stat()
// return info.Size()
// }
// }
// })
//
// Use Cases:
// - Database connections: Acquire connection, execute queries, close connection
// - File handles: Open file, read/write, close file
// - Network connections: Establish connection, transfer data, close connection
// - Locks: Acquire lock, perform critical section, release lock
// - Temporary resources: Create temp file/directory, use it, clean up
//
//go:inline
func WithResource[A, B, ANY any](
onCreate ReaderIO[A], onRelease Kleisli[A, ANY]) Kleisli[Kleisli[A, B], B] {
return function.Bind13of3(Bracket[A, B, ANY])(onCreate, function.Ignore2of2[B](onRelease))
}

View File

@@ -0,0 +1,456 @@
// 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 readerio
import (
"context"
"errors"
"testing"
"github.com/IBM/fp-go/v2/io"
"github.com/stretchr/testify/assert"
)
// mockResource simulates a resource that tracks its lifecycle
type mockResource struct {
id int
acquired bool
released bool
used bool
}
// TestBracket_Success tests that Bracket properly manages resource lifecycle on success
func TestBracket_Success(t *testing.T) {
resource := &mockResource{id: 1}
// Acquire resource
acquire := func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource.acquired = true
return resource
}
}
// Use resource
use := func(r *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
r.used = true
return "success"
}
}
}
// Release resource
release := func(r *mockResource, result string) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r.released = true
return nil
}
}
}
// Execute bracket
operation := Bracket(acquire, use, release)
result := operation(context.Background())()
// Verify lifecycle
assert.True(t, resource.acquired, "Resource should be acquired")
assert.True(t, resource.used, "Resource should be used")
assert.True(t, resource.released, "Resource should be released")
assert.Equal(t, "success", result)
}
// TestBracket_MultipleResources tests managing multiple resources
func TestBracket_MultipleResources(t *testing.T) {
resource1 := &mockResource{id: 1}
resource2 := &mockResource{id: 2}
acquire1 := func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource1.acquired = true
return resource1
}
}
use1 := func(r1 *mockResource) ReaderIO[*mockResource] {
return func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
r1.used = true
resource2.acquired = true
return resource2
}
}
}
release1 := func(r1 *mockResource, result string) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r1.released = true
return nil
}
}
}
// Nested bracket for second resource
use2 := func(r2 *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
r2.used = true
return "both used"
}
}
}
release2 := func(r2 *mockResource, result string) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r2.released = true
return nil
}
}
}
// Compose brackets
operation := Bracket(acquire1, func(r1 *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
r2 := use1(r1)(ctx)()
return Bracket(
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource { return r2 }
},
use2,
release2,
)(ctx)
}
}, release1)
result := operation(context.Background())()
assert.True(t, resource1.acquired)
assert.True(t, resource1.used)
assert.True(t, resource1.released)
assert.True(t, resource2.acquired)
assert.True(t, resource2.used)
assert.True(t, resource2.released)
assert.Equal(t, "both used", result)
}
// TestWithResource_Success tests WithResource with successful operation
func TestWithResource_Success(t *testing.T) {
resource := &mockResource{id: 1}
// Define resource management
withResource := WithResource[*mockResource, string, any](
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource.acquired = true
return resource
}
},
func(r *mockResource) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r.released = true
return nil
}
}
},
)
// Use resource
operation := withResource(func(r *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
r.used = true
return "result"
}
}
})
result := operation(context.Background())()
assert.True(t, resource.acquired)
assert.True(t, resource.used)
assert.True(t, resource.released)
assert.Equal(t, "result", result)
}
// TestWithResource_Reusability tests that WithResource can be reused with different operations
func TestWithResource_Reusability(t *testing.T) {
callCount := 0
withResource := WithResource[*mockResource, int, any](
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
callCount++
return &mockResource{id: callCount, acquired: true}
}
},
func(r *mockResource) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r.released = true
return nil
}
}
},
)
// First operation
op1 := withResource(func(r *mockResource) ReaderIO[int] {
return func(ctx context.Context) io.IO[int] {
return func() int {
r.used = true
return r.id * 2
}
}
})
result1 := op1(context.Background())()
assert.Equal(t, 2, result1)
assert.Equal(t, 1, callCount)
// Second operation (should create new resource)
op2 := withResource(func(r *mockResource) ReaderIO[int] {
return func(ctx context.Context) io.IO[int] {
return func() int {
r.used = true
return r.id * 3
}
}
})
result2 := op2(context.Background())()
assert.Equal(t, 6, result2)
assert.Equal(t, 2, callCount)
}
// TestWithResource_DifferentResultTypes tests WithResource with different result types
func TestWithResource_DifferentResultTypes(t *testing.T) {
resource := &mockResource{id: 42}
withResourceInt := WithResource[*mockResource, int, any](
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource.acquired = true
return resource
}
},
func(r *mockResource) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r.released = true
return nil
}
}
},
)
// Operation returning int
opInt := withResourceInt(func(r *mockResource) ReaderIO[int] {
return func(ctx context.Context) io.IO[int] {
return func() int {
return r.id
}
}
})
resultInt := opInt(context.Background())()
assert.Equal(t, 42, resultInt)
// Reset resource state
resource.acquired = false
resource.released = false
// Create new WithResource for string type
withResourceString := WithResource[*mockResource, string, any](
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource.acquired = true
return resource
}
},
func(r *mockResource) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
r.released = true
return nil
}
}
},
)
// Operation returning string
opString := withResourceString(func(r *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
return "value"
}
}
})
resultString := opString(context.Background())()
assert.Equal(t, "value", resultString)
assert.True(t, resource.released)
}
// TestWithResource_ContextPropagation tests that context is properly propagated
func TestWithResource_ContextPropagation(t *testing.T) {
type contextKey string
const key contextKey = "test-key"
withResource := WithResource[string, string, any](
func(ctx context.Context) io.IO[string] {
return func() string {
value := ctx.Value(key)
if value != nil {
return value.(string)
}
return "no-value"
}
},
func(r string) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
return nil
}
}
},
)
operation := withResource(func(r string) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
return r + "-processed"
}
}
})
ctx := context.WithValue(context.Background(), key, "test-value")
result := operation(ctx)()
assert.Equal(t, "test-value-processed", result)
}
// TestWithResource_ErrorInRelease tests behavior when release function encounters an error
func TestWithResource_ErrorInRelease(t *testing.T) {
resource := &mockResource{id: 1}
releaseError := errors.New("release failed")
withResource := WithResource[*mockResource, string, error](
func(ctx context.Context) io.IO[*mockResource] {
return func() *mockResource {
resource.acquired = true
return resource
}
},
func(r *mockResource) ReaderIO[error] {
return func(ctx context.Context) io.IO[error] {
return func() error {
r.released = true
return releaseError
}
}
},
)
operation := withResource(func(r *mockResource) ReaderIO[string] {
return func(ctx context.Context) io.IO[string] {
return func() string {
r.used = true
return "success"
}
}
})
result := operation(context.Background())()
// Operation should succeed even if release returns error
assert.Equal(t, "success", result)
assert.True(t, resource.acquired)
assert.True(t, resource.used)
assert.True(t, resource.released)
}
// BenchmarkBracket benchmarks the Bracket function
func BenchmarkBracket(b *testing.B) {
acquire := func(ctx context.Context) io.IO[int] {
return func() int {
return 42
}
}
use := func(n int) ReaderIO[int] {
return func(ctx context.Context) io.IO[int] {
return func() int {
return n * 2
}
}
}
release := func(n int, result int) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
return nil
}
}
}
operation := Bracket(acquire, use, release)
ctx := context.Background()
b.ResetTimer()
for i := 0; i < b.N; i++ {
operation(ctx)()
}
}
// BenchmarkWithResource benchmarks the WithResource function
func BenchmarkWithResource(b *testing.B) {
withResource := WithResource[int, int, any](
func(ctx context.Context) io.IO[int] {
return func() int {
return 42
}
},
func(n int) ReaderIO[any] {
return func(ctx context.Context) io.IO[any] {
return func() any {
return nil
}
}
},
)
operation := withResource(func(n int) ReaderIO[int] {
return func(ctx context.Context) io.IO[int] {
return func() int {
return n * 2
}
}
})
ctx := context.Background()
b.ResetTimer()
for i := 0; i < b.N; i++ {
operation(ctx)()
}
}
// Made with Bob

View File

@@ -19,6 +19,9 @@ import (
"context"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/pair"
RIO "github.com/IBM/fp-go/v2/readerio"
)
// Promap is the profunctor map operation that transforms both the input and output of a context-based ReaderIO.
@@ -33,21 +36,24 @@ import (
// The function f returns both a new context and a CancelFunc that should be called to release resources.
//
// Type Parameters:
// - R: The input environment type that f transforms into context.Context
// - A: The original result type produced by the ReaderIO
// - B: The new output result type
//
// Parameters:
// - f: Function to transform the input context (contravariant)
// - f: Function to transform the input environment R into context.Context (contravariant)
// - g: Function to transform the output value from A to B (covariant)
//
// Returns:
// - An Operator that takes a ReaderIO[A] and returns a ReaderIO[B]
// - A Kleisli arrow that takes a ReaderIO[A] and returns a function from R to B
//
// Note: When R is context.Context, this simplifies to an Operator[A, B]
//
//go:inline
func Promap[A, B any](f func(context.Context) (context.Context, context.CancelFunc), g func(A) B) Operator[A, B] {
func Promap[R, A, B any](f pair.Kleisli[context.CancelFunc, R, context.Context], g func(A) B) RIO.Kleisli[R, ReaderIO[A], B] {
return function.Flow2(
Local[A](f),
Map(g),
RIO.Map[R](g),
)
}
@@ -61,14 +67,87 @@ func Promap[A, B any](f func(context.Context) (context.Context, context.CancelFu
//
// Type Parameters:
// - A: The result type (unchanged)
// - R: The input environment type that f transforms into context.Context
//
// Parameters:
// - f: Function to transform the context, returning a new context and CancelFunc
// - f: Function to transform the input environment R into context.Context, returning a new context and CancelFunc
//
// Returns:
// - An Operator that takes a ReaderIO[A] and returns a ReaderIO[A]
// - A Kleisli arrow that takes a ReaderIO[A] and returns a function from R to A
//
// Note: When R is context.Context, this simplifies to an Operator[A, A]
//
//go:inline
func Contramap[A any](f func(context.Context) (context.Context, context.CancelFunc)) Operator[A, A] {
func Contramap[A, R any](f pair.Kleisli[context.CancelFunc, R, context.Context]) RIO.Kleisli[R, ReaderIO[A], A] {
return Local[A](f)
}
// LocalIOK transforms the context using an IO effect before passing it to a ReaderIO computation.
//
// This is similar to Local, but the context transformation itself is wrapped in an IO effect,
// allowing for side-effectful context transformations. The transformation function receives
// the current context and returns an IO effect that produces a new context along with a
// cancel function. The cancel function is automatically called when the computation completes
// (via defer), ensuring proper cleanup of resources.
//
// This is useful for:
// - Context transformations that require side effects (e.g., loading configuration)
// - Lazy initialization of context values
// - Context transformations that may fail or need to perform I/O
// - Composing effectful context setup with computations
//
// Type Parameters:
// - A: The value type of the ReaderIO
//
// Parameters:
// - f: An IO Kleisli arrow that transforms the context with side effects
//
// Returns:
// - An Operator that runs the computation with the effectfully transformed context
//
// Example:
//
// import (
// "context"
// G "github.com/IBM/fp-go/v2/io"
// F "github.com/IBM/fp-go/v2/function"
// )
//
// // Context transformation with side effects (e.g., loading config)
// loadConfig := func(ctx context.Context) G.IO[ContextCancel] {
// return func() ContextCancel {
// // Simulate loading configuration
// config := loadConfigFromFile()
// newCtx := context.WithValue(ctx, "config", config)
// return pair.MakePair[context.CancelFunc](func() {}, newCtx)
// }
// }
//
// getValue := readerio.FromReader(func(ctx context.Context) string {
// if cfg := ctx.Value("config"); cfg != nil {
// return cfg.(string)
// }
// return "default"
// })
//
// result := F.Pipe1(
// getValue,
// readerio.LocalIOK[string](loadConfig),
// )
// value := result(t.Context())() // Loads config and uses it
//
// Comparison with Local:
// - Local: Takes a pure function that transforms the context
// - LocalIOK: Takes an IO effect that transforms the context, allowing side effects
func LocalIOK[A any](f io.Kleisli[context.Context, ContextCancel]) Operator[A, A] {
return func(r ReaderIO[A]) ReaderIO[A] {
return func(ctx context.Context) IO[A] {
p := f(ctx)
return func() A {
otherCancel, otherCtx := pair.Unpack(p())
defer otherCancel()
return r(otherCtx)()
}
}
}
}

View File

@@ -21,6 +21,7 @@ import (
"testing"
"time"
"github.com/IBM/fp-go/v2/pair"
"github.com/stretchr/testify/assert"
)
@@ -38,9 +39,9 @@ func TestPromapBasic(t *testing.T) {
}
// Transform context and result
addKey := func(ctx context.Context) (context.Context, context.CancelFunc) {
addKey := func(ctx context.Context) ContextCancel {
newCtx := context.WithValue(ctx, "key", 42)
return newCtx, func() {}
return pair.MakePair[context.CancelFunc](func() {}, newCtx)
}
toString := strconv.Itoa
@@ -63,9 +64,9 @@ func TestContramapBasic(t *testing.T) {
}
}
addKey := func(ctx context.Context) (context.Context, context.CancelFunc) {
addKey := func(ctx context.Context) ContextCancel {
newCtx := context.WithValue(ctx, "key", 100)
return newCtx, func() {}
return pair.MakePair[context.CancelFunc](func() {}, newCtx)
}
adapted := Contramap[int](addKey)(getValue)
@@ -85,8 +86,9 @@ func TestLocalBasic(t *testing.T) {
}
}
addTimeout := func(ctx context.Context) (context.Context, context.CancelFunc) {
return context.WithTimeout(ctx, time.Second)
addTimeout := func(ctx context.Context) ContextCancel {
newCtx, cancelFct := context.WithTimeout(ctx, time.Second)
return pair.MakePair(cancelFct, newCtx)
}
adapted := Local[bool](addTimeout)(getValue)
@@ -95,3 +97,81 @@ func TestLocalBasic(t *testing.T) {
assert.True(t, result)
})
}
// TestLocalIOKBasic tests basic LocalIOK functionality
func TestLocalIOKBasic(t *testing.T) {
t.Run("context transformation with IO effect", func(t *testing.T) {
getValue := func(ctx context.Context) IO[string] {
return func() string {
if v := ctx.Value("key"); v != nil {
return v.(string)
}
return "default"
}
}
// Context transformation wrapped in IO effect
addKeyIO := func(ctx context.Context) IO[ContextCancel] {
return func() ContextCancel {
// Simulate side effect (e.g., loading config)
newCtx := context.WithValue(ctx, "key", "loaded-value")
return pair.MakePair[context.CancelFunc](func() {}, newCtx)
}
}
adapted := LocalIOK[string](addKeyIO)(getValue)
result := adapted(t.Context())()
assert.Equal(t, "loaded-value", result)
})
t.Run("cleanup function is called", func(t *testing.T) {
cleanupCalled := false
getValue := func(ctx context.Context) IO[int] {
return func() int {
if v := ctx.Value("value"); v != nil {
return v.(int)
}
return 0
}
}
addValueIO := func(ctx context.Context) IO[ContextCancel] {
return func() ContextCancel {
newCtx := context.WithValue(ctx, "value", 42)
cleanup := context.CancelFunc(func() {
cleanupCalled = true
})
return pair.MakePair(cleanup, newCtx)
}
}
adapted := LocalIOK[int](addValueIO)(getValue)
result := adapted(t.Context())()
assert.Equal(t, 42, result)
assert.True(t, cleanupCalled, "cleanup function should be called")
})
t.Run("works with timeout context", func(t *testing.T) {
getValue := func(ctx context.Context) IO[bool] {
return func() bool {
_, hasDeadline := ctx.Deadline()
return hasDeadline
}
}
addTimeoutIO := func(ctx context.Context) IO[ContextCancel] {
return func() ContextCancel {
newCtx, cancelFct := context.WithTimeout(ctx, time.Second)
return pair.MakePair(cancelFct, newCtx)
}
}
adapted := LocalIOK[bool](addTimeoutIO)(getValue)
result := adapted(t.Context())()
assert.True(t, result, "context should have deadline")
})
}

View File

@@ -20,6 +20,7 @@ import (
"time"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/reader"
RIO "github.com/IBM/fp-go/v2/readerio"
)
@@ -633,12 +634,15 @@ func ReadIO[A any](r IO[context.Context]) func(ReaderIO[A]) IO[A] {
//
// Type Parameters:
// - A: The value type of the ReaderIO
// - R: The input environment type that f transforms into context.Context
//
// Parameters:
// - f: A function that transforms the context and returns a cancel function
// - f: A function that transforms the input environment R into context.Context and returns a cancel function
//
// Returns:
// - An Operator that runs the computation with the transformed context
// - A Kleisli arrow that runs the computation with the transformed context
//
// Note: When R is context.Context, this simplifies to an Operator[A, A]
//
// Example:
//
@@ -677,11 +681,11 @@ func ReadIO[A any](r IO[context.Context]) func(ReaderIO[A]) IO[A] {
// fetchData,
// withTimeout,
// )
func Local[A any](f func(context.Context) (context.Context, context.CancelFunc)) Operator[A, A] {
return func(rr ReaderIO[A]) ReaderIO[A] {
return func(ctx context.Context) IO[A] {
func Local[A, R any](f pair.Kleisli[context.CancelFunc, R, context.Context]) RIO.Kleisli[R, ReaderIO[A], A] {
return func(rr ReaderIO[A]) RIO.ReaderIO[R, A] {
return func(r R) IO[A] {
return func() A {
otherCtx, otherCancel := f(ctx)
otherCancel, otherCtx := pair.Unpack(f(r))
defer otherCancel()
return rr(otherCtx)()
}
@@ -742,8 +746,9 @@ func Local[A any](f func(context.Context) (context.Context, context.CancelFunc))
// )
// data := result(t.Context())() // Returns Data{Value: "quick"}
func WithTimeout[A any](timeout time.Duration) Operator[A, A] {
return Local[A](func(ctx context.Context) (context.Context, context.CancelFunc) {
return context.WithTimeout(ctx, timeout)
return Local[A](func(ctx context.Context) ContextCancel {
newCtx, cancelFct := context.WithTimeout(ctx, timeout)
return pair.MakePair(cancelFct, newCtx)
})
}
@@ -806,8 +811,9 @@ func WithTimeout[A any](timeout time.Duration) Operator[A, A] {
// )
// data := result(parentCtx)() // Will use parent's 1-hour deadline
func WithDeadline[A any](deadline time.Time) Operator[A, A] {
return Local[A](func(ctx context.Context) (context.Context, context.CancelFunc) {
return context.WithDeadline(ctx, deadline)
return Local[A](func(ctx context.Context) ContextCancel {
newCtx, cancelFct := context.WithDeadline(ctx, deadline)
return pair.MakePair(cancelFct, newCtx)
})
}

View File

@@ -23,6 +23,7 @@ import (
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/lazy"
"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/readerio"
@@ -81,4 +82,15 @@ type (
Predicate[A any] = predicate.Predicate[A]
Void = function.Void
// Pair represents a tuple of two values of types A and B.
// It is used to group two related values together.
Pair[A, B any] = pair.Pair[A, B]
// ContextCancel represents a pair of a cancel function and a context.
// It is used in operations that create new contexts with cancellation capabilities.
//
// The first element is the CancelFunc that should be called to release resources.
// The second element is the new Context that was created.
ContextCancel = Pair[context.CancelFunc, context.Context]
)

View File

@@ -28,6 +28,7 @@ import (
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/logging"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/result"
)
@@ -90,132 +91,7 @@ func withLoggingContext(lctx loggingContext) Endomorphism[context.Context] {
return F.Bind2nd(withLoggingContextValue, any(lctx))
}
// LogEntryExitF creates a customizable operator that wraps a ReaderIOResult computation with entry/exit callbacks.
//
// This is a more flexible version of LogEntryExit that allows you to provide custom callbacks for
// entry and exit events. The onEntry callback receives the current context and can return a modified
// context (e.g., with additional logging information). The onExit callback receives the computation
// result and can perform custom logging, metrics collection, or cleanup.
//
// The function uses the bracket pattern to ensure that:
// - The onEntry callback is executed before the computation starts
// - The computation runs with the context returned by onEntry
// - The onExit callback is executed after the computation completes (success or failure)
// - The original result is preserved and returned unchanged
// - Cleanup happens even if the computation fails
//
// Type Parameters:
// - A: The success type of the ReaderIOResult
// - ANY: The return type of the onExit callback (typically any)
//
// Parameters:
// - onEntry: A ReaderIO that receives the current context and returns a (possibly modified) context.
// This is executed before the computation starts. Use this for logging entry, adding context values,
// starting timers, or initialization logic.
// - onExit: A Kleisli function that receives the Result[A] and returns a ReaderIO[ANY].
// This is executed after the computation completes, regardless of success or failure.
// Use this for logging exit, recording metrics, cleanup, or finalization logic.
//
// Returns:
// - An Operator that wraps the ReaderIOResult computation with the custom entry/exit callbacks
//
// Example with custom context modification:
//
// type RequestID string
//
// logOp := LogEntryExitF[User, any](
// func(ctx context.Context) IO[context.Context] {
// return func() context.Context {
// reqID := RequestID(uuid.New().String())
// log.Printf("[%s] Starting operation", reqID)
// return context.WithValue(ctx, "requestID", reqID)
// }
// },
// func(res Result[User]) ReaderIO[any] {
// return func(ctx context.Context) IO[any] {
// return func() any {
// reqID := ctx.Value("requestID").(RequestID)
// return F.Pipe1(
// res,
// result.Fold(
// func(err error) any {
// log.Printf("[%s] Operation failed: %v", reqID, err)
// return nil
// },
// func(_ User) any {
// log.Printf("[%s] Operation succeeded", reqID)
// return nil
// },
// ),
// )
// }
// }
// },
// )
//
// wrapped := logOp(fetchUser(123))
//
// Example with metrics collection:
//
// import "github.com/prometheus/client_golang/prometheus"
//
// metricsOp := LogEntryExitF[Response, any](
// func(ctx context.Context) IO[context.Context] {
// return func() context.Context {
// requestCount.WithLabelValues("api_call", "started").Inc()
// return context.WithValue(ctx, "startTime", time.Now())
// }
// },
// func(res Result[Response]) ReaderIO[any] {
// return func(ctx context.Context) IO[any] {
// return func() any {
// startTime := ctx.Value("startTime").(time.Time)
// duration := time.Since(startTime).Seconds()
//
// return F.Pipe1(
// res,
// result.Fold(
// func(err error) any {
// requestCount.WithLabelValues("api_call", "error").Inc()
// requestDuration.WithLabelValues("api_call", "error").Observe(duration)
// return nil
// },
// func(_ Response) any {
// requestCount.WithLabelValues("api_call", "success").Inc()
// requestDuration.WithLabelValues("api_call", "success").Observe(duration)
// return nil
// },
// ),
// )
// }
// }
// },
// )
//
// Use Cases:
// - Custom context modification: Adding request IDs, trace IDs, or other context values
// - Structured logging: Integration with zap, logrus, or other structured loggers
// - Metrics collection: Recording operation durations, success/failure rates
// - Distributed tracing: OpenTelemetry, Jaeger integration
// - Custom monitoring: Application-specific monitoring and alerting
//
// Note: LogEntryExit is implemented using LogEntryExitF with standard logging and context management.
// Use LogEntryExitF when you need more control over the entry/exit behavior or context modification.
func LogEntryExitF[A, ANY any](
onEntry ReaderIO[context.Context],
onExit readerio.Kleisli[Result[A], ANY],
) Operator[A, A] {
bracket := F.Bind13of3(readerio.Bracket[context.Context, Result[A], ANY])(onEntry, func(newCtx context.Context, res Result[A]) ReaderIO[ANY] {
return readerio.FromIO(onExit(res)(newCtx)) // Get the exit callback for this result
})
return func(src ReaderIOResult[A]) ReaderIOResult[A] {
return bracket(F.Flow2(
src,
FromIOResult,
))
}
}
func noop() {}
// onEntry creates a ReaderIO that handles the entry logging for an operation.
// It generates a unique logging ID, captures the start time, and logs the entry message.
@@ -230,15 +106,15 @@ func LogEntryExitF[A, ANY any](
// - A ReaderIO that prepares the context with logging information and logs the entry
func onEntry(
logLevel slog.Level,
cb func(context.Context) *slog.Logger,
cb Reader[context.Context, *slog.Logger],
nameAttr slog.Attr,
) ReaderIO[context.Context] {
) ReaderIO[ContextCancel] {
return func(ctx context.Context) IO[context.Context] {
return func(ctx context.Context) IO[ContextCancel] {
// logger
logger := cb(ctx)
return func() context.Context {
return func() ContextCancel {
// check if the logger is enabled
if logger.Enabled(ctx, logLevel) {
// Generate unique logging ID and capture start time
@@ -258,19 +134,23 @@ func onEntry(
})
withLogger := logging.WithLogger(newLogger)
return withCtx(withLogger(ctx))
return F.Pipe2(
ctx,
withLogger,
pair.Map[context.CancelFunc](withCtx),
)
}
// logging disabled
withCtx := withLoggingContext(loggingContext{
logger: logger,
isEnabled: false,
})
return withCtx(ctx)
return pair.MakePair[context.CancelFunc](noop, withCtx(ctx))
}
}
}
// onExitAny creates a Kleisli function that handles exit logging for an operation.
// onExitVoid creates a Kleisli function that handles exit logging for an operation.
// It logs either success or error based on the Result, including the operation duration.
// Only logs if logging was enabled during entry (checked via loggingContext.isEnabled).
//
@@ -280,33 +160,33 @@ func onEntry(
//
// Returns:
// - A Kleisli function that logs the exit/error and returns nil
func onExitAny(
func onExitVoid(
logLevel slog.Level,
nameAttr slog.Attr,
) readerio.Kleisli[Result[any], any] {
return func(res Result[any]) ReaderIO[any] {
return func(ctx context.Context) IO[any] {
) readerio.Kleisli[Result[Void], Void] {
return func(res Result[Void]) ReaderIO[Void] {
return func(ctx context.Context) IO[Void] {
value := getLoggingContext(ctx)
if value.isEnabled {
return func() any {
return func() Void {
// Retrieve logging information from context
durationAttr := slog.Duration("duration", time.Since(value.startTime))
// Log error with ID and duration
onError := func(err error) any {
onError := func(err error) Void {
value.logger.LogAttrs(ctx, logLevel, "[throwing]",
nameAttr,
durationAttr,
slog.Any("error", err))
return nil
return F.VOID
}
// Log success with ID and duration
onSuccess := func(_ any) any {
onSuccess := func(v Void) Void {
value.logger.LogAttrs(ctx, logLevel, "[exiting ]", nameAttr, durationAttr)
return nil
return v
}
return F.Pipe1(
@@ -316,7 +196,7 @@ func onExitAny(
}
}
// nothing to do
return io.Of[any](nil)
return io.Of(F.VOID)
}
}
}
@@ -369,18 +249,26 @@ func onExitAny(
// )
func LogEntryExitWithCallback[A any](
logLevel slog.Level,
cb func(context.Context) *slog.Logger,
cb Reader[context.Context, *slog.Logger],
name string) Operator[A, A] {
nameAttr := slog.String("name", name)
return LogEntryExitF(
entry := F.Pipe1(
onEntry(logLevel, cb, nameAttr),
F.Flow2(
result.MapTo[A, any](nil),
onExitAny(logLevel, nameAttr),
),
readerio.LocalIOK[Result[A]],
)
exit := readerio.Tap(F.Flow2(
result.MapTo[A](F.VOID),
onExitVoid(logLevel, nameAttr),
))
return F.Flow2(
exit,
entry,
)
}
// LogEntryExit creates an operator that logs the entry and exit of a ReaderIOResult computation with timing and correlation IDs.
@@ -499,12 +387,12 @@ func LogEntryExit[A any](name string) Operator[A, A] {
func curriedLog(
logLevel slog.Level,
cb func(context.Context) *slog.Logger,
message string) func(slog.Attr) func(context.Context) func() struct{} {
return F.Curry2(func(a slog.Attr, ctx context.Context) func() struct{} {
message string) func(slog.Attr) ReaderIO[Void] {
return F.Curry2(func(a slog.Attr, ctx context.Context) IO[Void] {
logger := cb(ctx)
return func() struct{} {
return func() Void {
logger.LogAttrs(ctx, logLevel, message, a)
return struct{}{}
return F.VOID
}
})
}
@@ -571,7 +459,7 @@ func curriedLog(
// - Conditional logging: Enable/disable logging based on logger configuration
func SLogWithCallback[A any](
logLevel slog.Level,
cb func(context.Context) *slog.Logger,
cb Reader[context.Context, *slog.Logger],
message string) Kleisli[Result[A], A] {
return F.Pipe1(
@@ -582,18 +470,23 @@ func SLogWithCallback[A any](
curriedLog(logLevel, cb, message),
),
// preserve the original context
reader.Chain(reader.Sequence(readerio.MapTo[struct{}, Result[A]])),
reader.Chain(reader.Sequence(readerio.MapTo[Void, Result[A]])),
)
}
// SLog creates a Kleisli arrow that logs a Result value (success or error) with a message.
//
// This function logs both successful values and errors at Info level using the logger from the context.
// This function logs both successful values and errors at Info level. It retrieves the logger
// using logging.GetLoggerFromContext, which returns either:
// - The logger stored in the context via logging.WithLogger, or
// - The global logger (set via logging.SetLogger or slog.Default())
//
// It's a convenience wrapper around SLogWithCallback with standard settings.
//
// The logged output includes:
// - For success: The message with the value as a structured "value" attribute
// - For error: The message with the error as a structured "error" attribute
// The message parameter becomes the main log message text, and the Result value or error
// is attached as a structured logging attribute:
// - For success: Logs message with attribute value=<the actual value>
// - For error: Logs message with attribute error=<the error>
//
// The Result is passed through unchanged after logging, making this function transparent in the
// computation pipeline.
@@ -647,25 +540,47 @@ func SLog[A any](message string) Kleisli[Result[A], A] {
return SLogWithCallback[A](slog.LevelInfo, logging.GetLoggerFromContext, message)
}
// TapSLog creates an operator that logs only successful values with a message and passes them through unchanged.
// TapSLog creates an operator that logs both successful values and errors with a message,
// and passes the ReaderIOResult through unchanged.
//
// This function is useful for debugging and monitoring values as they flow through a ReaderIOResult
// computation chain. Unlike SLog which logs both successes and errors, TapSLog only logs when the
// computation is successful. If the computation contains an error, no logging occurs and the error
// is propagated unchanged.
// computation chain. It logs both successful values and errors at Info level. It retrieves the logger
// using logging.GetLoggerFromContext, which returns either:
// - The logger stored in the context via logging.WithLogger, or
// - The global logger (set via logging.SetLogger or slog.Default())
//
// The logged output includes:
// - The provided message
// - The value being passed through (as a structured "value" attribute)
// The ReaderIOResult is returned unchanged after logging.
//
// The difference between TapSLog and SLog is their position in the pipeline:
// - SLog is a Kleisli[Result[A], A] used with Chain to intercept the raw Result
// - TapSLog is an Operator[A, A] used directly in a pipe on a ReaderIOResult[A]
//
// Both log the same information (success value or error), but TapSLog is more ergonomic
// when composing ReaderIOResult pipelines with F.Pipe.
//
// The message parameter becomes the main log message text, and the Result value or error
// is attached as a structured logging attribute:
// - For success: Logs message with attribute value=<the actual value>
// - For error: Logs message with attribute error=<the error>
//
// For example, TapSLog[User]("Fetched user") with a successful result produces:
//
// Log message: "Fetched user"
// Structured attribute: value={ID:123 Name:"Alice"}
//
// With an error result, it produces:
//
// Log message: "Fetched user"
// Structured attribute: error="user not found"
//
// Type Parameters:
// - A: The type of the value to log and pass through
// - A: The success type of the ReaderIOResult to log and pass through
//
// Parameters:
// - message: A descriptive message to include in the log entry
//
// Returns:
// - An Operator that logs successful values and returns them unchanged
// - An Operator that logs the Result (value or error) and returns the ReaderIOResult unchanged
//
// Example with simple value logging:
//
@@ -680,7 +595,7 @@ func SLog[A any](message string) Kleisli[Result[A], A] {
// )
//
// result := pipeline(t.Context())()
// // Logs: "Fetched user" value={ID:123 Name:"Alice"}
// // If successful, logs: "Fetched user" value={ID:123 Name:"Alice"}
// // Returns: result.Of("Alice")
//
// Example in a processing pipeline:
@@ -695,36 +610,36 @@ func SLog[A any](message string) Kleisli[Result[A], A] {
// )
//
// result := processOrder(t.Context())()
// // Logs each successful step with the intermediate values
// // If any step fails, subsequent TapSLog calls don't log
// // Logs each step with its value or error
//
// Example with error handling:
//
// pipeline := F.Pipe3(
// fetchData(id),
// TapSLog[Data]("Data fetched"),
// Chain(func(d Data) ReaderIOResult[Result] {
// Chain(func(d Data) ReaderIOResult[Data] {
// if d.IsValid() {
// return Of(processData(d))
// }
// return Left[Result](errors.New("invalid data"))
// return Left[Data](errors.New("invalid data"))
// }),
// TapSLog[Result]("Data processed"),
// TapSLog[Data]("Data processed"),
// )
//
// // If fetchData succeeds: logs "Data fetched" with the data
// // If processing succeeds: logs "Data processed" with the result
// // If processing fails: "Data processed" is NOT logged (error propagates)
// // If fetchData succeeds: logs "Data fetched" value={...}
// // If fetchData fails: logs "Data fetched" error="..."
// // If processing succeeds: logs "Data processed" value={...}
// // If processing fails: logs "Data processed" error="invalid data"
//
// Use Cases:
// - Debugging: Inspect intermediate successful values in a computation pipeline
// - Monitoring: Track successful data flow through complex operations
// - Troubleshooting: Identify where successful computations stop (last logged value before error)
// - Auditing: Log important successful values for compliance or security
// - Development: Understand data transformations during development
// - Debugging: Inspect intermediate values and errors in a computation pipeline
// - Monitoring: Track both successful and failed data flow through complex operations
// - Troubleshooting: Identify where errors are introduced or propagated
// - Auditing: Log important values and failures for compliance or security
// - Development: Understand data transformations and error paths during development
//
// Note: This function only logs successful values. Errors are silently propagated without logging.
// For logging both successes and errors, use SLog instead.
// Note: This function logs both successful values and errors. It is equivalent to SLog
// but expressed as an Operator for direct use in F.Pipe pipelines on ReaderIOResult values.
//
//go:inline
func TapSLog[A any](message string) Operator[A, A] {

View File

@@ -0,0 +1,417 @@
// 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 (
"bytes"
"errors"
"log/slog"
"strings"
"testing"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/logging"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
)
// TestTapSLogComprehensive_Success verifies TapSLog logs successful values
func TestTapSLogComprehensive_Success(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
t.Run("logs integer success value", func(t *testing.T) {
buf.Reset()
pipeline := F.Pipe2(
Of(42),
TapSLog[int]("Integer value"),
Map(N.Mul(2)),
)
res := pipeline(t.Context())()
// Verify result is correct
assert.Equal(t, 84, F.Pipe1(res, getOrZero))
// Verify logging occurred
logOutput := buf.String()
assert.Contains(t, logOutput, "Integer value", "Should log the message")
assert.Contains(t, logOutput, "value=42", "Should log the success value")
assert.NotContains(t, logOutput, "error", "Should not contain error keyword for success")
})
t.Run("logs string success value", func(t *testing.T) {
buf.Reset()
pipeline := F.Pipe1(
Of("hello world"),
TapSLog[string]("String value"),
)
res := pipeline(t.Context())()
// Verify result is correct
assert.True(t, F.Pipe1(res, isRight[string]))
// Verify logging occurred
logOutput := buf.String()
assert.Contains(t, logOutput, "String value")
assert.Contains(t, logOutput, `value="hello world"`)
})
t.Run("logs struct success value", func(t *testing.T) {
buf.Reset()
type User struct {
ID int
Name string
}
user := User{ID: 123, Name: "Alice"}
pipeline := F.Pipe1(
Of(user),
TapSLog[User]("User struct"),
)
res := pipeline(t.Context())()
// Verify result is correct
assert.True(t, F.Pipe1(res, isRight[User]))
// Verify logging occurred with struct fields
logOutput := buf.String()
assert.Contains(t, logOutput, "User struct")
assert.Contains(t, logOutput, "ID:123")
assert.Contains(t, logOutput, "Name:Alice")
})
t.Run("logs multiple success values in pipeline", func(t *testing.T) {
buf.Reset()
step1 := F.Pipe2(
Of(10),
TapSLog[int]("Initial value"),
Map(N.Mul(2)),
)
pipeline := F.Pipe2(
step1,
TapSLog[int]("After doubling"),
Map(N.Add(5)),
)
res := pipeline(t.Context())()
// Verify result is correct
assert.Equal(t, 25, getOrZero(res))
// Verify both log entries
logOutput := buf.String()
assert.Contains(t, logOutput, "Initial value")
assert.Contains(t, logOutput, "value=10")
assert.Contains(t, logOutput, "After doubling")
assert.Contains(t, logOutput, "value=20")
})
}
// TestTapSLogComprehensive_Error verifies TapSLog behavior with errors
func TestTapSLogComprehensive_Error(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
t.Run("logs error values", func(t *testing.T) {
buf.Reset()
testErr := errors.New("test error")
pipeline := F.Pipe2(
Left[int](testErr),
TapSLog[int]("Error case"),
Map(N.Mul(2)),
)
res := pipeline(t.Context())()
// Verify error is preserved
assert.True(t, F.Pipe1(res, isLeft[int]))
// Verify logging occurred for error
logOutput := buf.String()
assert.Contains(t, logOutput, "Error case", "Should log the message")
assert.Contains(t, logOutput, "error", "Should contain error keyword")
assert.Contains(t, logOutput, "test error", "Should log the error message")
assert.NotContains(t, logOutput, "value=", "Should not log 'value=' for errors")
})
t.Run("preserves error through pipeline", func(t *testing.T) {
buf.Reset()
originalErr := errors.New("original error")
step1 := F.Pipe2(
Left[int](originalErr),
TapSLog[int]("First tap"),
Map(N.Mul(2)),
)
pipeline := F.Pipe2(
step1,
TapSLog[int]("Second tap"),
Map(N.Add(5)),
)
res := pipeline(t.Context())()
// Verify error is preserved
assert.True(t, isLeft(res))
// Verify both taps logged the error
logOutput := buf.String()
errorCount := strings.Count(logOutput, "original error")
assert.Equal(t, 2, errorCount, "Both TapSLog calls should log the error")
assert.Contains(t, logOutput, "First tap")
assert.Contains(t, logOutput, "Second tap")
})
t.Run("logs error after successful operation", func(t *testing.T) {
buf.Reset()
pipeline := F.Pipe3(
Of(10),
TapSLog[int]("Before error"),
Chain(func(n int) ReaderIOResult[int] {
return Left[int](errors.New("chain error"))
}),
TapSLog[int]("After error"),
)
res := pipeline(t.Context())()
// Verify error is present
assert.True(t, F.Pipe1(res, isLeft[int]))
// Verify both logs
logOutput := buf.String()
assert.Contains(t, logOutput, "Before error")
assert.Contains(t, logOutput, "value=10")
assert.Contains(t, logOutput, "After error")
assert.Contains(t, logOutput, "chain error")
})
}
// TestTapSLogComprehensive_EdgeCases verifies TapSLog with edge cases
func TestTapSLogComprehensive_EdgeCases(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
t.Run("logs zero value", func(t *testing.T) {
buf.Reset()
pipeline := F.Pipe1(
Of(0),
TapSLog[int]("Zero value"),
)
res := pipeline(t.Context())()
assert.Equal(t, 0, F.Pipe1(res, getOrZero))
logOutput := buf.String()
assert.Contains(t, logOutput, "Zero value")
assert.Contains(t, logOutput, "value=0")
})
t.Run("logs empty string", func(t *testing.T) {
buf.Reset()
pipeline := F.Pipe1(
Of(""),
TapSLog[string]("Empty string"),
)
res := pipeline(t.Context())()
assert.True(t, F.Pipe1(res, isRight[string]))
logOutput := buf.String()
assert.Contains(t, logOutput, "Empty string")
assert.Contains(t, logOutput, `value=""`)
})
t.Run("logs nil pointer", func(t *testing.T) {
buf.Reset()
type Data struct {
Value string
}
var nilData *Data
pipeline := F.Pipe1(
Of(nilData),
TapSLog[*Data]("Nil pointer"),
)
res := pipeline(t.Context())()
assert.True(t, F.Pipe1(res, isRight[*Data]))
logOutput := buf.String()
assert.Contains(t, logOutput, "Nil pointer")
// Nil representation may vary, but should be logged
assert.NotEmpty(t, logOutput)
})
t.Run("respects logger level - disabled", func(t *testing.T) {
buf.Reset()
// Create logger that only logs errors
errorLogger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelError,
}))
oldLogger := logging.SetLogger(errorLogger)
defer logging.SetLogger(oldLogger)
pipeline := F.Pipe1(
Of(42),
TapSLog[int]("Should not log"),
)
res := pipeline(t.Context())()
assert.Equal(t, 42, F.Pipe1(res, getOrZero))
// Should have no logs since level is ERROR
logOutput := buf.String()
assert.Empty(t, logOutput, "Should not log when level is disabled")
})
}
// TestTapSLogComprehensive_Integration verifies TapSLog in realistic scenarios
func TestTapSLogComprehensive_Integration(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
t.Run("complex pipeline with mixed success and error", func(t *testing.T) {
buf.Reset()
// Simulate a data processing pipeline
validatePositive := func(n int) ReaderIOResult[int] {
if n > 0 {
return Of(n)
}
return Left[int](errors.New("number must be positive"))
}
step1 := F.Pipe3(
Of(5),
TapSLog[int]("Input received"),
Map(N.Mul(2)),
TapSLog[int]("After multiplication"),
)
pipeline := F.Pipe2(
step1,
Chain(validatePositive),
TapSLog[int]("After validation"),
)
res := pipeline(t.Context())()
assert.Equal(t, 10, getOrZero(res))
logOutput := buf.String()
assert.Contains(t, logOutput, "Input received")
assert.Contains(t, logOutput, "value=5")
assert.Contains(t, logOutput, "After multiplication")
assert.Contains(t, logOutput, "value=10")
assert.Contains(t, logOutput, "After validation")
assert.Contains(t, logOutput, "value=10")
})
t.Run("error propagation with logging", func(t *testing.T) {
buf.Reset()
validatePositive := func(n int) ReaderIOResult[int] {
if n > 0 {
return Of(n)
}
return Left[int](errors.New("number must be positive"))
}
step1 := F.Pipe3(
Of(-5),
TapSLog[int]("Input received"),
Map(N.Mul(2)),
TapSLog[int]("After multiplication"),
)
pipeline := F.Pipe2(
step1,
Chain(validatePositive),
TapSLog[int]("After validation"),
)
res := pipeline(t.Context())()
assert.True(t, isLeft(res))
logOutput := buf.String()
// First two taps should log success
assert.Contains(t, logOutput, "Input received")
assert.Contains(t, logOutput, "value=-5")
assert.Contains(t, logOutput, "After multiplication")
assert.Contains(t, logOutput, "value=-10")
// Last tap should log error
assert.Contains(t, logOutput, "After validation")
assert.Contains(t, logOutput, "number must be positive")
})
}
// Helper functions for tests
func getOrZero(res Result[int]) int {
val, err := result.Unwrap(res)
if err == nil {
return val
}
return 0
}
func isRight[A any](res Result[A]) bool {
return result.IsRight(res)
}
func isLeft[A any](res Result[A]) bool {
return result.IsLeft(res)
}
// Made with Bob

View File

@@ -13,6 +13,7 @@ import (
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/logging"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/result"
S "github.com/IBM/fp-go/v2/string"
"github.com/stretchr/testify/assert"
@@ -53,6 +54,11 @@ func TestLogEntryExitSuccess(t *testing.T) {
assert.Contains(t, logOutput, "TestOperation")
assert.Contains(t, logOutput, "ID=")
assert.Contains(t, logOutput, "duration=")
// Verify entry log appears before exit log
enteringIdx := strings.Index(logOutput, "[entering]")
exitingIdx := strings.Index(logOutput, "[exiting ]")
assert.Greater(t, exitingIdx, enteringIdx, "Exit log should appear after entry log")
}
// TestLogEntryExitError tests error operation logging
@@ -81,6 +87,11 @@ func TestLogEntryExitError(t *testing.T) {
assert.Contains(t, logOutput, "test error")
assert.Contains(t, logOutput, "ID=")
assert.Contains(t, logOutput, "duration=")
// Verify entry log appears before error log
enteringIdx := strings.Index(logOutput, "[entering]")
throwingIdx := strings.Index(logOutput, "[throwing]")
assert.Greater(t, throwingIdx, enteringIdx, "Error log should appear after entry log")
}
// TestLogEntryExitNested tests nested operations with different IDs
@@ -119,6 +130,48 @@ func TestLogEntryExitNested(t *testing.T) {
exitCount := strings.Count(logOutput, "[exiting ]")
assert.Equal(t, 2, enterCount, "Should have 2 entering logs")
assert.Equal(t, 2, exitCount, "Should have 2 exiting logs")
// Verify log ordering: Each operation logs entry before exit
// Note: Due to Chain semantics, OuterOp completes before InnerOp starts
lines := strings.Split(logOutput, "\n")
var logSequence []string
for _, line := range lines {
if strings.Contains(line, "OuterOp") && strings.Contains(line, "[entering]") {
logSequence = append(logSequence, "OuterOp-entering")
} else if strings.Contains(line, "OuterOp") && strings.Contains(line, "[exiting ]") {
logSequence = append(logSequence, "OuterOp-exiting")
} else if strings.Contains(line, "InnerOp") && strings.Contains(line, "[entering]") {
logSequence = append(logSequence, "InnerOp-entering")
} else if strings.Contains(line, "InnerOp") && strings.Contains(line, "[exiting ]") {
logSequence = append(logSequence, "InnerOp-exiting")
}
}
// Verify each operation's entry comes before its exit
assert.Equal(t, 4, len(logSequence), "Should have 4 log entries")
// Find indices
outerEnterIdx := -1
outerExitIdx := -1
innerEnterIdx := -1
innerExitIdx := -1
for i, log := range logSequence {
switch log {
case "OuterOp-entering":
outerEnterIdx = i
case "OuterOp-exiting":
outerExitIdx = i
case "InnerOp-entering":
innerEnterIdx = i
case "InnerOp-exiting":
innerExitIdx = i
}
}
// Verify entry before exit for each operation
assert.Greater(t, outerExitIdx, outerEnterIdx, "OuterOp exit should come after OuterOp entry")
assert.Greater(t, innerExitIdx, innerEnterIdx, "InnerOp exit should come after InnerOp entry")
}
// TestLogEntryExitWithCallback tests custom log level and callback
@@ -172,76 +225,6 @@ func TestLogEntryExitDisabled(t *testing.T) {
assert.Empty(t, logOutput, "Should have no logs when logging is disabled")
}
// TestLogEntryExitF tests custom entry/exit callbacks
func TestLogEntryExitF(t *testing.T) {
var entryCount, exitCount int
onEntry := func(ctx context.Context) IO[context.Context] {
return func() context.Context {
entryCount++
return ctx
}
}
onExit := func(res Result[string]) ReaderIO[any] {
return func(ctx context.Context) IO[any] {
return func() any {
exitCount++
return nil
}
}
}
operation := F.Pipe1(
Of("test"),
LogEntryExitF(onEntry, onExit),
)
res := operation(t.Context())()
assert.True(t, result.IsRight(res))
assert.Equal(t, 1, entryCount, "Entry callback should be called once")
assert.Equal(t, 1, exitCount, "Exit callback should be called once")
}
// TestLogEntryExitFWithError tests custom callbacks with error
func TestLogEntryExitFWithError(t *testing.T) {
var entryCount, exitCount int
var capturedError error
onEntry := func(ctx context.Context) IO[context.Context] {
return func() context.Context {
entryCount++
return ctx
}
}
onExit := func(res Result[string]) ReaderIO[any] {
return func(ctx context.Context) IO[any] {
return func() any {
exitCount++
if result.IsLeft(res) {
_, capturedError = result.Unwrap(res)
}
return nil
}
}
}
testErr := errors.New("custom error")
operation := F.Pipe1(
Left[string](testErr),
LogEntryExitF(onEntry, onExit),
)
res := operation(t.Context())()
assert.True(t, result.IsLeft(res))
assert.Equal(t, 1, entryCount, "Entry callback should be called once")
assert.Equal(t, 1, exitCount, "Exit callback should be called once")
assert.Equal(t, testErr, capturedError, "Should capture the error")
}
// TestLoggingIDUniqueness tests that logging IDs are unique
func TestLoggingIDUniqueness(t *testing.T) {
var buf bytes.Buffer
@@ -287,7 +270,8 @@ func TestLogEntryExitWithContextLogger(t *testing.T) {
Level: slog.LevelInfo,
}))
ctx := logging.WithLogger(contextLogger)(t.Context())
cancelFct, ctx := pair.Unpack(logging.WithLogger(contextLogger)(t.Context()))
defer cancelFct()
operation := F.Pipe1(
Of("context value"),
@@ -546,7 +530,8 @@ func TestTapSLogWithContextLogger(t *testing.T) {
Level: slog.LevelInfo,
}))
ctx := logging.WithLogger(contextLogger)(t.Context())
cancelFct, ctx := pair.Unpack(logging.WithLogger(contextLogger)(t.Context()))
defer cancelFct()
operation := F.Pipe2(
Of("test value"),
@@ -660,3 +645,138 @@ func TestSLogWithCallbackLogsError(t *testing.T) {
assert.Contains(t, logOutput, "warning error")
assert.Contains(t, logOutput, "level=WARN")
}
// TestTapSLogPreservesResult tests that TapSLog doesn't modify the result
func TestTapSLogPreservesResult(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
// Test with success value
successOp := F.Pipe2(
Of(42),
TapSLog[int]("Success value"),
Map(N.Mul(2)),
)
successRes := successOp(t.Context())()
assert.Equal(t, result.Of(84), successRes)
// Test with error value
testErr := errors.New("test error")
errorOp := F.Pipe2(
Left[int](testErr),
TapSLog[int]("Error value"),
Map(N.Mul(2)),
)
errorRes := errorOp(t.Context())()
assert.True(t, result.IsLeft(errorRes))
// Verify the error is preserved
_, err := result.Unwrap(errorRes)
assert.Equal(t, testErr, err)
}
// TestTapSLogChainBehavior tests that TapSLog properly chains with other operations
func TestTapSLogChainBehavior(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
// Create a pipeline with multiple TapSLog calls
step1 := F.Pipe2(
Of(1),
TapSLog[int]("Step 1"),
Map(N.Mul(2)),
)
step2 := F.Pipe2(
step1,
TapSLog[int]("Step 2"),
Map(N.Mul(3)),
)
pipeline := F.Pipe1(
step2,
TapSLog[int]("Step 3"),
)
res := pipeline(t.Context())()
assert.Equal(t, result.Of(6), res)
logOutput := buf.String()
// Verify all steps were logged
assert.Contains(t, logOutput, "Step 1")
assert.Contains(t, logOutput, "value=1")
assert.Contains(t, logOutput, "Step 2")
assert.Contains(t, logOutput, "value=2")
assert.Contains(t, logOutput, "Step 3")
assert.Contains(t, logOutput, "value=6")
}
// TestTapSLogWithNilValue tests TapSLog with nil pointer values
func TestTapSLogWithNilValue(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
type Data struct {
Value string
}
// Test with nil pointer
var nilData *Data
operation := F.Pipe1(
Of(nilData),
TapSLog[*Data]("Nil pointer value"),
)
res := operation(t.Context())()
assert.True(t, result.IsRight(res))
logOutput := buf.String()
assert.Contains(t, logOutput, "Nil pointer value")
// The exact representation of nil may vary, but it should be logged
assert.NotEmpty(t, logOutput)
}
// TestTapSLogLogsErrors verifies that TapSLog DOES log errors
// TapSLog uses SLog internally, which logs both success values and errors
func TestTapSLogLogsErrors(t *testing.T) {
var buf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{
Level: slog.LevelInfo,
}))
oldLogger := logging.SetLogger(logger)
defer logging.SetLogger(oldLogger)
testErr := errors.New("test error message")
pipeline := F.Pipe2(
Left[int](testErr),
TapSLog[int]("Error logging test"),
Map(N.Mul(2)),
)
res := pipeline(t.Context())()
// Verify the error is preserved
assert.True(t, result.IsLeft(res))
// Verify logging occurred for the error
logOutput := buf.String()
assert.NotEmpty(t, logOutput, "TapSLog should log when the Result is an error")
assert.Contains(t, logOutput, "Error logging test")
assert.Contains(t, logOutput, "error")
assert.Contains(t, logOutput, "test error message")
}

View File

@@ -22,6 +22,7 @@ import (
"github.com/IBM/fp-go/v2/io"
"github.com/IBM/fp-go/v2/ioresult"
"github.com/IBM/fp-go/v2/pair"
RIOR "github.com/IBM/fp-go/v2/readerioresult"
"github.com/IBM/fp-go/v2/result"
)
@@ -38,21 +39,24 @@ import (
// The error type is fixed as error and remains unchanged through the transformation.
//
// Type Parameters:
// - R: The input environment type that f transforms into context.Context
// - A: The original success type produced by the ReaderIOResult
// - B: The new output success type
//
// Parameters:
// - f: Function to transform the input context (contravariant)
// - f: Function to transform the input environment R into context.Context (contravariant)
// - g: Function to transform the output success value from A to B (covariant)
//
// Returns:
// - An Operator that takes a ReaderIOResult[A] and returns a ReaderIOResult[B]
// - A Kleisli arrow that takes a ReaderIOResult[A] and returns a function from R to B
//
// Note: When R is context.Context, this simplifies to an Operator[A, B]
//
//go:inline
func Promap[A, B any](f pair.Kleisli[context.CancelFunc, context.Context, context.Context], g func(A) B) Operator[A, B] {
func Promap[R, A, B any](f pair.Kleisli[context.CancelFunc, R, context.Context], g func(A) B) RIOR.Kleisli[R, ReaderIOResult[A], B] {
return function.Flow2(
Local[A](f),
Map(g),
RIOR.Map[R](g),
)
}
@@ -66,18 +70,41 @@ func Promap[A, B any](f pair.Kleisli[context.CancelFunc, context.Context, contex
//
// Type Parameters:
// - A: The success type (unchanged)
// - R: The input environment type that f transforms into context.Context
//
// Parameters:
// - f: Function to transform the context, returning a new context and CancelFunc
// - f: Function to transform the input environment R into context.Context, returning a new context and CancelFunc
//
// Returns:
// - A Kleisli arrow that takes a ReaderIOResult[A] and returns a function from R to A
//
// Note: When R is context.Context, this simplifies to an Operator[A, A]
//
//go:inline
func Contramap[A, R any](f pair.Kleisli[context.CancelFunc, R, context.Context]) RIOR.Kleisli[R, ReaderIOResult[A], A] {
return Local[A](f)
}
// ContramapIOK changes the context during the execution of a ReaderIOResult using an IO effect.
// This is the contravariant functor operation with IO effects.
//
// ContramapIOK is an alias for LocalIOK and is useful for adapting a ReaderIOResult to work with
// a modified context when the transformation itself requires side effects.
//
// Type Parameters:
// - A: The success type (unchanged)
//
// Parameters:
// - f: An IO Kleisli arrow that transforms the context with side effects
//
// Returns:
// - An Operator that takes a ReaderIOResult[A] and returns a ReaderIOResult[A]
//
// See Also:
// - Contramap: For pure context transformations
// - LocalIOK: The underlying implementation
//
//go:inline
func Contramap[A any](f pair.Kleisli[context.CancelFunc, context.Context, context.Context]) Operator[A, A] {
return Local[A](f)
}
func ContramapIOK[A any](f io.Kleisli[context.Context, ContextCancel]) Operator[A, A] {
return LocalIOK[A](f)
}
@@ -189,8 +216,6 @@ func LocalIOK[A any](f io.Kleisli[context.Context, ContextCancel]) Operator[A, A
//
// - Local: For pure context transformations
// - LocalIOK: For context transformations with side effects that cannot fail
//
//go:inline
func LocalIOResultK[A any](f ioresult.Kleisli[context.Context, ContextCancel]) Operator[A, A] {
return func(rr ReaderIOResult[A]) ReaderIOResult[A] {
return func(ctx context.Context) IOResult[A] {

View File

@@ -77,6 +77,105 @@ func TestContramapBasic(t *testing.T) {
})
}
// TestContramapIOK tests ContramapIOK functionality
func TestContramapIOK(t *testing.T) {
t.Run("transforms context with IO effect", func(t *testing.T) {
getValue := func(ctx context.Context) IOResult[string] {
return func() R.Result[string] {
if v := ctx.Value("requestID"); v != nil {
return R.Of(v.(string))
}
return R.Of("no-id")
}
}
addRequestID := func(ctx context.Context) io.IO[ContextCancel] {
return func() ContextCancel {
// Simulate generating a request ID via side effect
requestID := "req-12345"
newCtx := context.WithValue(ctx, "requestID", requestID)
return pair.MakePair(context.CancelFunc(func() {}), newCtx)
}
}
adapted := ContramapIOK[string](addRequestID)(getValue)
result := adapted(t.Context())()
assert.Equal(t, R.Of("req-12345"), result)
})
t.Run("preserves value type", func(t *testing.T) {
getValue := func(ctx context.Context) IOResult[int] {
return func() R.Result[int] {
if v := ctx.Value("counter"); v != nil {
return R.Of(v.(int))
}
return R.Of(0)
}
}
addCounter := func(ctx context.Context) io.IO[ContextCancel] {
return func() ContextCancel {
newCtx := context.WithValue(ctx, "counter", 999)
return pair.MakePair(context.CancelFunc(func() {}), newCtx)
}
}
adapted := ContramapIOK[int](addCounter)(getValue)
result := adapted(t.Context())()
assert.Equal(t, R.Of(999), result)
})
t.Run("calls cancel function", func(t *testing.T) {
cancelCalled := false
getValue := func(ctx context.Context) IOResult[string] {
return func() R.Result[string] {
return R.Of("test")
}
}
addData := func(ctx context.Context) io.IO[ContextCancel] {
return func() ContextCancel {
newCtx := context.WithValue(ctx, "data", "value")
cancelFunc := context.CancelFunc(func() {
cancelCalled = true
})
return pair.MakePair(cancelFunc, newCtx)
}
}
adapted := ContramapIOK[string](addData)(getValue)
_ = adapted(t.Context())()
assert.True(t, cancelCalled, "cancel function should be called")
})
t.Run("handles cancelled context", func(t *testing.T) {
getValue := func(ctx context.Context) IOResult[string] {
return func() R.Result[string] {
return R.Of("should not reach here")
}
}
addData := func(ctx context.Context) io.IO[ContextCancel] {
return func() ContextCancel {
newCtx := context.WithValue(ctx, "data", "value")
return pair.MakePair(context.CancelFunc(func() {}), newCtx)
}
}
ctx, cancel := context.WithCancel(t.Context())
cancel()
adapted := ContramapIOK[string](addData)(getValue)
result := adapted(ctx)()
assert.True(t, R.IsLeft(result))
})
}
// TestLocalBasic tests basic Local functionality
func TestLocalBasic(t *testing.T) {
t.Run("adds value to context", func(t *testing.T) {

View File

@@ -32,7 +32,6 @@ import (
"github.com/IBM/fp-go/v2/reader"
RIOR "github.com/IBM/fp-go/v2/readerioresult"
"github.com/IBM/fp-go/v2/readeroption"
"github.com/IBM/fp-go/v2/result"
)
const (
@@ -1011,12 +1010,15 @@ func TapLeftIOK[A, B any](f io.Kleisli[error, B]) Operator[A, A] {
//
// Type Parameters:
// - A: The value type of the ReaderIOResult
// - R: The input environment type that f transforms into context.Context
//
// Parameters:
// - f: A function that transforms the context and returns a cancel function
// - f: A function that transforms the input environment R into context.Context and returns a cancel function
//
// Returns:
// - An Operator that runs the computation with the transformed context
// - A Kleisli arrow that runs the computation with the transformed context
//
// Note: When R is context.Context, this simplifies to an Operator[A, A]
//
// Example:
//
@@ -1055,19 +1057,10 @@ func TapLeftIOK[A, B any](f io.Kleisli[error, B]) Operator[A, A] {
// fetchData,
// withTimeout,
// )
func Local[A any](f pair.Kleisli[context.CancelFunc, context.Context, context.Context]) Operator[A, A] {
return func(rr ReaderIOResult[A]) ReaderIOResult[A] {
return func(ctx context.Context) IOResult[A] {
return func() Result[A] {
if ctx.Err() != nil {
return result.Left[A](context.Cause(ctx))
}
otherCancel, otherCtx := pair.Unpack(f(ctx))
defer otherCancel()
return rr(otherCtx)()
}
}
}
//
//go:inline
func Local[A, R any](f pair.Kleisli[context.CancelFunc, R, context.Context]) RIOR.Kleisli[R, ReaderIOResult[A], A] {
return readerio.Local[Result[A]](f)
}
// WithTimeout adds a timeout to the context for a ReaderIOResult computation.

View File

@@ -0,0 +1,213 @@
// 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 readerreaderioresult
import (
"context"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/ioresult"
)
// Eitherize converts a function that returns a value and error into a ReaderReaderIOResult.
//
// This function takes a function that accepts an outer context R and context.Context,
// returning a value T and an error, and converts it into a ReaderReaderIOResult[R, T].
// The error is automatically converted into the Left case of the Result, while successful
// values become the Right case.
//
// This is particularly useful for integrating standard Go error-handling patterns into
// the functional programming style of ReaderReaderIOResult. It is especially helpful
// for adapting interface member functions that accept a context. When you have an
// interface method with signature (receiver, context.Context) (T, error), you can
// use Eitherize to convert it into a ReaderReaderIOResult where the receiver becomes
// the outer reader context R.
//
// # Type Parameters
//
// - R: The outer reader context type (e.g., application configuration)
// - T: The success value type
//
// # Parameters
//
// - f: A function that takes R and context.Context and returns (T, error)
//
// # Returns
//
// - ReaderReaderIOResult[R, T]: A computation that depends on R and context.Context,
// performs IO, and produces a Result[T]
//
// # Example Usage
//
// type AppConfig struct {
// DatabaseURL string
// }
//
// // A function using standard Go error handling
// func fetchUser(cfg AppConfig, ctx context.Context) (*User, error) {
// // Implementation that may return an error
// return &User{ID: 1, Name: "Alice"}, nil
// }
//
// // Convert to ReaderReaderIOResult
// fetchUserRR := Eitherize(fetchUser)
//
// // Use in functional composition
// result := F.Pipe1(
// fetchUserRR,
// Map[AppConfig](func(u *User) string { return u.Name }),
// )
//
// // Execute with config and context
// cfg := AppConfig{DatabaseURL: "postgres://localhost"}
// outcome := result(cfg)(context.Background())()
//
// # Adapting Interface Methods
//
// Eitherize is particularly useful for adapting interface member functions:
//
// type UserRepository interface {
// GetUser(ctx context.Context, id int) (*User, error)
// }
//
// type UserRepo struct {
// db *sql.DB
// }
//
// func (r *UserRepo) GetUser(ctx context.Context, id int) (*User, error) {
// // Implementation
// return &User{ID: id}, nil
// }
//
// // Adapt the method by binding the first parameter (receiver)
// repo := &UserRepo{db: db}
// getUserRR := Eitherize(func(id int, ctx context.Context) (*User, error) {
// return repo.GetUser(ctx, id)
// })
//
// // Now getUserRR has type: ReaderReaderIOResult[int, *User]
// // The receiver (repo) is captured in the closure
// // The id becomes the outer reader context R
//
// # See Also
//
// - Eitherize1: For functions that take an additional parameter
// - ioresult.Eitherize2: The underlying conversion function
func Eitherize[R, T any](f func(R, context.Context) (T, error)) ReaderReaderIOResult[R, T] {
return F.Pipe1(
ioresult.Eitherize2(f),
F.Curry2,
)
}
// Eitherize1 converts a function that takes an additional parameter and returns a value
// and error into a Kleisli arrow.
//
// This function takes a function that accepts an outer context R, context.Context, and
// an additional parameter A, returning a value T and an error, and converts it into a
// Kleisli arrow (A -> ReaderReaderIOResult[R, T]). The error is automatically converted
// into the Left case of the Result, while successful values become the Right case.
//
// This is useful for creating composable operations that depend on both contexts and
// an input value, following standard Go error-handling patterns. It is especially helpful
// for adapting interface member functions that accept a context and additional parameters.
// When you have an interface method with signature (receiver, context.Context, A) (T, error),
// you can use Eitherize1 to convert it into a Kleisli arrow where the receiver becomes
// the outer reader context R and A becomes the input parameter.
//
// # Type Parameters
//
// - R: The outer reader context type (e.g., application configuration)
// - A: The input parameter type
// - T: The success value type
//
// # Parameters
//
// - f: A function that takes R, context.Context, and A, returning (T, error)
//
// # Returns
//
// - Kleisli[R, A, T]: A function from A to ReaderReaderIOResult[R, T]
//
// # Example Usage
//
// type AppConfig struct {
// DatabaseURL string
// }
//
// // A function using standard Go error handling
// func fetchUserByID(cfg AppConfig, ctx context.Context, id int) (*User, error) {
// // Implementation that may return an error
// return &User{ID: id, Name: "Alice"}, nil
// }
//
// // Convert to Kleisli arrow
// fetchUserKleisli := Eitherize1(fetchUserByID)
//
// // Use in functional composition with Chain
// pipeline := F.Pipe1(
// Of[AppConfig](123),
// Chain[AppConfig](fetchUserKleisli),
// )
//
// // Execute with config and context
// cfg := AppConfig{DatabaseURL: "postgres://localhost"}
// outcome := pipeline(cfg)(context.Background())()
//
// # Adapting Interface Methods
//
// Eitherize1 is particularly useful for adapting interface member functions with parameters:
//
// type UserRepository interface {
// GetUserByID(ctx context.Context, id int) (*User, error)
// UpdateUser(ctx context.Context, user *User) error
// }
//
// type UserRepo struct {
// db *sql.DB
// }
//
// func (r *UserRepo) GetUserByID(ctx context.Context, id int) (*User, error) {
// // Implementation
// return &User{ID: id}, nil
// }
//
// // Adapt the method - receiver becomes R, id becomes A
// repo := &UserRepo{db: db}
// getUserKleisli := Eitherize1(func(r *UserRepo, ctx context.Context, id int) (*User, error) {
// return r.GetUserByID(ctx, id)
// })
//
// // Now getUserKleisli has type: Kleisli[*UserRepo, int, *User]
// // Which is: func(int) ReaderReaderIOResult[*UserRepo, *User]
// // Use it in composition:
// pipeline := F.Pipe1(
// Of[*UserRepo](123),
// Chain[*UserRepo](getUserKleisli),
// )
// result := pipeline(repo)(context.Background())()
//
// # See Also
//
// - Eitherize: For functions without an additional parameter
// - Chain: For composing Kleisli arrows
// - ioresult.Eitherize3: The underlying conversion function
func Eitherize1[R, A, T any](f func(R, context.Context, A) (T, error)) Kleisli[R, A, T] {
return F.Flow2(
F.Bind3of3(ioresult.Eitherize3(f)),
F.Curry2,
)
}

View File

@@ -0,0 +1,507 @@
// 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 readerreaderioresult
import (
"context"
"errors"
"fmt"
"strconv"
"testing"
F "github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
)
type TestConfig struct {
Prefix string
MaxLen int
}
var testConfig = TestConfig{
Prefix: "test",
MaxLen: 100,
}
// TestEitherize_Success tests successful conversion with Eitherize
func TestEitherize_Success(t *testing.T) {
t.Run("converts successful function to ReaderReaderIOResult", func(t *testing.T) {
// Arrange
successFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return cfg.Prefix + "-success", nil
}
rr := Eitherize(successFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of("test-success"), outcome)
})
t.Run("preserves context values", func(t *testing.T) {
// Arrange
type ctxKey string
key := ctxKey("testKey")
expectedValue := "contextValue"
contextFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
value := ctx.Value(key)
if value == nil {
return "", errors.New("context value not found")
}
return value.(string), nil
}
rr := Eitherize(contextFunc)
ctx := context.WithValue(context.Background(), key, expectedValue)
// Act
outcome := rr(testConfig)(ctx)()
// Assert
assert.Equal(t, result.Of(expectedValue), outcome)
})
t.Run("works with different types", func(t *testing.T) {
// Arrange
intFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return cfg.MaxLen, nil
}
rr := Eitherize(intFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(100), outcome)
})
}
// TestEitherize_Failure tests error handling with Eitherize
func TestEitherize_Failure(t *testing.T) {
t.Run("converts error to Left", func(t *testing.T) {
// Arrange
expectedErr := errors.New("operation failed")
failFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return "", expectedErr
}
rr := Eitherize(failFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
assert.Equal(t, result.Left[string](expectedErr), outcome)
})
t.Run("preserves error message", func(t *testing.T) {
// Arrange
expectedErr := fmt.Errorf("validation error: field is required")
failFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return 0, expectedErr
}
rr := Eitherize(failFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
leftValue := result.MonadFold(outcome,
F.Identity[error],
func(int) error { return nil },
)
assert.Equal(t, expectedErr, leftValue)
})
}
// TestEitherize_EdgeCases tests edge cases for Eitherize
func TestEitherize_EdgeCases(t *testing.T) {
t.Run("handles nil context", func(t *testing.T) {
// Arrange
nilCtxFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
if ctx == nil {
return "nil-context", nil
}
return "non-nil-context", nil
}
rr := Eitherize(nilCtxFunc)
// Act
outcome := rr(testConfig)(nil)()
// Assert
assert.Equal(t, result.Of("nil-context"), outcome)
})
t.Run("handles zero value config", func(t *testing.T) {
// Arrange
zeroFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return cfg.Prefix, nil
}
rr := Eitherize(zeroFunc)
// Act
outcome := rr(TestConfig{})(context.Background())()
// Assert
assert.Equal(t, result.Of(""), outcome)
})
t.Run("handles pointer types", func(t *testing.T) {
// Arrange
type User struct {
Name string
}
ptrFunc := func(cfg TestConfig, ctx context.Context) (*User, error) {
return &User{Name: "Alice"}, nil
}
rr := Eitherize(ptrFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsRight(outcome))
user := result.MonadFold(outcome,
func(error) *User { return nil },
F.Identity[*User],
)
assert.NotNil(t, user)
assert.Equal(t, "Alice", user.Name)
})
}
// TestEitherize_Integration tests integration with other operations
func TestEitherize_Integration(t *testing.T) {
t.Run("composes with Map", func(t *testing.T) {
// Arrange
baseFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return 42, nil
}
rr := Eitherize(baseFunc)
// Act
pipeline := F.Pipe1(
rr,
Map[TestConfig](func(n int) string { return strconv.Itoa(n) }),
)
outcome := pipeline(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of("42"), outcome)
})
t.Run("composes with Chain", func(t *testing.T) {
// Arrange
firstFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return 10, nil
}
secondFunc := func(n int) ReaderReaderIOResult[TestConfig, string] {
return Of[TestConfig](fmt.Sprintf("value: %d", n))
}
// Act
pipeline := F.Pipe1(
Eitherize(firstFunc),
Chain[TestConfig](secondFunc),
)
outcome := pipeline(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of("value: 10"), outcome)
})
}
// TestEitherize1_Success tests successful conversion with Eitherize1
func TestEitherize1_Success(t *testing.T) {
t.Run("converts successful function to Kleisli", func(t *testing.T) {
// Arrange
addFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
return n + cfg.MaxLen, nil
}
kleisli := Eitherize1(addFunc)
// Act
outcome := kleisli(10)(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(110), outcome)
})
t.Run("works with string input", func(t *testing.T) {
// Arrange
concatFunc := func(cfg TestConfig, ctx context.Context, s string) (string, error) {
return cfg.Prefix + "-" + s, nil
}
kleisli := Eitherize1(concatFunc)
// Act
outcome := kleisli("input")(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of("test-input"), outcome)
})
t.Run("preserves context in Kleisli", func(t *testing.T) {
// Arrange
type ctxKey string
key := ctxKey("multiplier")
multiplyFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
multiplier := ctx.Value(key)
if multiplier == nil {
return n, nil
}
return n * multiplier.(int), nil
}
kleisli := Eitherize1(multiplyFunc)
ctx := context.WithValue(context.Background(), key, 3)
// Act
outcome := kleisli(5)(testConfig)(ctx)()
// Assert
assert.Equal(t, result.Of(15), outcome)
})
}
// TestEitherize1_Failure tests error handling with Eitherize1
func TestEitherize1_Failure(t *testing.T) {
t.Run("converts error to Left in Kleisli", func(t *testing.T) {
// Arrange
expectedErr := errors.New("division by zero")
divideFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
if n == 0 {
return 0, expectedErr
}
return 100 / n, nil
}
kleisli := Eitherize1(divideFunc)
// Act
outcome := kleisli(0)(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
assert.Equal(t, result.Left[int](expectedErr), outcome)
})
t.Run("preserves error context", func(t *testing.T) {
// Arrange
validateFunc := func(cfg TestConfig, ctx context.Context, s string) (string, error) {
if len(s) > cfg.MaxLen {
return "", fmt.Errorf("string too long: %d > %d", len(s), cfg.MaxLen)
}
return s, nil
}
kleisli := Eitherize1(validateFunc)
longString := string(make([]byte, 200))
// Act
outcome := kleisli(longString)(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
leftValue := result.MonadFold(outcome,
F.Identity[error],
func(string) error { return nil },
)
assert.Contains(t, leftValue.Error(), "string too long")
})
}
// TestEitherize1_EdgeCases tests edge cases for Eitherize1
func TestEitherize1_EdgeCases(t *testing.T) {
t.Run("handles zero value input", func(t *testing.T) {
// Arrange
zeroFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
return n, nil
}
kleisli := Eitherize1(zeroFunc)
// Act
outcome := kleisli(0)(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(0), outcome)
})
t.Run("handles pointer input", func(t *testing.T) {
// Arrange
type Input struct {
Value int
}
ptrFunc := func(cfg TestConfig, ctx context.Context, in *Input) (int, error) {
if in == nil {
return 0, errors.New("nil input")
}
return in.Value, nil
}
kleisli := Eitherize1(ptrFunc)
// Act
outcome := kleisli(&Input{Value: 42})(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(42), outcome)
})
t.Run("handles nil pointer input", func(t *testing.T) {
// Arrange
type Input struct {
Value int
}
ptrFunc := func(cfg TestConfig, ctx context.Context, in *Input) (int, error) {
if in == nil {
return 0, errors.New("nil input")
}
return in.Value, nil
}
kleisli := Eitherize1(ptrFunc)
// Act
outcome := kleisli((*Input)(nil))(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
})
}
// TestEitherize1_Integration tests integration with other operations
func TestEitherize1_Integration(t *testing.T) {
t.Run("composes with Chain", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
doubleFunc := func(n int) ReaderReaderIOResult[TestConfig, int] {
return Of[TestConfig](n * 2)
}
parseKleisli := Eitherize1(parseFunc)
// Act
pipeline := F.Pipe2(
Of[TestConfig]("42"),
Chain[TestConfig](parseKleisli),
Chain[TestConfig](doubleFunc),
)
outcome := pipeline(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(84), outcome)
})
t.Run("handles error in chain", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
parseKleisli := Eitherize1(parseFunc)
// Act
pipeline := F.Pipe1(
Of[TestConfig]("not-a-number"),
Chain(parseKleisli),
)
outcome := pipeline(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsLeft(outcome))
})
t.Run("composes multiple Kleisli arrows", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
formatFunc := func(cfg TestConfig, ctx context.Context, n int) (string, error) {
return fmt.Sprintf("%s-%d", cfg.Prefix, n), nil
}
parseKleisli := Eitherize1(parseFunc)
formatKleisli := Eitherize1(formatFunc)
// Act
pipeline := F.Pipe2(
Of[TestConfig]("123"),
Chain[TestConfig](parseKleisli),
Chain[TestConfig](formatKleisli),
)
outcome := pipeline(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of("test-123"), outcome)
})
}
// TestEitherize_TypeSafety tests type safety across different scenarios
func TestEitherize_TypeSafety(t *testing.T) {
t.Run("Eitherize with complex types", func(t *testing.T) {
// Arrange
type ComplexResult struct {
Data map[string]int
Count int
}
complexFunc := func(cfg TestConfig, ctx context.Context) (ComplexResult, error) {
return ComplexResult{
Data: map[string]int{"key": 42},
Count: 1,
}, nil
}
rr := Eitherize(complexFunc)
// Act
outcome := rr(testConfig)(context.Background())()
// Assert
assert.True(t, result.IsRight(outcome))
value := result.MonadFold(outcome,
func(error) ComplexResult { return ComplexResult{} },
F.Identity[ComplexResult],
)
assert.Equal(t, 42, value.Data["key"])
assert.Equal(t, 1, value.Count)
})
t.Run("Eitherize1 with different input and output types", func(t *testing.T) {
// Arrange
type Input struct {
ID int
}
type Output struct {
Name string
}
convertFunc := func(cfg TestConfig, ctx context.Context, in Input) (Output, error) {
return Output{Name: fmt.Sprintf("%s-%d", cfg.Prefix, in.ID)}, nil
}
kleisli := Eitherize1(convertFunc)
// Act
outcome := kleisli(Input{ID: 99})(testConfig)(context.Background())()
// Assert
assert.Equal(t, result.Of(Output{Name: "test-99"}), outcome)
})
}

View File

@@ -13,6 +13,17 @@ import (
// Local modifies the outer environment before passing it to a computation.
// Useful for providing different configurations to sub-computations.
//
// Type Parameters:
// - A: The success type produced by the ReaderReaderIOResult
// - R1: The original outer environment type expected by the ReaderReaderIOResult
// - R2: The new input outer environment type
//
// Parameters:
// - f: A function that transforms R2 to R1
//
// Returns:
// - A function that takes a ReaderReaderIOResult[R1, A] and returns a ReaderReaderIOResult[R2, A]
//
//go:inline
func Local[A, R1, R2 any](f func(R2) R1) func(ReaderReaderIOResult[R1, A]) ReaderReaderIOResult[R2, A] {
return RRIOE.Local[context.Context, error, A](f)
@@ -102,6 +113,29 @@ func LocalIOResultK[A, R1, R2 any](f ioresult.Kleisli[R2, R1]) func(ReaderReader
return RRIOE.LocalIOEitherK[context.Context, A](f)
}
// LocalResultK transforms the outer environment of a ReaderReaderIOResult using a Result-based Kleisli arrow.
// It allows you to modify the outer environment through a pure computation that can fail before
// passing it to the ReaderReaderIOResult.
//
// This is useful when the outer environment transformation is a pure computation that can fail,
// such as parsing, validation, or data transformation that doesn't require IO effects.
//
// The transformation happens in two stages:
// 1. The Result function f is executed with the R2 environment to produce Result[R1]
// 2. If successful (Ok), the R1 value is passed as the outer environment to the ReaderReaderIOResult[R1, A]
// 3. If failed (Err), the error is propagated without executing the ReaderReaderIOResult
//
// Type Parameters:
// - A: The success type produced by the ReaderReaderIOResult
// - R1: The original outer environment type expected by the ReaderReaderIOResult
// - R2: The new input outer environment type
//
// Parameters:
// - f: A Result Kleisli arrow that transforms R2 to R1 with pure computation that can fail
//
// Returns:
// - A function that takes a ReaderReaderIOResult[R1, A] and returns a ReaderReaderIOResult[R2, A]
//
//go:inline
func LocalResultK[A, R1, R2 any](f result.Kleisli[R2, R1]) func(ReaderReaderIOResult[R1, A]) ReaderReaderIOResult[R2, A] {
return RRIOE.LocalEitherK[context.Context, A](f)
@@ -162,6 +196,31 @@ func LocalReaderIOResultK[A, R1, R2 any](f readerioresult.Kleisli[R2, R1]) func(
return RRIOE.LocalReaderIOEitherK[A](f)
}
// LocalReaderReaderIOEitherK transforms the outer environment of a ReaderReaderIOResult using a ReaderReaderIOResult-based Kleisli arrow.
// It allows you to modify the outer environment through a computation that depends on both the outer environment
// and the inner context, and can perform IO effects that may fail.
//
// This is the most powerful Local variant, useful when the outer environment transformation requires:
// - Access to both the outer environment (R2) and inner context (context.Context)
// - IO operations that can fail
// - Complex transformations that need the full computational context
//
// The transformation happens in three stages:
// 1. The ReaderReaderIOResult effect f is executed with the R2 outer environment and inner context
// 2. If successful (Ok), the R1 value is passed as the outer environment to the ReaderReaderIOResult[R1, A]
// 3. If failed (Err), the error is propagated without executing the ReaderReaderIOResult
//
// Type Parameters:
// - A: The success type produced by the ReaderReaderIOResult
// - R1: The original outer environment type expected by the ReaderReaderIOResult
// - R2: The new input outer environment type
//
// Parameters:
// - f: A ReaderReaderIOResult Kleisli arrow that transforms R2 to R1 with full context-aware IO effects that can fail
//
// Returns:
// - A function that takes a ReaderReaderIOResult[R1, A] and returns a ReaderReaderIOResult[R2, A]
//
//go:inline
func LocalReaderReaderIOEitherK[A, R1, R2 any](f Kleisli[R2, R2, R1]) func(ReaderReaderIOResult[R1, A]) ReaderReaderIOResult[R2, A] {
return RRIOE.LocalReaderReaderIOEitherK[A](f)

View File

@@ -24,6 +24,7 @@ import (
"github.com/IBM/fp-go/v2/logging"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
)
@@ -104,7 +105,8 @@ func TestSLogWithContextLogger(t *testing.T) {
Level: slog.LevelInfo,
}))
ctx := logging.WithLogger(contextLogger)(t.Context())
cancelFct, ctx := pair.Unpack(logging.WithLogger(contextLogger)(t.Context()))
defer cancelFct()
res1 := result.Of("test value")
logged := SLog[string]("Context logger test")(res1)(ctx)

View File

@@ -21,8 +21,9 @@ import (
RIORES "github.com/IBM/fp-go/v2/context/readerioresult"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/internal/statet"
RIOR "github.com/IBM/fp-go/v2/readerioresult"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/result"
SRIOE "github.com/IBM/fp-go/v2/statereaderioeither"
)
// Left creates a StateReaderIOResult that represents a failed computation with the given error.
@@ -202,21 +203,41 @@ func FromResult[S, A any](ma Result[A]) StateReaderIOResult[S, A] {
// Combinators
// Local runs a computation with a modified context.
// The function f transforms the context before passing it to the computation.
// The function f transforms the context before passing it to the computation,
// returning both a new context and a CancelFunc that should be called to release resources.
//
// This is useful for:
// - Adding values to the context
// - Setting timeouts or deadlines
// - Modifying context metadata
//
// The CancelFunc is automatically called after the computation completes to ensure proper cleanup.
//
// Type Parameters:
// - S: The state type
// - A: The result type
// - R: The input environment type that f transforms into context.Context
//
// Parameters:
// - f: Function to transform the input environment R into context.Context, returning a new context and CancelFunc
//
// Returns:
// - A Kleisli arrow that takes a StateReaderIOResult[S, A] and returns a StateReaderIOEither[S, R, error, A]
//
// Note: When R is context.Context, the return type simplifies to func(StateReaderIOResult[S, A]) StateReaderIOResult[S, A]
//
// Example:
//
// // Modify context before running computation
// withTimeout := statereaderioresult.Local[AppState](
// func(ctx context.Context) context.Context {
// ctx, _ = context.WithTimeout(ctx, 60*time.Second)
// return ctx
// }
// // Add a timeout to a specific operation
// withTimeout := statereaderioresult.Local[AppState, Data](
// func(ctx context.Context) (context.Context, context.CancelFunc) {
// return context.WithTimeout(ctx, 60*time.Second)
// },
// )
// result := withTimeout(computation)
func Local[S, A any](f func(context.Context) context.Context) func(StateReaderIOResult[S, A]) StateReaderIOResult[S, A] {
return func(ma StateReaderIOResult[S, A]) StateReaderIOResult[S, A] {
return function.Flow2(ma, RIOR.Local[Pair[S, A]](f))
func Local[S, A, R any](f pair.Kleisli[context.CancelFunc, R, context.Context]) SRIOE.Kleisli[S, R, error, StateReaderIOResult[S, A], A] {
return func(ma StateReaderIOResult[S, A]) SRIOE.StateReaderIOEither[S, R, error, A] {
return function.Flow2(ma, RIORES.Local[Pair[S, A]](f))
}
}

View File

@@ -25,6 +25,7 @@ import (
"github.com/IBM/fp-go/v2/io"
IOR "github.com/IBM/fp-go/v2/ioresult"
N "github.com/IBM/fp-go/v2/number"
"github.com/IBM/fp-go/v2/pair"
P "github.com/IBM/fp-go/v2/pair"
RES "github.com/IBM/fp-go/v2/result"
"github.com/stretchr/testify/assert"
@@ -264,8 +265,8 @@ func TestLocal(t *testing.T) {
// Modify context before running computation
result := Local[testState, string](
func(c context.Context) context.Context {
return context.WithValue(c, "key", "value2")
func(c context.Context) ContextCancel {
return pair.MakePair[context.CancelFunc](func() {}, context.WithValue(c, "key", "value2"))
},
)(comp)

View File

@@ -16,6 +16,8 @@
package statereaderioresult
import (
"context"
RIORES "github.com/IBM/fp-go/v2/context/readerioresult"
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/io"
@@ -84,4 +86,11 @@ type (
Operator[S, A, B any] = Reader[StateReaderIOResult[S, A], StateReaderIOResult[S, B]]
Predicate[A any] = predicate.Predicate[A]
// ContextCancel represents a pair of a cancel function and a context.
// It is used in operations that create new contexts with cancellation capabilities.
//
// The first element is the CancelFunc that should be called to release resources.
// The second element is the new Context that was created.
ContextCancel = Pair[context.CancelFunc, context.Context]
)

208
v2/effect/eitherize.go Normal file
View File

@@ -0,0 +1,208 @@
// 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 effect
import (
"context"
"github.com/IBM/fp-go/v2/context/readerreaderioresult"
)
// Eitherize converts a function that returns a value and error into an Effect.
//
// This function takes a function that accepts a context C and context.Context,
// returning a value T and an error, and converts it into an Effect[C, T].
// The error is automatically converted into a failure, while successful
// values become successes.
//
// This is particularly useful for integrating standard Go error-handling patterns into
// the effect system. It is especially helpful for adapting interface member functions
// that accept a context. When you have an interface method with signature
// (receiver, context.Context) (T, error), you can use Eitherize to convert it into
// an Effect where the receiver becomes the context C.
//
// # Type Parameters
//
// - C: The context type required by the effect
// - T: The success value type
//
// # Parameters
//
// - f: A function that takes C and context.Context and returns (T, error)
//
// # Returns
//
// - Effect[C, T]: An effect that depends on C, performs IO, and produces T
//
// # Example Usage
//
// type AppConfig struct {
// DatabaseURL string
// }
//
// // A function using standard Go error handling
// func fetchUser(cfg AppConfig, ctx context.Context) (*User, error) {
// // Implementation that may return an error
// return &User{ID: 1, Name: "Alice"}, nil
// }
//
// // Convert to Effect
// fetchUserEffect := effect.Eitherize(fetchUser)
//
// // Use in functional composition
// pipeline := F.Pipe1(
// fetchUserEffect,
// effect.Map[AppConfig](func(u *User) string { return u.Name }),
// )
//
// // Execute with config
// cfg := AppConfig{DatabaseURL: "postgres://localhost"}
// result, err := effect.RunSync(effect.Provide[*User](cfg)(pipeline))(context.Background())
//
// # Adapting Interface Methods
//
// Eitherize is particularly useful for adapting interface member functions:
//
// type UserRepository interface {
// GetUser(ctx context.Context, id int) (*User, error)
// }
//
// type UserRepo struct {
// db *sql.DB
// }
//
// func (r *UserRepo) GetUser(ctx context.Context, id int) (*User, error) {
// // Implementation
// return &User{ID: id}, nil
// }
//
// // Adapt the method by binding the first parameter (receiver)
// repo := &UserRepo{db: db}
// getUserEffect := effect.Eitherize(func(id int, ctx context.Context) (*User, error) {
// return repo.GetUser(ctx, id)
// })
//
// // Now getUserEffect has type: Effect[int, *User]
// // The receiver (repo) is captured in the closure
// // The id becomes the context C
//
// # See Also
//
// - Eitherize1: For functions that take an additional parameter
// - readerreaderioresult.Eitherize: The underlying implementation
//
//go:inline
func Eitherize[C, T any](f func(C, context.Context) (T, error)) Effect[C, T] {
return readerreaderioresult.Eitherize(f)
}
// Eitherize1 converts a function that takes an additional parameter and returns a value
// and error into a Kleisli arrow.
//
// This function takes a function that accepts a context C, context.Context, and
// an additional parameter A, returning a value T and an error, and converts it into a
// Kleisli arrow (A -> Effect[C, T]). The error is automatically converted into a failure,
// while successful values become successes.
//
// This is useful for creating composable operations that depend on context and
// an input value, following standard Go error-handling patterns. It is especially helpful
// for adapting interface member functions that accept a context and additional parameters.
// When you have an interface method with signature (receiver, context.Context, A) (T, error),
// you can use Eitherize1 to convert it into a Kleisli arrow where the receiver becomes
// the context C and A becomes the input parameter.
//
// # Type Parameters
//
// - C: The context type required by the effect
// - A: The input parameter type
// - T: The success value type
//
// # Parameters
//
// - f: A function that takes C, context.Context, and A, returning (T, error)
//
// # Returns
//
// - Kleisli[C, A, T]: A function from A to Effect[C, T]
//
// # Example Usage
//
// type AppConfig struct {
// DatabaseURL string
// }
//
// // A function using standard Go error handling
// func fetchUserByID(cfg AppConfig, ctx context.Context, id int) (*User, error) {
// // Implementation that may return an error
// return &User{ID: id, Name: "Alice"}, nil
// }
//
// // Convert to Kleisli arrow
// fetchUserKleisli := effect.Eitherize1(fetchUserByID)
//
// // Use in functional composition with Chain
// pipeline := F.Pipe1(
// effect.Succeed[AppConfig](123),
// effect.Chain[AppConfig](fetchUserKleisli),
// )
//
// // Execute with config
// cfg := AppConfig{DatabaseURL: "postgres://localhost"}
// result, err := effect.RunSync(effect.Provide[*User](cfg)(pipeline))(context.Background())
//
// # Adapting Interface Methods
//
// Eitherize1 is particularly useful for adapting interface member functions with parameters:
//
// type UserRepository interface {
// GetUserByID(ctx context.Context, id int) (*User, error)
// UpdateUser(ctx context.Context, user *User) error
// }
//
// type UserRepo struct {
// db *sql.DB
// }
//
// func (r *UserRepo) GetUserByID(ctx context.Context, id int) (*User, error) {
// // Implementation
// return &User{ID: id}, nil
// }
//
// // Adapt the method - receiver becomes C, id becomes A
// repo := &UserRepo{db: db}
// getUserKleisli := effect.Eitherize1(func(r *UserRepo, ctx context.Context, id int) (*User, error) {
// return r.GetUserByID(ctx, id)
// })
//
// // Now getUserKleisli has type: Kleisli[*UserRepo, int, *User]
// // Which is: func(int) Effect[*UserRepo, *User]
// // Use it in composition:
// pipeline := F.Pipe1(
// effect.Succeed[*UserRepo](123),
// effect.Chain[*UserRepo](getUserKleisli),
// )
// result, err := effect.RunSync(effect.Provide[*User](repo)(pipeline))(context.Background())
//
// # See Also
//
// - Eitherize: For functions without an additional parameter
// - Chain: For composing Kleisli arrows
// - readerreaderioresult.Eitherize1: The underlying implementation
//
//go:inline
func Eitherize1[C, A, T any](f func(C, context.Context, A) (T, error)) Kleisli[C, A, T] {
return readerreaderioresult.Eitherize1(f)
}

507
v2/effect/eitherize_test.go Normal file
View File

@@ -0,0 +1,507 @@
// 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 effect
import (
"context"
"errors"
"fmt"
"strconv"
"testing"
F "github.com/IBM/fp-go/v2/function"
"github.com/stretchr/testify/assert"
)
// TestEitherize_Success tests successful conversion with Eitherize
func TestEitherize_Success(t *testing.T) {
t.Run("converts successful function to Effect", func(t *testing.T) {
// Arrange
successFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return cfg.Prefix + "-success", nil
}
eff := Eitherize(successFunc)
// Act
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "LOG-success", result)
})
t.Run("preserves context values", func(t *testing.T) {
// Arrange
type ctxKey string
key := ctxKey("testKey")
expectedValue := "contextValue"
contextFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
value := ctx.Value(key)
if value == nil {
return "", errors.New("context value not found")
}
return value.(string), nil
}
eff := Eitherize(contextFunc)
// Act
ioResult := Provide[string](testConfig)(eff)
readerResult := RunSync(ioResult)
ctx := context.WithValue(context.Background(), key, expectedValue)
result, err := readerResult(ctx)
// Assert
assert.NoError(t, err)
assert.Equal(t, expectedValue, result)
})
t.Run("works with different types", func(t *testing.T) {
// Arrange
intFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return cfg.Multiplier, nil
}
eff := Eitherize(intFunc)
// Act
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 3, result)
})
}
// TestEitherize_Failure tests error handling with Eitherize
func TestEitherize_Failure(t *testing.T) {
t.Run("converts error to failure", func(t *testing.T) {
// Arrange
expectedErr := errors.New("operation failed")
failFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return "", expectedErr
}
eff := Eitherize(failFunc)
// Act
_, err := runEffect(eff, testConfig)
// Assert
assert.Error(t, err)
assert.Equal(t, expectedErr, err)
})
t.Run("preserves error message", func(t *testing.T) {
// Arrange
expectedErr := fmt.Errorf("validation error: field is required")
failFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return 0, expectedErr
}
eff := Eitherize(failFunc)
// Act
_, err := runEffect(eff, testConfig)
// Assert
assert.Error(t, err)
assert.Equal(t, expectedErr, err)
})
}
// TestEitherize_EdgeCases tests edge cases for Eitherize
func TestEitherize_EdgeCases(t *testing.T) {
t.Run("handles nil context", func(t *testing.T) {
// Arrange
nilCtxFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
if ctx == nil {
return "nil-context", nil
}
return "non-nil-context", nil
}
eff := Eitherize(nilCtxFunc)
// Act
ioResult := Provide[string](testConfig)(eff)
readerResult := RunSync(ioResult)
result, err := readerResult(nil)
// Assert
assert.NoError(t, err)
assert.Equal(t, "nil-context", result)
})
t.Run("handles zero value config", func(t *testing.T) {
// Arrange
zeroFunc := func(cfg TestConfig, ctx context.Context) (string, error) {
return cfg.Prefix, nil
}
eff := Eitherize(zeroFunc)
// Act
result, err := runEffect(eff, TestConfig{})
// Assert
assert.NoError(t, err)
assert.Equal(t, "", result)
})
t.Run("handles pointer types", func(t *testing.T) {
// Arrange
type User struct {
Name string
}
ptrFunc := func(cfg TestConfig, ctx context.Context) (*User, error) {
return &User{Name: cfg.Prefix}, nil
}
eff := Eitherize(ptrFunc)
// Act
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.NotNil(t, result)
assert.Equal(t, "LOG", result.Name)
})
}
// TestEitherize_Integration tests integration with other operations
func TestEitherize_Integration(t *testing.T) {
t.Run("composes with Map", func(t *testing.T) {
// Arrange
baseFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return cfg.Multiplier, nil
}
eff := Eitherize(baseFunc)
// Act
pipeline := F.Pipe1(
eff,
Map[TestConfig](func(n int) string { return strconv.Itoa(n) }),
)
result, err := runEffect(pipeline, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "3", result)
})
t.Run("composes with Chain", func(t *testing.T) {
// Arrange
firstFunc := func(cfg TestConfig, ctx context.Context) (int, error) {
return cfg.Multiplier, nil
}
secondFunc := func(n int) Effect[TestConfig, string] {
return Succeed[TestConfig](fmt.Sprintf("value: %d", n))
}
// Act
pipeline := F.Pipe1(
Eitherize(firstFunc),
Chain[TestConfig](secondFunc),
)
result, err := runEffect(pipeline, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "value: 3", result)
})
}
// TestEitherize1_Success tests successful conversion with Eitherize1
func TestEitherize1_Success(t *testing.T) {
t.Run("converts successful function to Kleisli", func(t *testing.T) {
// Arrange
multiplyFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
return n * cfg.Multiplier, nil
}
kleisli := Eitherize1(multiplyFunc)
// Act
eff := kleisli(10)
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 30, result)
})
t.Run("works with string input", func(t *testing.T) {
// Arrange
concatFunc := func(cfg TestConfig, ctx context.Context, s string) (string, error) {
return cfg.Prefix + "-" + s, nil
}
kleisli := Eitherize1(concatFunc)
// Act
eff := kleisli("input")
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "LOG-input", result)
})
t.Run("preserves context in Kleisli", func(t *testing.T) {
// Arrange
type ctxKey string
key := ctxKey("factor")
scaleFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
factor := ctx.Value(key)
if factor == nil {
return n * cfg.Multiplier, nil
}
return n * factor.(int), nil
}
kleisli := Eitherize1(scaleFunc)
// Act
eff := kleisli(5)
ioResult := Provide[int](testConfig)(eff)
readerResult := RunSync(ioResult)
ctx := context.WithValue(context.Background(), key, 7)
result, err := readerResult(ctx)
// Assert
assert.NoError(t, err)
assert.Equal(t, 35, result)
})
}
// TestEitherize1_Failure tests error handling with Eitherize1
func TestEitherize1_Failure(t *testing.T) {
t.Run("converts error to failure in Kleisli", func(t *testing.T) {
// Arrange
expectedErr := errors.New("division by zero")
divideFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
if n == 0 {
return 0, expectedErr
}
return 100 / n, nil
}
kleisli := Eitherize1(divideFunc)
// Act
eff := kleisli(0)
_, err := runEffect(eff, testConfig)
// Assert
assert.Error(t, err)
assert.Equal(t, expectedErr, err)
})
t.Run("preserves error context", func(t *testing.T) {
// Arrange
validateFunc := func(cfg TestConfig, ctx context.Context, s string) (string, error) {
if len(s) > 10 {
return "", fmt.Errorf("string too long: %d > 10", len(s))
}
return s, nil
}
kleisli := Eitherize1(validateFunc)
// Act
eff := kleisli("this-string-is-too-long")
_, err := runEffect(eff, testConfig)
// Assert
assert.Error(t, err)
assert.Contains(t, err.Error(), "string too long")
})
}
// TestEitherize1_EdgeCases tests edge cases for Eitherize1
func TestEitherize1_EdgeCases(t *testing.T) {
t.Run("handles zero value input", func(t *testing.T) {
// Arrange
zeroFunc := func(cfg TestConfig, ctx context.Context, n int) (int, error) {
return n, nil
}
kleisli := Eitherize1(zeroFunc)
// Act
eff := kleisli(0)
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 0, result)
})
t.Run("handles pointer input", func(t *testing.T) {
// Arrange
type Input struct {
Value int
}
ptrFunc := func(cfg TestConfig, ctx context.Context, in *Input) (int, error) {
if in == nil {
return 0, errors.New("nil input")
}
return in.Value * cfg.Multiplier, nil
}
kleisli := Eitherize1(ptrFunc)
// Act
eff := kleisli(&Input{Value: 7})
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 21, result)
})
t.Run("handles nil pointer input", func(t *testing.T) {
// Arrange
type Input struct {
Value int
}
ptrFunc := func(cfg TestConfig, ctx context.Context, in *Input) (int, error) {
if in == nil {
return 0, errors.New("nil input")
}
return in.Value, nil
}
kleisli := Eitherize1(ptrFunc)
// Act
eff := kleisli((*Input)(nil))
_, err := runEffect(eff, testConfig)
// Assert
assert.Error(t, err)
assert.Contains(t, err.Error(), "nil input")
})
}
// TestEitherize1_Integration tests integration with other operations
func TestEitherize1_Integration(t *testing.T) {
t.Run("composes with Chain", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
doubleFunc := func(n int) Effect[TestConfig, int] {
return Succeed[TestConfig](n * 2)
}
parseKleisli := Eitherize1(parseFunc)
// Act
pipeline := F.Pipe2(
Succeed[TestConfig]("42"),
Chain[TestConfig](parseKleisli),
Chain[TestConfig](doubleFunc),
)
result, err := runEffect(pipeline, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 84, result)
})
t.Run("handles error in chain", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
parseKleisli := Eitherize1(parseFunc)
// Act
pipeline := F.Pipe1(
Succeed[TestConfig]("not-a-number"),
Chain[TestConfig](parseKleisli),
)
_, err := runEffect(pipeline, testConfig)
// Assert
assert.Error(t, err)
})
t.Run("composes multiple Kleisli arrows", func(t *testing.T) {
// Arrange
parseFunc := func(cfg TestConfig, ctx context.Context, s string) (int, error) {
return strconv.Atoi(s)
}
formatFunc := func(cfg TestConfig, ctx context.Context, n int) (string, error) {
return fmt.Sprintf("%s-%d", cfg.Prefix, n), nil
}
parseKleisli := Eitherize1(parseFunc)
formatKleisli := Eitherize1(formatFunc)
// Act
pipeline := F.Pipe2(
Succeed[TestConfig]("123"),
Chain[TestConfig](parseKleisli),
Chain[TestConfig](formatKleisli),
)
result, err := runEffect(pipeline, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "LOG-123", result)
})
}
// TestEitherize_TypeSafety tests type safety across different scenarios
func TestEitherize_TypeSafety(t *testing.T) {
t.Run("Eitherize with complex types", func(t *testing.T) {
// Arrange
type ComplexResult struct {
Data map[string]int
Count int
}
complexFunc := func(cfg TestConfig, ctx context.Context) (ComplexResult, error) {
return ComplexResult{
Data: map[string]int{cfg.Prefix: cfg.Multiplier},
Count: cfg.Multiplier,
}, nil
}
eff := Eitherize(complexFunc)
// Act
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, 3, result.Data["LOG"])
assert.Equal(t, 3, result.Count)
})
t.Run("Eitherize1 with different input and output types", func(t *testing.T) {
// Arrange
type Input struct {
ID int
}
type Output struct {
Name string
}
convertFunc := func(cfg TestConfig, ctx context.Context, in Input) (Output, error) {
return Output{Name: fmt.Sprintf("%s-%d", cfg.Prefix, in.ID)}, nil
}
kleisli := Eitherize1(convertFunc)
// Act
eff := kleisli(Input{ID: 99})
result, err := runEffect(eff, testConfig)
// Assert
assert.NoError(t, err)
assert.Equal(t, "LOG-99", result.Name)
})
}

View File

@@ -55,5 +55,7 @@ type (
// It's commonly used for filtering and conditional operations.
Predicate[A any] = predicate.Predicate[A]
// Pair represents a tuple of two values of types L and R.
// It's commonly used to return multiple values from functions or to group related data.
Pair[L, R any] = pair.Pair[L, R]
)

View File

@@ -4,7 +4,7 @@ go 1.24
require (
github.com/stretchr/testify v1.11.1
github.com/urfave/cli/v3 v3.6.2
github.com/urfave/cli/v3 v3.7.0
)
require (

View File

@@ -6,6 +6,8 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/urfave/cli/v3 v3.6.2 h1:lQuqiPrZ1cIz8hz+HcrG0TNZFxU70dPZ3Yl+pSrH9A8=
github.com/urfave/cli/v3 v3.6.2/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
github.com/urfave/cli/v3 v3.7.0 h1:AGSnbUyjtLiM+WJUb4dzXKldl/gL+F8OwmRDtVr6g2U=
github.com/urfave/cli/v3 v3.7.0/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

View File

@@ -23,6 +23,8 @@ import (
"log"
"log/slog"
"sync/atomic"
"github.com/IBM/fp-go/v2/pair"
)
// LoggingCallbacks creates a pair of logging callback functions from the provided loggers.
@@ -128,6 +130,7 @@ var loggerInContextKey loggerInContextType
// logger.Info("Processing request")
// }
func GetLoggerFromContext(ctx context.Context) *slog.Logger {
// using idomatic style to avoid import cycle
value, ok := ctx.Value(loggerInContextKey).(*slog.Logger)
if !ok {
return globalLogger.Load()
@@ -135,9 +138,11 @@ func GetLoggerFromContext(ctx context.Context) *slog.Logger {
return value
}
// WithLogger returns an endomorphism that adds a logger to a context.
// An endomorphism is a function that takes a value and returns a value of the same type.
// This function creates a context transformation that embeds the provided logger.
func noop() {}
// WithLogger returns a Kleisli arrow that adds a logger to a context.
// A Kleisli arrow transforms a context into a ContextCancel pair containing
// a no-op cancel function and the new context with the embedded logger.
//
// This is particularly useful in functional programming patterns where you want to
// compose context transformations, or when working with middleware that needs to
@@ -147,7 +152,7 @@ func GetLoggerFromContext(ctx context.Context) *slog.Logger {
// - l: The *slog.Logger to embed in the context
//
// Returns:
// - An Endomorphism[context.Context] function that adds the logger to a context
// - A Kleisli arrow (function from context.Context to ContextCancel) that adds the logger to a context
//
// Example:
//
@@ -156,13 +161,14 @@ func GetLoggerFromContext(ctx context.Context) *slog.Logger {
//
// // Apply it to a context
// ctx := context.Background()
// ctxWithLogger := addLogger(ctx)
// result := addLogger(ctx)
// ctxWithLogger := pair.Second(result)
//
// // Retrieve the logger later
// logger := GetLoggerFromContext(ctxWithLogger)
// logger.Info("Using context logger")
func WithLogger(l *slog.Logger) Endomorphism[context.Context] {
return func(ctx context.Context) context.Context {
return context.WithValue(ctx, loggerInContextKey, l)
func WithLogger(l *slog.Logger) pair.Kleisli[context.CancelFunc, context.Context, context.Context] {
return func(ctx context.Context) ContextCancel {
return pair.MakePair[context.CancelFunc](noop, context.WithValue(ctx, loggerInContextKey, l))
}
}

View File

@@ -17,10 +17,13 @@ package logging
import (
"bytes"
"context"
"log"
"log/slog"
"strings"
"testing"
"github.com/IBM/fp-go/v2/pair"
S "github.com/IBM/fp-go/v2/string"
)
@@ -288,3 +291,355 @@ func BenchmarkLoggingCallbacks_Logging(b *testing.B) {
infoLog("benchmark message %d", i)
}
}
// TestSetLogger_Success tests setting a new global logger and verifying it returns the old one.
func TestSetLogger_Success(t *testing.T) {
// Save original logger to restore later
originalLogger := GetLogger()
defer SetLogger(originalLogger)
// Create a new logger
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
newLogger := slog.New(handler)
// Set the new logger
oldLogger := SetLogger(newLogger)
// Verify old logger was returned
if oldLogger == nil {
t.Error("Expected SetLogger to return the previous logger")
}
// Verify new logger is now active
currentLogger := GetLogger()
if currentLogger != newLogger {
t.Error("Expected GetLogger to return the newly set logger")
}
}
// TestSetLogger_Multiple tests setting logger multiple times.
func TestSetLogger_Multiple(t *testing.T) {
// Save original logger to restore later
originalLogger := GetLogger()
defer SetLogger(originalLogger)
// Create three loggers
logger1 := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
logger2 := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
logger3 := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
// Set first logger
old1 := SetLogger(logger1)
if GetLogger() != logger1 {
t.Error("Expected logger1 to be active")
}
// Set second logger
old2 := SetLogger(logger2)
if old2 != logger1 {
t.Error("Expected SetLogger to return logger1")
}
if GetLogger() != logger2 {
t.Error("Expected logger2 to be active")
}
// Set third logger
old3 := SetLogger(logger3)
if old3 != logger2 {
t.Error("Expected SetLogger to return logger2")
}
if GetLogger() != logger3 {
t.Error("Expected logger3 to be active")
}
// Restore to original
restored := SetLogger(old1)
if restored != logger3 {
t.Error("Expected SetLogger to return logger3")
}
}
// TestGetLogger_Default tests that GetLogger returns a valid logger by default.
func TestGetLogger_Default(t *testing.T) {
logger := GetLogger()
if logger == nil {
t.Error("Expected GetLogger to return a non-nil logger")
}
// Verify it's usable
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
testLogger := slog.New(handler)
oldLogger := SetLogger(testLogger)
defer SetLogger(oldLogger)
GetLogger().Info("test message")
if !strings.Contains(buf.String(), "test message") {
t.Errorf("Expected logger to log message, got: %s", buf.String())
}
}
// TestGetLogger_AfterSet tests that GetLogger returns the logger set by SetLogger.
func TestGetLogger_AfterSet(t *testing.T) {
originalLogger := GetLogger()
defer SetLogger(originalLogger)
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
customLogger := slog.New(handler)
SetLogger(customLogger)
retrievedLogger := GetLogger()
if retrievedLogger != customLogger {
t.Error("Expected GetLogger to return the custom logger")
}
// Verify it's the same instance by logging
retrievedLogger.Info("test")
if !strings.Contains(buf.String(), "test") {
t.Error("Expected retrieved logger to be the same instance")
}
}
// TestGetLoggerFromContext_WithLogger tests retrieving a logger from context.
func TestGetLoggerFromContext_WithLogger(t *testing.T) {
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
contextLogger := slog.New(handler)
// Create context with logger using WithLogger
ctx := context.Background()
kleisli := WithLogger(contextLogger)
result := kleisli(ctx)
ctxWithLogger := pair.Second(result)
// Retrieve logger from context
retrievedLogger := GetLoggerFromContext(ctxWithLogger)
if retrievedLogger != contextLogger {
t.Error("Expected to retrieve the context logger")
}
// Verify it's the same instance by logging
retrievedLogger.Info("context test")
if !strings.Contains(buf.String(), "context test") {
t.Error("Expected retrieved logger to be the same instance")
}
}
// TestGetLoggerFromContext_WithoutLogger tests that it returns global logger when context has no logger.
func TestGetLoggerFromContext_WithoutLogger(t *testing.T) {
originalLogger := GetLogger()
defer SetLogger(originalLogger)
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
globalLogger := slog.New(handler)
SetLogger(globalLogger)
// Create context without logger
ctx := context.Background()
// Should return global logger
retrievedLogger := GetLoggerFromContext(ctx)
if retrievedLogger != globalLogger {
t.Error("Expected to retrieve the global logger when context has no logger")
}
// Verify it's the same instance
retrievedLogger.Info("global test")
if !strings.Contains(buf.String(), "global test") {
t.Error("Expected retrieved logger to be the global logger")
}
}
// TestGetLoggerFromContext_NilContext tests behavior with nil context value.
func TestGetLoggerFromContext_NilContext(t *testing.T) {
originalLogger := GetLogger()
defer SetLogger(originalLogger)
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
globalLogger := slog.New(handler)
SetLogger(globalLogger)
// Create context with wrong type value
ctx := context.WithValue(context.Background(), loggerInContextKey, "not a logger")
// Should return global logger when type assertion fails
retrievedLogger := GetLoggerFromContext(ctx)
if retrievedLogger != globalLogger {
t.Error("Expected to retrieve the global logger when context value is wrong type")
}
}
// TestWithLogger_CreatesContextWithLogger tests that WithLogger adds logger to context.
func TestWithLogger_CreatesContextWithLogger(t *testing.T) {
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
testLogger := slog.New(handler)
// Create Kleisli arrow
kleisli := WithLogger(testLogger)
// Apply to context
ctx := context.Background()
result := kleisli(ctx)
// Verify result is a ContextCancel pair
cancelFunc := pair.First(result)
newCtx := pair.Second(result)
if cancelFunc == nil {
t.Error("Expected cancel function to be non-nil")
}
if newCtx == nil {
t.Error("Expected new context to be non-nil")
}
// Verify logger is in context
retrievedLogger := GetLoggerFromContext(newCtx)
if retrievedLogger != testLogger {
t.Error("Expected logger to be in the new context")
}
}
// TestWithLogger_CancelFuncIsNoop tests that the cancel function is a no-op.
func TestWithLogger_CancelFuncIsNoop(t *testing.T) {
testLogger := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
kleisli := WithLogger(testLogger)
ctx := context.Background()
result := kleisli(ctx)
cancelFunc := pair.First(result)
// Calling cancel should not panic
defer func() {
if r := recover(); r != nil {
t.Errorf("Cancel function panicked: %v", r)
}
}()
cancelFunc()
}
// TestWithLogger_PreservesOriginalContext tests that original context is not modified.
func TestWithLogger_PreservesOriginalContext(t *testing.T) {
originalLogger := GetLogger()
defer SetLogger(originalLogger)
var buf bytes.Buffer
handler := slog.NewTextHandler(&buf, nil)
globalLogger := slog.New(handler)
SetLogger(globalLogger)
testLogger := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
kleisli := WithLogger(testLogger)
// Original context without logger
originalCtx := context.Background()
// Apply transformation
result := kleisli(originalCtx)
newCtx := pair.Second(result)
// Original context should still return global logger
originalCtxLogger := GetLoggerFromContext(originalCtx)
if originalCtxLogger != globalLogger {
t.Error("Expected original context to still use global logger")
}
// New context should have the test logger
newCtxLogger := GetLoggerFromContext(newCtx)
if newCtxLogger != testLogger {
t.Error("Expected new context to have the test logger")
}
}
// TestWithLogger_Composition tests composing multiple WithLogger calls.
func TestWithLogger_Composition(t *testing.T) {
logger1 := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
logger2 := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
kleisli1 := WithLogger(logger1)
kleisli2 := WithLogger(logger2)
ctx := context.Background()
// Apply first transformation
result1 := kleisli1(ctx)
ctx1 := pair.Second(result1)
// Verify first logger
if GetLoggerFromContext(ctx1) != logger1 {
t.Error("Expected first logger in context after first transformation")
}
// Apply second transformation (should override)
result2 := kleisli2(ctx1)
ctx2 := pair.Second(result2)
// Verify second logger (should override first)
if GetLoggerFromContext(ctx2) != logger2 {
t.Error("Expected second logger to override first logger")
}
}
// BenchmarkSetLogger benchmarks setting the global logger.
func BenchmarkSetLogger(b *testing.B) {
logger := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
b.ResetTimer()
for i := 0; i < b.N; i++ {
SetLogger(logger)
}
}
// BenchmarkGetLogger benchmarks getting the global logger.
func BenchmarkGetLogger(b *testing.B) {
b.ResetTimer()
for i := 0; i < b.N; i++ {
GetLogger()
}
}
// BenchmarkGetLoggerFromContext_WithLogger benchmarks retrieving logger from context.
func BenchmarkGetLoggerFromContext_WithLogger(b *testing.B) {
logger := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
kleisli := WithLogger(logger)
ctx := pair.Second(kleisli(context.Background()))
b.ResetTimer()
for i := 0; i < b.N; i++ {
GetLoggerFromContext(ctx)
}
}
// BenchmarkGetLoggerFromContext_WithoutLogger benchmarks retrieving global logger from context.
func BenchmarkGetLoggerFromContext_WithoutLogger(b *testing.B) {
ctx := context.Background()
b.ResetTimer()
for i := 0; i < b.N; i++ {
GetLoggerFromContext(ctx)
}
}
// BenchmarkWithLogger benchmarks creating context with logger.
func BenchmarkWithLogger(b *testing.B) {
logger := slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil))
kleisli := WithLogger(logger)
ctx := context.Background()
b.ResetTimer()
for i := 0; i < b.N; i++ {
kleisli(ctx)
}
}

View File

@@ -16,7 +16,10 @@
package logging
import (
"context"
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/pair"
)
type (
@@ -39,4 +42,15 @@ type (
// ctx := context.Background()
// newCtx := addLogger(ctx) // Both ctx and newCtx are context.Context
Endomorphism[A any] = endomorphism.Endomorphism[A]
// Pair represents a tuple of two values of types A and B.
// It is used to group two related values together.
Pair[A, B any] = pair.Pair[A, B]
// ContextCancel represents a pair of a cancel function and a context.
// It is used in operations that create new contexts with cancellation capabilities.
//
// The first element is the CancelFunc that should be called to release resources.
// The second element is the new Context that was created.
ContextCancel = Pair[context.CancelFunc, context.Context]
)

52
v2/monoid/types.go Normal file
View File

@@ -0,0 +1,52 @@
// 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 monoid
import "github.com/IBM/fp-go/v2/function"
// Void is an alias for function.Void, representing the unit type.
//
// The Void type (also known as Unit in functional programming) has exactly one value,
// making it useful for representing the absence of meaningful information. It's similar
// to void in other languages, but as a value rather than the absence of a value.
//
// This type alias is provided in the monoid package for convenience when working with
// VoidMonoid and other monoid operations that may use the unit type.
//
// Common use cases:
// - As a return type for functions that perform side effects but don't return meaningful data
// - As a placeholder type parameter when a type is required but no data needs to be passed
// - In monoid operations where you need to track that operations occurred without caring about results
//
// See also:
// - function.Void: The underlying type definition
// - function.VOID: The single inhabitant of the Void type
// - VoidMonoid: A monoid instance for the Void type
//
// Example:
//
// // Function that performs an action but returns no meaningful data
// func logMessage(msg string) Void {
// fmt.Println(msg)
// return function.VOID
// }
//
// // Using Void in monoid operations
// m := VoidMonoid()
// result := m.Concat(function.VOID, function.VOID) // function.VOID
type (
Void = function.Void
)

65
v2/monoid/void.go Normal file
View File

@@ -0,0 +1,65 @@
// 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 monoid
import (
"github.com/IBM/fp-go/v2/function"
S "github.com/IBM/fp-go/v2/semigroup"
)
// VoidMonoid creates a Monoid for the Void (unit) type.
//
// The Void type has exactly one value (function.VOID), making it trivial to define
// a monoid. This monoid uses the Last semigroup, which always returns the second
// argument, though since all Void values are identical, the choice of semigroup
// doesn't affect the result.
//
// This monoid is useful in contexts where:
// - A monoid instance is required but no meaningful data needs to be combined
// - You need to track that an operation occurred without caring about its result
// - Building generic abstractions that work with any monoid, including the trivial case
//
// # Monoid Laws
//
// The VoidMonoid satisfies all monoid laws trivially:
// - Associativity: Concat(Concat(x, y), z) = Concat(x, Concat(y, z)) - always VOID
// - Left Identity: Concat(Empty(), x) = x - always VOID
// - Right Identity: Concat(x, Empty()) = x - always VOID
//
// Returns:
// - A Monoid[Void] instance
//
// Example:
//
// m := VoidMonoid()
// result := m.Concat(function.VOID, function.VOID) // function.VOID
// empty := m.Empty() // function.VOID
//
// // Useful for tracking operations without data
// type Action = func() Void
// actions := []Action{
// func() Void { fmt.Println("Action 1"); return function.VOID },
// func() Void { fmt.Println("Action 2"); return function.VOID },
// }
// // Execute all actions and combine results
// results := A.Map(func(a Action) Void { return a() })(actions)
// _ = ConcatAll(m)(results) // All actions executed, result is VOID
func VoidMonoid() Monoid[Void] {
return MakeMonoid(
S.Last[Void]().Concat,
function.VOID,
)
}

290
v2/monoid/void_test.go Normal file
View File

@@ -0,0 +1,290 @@
// 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 monoid
import (
"testing"
"github.com/IBM/fp-go/v2/function"
"github.com/stretchr/testify/assert"
)
// TestVoidMonoid_Basic tests basic VoidMonoid functionality
func TestVoidMonoid_Basic(t *testing.T) {
m := VoidMonoid()
// Test Empty returns VOID
empty := m.Empty()
assert.Equal(t, function.VOID, empty)
// Test Concat returns VOID (since all Void values are identical)
result := m.Concat(function.VOID, function.VOID)
assert.Equal(t, function.VOID, result)
}
// TestVoidMonoid_Laws verifies VoidMonoid satisfies monoid laws
func TestVoidMonoid_Laws(t *testing.T) {
m := VoidMonoid()
// Since Void has only one value, we test with that value
v := function.VOID
// Left Identity: Concat(Empty(), x) = x
t.Run("left identity", func(t *testing.T) {
result := m.Concat(m.Empty(), v)
assert.Equal(t, v, result, "Left identity law failed")
})
// Right Identity: Concat(x, Empty()) = x
t.Run("right identity", func(t *testing.T) {
result := m.Concat(v, m.Empty())
assert.Equal(t, v, result, "Right identity law failed")
})
// Associativity: Concat(Concat(x, y), z) = Concat(x, Concat(y, z))
t.Run("associativity", func(t *testing.T) {
left := m.Concat(m.Concat(v, v), v)
right := m.Concat(v, m.Concat(v, v))
assert.Equal(t, left, right, "Associativity law failed")
})
// All results should be VOID
t.Run("all operations return VOID", func(t *testing.T) {
assert.Equal(t, function.VOID, m.Concat(v, v))
assert.Equal(t, function.VOID, m.Empty())
assert.Equal(t, function.VOID, m.Concat(m.Empty(), v))
assert.Equal(t, function.VOID, m.Concat(v, m.Empty()))
})
}
// TestVoidMonoid_ConcatAll tests combining multiple Void values
func TestVoidMonoid_ConcatAll(t *testing.T) {
m := VoidMonoid()
concatAll := ConcatAll(m)
tests := []struct {
name string
input []Void
expected Void
}{
{
name: "empty slice",
input: []Void{},
expected: function.VOID,
},
{
name: "single element",
input: []Void{function.VOID},
expected: function.VOID,
},
{
name: "multiple elements",
input: []Void{function.VOID, function.VOID, function.VOID},
expected: function.VOID,
},
{
name: "many elements",
input: make([]Void, 100),
expected: function.VOID,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Initialize slice with VOID values
for i := range tt.input {
tt.input[i] = function.VOID
}
result := concatAll(tt.input)
assert.Equal(t, tt.expected, result)
})
}
}
// TestVoidMonoid_Fold tests the Fold function with VoidMonoid
func TestVoidMonoid_Fold(t *testing.T) {
m := VoidMonoid()
fold := Fold(m)
// Fold should behave identically to ConcatAll
voids := []Void{function.VOID, function.VOID, function.VOID}
result := fold(voids)
assert.Equal(t, function.VOID, result)
// Empty fold
emptyResult := fold([]Void{})
assert.Equal(t, function.VOID, emptyResult)
}
// TestVoidMonoid_Reverse tests that Reverse doesn't affect VoidMonoid
func TestVoidMonoid_Reverse(t *testing.T) {
m := VoidMonoid()
reversed := Reverse(m)
// Since all Void values are identical, reverse should have no effect
v := function.VOID
assert.Equal(t, m.Concat(v, v), reversed.Concat(v, v))
assert.Equal(t, m.Empty(), reversed.Empty())
// Test identity laws still hold
assert.Equal(t, v, reversed.Concat(reversed.Empty(), v))
assert.Equal(t, v, reversed.Concat(v, reversed.Empty()))
}
// TestVoidMonoid_ToSemigroup tests conversion to Semigroup
func TestVoidMonoid_ToSemigroup(t *testing.T) {
m := VoidMonoid()
sg := ToSemigroup(m)
// Should work as a semigroup
result := sg.Concat(function.VOID, function.VOID)
assert.Equal(t, function.VOID, result)
// Verify it's the same underlying operation
assert.Equal(t, m.Concat(function.VOID, function.VOID), sg.Concat(function.VOID, function.VOID))
}
// TestVoidMonoid_FunctionMonoid tests VoidMonoid with FunctionMonoid
func TestVoidMonoid_FunctionMonoid(t *testing.T) {
m := VoidMonoid()
funcMonoid := FunctionMonoid[string](m)
// Create functions that return Void
f1 := func(s string) Void { return function.VOID }
f2 := func(s string) Void { return function.VOID }
// Combine functions
combined := funcMonoid.Concat(f1, f2)
// Test combined function
result := combined("test")
assert.Equal(t, function.VOID, result)
// Test empty function
emptyFunc := funcMonoid.Empty()
assert.Equal(t, function.VOID, emptyFunc("anything"))
}
// TestVoidMonoid_PracticalUsage demonstrates practical usage patterns
func TestVoidMonoid_PracticalUsage(t *testing.T) {
m := VoidMonoid()
// Simulate tracking that operations occurred without caring about results
type Action func() Void
actions := []Action{
func() Void { return function.VOID }, // Action 1
func() Void { return function.VOID }, // Action 2
func() Void { return function.VOID }, // Action 3
}
// Execute all actions and collect results
results := make([]Void, len(actions))
for i, action := range actions {
results[i] = action()
}
// Combine all results (all are VOID)
finalResult := ConcatAll(m)(results)
assert.Equal(t, function.VOID, finalResult)
}
// TestVoidMonoid_EdgeCases tests edge cases
func TestVoidMonoid_EdgeCases(t *testing.T) {
m := VoidMonoid()
t.Run("multiple concatenations", func(t *testing.T) {
// Chain multiple Concat operations
result := m.Concat(
m.Concat(
m.Concat(function.VOID, function.VOID),
function.VOID,
),
function.VOID,
)
assert.Equal(t, function.VOID, result)
})
t.Run("concat with empty", func(t *testing.T) {
// Various combinations with Empty()
assert.Equal(t, function.VOID, m.Concat(m.Empty(), m.Empty()))
assert.Equal(t, function.VOID, m.Concat(m.Concat(m.Empty(), function.VOID), m.Empty()))
})
t.Run("large slice", func(t *testing.T) {
// Test with a large number of elements
largeSlice := make([]Void, 10000)
for i := range largeSlice {
largeSlice[i] = function.VOID
}
result := ConcatAll(m)(largeSlice)
assert.Equal(t, function.VOID, result)
})
}
// TestVoidMonoid_TypeSafety verifies type safety
func TestVoidMonoid_TypeSafety(t *testing.T) {
m := VoidMonoid()
// Verify it implements Monoid interface
var _ Monoid[Void] = m
// Verify Empty returns correct type
empty := m.Empty()
var _ Void = empty
// Verify Concat returns correct type
result := m.Concat(function.VOID, function.VOID)
var _ Void = result
}
// BenchmarkVoidMonoid_Concat benchmarks the Concat operation
func BenchmarkVoidMonoid_Concat(b *testing.B) {
m := VoidMonoid()
v := function.VOID
b.ResetTimer()
for b.Loop() {
_ = m.Concat(v, v)
}
}
// BenchmarkVoidMonoid_ConcatAll benchmarks combining multiple Void values
func BenchmarkVoidMonoid_ConcatAll(b *testing.B) {
m := VoidMonoid()
concatAll := ConcatAll(m)
voids := make([]Void, 1000)
for i := range voids {
voids[i] = function.VOID
}
b.ResetTimer()
for b.Loop() {
_ = concatAll(voids)
}
}
// BenchmarkVoidMonoid_Empty benchmarks the Empty operation
func BenchmarkVoidMonoid_Empty(b *testing.B) {
m := VoidMonoid()
b.ResetTimer()
for b.Loop() {
_ = m.Empty()
}
}

505
v2/optics/codec/bind.go Normal file
View File

@@ -0,0 +1,505 @@
// 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/optics/codec/validate"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/semigroup"
)
// Do creates the initial empty codec to be used as the starting point for
// do-notation style codec construction.
//
// This is the entry point for building up a struct codec field-by-field using
// the applicative and monadic sequencing operators ApSL, ApSO, and Bind.
// It wraps Empty and lifts a lazily-evaluated default Pair[O, A] into a
// Type[A, O, I] that ignores its input and always succeeds with the default value.
//
// # Type Parameters
//
// - I: The input type for decoding (what the codec reads from)
// - A: The target struct type being built up (what the codec decodes to)
// - O: The output type for encoding (what the codec writes to)
//
// # Parameters
//
// - e: A Lazy[Pair[O, A]] providing the initial default values:
// - pair.Head(e()): The default encoded output O (e.g. an empty monoid value)
// - pair.Tail(e()): The initial zero value of the struct A (e.g. MyStruct{})
//
// # Returns
//
// - A Type[A, O, I] that always decodes to the default A and encodes to the
// default O, regardless of input. This is then transformed by chaining
// ApSL, ApSO, or Bind operators to add fields one by one.
//
// # Example Usage
//
// Building a struct codec using do-notation style:
//
// import (
// "github.com/IBM/fp-go/v2/function"
// "github.com/IBM/fp-go/v2/lazy"
// "github.com/IBM/fp-go/v2/optics/codec"
// "github.com/IBM/fp-go/v2/optics/lens"
// "github.com/IBM/fp-go/v2/pair"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// type Person struct {
// Name string
// Age int
// }
//
// nameLens := lens.MakeLens(
// func(p Person) string { return p.Name },
// func(p Person, name string) Person { p.Name = name; return p },
// )
// ageLens := lens.MakeLens(
// func(p Person) int { return p.Age },
// func(p Person, age int) Person { p.Age = age; return p },
// )
//
// personCodec := F.Pipe2(
// codec.Do[any, Person, string](lazy.Of(pair.MakePair("", Person{}))),
// codec.ApSL(S.Monoid, nameLens, codec.String()),
// codec.ApSL(S.Monoid, ageLens, codec.Int()),
// )
//
// # Notes
//
// - Do is typically the first call in a codec pipeline, followed by ApSL, ApSO, or Bind
// - The lazy pair should use the monoid's empty value for O and the zero value for A
// - For convenience, use Struct to create the initial codec for named struct types
//
// # See Also
//
// - Empty: The underlying codec constructor that Do delegates to
// - ApSL: Applicative sequencing for required struct fields via Lens
// - ApSO: Applicative sequencing for optional struct fields via Optional
// - Bind: Monadic sequencing for context-dependent field codecs
//
//go:inline
func Do[I, A, O any](e Lazy[Pair[O, A]]) Type[A, O, I] {
return Empty[I](e)
}
// ApSL creates an applicative sequencing operator for codecs using a lens.
//
// This function implements the "ApS" (Applicative Sequencing) pattern for codecs,
// allowing you to build up complex codecs by combining a base codec with a field
// accessed through a lens. It's particularly useful for building struct codecs
// field-by-field in a composable way.
//
// The function combines:
// - Encoding: Extracts the field value using the lens, encodes it with fa, and
// combines it with the base encoding using the monoid
// - Validation: Validates the field using the lens and combines the validation
// with the base validation
//
// # Type Parameters
//
// - S: The source struct type (what we're building a codec for)
// - T: The field type accessed by the lens
// - O: The output type for encoding (must have a monoid)
// - I: The input type for decoding
//
// # Parameters
//
// - m: A Monoid[O] for combining encoded outputs
// - l: A Lens[S, T] that focuses on a specific field in S
// - fa: A Type[T, O, I] codec for the field type T
//
// # Returns
//
// An Operator[S, S, O, I] that transforms a base codec by adding the field
// specified by the lens.
//
// # How It Works
//
// 1. **Encoding**: When encoding a value of type S:
// - Extract the field T using l.Get
// - Encode T to O using fa.Encode
// - Combine with the base encoding using the monoid
//
// 2. **Validation**: When validating input I:
// - Validate the field using fa.Validate through the lens
// - Combine with the base validation
//
// 3. **Type Checking**: Preserves the base type checker
//
// # Example
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec"
// "github.com/IBM/fp-go/v2/optics/lens"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// type Person struct {
// Name string
// Age int
// }
//
// // Lenses for Person fields
// nameLens := lens.MakeLens(
// func(p *Person) string { return p.Name },
// func(p *Person, name string) *Person { p.Name = name; return p },
// )
//
// // Build a Person codec field by field
// personCodec := F.Pipe1(
// codec.Struct[Person]("Person"),
// codec.ApSL(S.Monoid, nameLens, codec.String),
// // ... add more fields
// )
//
// # Use Cases
//
// - Building struct codecs incrementally
// - Composing codecs for nested structures
// - Creating type-safe serialization/deserialization
// - Implementing Do-notation style codec construction
//
// # Notes
//
// - The monoid determines how encoded outputs are combined
// - The lens must be total (handle all cases safely)
// - This is typically used with other ApS functions to build complete codecs
// - The name is automatically generated for debugging purposes
//
// See also:
// - validate.ApSL: The underlying validation combinator
// - reader.ApplicativeMonoid: The monoid-based applicative instance
// - Lens: The optic for accessing struct fields
func ApSL[S, T, O, I any](
m Monoid[O],
l Lens[S, T],
fa Type[T, O, I],
) Operator[S, S, O, I] {
name := fmt.Sprintf("ApS[%s x %s]", l, fa)
rm := reader.ApplicativeMonoid[S](m)
encConcat := F.Pipe1(
F.Flow2(
l.Get,
fa.Encode,
),
semigroup.AppendTo(rm),
)
valConcat := validate.ApSL(l, fa.Validate)
return func(t Type[S, O, I]) Type[S, O, I] {
return MakeType(
name,
t.Is,
F.Pipe1(
t.Validate,
valConcat,
),
encConcat(t.Encode),
)
}
}
// ApSO creates an applicative sequencing operator for codecs using an optional.
//
// This function implements the "ApS" (Applicative Sequencing) pattern for codecs
// with optional fields, allowing you to build up complex codecs by combining a base
// codec with a field that may or may not be present. It's particularly useful for
// building struct codecs with optional fields in a composable way.
//
// The function combines:
// - Encoding: Attempts to extract the optional field value, encodes it if present,
// and combines it with the base encoding using the monoid. If the field is absent,
// only the base encoding is used.
// - Validation: Validates the optional field and combines the validation with the
// base validation using applicative semantics (error accumulation).
//
// # Type Parameters
//
// - S: The source struct type (what we're building a codec for)
// - T: The optional field type accessed by the optional
// - O: The output type for encoding (must have a monoid)
// - I: The input type for decoding
//
// # Parameters
//
// - m: A Monoid[O] for combining encoded outputs
// - o: An Optional[S, T] that focuses on a field in S that may not exist
// - fa: A Type[T, O, I] codec for the optional field type T
//
// # Returns
//
// An Operator[S, S, O, I] that transforms a base codec by adding the optional field
// specified by the optional.
//
// # How It Works
//
// 1. **Encoding**: When encoding a value of type S:
// - Try to extract the optional field T using o.GetOption
// - If present (Some(T)): Encode T to O using fa.Encode and combine with base using monoid
// - If absent (None): Return only the base encoding unchanged
//
// 2. **Validation**: When validating input I:
// - Validate the optional field using fa.Validate through o.Set
// - Combine with the base validation using applicative semantics
// - Accumulates all validation errors from both base and field
//
// 3. **Type Checking**: Preserves the base type checker
//
// # Difference from ApSL
//
// Unlike ApSL which works with required fields via Lens, ApSO handles optional fields:
// - ApSL: Field always exists, always encoded
// - ApSO: Field may not exist, only encoded when present
// - ApSO uses Optional.GetOption which returns Option[T]
// - ApSO gracefully handles missing fields without errors
//
// # Example
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec"
// "github.com/IBM/fp-go/v2/optics/optional"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// type Person struct {
// Name string
// Nickname *string // Optional field
// }
//
// // Optional for Person.Nickname
// nicknameOpt := optional.MakeOptional(
// func(p Person) option.Option[string] {
// if p.Nickname != nil {
// return option.Some(*p.Nickname)
// }
// return option.None[string]()
// },
// func(p Person, nick string) Person {
// p.Nickname = &nick
// return p
// },
// )
//
// // Build a Person codec with optional nickname
// personCodec := F.Pipe1(
// codec.Struct[Person]("Person"),
// codec.ApSO(S.Monoid, nicknameOpt, codec.String),
// )
//
// // Encoding with nickname present
// p1 := Person{Name: "Alice", Nickname: ptr("Ali")}
// encoded1 := personCodec.Encode(p1) // Includes nickname
//
// // Encoding with nickname absent
// p2 := Person{Name: "Bob", Nickname: nil}
// encoded2 := personCodec.Encode(p2) // No nickname in output
//
// # Use Cases
//
// - Building struct codecs with optional/nullable fields
// - Handling pointer fields that may be nil
// - Composing codecs for structures with optional nested data
// - Creating flexible serialization that omits absent fields
//
// # Notes
//
// - The monoid determines how encoded outputs are combined when field is present
// - When the optional field is absent, encoding returns base encoding unchanged
// - Validation still accumulates errors even for optional fields
// - The name is automatically generated for debugging purposes
//
// # See Also
//
// - ApSL: For required fields using Lens
// - validate.ApS: The underlying validation combinator
// - Optional: The optic for accessing optional fields
func ApSO[S, T, O, I any](
m Monoid[O],
o Optional[S, T],
fa Type[T, O, I],
) Operator[S, S, O, I] {
name := fmt.Sprintf("ApS[%s x %s]", o, fa)
encConcat := F.Flow2(
o.GetOption,
option.Map(F.Flow2(
fa.Encode,
semigroup.AppendTo(m),
)),
)
valConcat := validate.ApS(o.Set, fa.Validate)
return func(t Type[S, O, I]) Type[S, O, I] {
return MakeType(
name,
t.Is,
F.Pipe1(
t.Validate,
valConcat,
),
func(s S) O {
to := t.Encode(s)
return F.Pipe2(
encConcat(s),
option.Flap[O](to),
option.GetOrElse(lazy.Of(to)),
)
},
)
}
}
// Bind creates a monadic sequencing operator for codecs using a lens and a Kleisli arrow.
//
// This function implements the "Bind" (monadic bind / chain) pattern for codecs,
// allowing you to build up complex codecs where the codec for a field depends on
// the current decoded value of the struct. Unlike ApSL which uses a fixed field
// codec, Bind accepts a Kleisli arrow — a function from the current struct value S
// to a Type[T, O, I] — enabling context-sensitive codec construction.
//
// The function combines:
// - Encoding: Evaluates the Kleisli arrow f on the current struct value s to obtain
// the field codec, extracts the field T using the lens, encodes it with that codec,
// and combines it with the base encoding using the monoid.
// - Validation: Validates the base struct first (monadic sequencing), then uses the
// Kleisli arrow to obtain the field codec for the decoded struct value, and validates
// the field through the lens. Errors are propagated but NOT accumulated (fail-fast
// semantics, unlike ApSL which accumulates errors).
//
// # Type Parameters
//
// - S: The source struct type (what we're building a codec for)
// - T: The field type accessed by the lens
// - O: The output type for encoding (must have a monoid)
// - I: The input type for decoding
//
// # Parameters
//
// - m: A Monoid[O] for combining encoded outputs
// - l: A Lens[S, T] that focuses on a specific field in S
// - f: A Kleisli[S, T, O, I] — a function from S to Type[T, O, I] — that produces
// the field codec based on the current struct value
//
// # Returns
//
// An Operator[S, S, O, I] that transforms a base codec by adding the field
// specified by the lens, where the field codec is determined by the Kleisli arrow.
//
// # How It Works
//
// 1. **Encoding**: When encoding a value of type S:
// - Evaluate f(s) to obtain the field codec fa
// - Extract the field T using l.Get
// - Encode T to O using fa.Encode
// - Combine with the base encoding using the monoid
//
// 2. **Validation**: When validating input I:
// - Run the base validation to obtain a decoded S (fail-fast: stop on base failure)
// - For the decoded S, evaluate f(s) to obtain the field codec fa
// - Validate the input I using fa.Validate
// - Set the validated T into S using l.Set
//
// 3. **Type Checking**: Preserves the base type checker
//
// # Difference from ApSL
//
// Unlike ApSL which uses a fixed field codec:
// - ApSL: Field codec is fixed at construction time; errors are accumulated
// - Bind: Field codec depends on the current struct value (Kleisli arrow); validation
// uses monadic sequencing (fail-fast on base failure)
// - Bind is more powerful but less parallel than ApSL
//
// # Example
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec"
// "github.com/IBM/fp-go/v2/optics/lens"
// S "github.com/IBM/fp-go/v2/string"
// )
//
// type Config struct {
// Mode string
// Value int
// }
//
// modeLens := lens.MakeLens(
// func(c Config) string { return c.Mode },
// func(c Config, mode string) Config { c.Mode = mode; return c },
// )
//
// // Build a Config codec where the Value codec depends on the Mode
// configCodec := F.Pipe1(
// codec.Struct[Config]("Config"),
// codec.Bind(S.Monoid, modeLens, func(c Config) codec.Type[string, string, any] {
// return codec.String()
// }),
// )
//
// # Use Cases
//
// - Building codecs where a field's codec depends on another field's value
// - Implementing discriminated unions or tagged variants
// - Context-sensitive validation (e.g., validate field B differently based on field A)
// - Dependent type-like patterns in codec construction
//
// # Notes
//
// - The monoid determines how encoded outputs are combined
// - The lens must be total (handle all cases safely)
// - Validation uses monadic (fail-fast) sequencing: if the base codec fails,
// the Kleisli arrow is never evaluated
// - The name is automatically generated for debugging purposes
//
// See also:
// - ApSL: Applicative sequencing with a fixed lens codec (error accumulation)
// - Kleisli: The function type from S to Type[T, O, I]
// - validate.Bind: The underlying validate-level bind combinator
func Bind[S, T, O, I any](
m Monoid[O],
l Lens[S, T],
f Kleisli[S, T, O, I],
) Operator[S, S, O, I] {
name := fmt.Sprintf("Bind[%s]", l)
val := F.Curry2(Type[T, O, I].Validate)
return func(t Type[S, O, I]) Type[S, O, I] {
return MakeType(
name,
t.Is,
F.Pipe1(
t.Validate,
validate.Bind(l.Set, F.Flow2(f, val)),
),
func(s S) O {
return m.Concat(t.Encode(s), f(s).Encode(l.Get(s)))
},
)
}
}

1401
v2/optics/codec/bind_test.go Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -11,6 +11,7 @@ import (
"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"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/reader"
@@ -100,7 +101,7 @@ func (t *typeImpl[A, O, I]) Is(i any) Result[A] {
// stringToInt := codec.MakeType(...) // Type[int, string, string]
// intToPositive := codec.MakeType(...) // Type[PositiveInt, int, int]
// composed := codec.Pipe(intToPositive)(stringToInt) // Type[PositiveInt, string, string]
func Pipe[A, B, O, I any](ab Type[B, A, A]) func(Type[A, O, I]) Type[B, O, I] {
func Pipe[O, I, A, B any](ab Type[B, A, A]) Operator[A, B, O, I] {
return func(this Type[A, O, I]) Type[B, O, I] {
return MakeType(
fmt.Sprintf("Pipe(%s, %s)", this.Name(), ab.Name()),
@@ -747,3 +748,114 @@ func FromRefinement[A, B any](refinement Refinement[A, B]) Type[B, A, A] {
refinement.ReverseGet,
)
}
// Empty creates a Type codec that ignores input during decoding and uses a default value,
// and ignores the value during encoding, using a default output.
//
// This codec is useful for:
// - Providing default values for optional fields
// - Creating placeholder codecs in generic contexts
// - Implementing constant codecs that always produce the same value
// - Building codecs for phantom types or unit-like types
//
// The codec uses a lazily-evaluated Pair[O, A] to provide both the default output
// for encoding and the default value for decoding. The lazy evaluation ensures that
// the defaults are only computed when needed.
//
// # 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, but is ignored)
//
// # Parameters
//
// - e: A Lazy[Pair[O, A]] that provides the default values:
// - pair.Head(e()): The default output value O used during encoding
// - pair.Tail(e()): The default decoded value A used during decoding
//
// # Returns
//
// - A Type[A, O, I] that:
// - Decode: Always succeeds and returns the default value A, ignoring input I
// - Encode: Always returns the default output O, ignoring the input value A
// - Is: Checks if a value is of type A (standard type checking)
// - Name: Returns "Empty"
//
// # Behavior
//
// Decoding:
// - Ignores the input value completely
// - Always succeeds with validation.Success
// - Returns the default value from pair.Tail(e())
//
// Encoding:
// - Ignores the input value completely
// - Always returns the default output from pair.Head(e())
//
// # Example Usage
//
// Creating a codec with default values:
//
// // Create a codec that always decodes to 42 and encodes to "default"
// defaultCodec := codec.Empty[int, string, any](lazy.Of(pair.MakePair("default", 42)))
//
// // Decode always returns 42, regardless of input
// result := defaultCodec.Decode("anything") // Success: Right(42)
// result = defaultCodec.Decode(123) // Success: Right(42)
// result = defaultCodec.Decode(nil) // Success: Right(42)
//
// // Encode always returns "default", regardless of input
// encoded := defaultCodec.Encode(100) // Returns: "default"
// encoded = defaultCodec.Encode(0) // Returns: "default"
//
// Using with struct fields for default values:
//
// type Config struct {
// Timeout int
// Retries int
// }
//
// // Codec that provides default retries value
// defaultRetries := codec.Empty[int, int, any](lazy.Of(pair.MakePair(3, 3)))
//
// configCodec := F.Pipe2(
// codec.Struct[Config]("Config"),
// codec.ApSL(S.Monoid, timeoutLens, codec.Int()),
// codec.ApSL(S.Monoid, retriesLens, defaultRetries),
// )
//
// Creating a unit-like codec:
//
// // Codec for a unit type that always produces Void
// unitCodec := codec.Empty[function.Void, function.Void, any](
// lazy.Of(pair.MakePair(function.VOID, function.VOID)),
// )
//
// # Use Cases
//
// - Default values: Provide fallback values when decoding optional fields
// - Constant codecs: Always produce the same value regardless of input
// - Placeholder codecs: Use in generic contexts where a codec is required but not used
// - Unit types: Encode/decode unit-like types that carry no information
// - Testing: Create simple codecs for testing codec composition
//
// # Notes
//
// - The lazy evaluation of the Pair ensures defaults are only computed when needed
// - Both encoding and decoding always succeed (no validation errors)
// - The input values are completely ignored in both directions
// - The Is method still performs standard type checking for type A
// - This codec is useful in applicative composition where some fields have defaults
//
// See also:
// - Id: For identity codecs that preserve values
// - MakeType: For creating custom codecs with validation logic
func Empty[I, A, O any](e Lazy[Pair[O, A]]) Type[A, O, I] {
return MakeType(
"Empty",
Is[A](),
validate.OfLazy[I](F.Pipe1(e, lazy.Map(pair.Tail[O, A]))),
reader.OfLazy[A](F.Pipe1(e, lazy.Map(pair.Head[O, A]))),
)
}

View File

@@ -7,9 +7,11 @@ import (
"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/validation"
"github.com/IBM/fp-go/v2/optics/prism"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/pair"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -19,12 +21,7 @@ func TestString(t *testing.T) {
stringType := String()
result := stringType.Decode("hello")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "hello", value)
assert.Equal(t, validation.Of("hello"), result)
})
t.Run("fails to decode non-string", func(t *testing.T) {
@@ -57,12 +54,7 @@ func TestString(t *testing.T) {
stringType := String()
result := stringType.Decode("")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) string { return "error" },
F.Identity[string],
)
assert.Equal(t, "", value)
assert.Equal(t, validation.Of(""), result)
})
}
@@ -71,12 +63,7 @@ func TestInt(t *testing.T) {
intType := Int()
result := intType.Decode(42)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
assert.Equal(t, validation.Of(42), result)
})
t.Run("fails to decode string as int", func(t *testing.T) {
@@ -109,24 +96,14 @@ func TestInt(t *testing.T) {
intType := Int()
result := intType.Decode(-42)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, -42, value)
assert.Equal(t, validation.Of(-42), result)
})
t.Run("decodes zero", func(t *testing.T) {
intType := Int()
result := intType.Decode(0)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
assert.Equal(t, validation.Of(0), result)
})
}
@@ -135,24 +112,14 @@ func TestBool(t *testing.T) {
boolType := Bool()
result := boolType.Decode(true)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) bool { return false },
F.Identity[bool],
)
assert.Equal(t, true, value)
assert.Equal(t, validation.Of(true), result)
})
t.Run("decodes false", func(t *testing.T) {
boolType := Bool()
result := boolType.Decode(false)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) bool { return true },
F.Identity[bool],
)
assert.Equal(t, false, value)
assert.Equal(t, validation.Of(false), result)
})
t.Run("fails to decode int as bool", func(t *testing.T) {
@@ -189,36 +156,21 @@ func TestArray(t *testing.T) {
intArray := Array(Int())
result := intArray.Decode([]int{1, 2, 3})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{1, 2, 3}, value)
assert.Equal(t, validation.Of([]int{1, 2, 3}), result)
})
t.Run("decodes valid string array", func(t *testing.T) {
stringArray := Array(String())
result := stringArray.Decode([]string{"a", "b", "c"})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []string { return nil },
F.Identity[[]string],
)
assert.Equal(t, []string{"a", "b", "c"}, value)
assert.Equal(t, validation.Of([]string{"a", "b", "c"}), result)
})
t.Run("decodes empty array", func(t *testing.T) {
intArray := Array(Int())
result := intArray.Decode([]int{})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{}, value)
assert.Equal(t, validation.Of([]int{}), result)
})
t.Run("fails when array contains invalid element", func(t *testing.T) {
@@ -256,12 +208,7 @@ func TestArray(t *testing.T) {
nestedArray := Array(Array(Int()))
result := nestedArray.Decode([][]int{{1, 2}, {3, 4}})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) [][]int { return nil },
F.Identity[[][]int],
)
assert.Equal(t, [][]int{{1, 2}, {3, 4}}, value)
assert.Equal(t, validation.Of([][]int{{1, 2}, {3, 4}}), result)
})
t.Run("fails to decode non-iterable", func(t *testing.T) {
@@ -275,12 +222,7 @@ func TestArray(t *testing.T) {
boolArray := Array(Bool())
result := boolArray.Decode([]bool{true, false, true})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []bool { return nil },
F.Identity[[]bool],
)
assert.Equal(t, []bool{true, false, true}, value)
assert.Equal(t, validation.Of([]bool{true, false, true}), result)
})
t.Run("collects multiple validation errors", func(t *testing.T) {
@@ -360,24 +302,14 @@ func TestTranscodeArray(t *testing.T) {
intTranscode := TranscodeArray(Int())
result := intTranscode.Decode([]any{1, 2, 3})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{1, 2, 3}, value)
assert.Equal(t, validation.Of([]int{1, 2, 3}), result)
})
t.Run("decodes valid string array from string slice", func(t *testing.T) {
stringTranscode := TranscodeArray(String())
result := stringTranscode.Decode([]any{"a", "b", "c"})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []string { return nil },
F.Identity[[]string],
)
assert.Equal(t, []string{"a", "b", "c"}, value)
assert.Equal(t, validation.Of([]string{"a", "b", "c"}), result)
})
t.Run("decodes empty array", func(t *testing.T) {
@@ -411,24 +343,14 @@ func TestTranscodeArray(t *testing.T) {
nestedTranscode := TranscodeArray(TranscodeArray(Int()))
result := nestedTranscode.Decode([][]any{{1, 2}, {3, 4}})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) [][]int { return nil },
F.Identity[[][]int],
)
assert.Equal(t, [][]int{{1, 2}, {3, 4}}, value)
assert.Equal(t, validation.Of([][]int{{1, 2}, {3, 4}}), result)
})
t.Run("decodes array of bools", func(t *testing.T) {
boolTranscode := TranscodeArray(Bool())
result := boolTranscode.Decode([]any{true, false, true})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []bool { return nil },
F.Identity[[]bool],
)
assert.Equal(t, []bool{true, false, true}, value)
assert.Equal(t, validation.Of([]bool{true, false, true}), result)
})
t.Run("encodes empty array", func(t *testing.T) {
@@ -481,12 +403,7 @@ func TestTranscodeArrayWithTransformation(t *testing.T) {
arrayTranscode := TranscodeArray(stringToInt)
result := arrayTranscode.Decode([]string{"a", "bb", "ccc"})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{1, 2, 3}, value)
assert.Equal(t, validation.Of([]int{1, 2, 3}), result)
})
t.Run("encodes int slice to string slice", func(t *testing.T) {
@@ -1358,24 +1275,14 @@ func TestId(t *testing.T) {
idCodec := Id[string]()
result := idCodec.Decode("hello")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "hello", value)
assert.Equal(t, validation.Of("hello"), result)
})
t.Run("decodes int successfully", func(t *testing.T) {
idCodec := Id[int]()
result := idCodec.Decode(42)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
assert.Equal(t, 42, value)
assert.Equal(t, validation.Of(42), result)
})
t.Run("encodes with identity function", func(t *testing.T) {
@@ -1431,13 +1338,7 @@ func TestId(t *testing.T) {
person := Person{Name: "Alice", Age: 30}
result := idCodec.Decode(person)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) Person { return Person{} },
F.Identity[Person],
)
assert.Equal(t, person, value)
assert.Equal(t, validation.Of(person), result)
encoded := idCodec.Encode(person)
assert.Equal(t, person, encoded)
@@ -1450,13 +1351,7 @@ func TestIdWithTranscodeArray(t *testing.T) {
arrayCodec := TranscodeArray(intId)
result := arrayCodec.Decode([]int{1, 2, 3, 4, 5})
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{1, 2, 3, 4, 5}, value)
assert.Equal(t, validation.Of([]int{1, 2, 3, 4, 5}), result)
})
t.Run("Id codec encodes array with identity", func(t *testing.T) {
@@ -1473,13 +1368,7 @@ func TestIdWithTranscodeArray(t *testing.T) {
input := [][]int{{1, 2}, {3, 4}, {5}}
result := nestedCodec.Decode(input)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) [][]int { return nil },
F.Identity[[][]int],
)
assert.Equal(t, input, value)
assert.Equal(t, validation.Of(input), result)
})
}
@@ -1748,7 +1637,7 @@ func TestFromRefinementComposition(t *testing.T) {
positiveCodec := FromRefinement(positiveIntPrism)
// Compose with Int codec using Pipe
composed := Pipe[int, int, int, any](positiveCodec)(Int())
composed := Pipe[int, any](positiveCodec)(Int())
t.Run("ComposedDecodeValid", func(t *testing.T) {
result := composed.Decode(42)
@@ -1849,3 +1738,416 @@ func TestFromRefinementValidationContext(t *testing.T) {
assert.Equal(t, -5, err.Value)
})
}
// TestEmpty_Success tests that Empty always succeeds during decoding
func TestEmpty_Success(t *testing.T) {
t.Run("decodes any input to default value", func(t *testing.T) {
defaultCodec := Empty[any, int, string](lazy.Of(pair.MakePair("default", 42)))
// Test with various input types
testCases := []struct {
name string
input any
}{
{"string input", "anything"},
{"int input", 123},
{"nil input", nil},
{"bool input", true},
{"struct input", struct{ X int }{X: 10}},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
result := defaultCodec.Decode(tc.input)
assert.Equal(t, validation.Of(42), result)
})
}
})
t.Run("always returns same default value", func(t *testing.T) {
defaultCodec := Empty[any, string, string](lazy.Of(pair.MakePair("output", "default")))
result1 := defaultCodec.Decode(123)
result2 := defaultCodec.Decode("different")
result3 := defaultCodec.Decode(nil)
assert.True(t, either.IsRight(result1))
assert.True(t, either.IsRight(result2))
assert.True(t, either.IsRight(result3))
value1 := either.MonadFold(result1, func(validation.Errors) string { return "" }, F.Identity[string])
value2 := either.MonadFold(result2, func(validation.Errors) string { return "" }, F.Identity[string])
value3 := either.MonadFold(result3, func(validation.Errors) string { return "" }, F.Identity[string])
assert.Equal(t, "default", value1)
assert.Equal(t, "default", value2)
assert.Equal(t, "default", value3)
})
}
// TestEmpty_Encoding tests that Empty always uses default output during encoding
func TestEmpty_Encoding(t *testing.T) {
t.Run("encodes any value to default output", func(t *testing.T) {
defaultCodec := Empty[any, int, string](lazy.Of(pair.MakePair("default", 42)))
// Test with various input values
testCases := []struct {
name string
input int
}{
{"zero value", 0},
{"positive value", 100},
{"negative value", -50},
{"default value", 42},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
encoded := defaultCodec.Encode(tc.input)
assert.Equal(t, "default", encoded)
})
}
})
t.Run("always returns same default output", func(t *testing.T) {
defaultCodec := Empty[any, string, int](lazy.Of(pair.MakePair(999, "ignored")))
encoded1 := defaultCodec.Encode("value1")
encoded2 := defaultCodec.Encode("value2")
encoded3 := defaultCodec.Encode("")
assert.Equal(t, 999, encoded1)
assert.Equal(t, 999, encoded2)
assert.Equal(t, 999, encoded3)
})
}
// TestEmpty_Name tests that Empty has correct name
func TestEmpty_Name(t *testing.T) {
t.Run("has name 'Empty'", func(t *testing.T) {
defaultCodec := Empty[any, int, int](lazy.Of(pair.MakePair(0, 0)))
assert.Equal(t, "Empty", defaultCodec.Name())
})
}
// TestEmpty_TypeChecking tests that Empty performs standard type checking
func TestEmpty_TypeChecking(t *testing.T) {
t.Run("Is checks for correct type", func(t *testing.T) {
defaultCodec := Empty[any, int, string](lazy.Of(pair.MakePair("default", 42)))
// Should succeed for int
result := defaultCodec.Is(100)
assert.True(t, either.IsRight(result))
// Should fail for non-int
result = defaultCodec.Is("not an int")
assert.True(t, either.IsLeft(result))
})
t.Run("Is checks for string type", func(t *testing.T) {
defaultCodec := Empty[any, string, string](lazy.Of(pair.MakePair("out", "in")))
// Should succeed for string
result := defaultCodec.Is("hello")
assert.True(t, either.IsRight(result))
// Should fail for non-string
result = defaultCodec.Is(123)
assert.True(t, either.IsLeft(result))
})
}
// TestEmpty_LazyEvaluation tests that the Pair parameter allows dynamic values
func TestEmpty_LazyEvaluation(t *testing.T) {
t.Run("lazy pair allows dynamic values", func(t *testing.T) {
counter := 0
lazyPair := func() pair.Pair[int, int] {
counter++
return pair.MakePair(counter, counter*10)
}
defaultCodec := Empty[any, int, int](lazyPair)
// Each decode can get a different value if the lazy function is dynamic
result1 := defaultCodec.Decode("input1")
value1 := either.MonadFold(result1,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
result2 := defaultCodec.Decode("input2")
value2 := either.MonadFold(result2,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
// Values can be different if lazy function produces different results
assert.True(t, value1 > 0)
assert.True(t, value2 > 0)
})
}
// TestEmpty_WithStructs tests Empty with struct types
func TestEmpty_WithStructs(t *testing.T) {
type Config struct {
Timeout int
Retries int
}
t.Run("provides default struct value", func(t *testing.T) {
defaultConfig := Config{Timeout: 30, Retries: 3}
defaultCodec := Empty[any, Config, Config](lazy.Of(pair.MakePair(defaultConfig, defaultConfig)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) Config { return Config{} },
F.Identity[Config],
)
assert.Equal(t, 30, value.Timeout)
assert.Equal(t, 3, value.Retries)
})
t.Run("encodes to default struct", func(t *testing.T) {
defaultConfig := Config{Timeout: 30, Retries: 3}
inputConfig := Config{Timeout: 60, Retries: 5}
defaultCodec := Empty[any, Config, Config](lazy.Of(pair.MakePair(defaultConfig, defaultConfig)))
encoded := defaultCodec.Encode(inputConfig)
assert.Equal(t, 30, encoded.Timeout)
assert.Equal(t, 3, encoded.Retries)
})
}
// TestEmpty_WithPointers tests Empty with pointer types
func TestEmpty_WithPointers(t *testing.T) {
t.Run("provides default pointer value", func(t *testing.T) {
defaultValue := 42
defaultCodec := Empty[any, *int, *int](lazy.Of(pair.MakePair(&defaultValue, &defaultValue)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) *int { return nil },
F.Identity[*int],
)
require.NotNil(t, value)
assert.Equal(t, 42, *value)
})
t.Run("provides nil pointer as default", func(t *testing.T) {
var nilPtr *int
defaultCodec := Empty[any, *int, *int](lazy.Of(pair.MakePair(nilPtr, nilPtr)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) *int { return new(int) },
F.Identity[*int],
)
assert.Nil(t, value)
})
}
// TestEmpty_WithSlices tests Empty with slice types
func TestEmpty_WithSlices(t *testing.T) {
t.Run("provides default slice value", func(t *testing.T) {
defaultSlice := []int{1, 2, 3}
defaultCodec := Empty[any, []int, []int](lazy.Of(pair.MakePair(defaultSlice, defaultSlice)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{1, 2, 3}, value)
})
t.Run("provides empty slice as default", func(t *testing.T) {
emptySlice := []int{}
defaultCodec := Empty[any, []int, []int](lazy.Of(pair.MakePair(emptySlice, emptySlice)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) []int { return nil },
F.Identity[[]int],
)
assert.Equal(t, []int{}, value)
})
}
// TestEmpty_DifferentInputOutput tests Empty with different input and output types
func TestEmpty_DifferentInputOutput(t *testing.T) {
t.Run("decodes to int, encodes to string", func(t *testing.T) {
defaultCodec := Empty[any, int, string](lazy.Of(pair.MakePair("default-output", 42)))
// Decode always returns 42
result := defaultCodec.Decode("any input")
assert.Equal(t, validation.Of(42), result)
// Encode always returns "default-output"
encoded := defaultCodec.Encode(100)
assert.Equal(t, "default-output", encoded)
})
t.Run("decodes to string, encodes to int", func(t *testing.T) {
defaultCodec := Empty[any, string, int](lazy.Of(pair.MakePair(999, "default-value")))
// Decode always returns "default-value"
result := defaultCodec.Decode(123)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) string { return "" },
F.Identity[string],
)
assert.Equal(t, "default-value", value)
// Encode always returns 999
encoded := defaultCodec.Encode("any string")
assert.Equal(t, 999, encoded)
})
}
// TestEmpty_EdgeCases tests edge cases for Empty
func TestEmpty_EdgeCases(t *testing.T) {
t.Run("with zero values", func(t *testing.T) {
defaultCodec := Empty[any, int, int](lazy.Of(pair.MakePair(0, 0)))
result := defaultCodec.Decode("anything")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) int { return -1 },
F.Identity[int],
)
assert.Equal(t, 0, value)
encoded := defaultCodec.Encode(100)
assert.Equal(t, 0, encoded)
})
t.Run("with empty string", func(t *testing.T) {
defaultCodec := Empty[any, string, string](lazy.Of(pair.MakePair("", "")))
result := defaultCodec.Decode("non-empty")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) string { return "error" },
F.Identity[string],
)
assert.Equal(t, "", value)
encoded := defaultCodec.Encode("non-empty")
assert.Equal(t, "", encoded)
})
t.Run("with false boolean", func(t *testing.T) {
defaultCodec := Empty[any, bool, bool](lazy.Of(pair.MakePair(false, false)))
result := defaultCodec.Decode(true)
assert.Equal(t, validation.Of(false), result)
encoded := defaultCodec.Encode(true)
assert.Equal(t, false, encoded)
})
}
// TestEmpty_Integration tests Empty in composition scenarios
func TestEmpty_Integration(t *testing.T) {
t.Run("composes with other codecs using Pipe", func(t *testing.T) {
// Create a codec that always provides a default int
defaultIntCodec := Empty[any, int, int](lazy.Of(pair.MakePair(42, 42)))
// Create a refinement that only accepts positive integers
positiveIntPrism := prism.MakePrismWithName(
func(n int) option.Option[int] {
if n > 0 {
return option.Some(n)
}
return option.None[int]()
},
func(n int) int { return n },
"PositiveInt",
)
positiveCodec := FromRefinement(positiveIntPrism)
// Compose: always decode to 42, then validate it's positive
composed := Pipe[int, any](positiveCodec)(defaultIntCodec)
// Should succeed because 42 is positive
result := composed.Decode("anything")
assert.Equal(t, validation.Of(42), result)
})
t.Run("used as placeholder in generic contexts", func(t *testing.T) {
// Empty can be used where a codec is required but not actually used
unitCodec := Empty[any, Void, Void](
lazy.Of(pair.MakePair(F.VOID, F.VOID)),
)
result := unitCodec.Decode("ignored")
assert.Equal(t, validation.Of(F.VOID), result)
encoded := unitCodec.Encode(F.VOID)
assert.Equal(t, F.VOID, encoded)
})
}
// TestEmpty_RoundTrip tests that Empty maintains consistency
func TestEmpty_RoundTrip(t *testing.T) {
t.Run("decode then encode returns default output", func(t *testing.T) {
defaultCodec := Empty[any, int, string](lazy.Of(pair.MakePair("output", 42)))
// Decode
result := defaultCodec.Decode("input")
require.True(t, either.IsRight(result))
decoded := either.MonadFold(result,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
// Encode
encoded := defaultCodec.Encode(decoded)
// Should get default output, not related to decoded value
assert.Equal(t, "output", encoded)
})
t.Run("multiple round trips are consistent", func(t *testing.T) {
defaultCodec := Empty[any, int, int](lazy.Of(pair.MakePair(100, 50)))
// First round trip
result1 := defaultCodec.Decode("input1")
decoded1 := either.MonadFold(result1,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
encoded1 := defaultCodec.Encode(decoded1)
// Second round trip
result2 := defaultCodec.Decode("input2")
decoded2 := either.MonadFold(result2,
func(validation.Errors) int { return 0 },
F.Identity[int],
)
encoded2 := defaultCodec.Encode(decoded2)
// All decoded values should be the same
assert.Equal(t, 50, decoded1)
assert.Equal(t, 50, decoded2)
// All encoded values should be the same
assert.Equal(t, 100, encoded1)
assert.Equal(t, 100, encoded2)
})
}

View File

@@ -22,15 +22,19 @@
package codec
import (
"encoding"
"encoding/json"
"net/url"
"regexp"
"strconv"
"time"
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"
"github.com/IBM/fp-go/v2/optics/prism"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/result"
)
// validateFromParser creates a validation function from a parser that may fail.
@@ -338,3 +342,183 @@ func Int64FromString() Type[int64, string, string] {
prism.ParseInt64().ReverseGet,
)
}
// BoolFromString creates a bidirectional codec for parsing boolean values from strings.
// This codec converts string representations of booleans to bool values and vice versa.
//
// The codec:
// - Decodes: Parses a string to a bool using strconv.ParseBool
// - Encodes: Converts a bool to its string representation using strconv.FormatBool
// - Validates: Ensures the string contains a valid boolean value
//
// The codec accepts the following string values (case-insensitive):
// - true: "1", "t", "T", "true", "TRUE", "True"
// - false: "0", "f", "F", "false", "FALSE", "False"
//
// Returns:
// - A Type[bool, string, string] codec that handles bool/string conversions
//
// Example:
//
// boolCodec := BoolFromString()
//
// // Decode valid boolean strings
// validation := boolCodec.Decode("true")
// // validation is Right(true)
//
// validation := boolCodec.Decode("1")
// // validation is Right(true)
//
// validation := boolCodec.Decode("false")
// // validation is Right(false)
//
// validation := boolCodec.Decode("0")
// // validation is Right(false)
//
// // Encode a boolean to string
// str := boolCodec.Encode(true)
// // str is "true"
//
// str := boolCodec.Encode(false)
// // str is "false"
//
// // Invalid boolean string fails validation
// validation := boolCodec.Decode("yes")
// // validation is Left(ValidationError{...})
//
// // Case variations are accepted
// validation := boolCodec.Decode("TRUE")
// // validation is Right(true)
func BoolFromString() Type[bool, string, string] {
return MakeType(
"BoolFromString",
Is[bool](),
validateFromParser(strconv.ParseBool),
strconv.FormatBool,
)
}
func decodeJSON[T any](dec json.Unmarshaler) ReaderResult[[]byte, T] {
return func(b []byte) Result[T] {
var t T
err := dec.UnmarshalJSON(b)
return result.TryCatchError(t, err)
}
}
func decodeText[T any](dec encoding.TextUnmarshaler) ReaderResult[[]byte, T] {
return func(b []byte) Result[T] {
var t T
err := dec.UnmarshalText(b)
return result.TryCatchError(t, err)
}
}
// MarshalText creates a bidirectional codec for types that implement encoding.TextMarshaler
// and encoding.TextUnmarshaler. This codec handles binary text serialization formats.
//
// The codec:
// - Decodes: Calls dec.UnmarshalText(b) to deserialize []byte into the target type T
// - Encodes: Calls enc.MarshalText() to serialize the value to []byte
// - Validates: Returns a failure if UnmarshalText returns an error
//
// Note: The enc and dec parameters are external marshaler/unmarshaler instances. The
// decoded value is the zero value of T after UnmarshalText has been called on dec
// (the caller is responsible for ensuring dec holds the decoded state).
//
// Type Parameters:
// - T: The Go type to encode/decode
//
// Parameters:
// - enc: An encoding.TextMarshaler used for encoding values to []byte
// - dec: An encoding.TextUnmarshaler used for decoding []byte to the target type
//
// Returns:
// - A Type[T, []byte, []byte] codec that handles text marshaling/unmarshaling
//
// Example:
//
// type MyType struct{ Value string }
//
// var instance MyType
// codec := MarshalText[MyType](instance, &instance)
//
// // Decode bytes to MyType
// result := codec.Decode([]byte(`some text`))
//
// // Encode MyType to bytes
// encoded := codec.Encode(instance)
func MarshalText[T any](
enc encoding.TextMarshaler,
dec encoding.TextUnmarshaler,
) Type[T, []byte, []byte] {
return MakeType(
"UnmarshalText",
Is[T](),
F.Pipe2(
dec,
decodeText[T],
validate.FromReaderResult,
),
func(t T) []byte {
b, _ := enc.MarshalText()
return b
},
)
}
// MarshalJSON creates a bidirectional codec for types that implement encoding/json's
// json.Marshaler and json.Unmarshaler interfaces. This codec handles JSON serialization.
//
// The codec:
// - Decodes: Calls dec.UnmarshalJSON(b) to deserialize []byte JSON into the target type T
// - Encodes: Calls enc.MarshalJSON() to serialize the value to []byte JSON
// - Validates: Returns a failure if UnmarshalJSON returns an error
//
// Note: The enc and dec parameters are external marshaler/unmarshaler instances. The
// decoded value is the zero value of T after UnmarshalJSON has been called on dec
// (the caller is responsible for ensuring dec holds the decoded state).
//
// Type Parameters:
// - T: The Go type to encode/decode
//
// Parameters:
// - enc: A json.Marshaler used for encoding values to JSON []byte
// - dec: A json.Unmarshaler used for decoding JSON []byte to the target type
//
// Returns:
// - A Type[T, []byte, []byte] codec that handles JSON marshaling/unmarshaling
//
// Example:
//
// type MyData struct {
// Name string `json:"name"`
// Value int `json:"value"`
// }
//
// var instance MyData
// codec := MarshalJSON[MyData](&instance, &instance)
//
// // Decode JSON bytes to MyData
// result := codec.Decode([]byte(`{"name":"test","value":42}`))
//
// // Encode MyData to JSON bytes
// encoded := codec.Encode(instance)
func MarshalJSON[T any](
enc json.Marshaler,
dec json.Unmarshaler,
) Type[T, []byte, []byte] {
return MakeType(
"UnmarshalJSON",
Is[T](),
F.Pipe2(
dec,
decodeJSON[T],
validate.FromReaderResult,
),
func(t T) []byte {
b, _ := enc.MarshalJSON()
return b
},
)
}

File diff suppressed because it is too large Load Diff

View File

@@ -19,12 +19,7 @@ func TestDo(t *testing.T) {
decoder := Do[string](State{})
result := decoder("input")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) State { return State{} },
F.Identity[State],
)
assert.Equal(t, State{}, value)
assert.Equal(t, validation.Of(State{}), result)
})
t.Run("creates decoder with initialized state", func(t *testing.T) {
@@ -79,12 +74,7 @@ func TestBind(t *testing.T) {
)
result := decoder("input")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) State { return State{} },
F.Identity[State],
)
assert.Equal(t, State{x: 42, y: 10}, value)
assert.Equal(t, validation.Of(State{x: 42, y: 10}), result)
})
t.Run("propagates failure", func(t *testing.T) {
@@ -216,12 +206,7 @@ func TestLet(t *testing.T) {
)
result := decoder("input")
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(validation.Errors) State { return State{} },
F.Identity[State],
)
assert.Equal(t, State{x: 60, y: 10, z: 20}, value)
assert.Equal(t, validation.Of(State{x: 60, y: 10, z: 20}), result)
})
}

View File

@@ -18,6 +18,47 @@ func Of[I, A any](a A) Decode[I, A] {
return readereither.Of[I, Errors](a)
}
// OfLazy converts a lazy computation into a Decode that ignores its input.
// The resulting Decode will evaluate the lazy computation when executed and wrap
// the result in a successful validation, regardless of the input provided.
//
// This function is intended solely for deferring the computation of a value, NOT for
// representing side effects. The lazy computation should be a pure function that
// produces the same result each time it's called (referential transparency). For
// operations with side effects, use appropriate effect types like IO or IOResult.
//
// This is useful for lifting deferred computations into the Decode context without
// requiring access to the input, while maintaining the validation wrapper for consistency.
//
// Type Parameters:
// - I: The input type (ignored by the resulting Decode)
// - A: The result type produced by the lazy computation
//
// Parameters:
// - fa: A lazy computation that produces a value of type A (must be pure, no side effects)
//
// Returns:
// - A Decode that ignores its input, evaluates the lazy computation, and wraps the result in Validation[A]
//
// Example:
//
// lazyValue := func() int { return 42 }
// decoder := decode.OfLazy[string](lazyValue)
// result := decoder("any input") // validation.Success(42)
//
// Example - Deferring expensive computation:
//
// expensiveCalc := func() Config {
// // Expensive but pure computation here
// return computeDefaultConfig()
// }
// decoder := decode.OfLazy[map[string]any](expensiveCalc)
// // Computation is deferred until the Decode is executed
// result := decoder(inputData) // validation.Success(config)
func OfLazy[I, A any](fa Lazy[A]) Decode[I, A] {
return readereither.OfLazy[I, Errors](fa)
}
// 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.

View File

@@ -51,6 +51,108 @@ func TestOf(t *testing.T) {
})
}
// TestOfLazy tests the OfLazy function
func TestOfLazy(t *testing.T) {
t.Run("evaluates lazy computation ignoring input", func(t *testing.T) {
lazyValue := func() int { return 42 }
decoder := OfLazy[string](lazyValue)
res := decoder("any input")
assert.Equal(t, validation.Of(42), res)
})
t.Run("defers computation until Decode is executed", func(t *testing.T) {
executed := false
lazyComputation := func() string {
executed = true
return "computed"
}
decoder := OfLazy[string](lazyComputation)
// Computation should not be executed yet
assert.False(t, executed, "lazy computation should not be executed during Decode creation")
// Execute the Decode
res := decoder("input")
// Now computation should be executed
assert.True(t, executed, "lazy computation should be executed when Decode runs")
assert.Equal(t, validation.Of("computed"), res)
})
t.Run("evaluates lazy computation each time Decode is called", func(t *testing.T) {
counter := 0
lazyCounter := func() int {
counter++
return counter
}
decoder := OfLazy[string](lazyCounter)
// First execution
res1 := decoder("input")
assert.Equal(t, validation.Of(1), res1)
// Second execution
res2 := decoder("input")
assert.Equal(t, validation.Of(2), res2)
// Third execution
res3 := decoder("input")
assert.Equal(t, validation.Of(3), res3)
})
t.Run("works with different types", func(t *testing.T) {
lazyString := func() string { return "hello" }
decoder1 := OfLazy[int](lazyString)
assert.Equal(t, validation.Of("hello"), decoder1(123))
lazySlice := func() []int { return []int{1, 2, 3} }
decoder2 := OfLazy[string](lazySlice)
assert.Equal(t, validation.Of([]int{1, 2, 3}), decoder2("input"))
type Person struct {
Name string
Age int
}
lazyStruct := func() Person { return Person{Name: "Alice", Age: 30} }
decoder3 := OfLazy[map[string]any](lazyStruct)
assert.Equal(t, validation.Of(Person{Name: "Alice", Age: 30}), decoder3(map[string]any{}))
})
t.Run("can be composed with other Decode operations", func(t *testing.T) {
lazyValue := func() int { return 10 }
decoder := MonadMap(
OfLazy[string](lazyValue),
func(x int) int { return x * 2 },
)
res := decoder("input")
assert.Equal(t, validation.Of(20), res)
})
t.Run("ignores input completely", func(t *testing.T) {
lazyValue := func() string { return "constant" }
decoder := OfLazy[string](lazyValue)
// Different inputs should produce same result
res1 := decoder("input1")
res2 := decoder("input2")
assert.Equal(t, validation.Of("constant"), res1)
assert.Equal(t, validation.Of("constant"), res2)
assert.Equal(t, res1, res2)
})
t.Run("always wraps result in success validation", func(t *testing.T) {
lazyValue := func() int { return 42 }
decoder := OfLazy[string](lazyValue)
res := decoder("input")
// Verify it's a successful validation
assert.True(t, either.IsRight(res))
assert.Equal(t, validation.Of(42), res)
})
}
// TestLeft tests the Left function
func TestLeft(t *testing.T) {
t.Run("creates decoder that always fails", func(t *testing.T) {

View File

@@ -2,6 +2,7 @@ package codec
import (
"github.com/IBM/fp-go/v2/endomorphism"
"github.com/IBM/fp-go/v2/function"
"github.com/IBM/fp-go/v2/internal/formatting"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/monoid"
@@ -10,12 +11,15 @@ import (
"github.com/IBM/fp-go/v2/optics/codec/validation"
"github.com/IBM/fp-go/v2/optics/decoder"
"github.com/IBM/fp-go/v2/optics/encoder"
"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/option"
"github.com/IBM/fp-go/v2/pair"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/readerresult"
"github.com/IBM/fp-go/v2/result"
"github.com/IBM/fp-go/v2/semigroup"
)
type (
@@ -338,4 +342,156 @@ type (
// - ApplicativeMonoid: Combines successful results using inner monoid
// - AlternativeMonoid: Combines applicative and alternative behaviors
Monoid[A any] = monoid.Monoid[A]
// Lens is an optic that focuses on a specific field within a product type S.
// It provides a way to get and set a field of type A within a structure of type S.
//
// A Lens[S, A] represents a relationship between a source type S and a focus type A,
// where the focus always exists (unlike Optional which may not exist).
//
// Lens operations:
// - Get: Extract the field value A from structure S
// - Set: Update the field value A in structure S, returning a new S
//
// Lens laws:
// 1. GetSet: If you get a value and then set it back, nothing changes
// Set(Get(s))(s) = s
// 2. SetGet: If you set a value, you can get it back
// Get(Set(a)(s)) = a
// 3. SetSet: Setting twice is the same as setting once with the final value
// Set(b)(Set(a)(s)) = Set(b)(s)
//
// In the codec context, lenses are used with ApSL to build codecs for struct fields:
// - Extract field values for encoding
// - Update field values during validation
// - Compose codec operations on nested structures
//
// Example:
// type Person struct { Name string; Age int }
//
// nameLens := lens.MakeLens(
// func(p Person) string { return p.Name },
// func(p Person, name string) Person { p.Name = name; return p },
// )
//
// // Use with ApSL to build a codec
// personCodec := F.Pipe1(
// codec.Struct[Person]("Person"),
// codec.ApSL(S.Monoid, nameLens, codec.String),
// )
//
// See also:
// - ApSL: Applicative sequencing with lens
// - Optional: For fields that may not exist
Lens[S, A any] = lens.Lens[S, A]
// Optional is an optic that focuses on a field within a product type S that may not exist.
// It provides a way to get and set an optional field of type A within a structure of type S.
//
// An Optional[S, A] represents a relationship between a source type S and a focus type A,
// where the focus may or may not be present (unlike Lens where it always exists).
//
// Optional operations:
// - GetOption: Try to extract the field value, returning Option[A]
// - Set: Update the field value if it exists, returning a new S
//
// Optional laws:
// 1. GetSet (No-op on None): If GetOption returns None, Set has no effect
// GetOption(s) = None => Set(a)(s) = s
// 2. SetGet (Get what you Set): If GetOption returns Some, you can get back what you set
// GetOption(s) = Some(_) => GetOption(Set(a)(s)) = Some(a)
// 3. SetSet (Last Set Wins): Setting twice is the same as setting once with the final value
// Set(b)(Set(a)(s)) = Set(b)(s)
//
// In the codec context, optionals are used with ApSO to build codecs for optional fields:
// - Extract optional field values for encoding (only if present)
// - Update optional field values during validation
// - Handle nullable or pointer fields gracefully
// - Compose codec operations on structures with optional data
//
// Example:
// type Person struct {
// Name string
// Nickname *string // Optional field
// }
//
// nicknameOpt := optional.MakeOptional(
// func(p Person) option.Option[string] {
// if p.Nickname != nil {
// return option.Some(*p.Nickname)
// }
// return option.None[string]()
// },
// func(p Person, nick string) Person {
// p.Nickname = &nick
// return p
// },
// )
//
// // Use with ApSO to build a codec with optional field
// personCodec := F.Pipe1(
// codec.Struct[Person]("Person"),
// codec.ApSO(S.Monoid, nicknameOpt, codec.String),
// )
//
// // Encoding omits the field when absent
// p1 := Person{Name: "Alice", Nickname: nil}
// encoded := personCodec.Encode(p1) // No nickname in output
//
// See also:
// - ApSO: Applicative sequencing with optional
// - Lens: For fields that always exist
Optional[S, A any] = optional.Optional[S, A]
// Semigroup represents an algebraic structure with an associative binary operation.
//
// A Semigroup[A] provides:
// - Concat(A, A): Combines two values associatively
//
// Semigroup law:
// - Associativity: Concat(Concat(a, b), c) = Concat(a, Concat(b, c))
//
// Unlike Monoid, Semigroup does not require an identity element (Empty).
// This makes it more general but less powerful for certain operations.
//
// In the codec context, semigroups are used to:
// - Combine validation errors
// - Merge partial results
// - Aggregate codec outputs
//
// Example semigroups:
// - String concatenation (without empty string)
// - Array concatenation (without empty array)
// - Error accumulation
//
// Note: Every Monoid is also a Semigroup, but not every Semigroup is a Monoid.
Semigroup[A any] = semigroup.Semigroup[A]
// Void represents a unit type with a single value.
//
// Void is used instead of struct{} to represent:
// - Unit values in functional programming
// - Placeholder types where no meaningful value is needed
// - Return types for functions that produce no useful result
//
// The single value of type Void is VOID (function.VOID).
//
// Usage:
// - Use function.Void (or F.Void) as the type
// - Use function.VOID (or F.VOID) as the value
//
// Example:
// unitCodec := codec.Empty[F.Void, F.Void, any](
// lazy.Of(pair.MakePair(F.VOID, F.VOID)),
// )
//
// Benefits over struct{}:
// - More explicit intent (unit type vs empty struct)
// - Consistent with functional programming conventions
// - Better semantic meaning in type signatures
//
// See also:
// - function.VOID: The single value of type Void
// - Empty: Codec function that uses Void for unit types
Void = function.Void
)

View File

@@ -170,12 +170,7 @@ func TestLet(t *testing.T) {
)
result := validator("input")(nil)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(Errors) State { return State{} },
F.Identity[State],
)
assert.Equal(t, State{x: 5, computed: 10}, value)
assert.Equal(t, validation.Of(State{x: 5, computed: 10}), result)
})
t.Run("preserves failure", func(t *testing.T) {
@@ -218,12 +213,7 @@ func TestLet(t *testing.T) {
)
result := validator("input")(nil)
assert.True(t, either.IsRight(result))
value := either.MonadFold(result,
func(Errors) State { return State{} },
F.Identity[State],
)
assert.Equal(t, State{x: 60, y: 10, z: 20}, value)
assert.Equal(t, validation.Of(State{x: 60, y: 10, z: 20}), result)
})
}

View File

@@ -160,6 +160,109 @@ func Of[I, A any](a A) Validate[I, A] {
return reader.Of[I](decode.Of[Context](a))
}
// OfLazy creates a Validate that defers the computation of a value until needed.
//
// This function lifts a lazy computation into the validation context. The computation
// is deferred until the validator is actually executed, allowing for efficient handling
// of expensive operations or values that may not always be needed.
//
// **IMPORTANT**: The lazy function MUST be pure (referentially transparent). It should
// always return the same value when called and must not perform side effects. For
// computations with side effects, use IO or IOEither types instead.
//
// # Type Parameters
//
// - I: The input type (not used, but required for type consistency)
// - A: The type of the value produced by the lazy computation
//
// # Parameters
//
// - fa: A lazy computation that produces a value of type A. This function is called
// each time the validator is executed.
//
// # Returns
//
// A Validate[I, A] that ignores its input and returns a successful validation containing
// the lazily computed value.
//
// # Purity Requirements
//
// The lazy function MUST be pure:
// - Always returns the same result for the same (lack of) input
// - No side effects (no I/O, no mutation, no randomness)
// - Deterministic and referentially transparent
//
// For side effects, use:
// - IO types for effectful computations
// - IOEither for effectful computations that may fail
//
// # Example: Deferring Expensive Computation
//
// import (
// "github.com/IBM/fp-go/v2/optics/codec/validate"
// "github.com/IBM/fp-go/v2/optics/codec/validation"
// )
//
// // Expensive computation deferred until needed
// expensiveValue := validate.OfLazy[string, int](func() int {
// // This computation only runs when the validator is executed
// return computeExpensiveValue()
// })
//
// result := expensiveValue("any input")(nil)
// // result is validation.Success(computed value)
//
// # Example: Lazy Default Value
//
// // Provide a default value that's only computed if needed
// withDefault := validate.OfLazy[Config, Config](func() Config {
// return loadDefaultConfig()
// })
//
// // Use in a validation pipeline
// validator := F.Pipe1(
// validateFromFile,
// validate.Alt(func() validate.Validate[string, Config] {
// return withDefault
// }),
// )
// // Default config only loaded if file validation fails
//
// # Example: Composition with Other Validators
//
// // Combine lazy value with validation logic
// lazyValidator := F.Pipe1(
// validate.OfLazy[string, int](func() int { return 42 }),
// validate.Chain(func(n int) validate.Validate[string, string] {
// return func(input string) validate.Reader[validation.Context, validation.Validation[string]] {
// return func(ctx validation.Context) validation.Validation[string] {
// if len(input) > n {
// return validation.FailureWithMessage[string](input, "too long")(ctx)
// }
// return validation.Success(input)
// }
// }
// }),
// )
//
// # Notes
//
// - The lazy function is evaluated each time the validator is executed
// - The input value I is ignored; the validator succeeds regardless of input
// - The result is always wrapped in a successful validation
// - This is useful for deferring expensive computations or providing lazy defaults
// - The lazy function must be pure - no side effects allowed
// - For side effects, use IO or IOEither types instead
//
// # See Also
//
// - Of: For non-lazy values
// - decode.OfLazy: The underlying decode operation
// - reader.Of: The reader lifting operation
func OfLazy[I, A any](fa Lazy[A]) Validate[I, A] {
return reader.Of[I](decode.OfLazy[Context](fa))
}
// MonadMap applies a function to the successful result of a validation.
//
// This is the functor map operation for Validate. It transforms the success value

View File

@@ -1274,3 +1274,139 @@ func TestOrElse(t *testing.T) {
}
})
}
// TestOfLazy tests the OfLazy function
func TestOfLazy(t *testing.T) {
t.Run("evaluates lazy computation", func(t *testing.T) {
// Create a validator with a lazy value
validator := OfLazy[string, int](func() int {
return 42
})
result := validator("any input")(nil)
assert.Equal(t, validation.Success(42), result)
})
t.Run("defers execution until called", func(t *testing.T) {
executed := false
validator := OfLazy[string, int](func() int {
executed = true
return 100
})
// Lazy function not executed yet
assert.False(t, executed)
// Execute the validator
result := validator("input")(nil)
// Now it should be executed
assert.True(t, executed)
assert.Equal(t, validation.Success(100), result)
})
t.Run("evaluates on each call", func(t *testing.T) {
callCount := 0
validator := OfLazy[string, int](func() int {
callCount++
return callCount
})
// First call
result1 := validator("input")(nil)
assert.Equal(t, validation.Success(1), result1)
// Second call - evaluates again
result2 := validator("input")(nil)
assert.Equal(t, validation.Success(2), result2)
// Third call
result3 := validator("input")(nil)
assert.Equal(t, validation.Success(3), result3)
})
t.Run("works with different types", func(t *testing.T) {
// String type
stringValidator := OfLazy[int, string](func() string {
return "hello"
})
result := stringValidator(42)(nil)
assert.Equal(t, validation.Success("hello"), result)
// Struct type
type Config struct {
Host string
Port int
}
configValidator := OfLazy[string, Config](func() Config {
return Config{Host: "localhost", Port: 8080}
})
result2 := configValidator("input")(nil)
assert.Equal(t, validation.Success(Config{Host: "localhost", Port: 8080}), result2)
// Slice type
sliceValidator := OfLazy[string, []int](func() []int {
return []int{1, 2, 3}
})
result3 := sliceValidator("input")(nil)
assert.Equal(t, validation.Success([]int{1, 2, 3}), result3)
})
t.Run("composes with other validators", func(t *testing.T) {
// Create a lazy validator that produces a number
lazyValue := OfLazy[string, int](func() int {
return 42
})
// Map to transform the value
validator := MonadMap(lazyValue, func(n int) int {
return n * 2
})
result := validator("any input")(nil)
assert.Equal(t, validation.Success(84), result)
})
t.Run("ignores input value", func(t *testing.T) {
validator := OfLazy[string, int](func() int {
return 999
})
// Different inputs should produce the same result
result1 := validator("input1")(nil)
result2 := validator("input2")(nil)
result3 := validator("")(nil)
assert.Equal(t, validation.Success(999), result1)
assert.Equal(t, validation.Success(999), result2)
assert.Equal(t, validation.Success(999), result3)
})
t.Run("always wraps in success validation", func(t *testing.T) {
validator := OfLazy[string, int](func() int {
return 42
})
result := validator("input")(nil)
// Verify it's a Right (success)
assert.True(t, E.IsRight(result))
// Extract and verify the value
value, _ := E.Unwrap(result)
assert.Equal(t, 42, value)
})
t.Run("works with context", func(t *testing.T) {
validator := OfLazy[string, string](func() string {
return "validated"
})
ctx := validation.Context{
{Key: "field", Type: "string"},
}
result := validator("input")(ctx)
assert.Equal(t, validation.Success("validated"), result)
})
}

View File

@@ -259,5 +259,42 @@ type (
// result := LetL(lens, double)(Success(21)) // Success(42)
Endomorphism[A any] = endomorphism.Endomorphism[A]
// Lazy represents a lazily-evaluated value of type A.
// This is an alias for lazy.Lazy[A], which defers computation until the value is needed.
//
// In the validation context, Lazy is used to defer expensive validation operations
// or to break circular dependencies in validation logic.
//
// Example:
//
// lazyValidation := lazy.Of(func() Validation[int] {
// // Expensive validation logic here
// return Success(42)
// })
// // Validation is not executed until lazyValidation() is called
Lazy[A any] = lazy.Lazy[A]
// ErrorsProvider is an interface for types that can provide a collection of errors.
// This interface allows validation errors to be extracted from various error types
// in a uniform way, supporting error aggregation and reporting.
//
// Types implementing this interface can be unwrapped to access their underlying
// error collection, enabling consistent error handling across different error types.
//
// Example:
//
// type MyErrors struct {
// errs []error
// }
//
// func (e *MyErrors) Errors() []error {
// return e.errs
// }
//
// // Usage
// var provider ErrorsProvider = &MyErrors{errs: []error{...}}
// allErrors := provider.Errors()
ErrorsProvider interface {
Errors() []error
}
)

View File

@@ -3,6 +3,7 @@ package validation
import (
"fmt"
"log/slog"
"strings"
A "github.com/IBM/fp-go/v2/array"
"github.com/IBM/fp-go/v2/either"
@@ -12,6 +13,11 @@ import (
// Returns a generic error message indicating this is a validation error.
// For detailed error information, use String() or Format() methods.
// toError converts the validation error to the error interface
func toError(v *ValidationError) error {
return v
}
// Error implements the error interface for ValidationError.
// Returns a generic error message.
func (v *ValidationError) Error() string {
@@ -34,44 +40,45 @@ func (v *ValidationError) String() string {
// It includes the context path, message, and optionally the cause error.
// Supports verbs: %s, %v, %+v (with additional details)
func (v *ValidationError) Format(s fmt.State, verb rune) {
// Build the context path
path := ""
for i, entry := range v.Context {
if i > 0 {
path += "."
}
if entry.Key != "" {
path += entry.Key
} else {
path += entry.Type
}
}
var result strings.Builder
// Start with the path if available
result := ""
if path != "" {
result = fmt.Sprintf("at %s: ", path)
// Build the context path
if len(v.Context) > 0 {
var path strings.Builder
for i, entry := range v.Context {
if i > 0 {
path.WriteString(".")
}
if entry.Key != "" {
path.WriteString(entry.Key)
} else {
path.WriteString(entry.Type)
}
}
result.WriteString("at ")
result.WriteString(path.String())
result.WriteString(": ")
}
// Add the message
result += v.Messsage
result.WriteString(v.Messsage)
// Add the cause if present
if v.Cause != nil {
if s.Flag('+') && verb == 'v' {
// Verbose format with detailed cause
result += fmt.Sprintf("\n caused by: %+v", v.Cause)
fmt.Fprintf(&result, "\n caused by: %+v", v.Cause)
} else {
result += fmt.Sprintf(" (caused by: %v)", v.Cause)
fmt.Fprintf(&result, " (caused by: %v)", v.Cause)
}
}
// Add value information for verbose format
if s.Flag('+') && verb == 'v' {
result += fmt.Sprintf("\n value: %#v", v.Value)
fmt.Fprintf(&result, "\n value: %#v", v.Value)
}
fmt.Fprint(s, result)
fmt.Fprint(s, result.String())
}
// LogValue implements the slog.LogValuer interface for ValidationError.
@@ -94,18 +101,18 @@ func (v *ValidationError) LogValue() slog.Value {
// Add context path if available
if len(v.Context) > 0 {
path := ""
var path strings.Builder
for i, entry := range v.Context {
if i > 0 {
path += "."
path.WriteString(".")
}
if entry.Key != "" {
path += entry.Key
path.WriteString(entry.Key)
} else {
path += entry.Type
path.WriteString(entry.Type)
}
}
attrs = append(attrs, slog.String("path", path))
attrs = append(attrs, slog.String("path", path.String()))
}
// Add cause if present
@@ -119,13 +126,14 @@ func (v *ValidationError) LogValue() slog.Value {
// Error implements the error interface for ValidationErrors.
// Returns a generic error message indicating validation errors occurred.
func (ve *validationErrors) Error() string {
if len(ve.errors) == 0 {
switch len(ve.errors) {
case 0:
return "ValidationErrors: no errors"
}
if len(ve.errors) == 1 {
case 1:
return "ValidationErrors: 1 error"
default:
return fmt.Sprintf("ValidationErrors: %d errors", len(ve.errors))
}
return fmt.Sprintf("ValidationErrors: %d errors", len(ve.errors))
}
// Unwrap returns the underlying cause error if present.
@@ -134,6 +142,33 @@ func (ve *validationErrors) Unwrap() error {
return ve.cause
}
// Errors implements the ErrorsProvider interface for validationErrors.
// It converts the internal collection of ValidationError pointers to a slice of error interfaces.
// This method enables uniform error extraction from validation error collections.
//
// The returned slice contains the same errors as the internal errors field,
// but typed as error interface values for compatibility with standard Go error handling.
//
// Returns:
// - A slice of error interfaces, one for each ValidationError in the collection
//
// Example:
//
// ve := &validationErrors{
// errors: Errors{
// &ValidationError{Messsage: "invalid email"},
// &ValidationError{Messsage: "age must be positive"},
// },
// }
// errs := ve.Errors()
// // errs is []error with 2 elements, each implementing the error interface
// for _, err := range errs {
// fmt.Println(err.Error()) // "ValidationError"
// }
func (ve *validationErrors) Errors() []error {
return A.MonadMap(ve.errors, toError)
}
// String returns a simple string representation of all validation errors.
// Each error is listed on a separate line with its index.
func (ve *validationErrors) String() string {
@@ -141,16 +176,17 @@ func (ve *validationErrors) String() string {
return "ValidationErrors: no errors"
}
result := fmt.Sprintf("ValidationErrors (%d):\n", len(ve.errors))
var result strings.Builder
fmt.Fprintf(&result, "ValidationErrors (%d):\n", len(ve.errors))
for i, err := range ve.errors {
result += fmt.Sprintf(" [%d] %s\n", i, err.String())
fmt.Fprintf(&result, " [%d] %s\n", i, err.String())
}
if ve.cause != nil {
result += fmt.Sprintf(" caused by: %v\n", ve.cause)
fmt.Fprintf(&result, " caused by: %v\n", ve.cause)
}
return result
return result.String()
}
// Format implements fmt.Formatter for custom formatting of ValidationErrors.

View File

@@ -846,3 +846,142 @@ func TestLogValuerInterface(t *testing.T) {
var _ slog.LogValuer = (*validationErrors)(nil)
})
}
// TestValidationErrors_Errors tests the Errors() method implementation
func TestValidationErrors_Errors(t *testing.T) {
t.Run("returns empty slice for no errors", func(t *testing.T) {
ve := &validationErrors{
errors: Errors{},
}
errs := ve.Errors()
assert.Empty(t, errs)
assert.NotNil(t, errs)
})
t.Run("converts single ValidationError to error interface", func(t *testing.T) {
ve := &validationErrors{
errors: Errors{
&ValidationError{Value: "test", Messsage: "invalid value"},
},
}
errs := ve.Errors()
require.Len(t, errs, 1)
assert.Equal(t, "ValidationError", errs[0].Error())
})
t.Run("converts multiple ValidationErrors to error interfaces", func(t *testing.T) {
ve := &validationErrors{
errors: Errors{
&ValidationError{Value: "test1", Messsage: "error 1"},
&ValidationError{Value: "test2", Messsage: "error 2"},
&ValidationError{Value: "test3", Messsage: "error 3"},
},
}
errs := ve.Errors()
require.Len(t, errs, 3)
for _, err := range errs {
assert.Equal(t, "ValidationError", err.Error())
}
})
t.Run("preserves error details in converted errors", func(t *testing.T) {
originalErr := &ValidationError{
Value: "abc",
Context: []ContextEntry{{Key: "field"}},
Messsage: "invalid format",
Cause: errors.New("parse error"),
}
ve := &validationErrors{
errors: Errors{originalErr},
}
errs := ve.Errors()
require.Len(t, errs, 1)
// Verify the error can be type-asserted back to ValidationError
validationErr, ok := errs[0].(*ValidationError)
require.True(t, ok)
assert.Equal(t, "abc", validationErr.Value)
assert.Equal(t, "invalid format", validationErr.Messsage)
assert.NotNil(t, validationErr.Cause)
assert.Len(t, validationErr.Context, 1)
})
t.Run("implements ErrorsProvider interface", func(t *testing.T) {
ve := &validationErrors{
errors: Errors{
&ValidationError{Messsage: "error 1"},
&ValidationError{Messsage: "error 2"},
},
}
// Verify it implements ErrorsProvider
var provider ErrorsProvider = ve
errs := provider.Errors()
assert.Len(t, errs, 2)
})
t.Run("returned errors are usable with standard error handling", func(t *testing.T) {
cause := errors.New("underlying error")
ve := &validationErrors{
errors: Errors{
&ValidationError{
Value: "test",
Messsage: "validation failed",
Cause: cause,
},
},
}
errs := ve.Errors()
require.Len(t, errs, 1)
// Test with errors.Is
assert.True(t, errors.Is(errs[0], cause))
// Test with errors.As
var validationErr *ValidationError
assert.True(t, errors.As(errs[0], &validationErr))
assert.Equal(t, "validation failed", validationErr.Messsage)
})
t.Run("does not modify original errors slice", func(t *testing.T) {
originalErrors := Errors{
&ValidationError{Value: "test1", Messsage: "error 1"},
&ValidationError{Value: "test2", Messsage: "error 2"},
}
ve := &validationErrors{
errors: originalErrors,
}
errs := ve.Errors()
require.Len(t, errs, 2)
// Original should be unchanged
assert.Len(t, ve.errors, 2)
assert.Equal(t, originalErrors, ve.errors)
})
t.Run("each error in slice is independent", func(t *testing.T) {
ve := &validationErrors{
errors: Errors{
&ValidationError{Value: "test1", Messsage: "error 1"},
&ValidationError{Value: "test2", Messsage: "error 2"},
},
}
errs := ve.Errors()
require.Len(t, errs, 2)
// Verify each error is distinct
err1, ok1 := errs[0].(*ValidationError)
err2, ok2 := errs[1].(*ValidationError)
require.True(t, ok1)
require.True(t, ok2)
assert.NotEqual(t, err1.Messsage, err2.Messsage)
assert.NotEqual(t, err1.Value, err2.Value)
})
}

View File

@@ -227,6 +227,51 @@ func Of[R, A any](a A) Reader[R, A] {
return function.Constant1[R](a)
}
// OfLazy converts a lazy computation into a Reader that ignores its environment.
// The resulting Reader will evaluate the lazy computation when executed, regardless
// of the environment provided.
//
// This function is intended solely for deferring the computation of a value, NOT for
// representing side effects. The lazy computation should be a pure function that
// produces the same result each time it's called (referential transparency). For
// operations with side effects, use appropriate effect types like IO or IOEither.
//
// This is useful for lifting deferred computations into the Reader context without
// requiring access to the environment.
//
// Type Parameters:
// - R: The environment type (ignored by the resulting Reader)
// - A: The result type produced by the lazy computation
//
// Parameters:
// - fa: A lazy computation that produces a value of type A (must be pure, no side effects)
//
// Returns:
// - A Reader that ignores its environment and evaluates the lazy computation
//
// Example:
//
// type Config struct { Host string }
// lazyValue := func() int { return 42 }
// r := reader.OfLazy[Config](lazyValue)
// result := r(Config{Host: "localhost"}) // 42
//
// Example - Deferring expensive computation:
//
// type Env struct { Debug bool }
// expensiveCalc := func() string {
// // Expensive but pure computation here
// return "computed result"
// }
// r := reader.OfLazy[Env](expensiveCalc)
// // Computation is deferred until the Reader is executed
// result := r(Env{Debug: true}) // "computed result"
func OfLazy[R, A any](fa Lazy[A]) Reader[R, A] {
return func(_ R) A {
return fa()
}
}
// MonadChain sequences two Reader computations where the second depends on the result of the first.
// Both computations share the same environment.
// This is the monadic bind operation (flatMap).

View File

@@ -92,6 +92,91 @@ func TestOf(t *testing.T) {
assert.Equal(t, "constant", result)
}
func TestOfLazy(t *testing.T) {
t.Run("evaluates lazy computation ignoring environment", func(t *testing.T) {
lazyValue := func() int { return 42 }
r := OfLazy[Config](lazyValue)
result := r(Config{Host: "localhost", Port: 8080})
assert.Equal(t, 42, result)
})
t.Run("defers computation until Reader is executed", func(t *testing.T) {
executed := false
lazyComputation := func() string {
executed = true
return "computed"
}
r := OfLazy[Config](lazyComputation)
// Computation should not be executed yet
assert.False(t, executed, "lazy computation should not be executed during Reader creation")
// Execute the Reader
result := r(Config{Host: "localhost"})
// Now computation should be executed
assert.True(t, executed, "lazy computation should be executed when Reader runs")
assert.Equal(t, "computed", result)
})
t.Run("evaluates lazy computation each time Reader is called", func(t *testing.T) {
counter := 0
lazyCounter := func() int {
counter++
return counter
}
r := OfLazy[Config](lazyCounter)
// First execution
result1 := r(Config{Host: "localhost"})
assert.Equal(t, 1, result1)
// Second execution
result2 := r(Config{Host: "localhost"})
assert.Equal(t, 2, result2)
// Third execution
result3 := r(Config{Host: "localhost"})
assert.Equal(t, 3, result3)
})
t.Run("works with different types", func(t *testing.T) {
lazyString := func() string { return "hello" }
r1 := OfLazy[Config](lazyString)
assert.Equal(t, "hello", r1(Config{}))
lazySlice := func() []int { return []int{1, 2, 3} }
r2 := OfLazy[Config](lazySlice)
assert.Equal(t, []int{1, 2, 3}, r2(Config{}))
lazyStruct := func() Config { return Config{Host: "test", Port: 9000} }
r3 := OfLazy[string](lazyStruct)
assert.Equal(t, Config{Host: "test", Port: 9000}, r3("ignored"))
})
t.Run("can be composed with other Reader operations", func(t *testing.T) {
lazyValue := func() int { return 10 }
r := F.Pipe1(
OfLazy[Config](lazyValue),
Map[Config](func(x int) int { return x * 2 }),
)
result := r(Config{Host: "localhost"})
assert.Equal(t, 20, result)
})
t.Run("ignores environment completely", func(t *testing.T) {
lazyValue := func() string { return "constant" }
r := OfLazy[Config](lazyValue)
// Different environments should produce same result
config1 := Config{Host: "host1", Port: 8080}
config2 := Config{Host: "host2", Port: 9090}
assert.Equal(t, "constant", r(config1))
assert.Equal(t, "constant", r(config2))
})
}
func TestChain(t *testing.T) {
config := Config{Port: 8080}
getPort := Asks(func(c Config) int { return c.Port })

View File

@@ -103,4 +103,6 @@ type (
// Seq represents an iterator sequence over values of type T.
Seq[T any] = iter.Seq[T]
Lazy[A any] = func() A
)

View File

@@ -23,6 +23,7 @@ import (
"github.com/IBM/fp-go/v2/internal/fromreader"
"github.com/IBM/fp-go/v2/internal/functor"
"github.com/IBM/fp-go/v2/internal/readert"
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/reader"
)
@@ -46,6 +47,13 @@ func Right[E, L, A any](r A) ReaderEither[E, L, A] {
return eithert.Right(reader.Of[E, Either[L, A]], r)
}
func OfLazy[E, L, A any](r Lazy[A]) ReaderEither[E, L, A] {
return reader.OfLazy[E](function.Pipe1(
r,
lazy.Map(ET.Of[L, A]),
))
}
func FromReader[L, E, A any](r Reader[E, A]) ReaderEither[E, L, A] {
return RightReader[L](r)
}

View File

@@ -23,10 +23,14 @@ import (
)
type (
// Lazy represents a deferred computation that produces a value of type A.
Lazy[A any] = lazy.Lazy[A]
// Option represents an optional value that may or may not be present.
Option[A any] = option.Option[A]
// Either represents a value of one of two possible types (a disjoint union).
// An instance of Either is either Left (representing an error) or Right (representing a success).
Either[E, A any] = either.Either[E, A]
// Reader represents a computation that depends on an environment R and produces a value A.
@@ -34,9 +38,9 @@ type (
// ReaderEither represents a computation that depends on an environment R and can fail
// with an error E or succeed with a value A.
// It combines Reader (dependency injection) with Either (error handling).
// It combines the Reader monad (for dependency injection) with the Either monad (for error handling).
ReaderEither[R, E, A any] = Reader[R, Either[E, A]]
// Kleisli represents a Kleisli arrow for the ReaderEither monad.
// It's a function from A to ReaderEither[R, E, B], used for composing operations that
// depend on an environment and may fail.
@@ -44,7 +48,6 @@ type (
// Operator represents a function that transforms one ReaderEither into another.
// It takes a ReaderEither[R, E, A] and produces a ReaderEither[R, E, B].
// This is commonly used for lifting functions into the ReaderEither context.
Operator[R, E, A, B any] = Kleisli[R, E, ReaderEither[R, E, A], B]
Lazy[A any] = lazy.Lazy[A]
)

View File

@@ -1,6 +1,7 @@
package readerio
import (
"github.com/IBM/fp-go/v2/function"
G "github.com/IBM/fp-go/v2/internal/bracket"
)
@@ -30,3 +31,10 @@ func Bracket[
release,
)
}
//go:inline
func WithResource[R, A, B, ANY any](
onCreate ReaderIO[R, A], onRelease Kleisli[R, A, ANY]) Kleisli[R, Kleisli[R, A, B], B] {
return function.Bind13of3(Bracket[R, A, B, ANY])(onCreate, function.Ignore2of2[B](onRelease))
}

View File

@@ -29,6 +29,7 @@ import (
"github.com/IBM/fp-go/v2/lazy"
"github.com/IBM/fp-go/v2/option"
"github.com/IBM/fp-go/v2/reader"
"github.com/IBM/fp-go/v2/readereither"
"github.com/IBM/fp-go/v2/result"
)
@@ -279,6 +280,49 @@ func Of[R, A any](a A) ReaderResult[R, A] {
return readert.MonadOf[ReaderResult[R, A]](ET.Of[error, A], a)
}
// OfLazy converts a lazy computation into a ReaderResult that ignores its environment.
// The resulting ReaderResult will evaluate the lazy computation when executed and wrap
// the result in a successful Result, regardless of the environment provided.
//
// This function is intended solely for deferring the computation of a value, NOT for
// representing side effects. The lazy computation should be a pure function that
// produces the same result each time it's called (referential transparency). For
// operations with side effects, use appropriate effect types like IO or IOResult.
//
// This is useful for lifting deferred computations into the ReaderResult context without
// requiring access to the environment, while maintaining the Result wrapper for consistency.
//
// Type Parameters:
// - R: The environment type (ignored by the resulting ReaderResult)
// - A: The result type produced by the lazy computation
//
// Parameters:
// - r: A lazy computation that produces a value of type A (must be pure, no side effects)
//
// Returns:
// - A ReaderResult that ignores its environment, evaluates the lazy computation, and wraps the result in Result[A]
//
// Example:
//
// type Config struct { Host string }
// lazyValue := func() int { return 42 }
// rr := readerresult.OfLazy[Config](lazyValue)
// result := rr(Config{Host: "localhost"}) // result.Of(42)
//
// Example - Deferring expensive computation:
//
// type Env struct { Debug bool }
// expensiveCalc := func() string {
// // Expensive but pure computation here
// return "computed result"
// }
// rr := readerresult.OfLazy[Env](expensiveCalc)
// // Computation is deferred until the ReaderResult is executed
// result := rr(Env{Debug: true}) // result.Of("computed result")
func OfLazy[R, A any](r Lazy[A]) ReaderResult[R, A] {
return readereither.OfLazy[R, error](r)
}
// MonadAp applies a function wrapped in a ReaderResult to a value wrapped in a ReaderResult.
// Both computations share the same environment. This is useful for combining independent
// computations that don't depend on each other's results.

View File

@@ -77,6 +77,101 @@ func TestOf(t *testing.T) {
assert.Equal(t, result.Of(42), rr(defaultContext))
}
func TestOfLazy(t *testing.T) {
t.Run("evaluates lazy computation ignoring environment", func(t *testing.T) {
lazyValue := func() int { return 42 }
rr := OfLazy[MyContext](lazyValue)
res := rr(defaultContext)
assert.Equal(t, result.Of(42), res)
})
t.Run("defers computation until ReaderResult is executed", func(t *testing.T) {
executed := false
lazyComputation := func() string {
executed = true
return "computed"
}
rr := OfLazy[MyContext](lazyComputation)
// Computation should not be executed yet
assert.False(t, executed, "lazy computation should not be executed during ReaderResult creation")
// Execute the ReaderResult
res := rr(defaultContext)
// Now computation should be executed
assert.True(t, executed, "lazy computation should be executed when ReaderResult runs")
assert.Equal(t, result.Of("computed"), res)
})
t.Run("evaluates lazy computation each time ReaderResult is called", func(t *testing.T) {
counter := 0
lazyCounter := func() int {
counter++
return counter
}
rr := OfLazy[MyContext](lazyCounter)
// First execution
res1 := rr(defaultContext)
assert.Equal(t, result.Of(1), res1)
// Second execution
res2 := rr(defaultContext)
assert.Equal(t, result.Of(2), res2)
// Third execution
res3 := rr(defaultContext)
assert.Equal(t, result.Of(3), res3)
})
t.Run("works with different types", func(t *testing.T) {
lazyString := func() string { return "hello" }
rr1 := OfLazy[MyContext](lazyString)
assert.Equal(t, result.Of("hello"), rr1(defaultContext))
lazySlice := func() []int { return []int{1, 2, 3} }
rr2 := OfLazy[MyContext](lazySlice)
assert.Equal(t, result.Of([]int{1, 2, 3}), rr2(defaultContext))
lazyStruct := func() MyContext { return "test" }
rr3 := OfLazy[string](lazyStruct)
assert.Equal(t, result.Of(MyContext("test")), rr3("ignored"))
})
t.Run("can be composed with other ReaderResult operations", func(t *testing.T) {
lazyValue := func() int { return 10 }
rr := F.Pipe1(
OfLazy[MyContext](lazyValue),
Map[MyContext](func(x int) int { return x * 2 }),
)
res := rr(defaultContext)
assert.Equal(t, result.Of(20), res)
})
t.Run("ignores environment completely", func(t *testing.T) {
lazyValue := func() string { return "constant" }
rr := OfLazy[MyContext](lazyValue)
// Different environments should produce same result
ctx1 := MyContext("context1")
ctx2 := MyContext("context2")
assert.Equal(t, result.Of("constant"), rr(ctx1))
assert.Equal(t, result.Of("constant"), rr(ctx2))
})
t.Run("always wraps result in success", func(t *testing.T) {
lazyValue := func() int { return 42 }
rr := OfLazy[MyContext](lazyValue)
res := rr(defaultContext)
// Verify it's a successful Result
assert.True(t, result.IsRight(res))
assert.Equal(t, result.Of(42), res)
})
}
func TestFromReader(t *testing.T) {
r := func(ctx MyContext) string { return string(ctx) }
rr := FromReader(r)

View File

@@ -6,9 +6,62 @@ This folder is meant to contain examples that illustrate how to use the library.
[![introduction to fp-go](presentation/cover.jpg)](https://www.youtube.com/watch?v=Jif3jL6DRdw "introduction to fp-go")
### References
## External Documentation References
- [Ryan's Blog](https://rlee.dev/practical-guide-to-fp-ts-part-1) - practical introduction into FP concepts
- [Investigate Functional Programming Concepts in Go](https://betterprogramming.pub/investigate-functional-programming-concepts-in-go-1dada09bc913) - discussion around FP concepts in golang
- [Investigating the I/O Monad in Go](https://medium.com/better-programming/investigating-the-i-o-monad-in-go-3c0fabbb4b3d) - a closer look at I/O monads in golang
-
### Official Documentation
- [API Documentation](https://pkg.go.dev/github.com/IBM/fp-go/v2) - Complete API reference
- [Go 1.24 Release Notes](https://tip.golang.org/doc/go1.24) - Information about generic type aliases
- [Go Blog: Generating code](https://go.dev/blog/generate) - Using `go generate`
- [Go Context Package](https://pkg.go.dev/context) - Standard library context documentation
### Functional Programming Concepts
#### Introductory Resources
- [Ryan's Blog](https://rlee.dev/practical-guide-to-fp-ts-part-1) - Practical introduction into FP concepts
- [Investigate Functional Programming Concepts in Go](https://betterprogramming.pub/investigate-functional-programming-concepts-in-go-1dada09bc913) - Discussion around FP concepts in golang
- [Investigating the I/O Monad in Go](https://medium.com/better-programming/investigating-the-i-o-monad-in-go-3c0fabbb4b3d) - A closer look at I/O monads in golang
- [Professor Frisby's Mostly Adequate Guide](https://github.com/MostlyAdequate/mostly-adequate-guide) - Comprehensive FP guide
- [mostly-adequate-fp-ts](https://github.com/ChuckJonas/mostly-adequate-fp-ts/) - TypeScript companion to Frisby's guide
#### Currying and Function Composition
- [Mostly Adequate Guide - Ch. 4: Currying](https://mostly-adequate.gitbook.io/mostly-adequate-guide/ch04) - Excellent introduction with clear examples
- [Curry and Function Composition](https://medium.com/javascript-scene/curry-and-function-composition-2c208d774983) by Eric Elliott
- [Why Curry Helps](https://hughfdjackson.com/javascript/why-curry-helps/) - Practical benefits of currying
### Haskell and Type Theory
- [Haskell Wiki - Currying](https://wiki.haskell.org/Currying) - Comprehensive explanation of currying in Haskell
- [Learn You a Haskell - Higher Order Functions](http://learnyouahaskell.com/higher-order-functions) - Introduction to currying and partial application
- [Haskell's Prelude](https://hackage.haskell.org/package/base/docs/Prelude.html) - Standard library showing data-last convention
- [Haskell Pair Type](https://hackage.haskell.org/package/TypeCompose-0.9.14/docs/Data-Pair.html) - Haskell definition of Pair
- [Haskell Lens Library](https://hackage.haskell.org/package/lens) - Pioneering optics library
### Optics
- [Introduction to optics: lenses and prisms](https://medium.com/@gcanti/introduction-to-optics-lenses-and-prisms-3230e73bfcfe) by Giulio Canti - Excellent introduction to optics concepts
- [Lenses in Functional Programming](https://www.schoolofhaskell.com/school/to-infinity-and-beyond/pick-of-the-week/a-little-lens-starter-tutorial) - Tutorial on lens fundamentals
- [Profunctor Optics: The Categorical View](https://bartoszmilewski.com/2017/07/07/profunctor-optics-the-categorical-view/) by Bartosz Milewski - Deep dive into the theory
- [Why Optics?](https://www.tweag.io/blog/2022-01-06-optics-vs-lenses/) - Discussion of benefits and use cases
### Related Libraries
- [fp-ts](https://github.com/gcanti/fp-ts) - TypeScript library that inspired fp-go
- [fp-ts Documentation](https://gcanti.github.io/fp-ts/) - TypeScript library documentation
- [fp-ts Issue #1238](https://github.com/gcanti/fp-ts/issues/1238) - Real-world examples of data-last refactoring
- [urfave/cli/v3](https://github.com/urfave/cli) - Underlying CLI framework
### Project Resources
- [GitHub Repository](https://github.com/IBM/fp-go) - Source code and issues
- [Coverage Status](https://coveralls.io/github/IBM/fp-go?branch=main) - Test coverage reports
- [Go Report Card](https://goreportcard.com/report/github.com/IBM/fp-go/v2) - Code quality metrics
- [Apache License 2.0](https://github.com/IBM/fp-go/blob/main/LICENSE) - Project license
### Internal Documentation
- [DESIGN.md](../DESIGN.md) - Design philosophy and patterns
- [IDIOMATIC_COMPARISON.md](../IDIOMATIC_COMPARISON.md) - Performance comparison between standard and idiomatic packages
- [Optics Overview](../optics/README.md) - Complete guide to lenses, prisms, and other optics
- [CLI Package](../cli/README.md) - Command-line interface utilities
- [ReaderResult Package](../idiomatic/context/readerresult/README.md) - Context-aware result handling

View File

@@ -123,3 +123,78 @@ func Last[A any]() Semigroup[A] {
func ToMagma[A any](s Semigroup[A]) M.Magma[A] {
return s
}
// ConcatWith creates a curried version of the Concat operation with the left argument fixed first.
// It returns a function that takes the left operand and returns another function that takes
// the right operand and performs the concatenation.
//
// This is useful for partial application and function composition patterns.
//
// # Type Parameters
//
// - A: The type of elements in the semigroup
//
// # Parameters
//
// - s: The semigroup to use for concatenation
//
// # Returns
//
// - func(A) func(A) A: A curried function that takes left then right operand
//
// # Example Usage
//
// import N "github.com/IBM/fp-go/v2/number"
// sum := N.SemigroupSum[int]()
// concatWith := ConcatWith(sum)
// add5 := concatWith(5)
// result := add5(3) // 5 + 3 = 8
//
// # See Also
//
// - AppendTo: Similar but fixes the right argument first
func ConcatWith[A any](s Semigroup[A]) func(A) func(A) A {
return func(l A) func(A) A {
return func(r A) A {
return s.Concat(l, r)
}
}
}
// AppendTo creates a curried version of the Concat operation with the right argument fixed first.
// It returns a function that takes the right operand and returns another function that takes
// the left operand and performs the concatenation.
//
// This is useful for partial application where you want to fix the second argument first,
// which is common in append-style operations.
//
// # Type Parameters
//
// - A: The type of elements in the semigroup
//
// # Parameters
//
// - s: The semigroup to use for concatenation
//
// # Returns
//
// - func(A) func(A) A: A curried function that takes right then left operand
//
// # Example Usage
//
// import S "github.com/IBM/fp-go/v2/string"
// strConcat := S.Semigroup
// appendTo := AppendTo(strConcat)
// addSuffix := appendTo("!")
// result := addSuffix("Hello") // "Hello" + "!" = "Hello!"
//
// # See Also
//
// - ConcatWith: Similar but fixes the left argument first
func AppendTo[A any](s Semigroup[A]) func(A) func(A) A {
return func(r A) func(A) A {
return func(l A) A {
return s.Concat(l, r)
}
}
}

View File

@@ -444,3 +444,261 @@ func BenchmarkFunctionSemigroup(b *testing.B) {
combined("hello")
}
}
// Test ConcatWith function
func TestConcatWith(t *testing.T) {
t.Run("with integer addition", func(t *testing.T) {
add := MakeSemigroup(func(a, b int) int { return a + b })
concatWith := ConcatWith(add)
// Fix left operand to 5
add5 := concatWith(5)
assert.Equal(t, 8, add5(3)) // 5 + 3 = 8
assert.Equal(t, 15, add5(10)) // 5 + 10 = 15
assert.Equal(t, 5, add5(0)) // 5 + 0 = 5
})
t.Run("with string concatenation", func(t *testing.T) {
concat := MakeSemigroup(func(a, b string) string { return a + b })
concatWith := ConcatWith(concat)
// Fix left operand to "Hello, "
greet := concatWith("Hello, ")
assert.Equal(t, "Hello, World", greet("World"))
assert.Equal(t, "Hello, Bob", greet("Bob"))
assert.Equal(t, "Hello, ", greet(""))
})
t.Run("with subtraction (non-commutative)", func(t *testing.T) {
sub := MakeSemigroup(func(a, b int) int { return a - b })
concatWith := ConcatWith(sub)
// Fix left operand to 10
subtract10 := concatWith(10)
assert.Equal(t, 7, subtract10(3)) // 10 - 3 = 7
assert.Equal(t, 5, subtract10(5)) // 10 - 5 = 5
assert.Equal(t, -5, subtract10(15)) // 10 - 15 = -5
})
t.Run("with First semigroup", func(t *testing.T) {
first := First[int]()
concatWith := ConcatWith(first)
// Fix left operand to 42
always42 := concatWith(42)
assert.Equal(t, 42, always42(1))
assert.Equal(t, 42, always42(100))
assert.Equal(t, 42, always42(0))
})
t.Run("with Last semigroup", func(t *testing.T) {
last := Last[string]()
concatWith := ConcatWith(last)
// Fix left operand to "first"
alwaysSecond := concatWith("first")
assert.Equal(t, "second", alwaysSecond("second"))
assert.Equal(t, "other", alwaysSecond("other"))
assert.Equal(t, "", alwaysSecond(""))
})
t.Run("currying behavior", func(t *testing.T) {
mul := MakeSemigroup(func(a, b int) int { return a * b })
concatWith := ConcatWith(mul)
// Create multiple partially applied functions
double := concatWith(2)
triple := concatWith(3)
quadruple := concatWith(4)
assert.Equal(t, 10, double(5)) // 2 * 5 = 10
assert.Equal(t, 15, triple(5)) // 3 * 5 = 15
assert.Equal(t, 20, quadruple(5)) // 4 * 5 = 20
})
t.Run("with complex types", func(t *testing.T) {
type Point struct {
X, Y int
}
pointAdd := MakeSemigroup(func(a, b Point) Point {
return Point{X: a.X + b.X, Y: a.Y + b.Y}
})
concatWith := ConcatWith(pointAdd)
// Fix left operand to origin offset
offset := concatWith(Point{X: 10, Y: 20})
assert.Equal(t, Point{X: 15, Y: 25}, offset(Point{X: 5, Y: 5}))
assert.Equal(t, Point{X: 10, Y: 20}, offset(Point{X: 0, Y: 0}))
})
}
// Test AppendTo function
func TestAppendTo(t *testing.T) {
t.Run("with integer addition", func(t *testing.T) {
add := MakeSemigroup(func(a, b int) int { return a + b })
appendTo := AppendTo(add)
// Fix right operand to 5
addTo5 := appendTo(5)
assert.Equal(t, 8, addTo5(3)) // 3 + 5 = 8
assert.Equal(t, 15, addTo5(10)) // 10 + 5 = 15
assert.Equal(t, 5, addTo5(0)) // 0 + 5 = 5
})
t.Run("with string concatenation", func(t *testing.T) {
concat := MakeSemigroup(func(a, b string) string { return a + b })
appendTo := AppendTo(concat)
// Fix right operand to "!"
addExclamation := appendTo("!")
assert.Equal(t, "Hello!", addExclamation("Hello"))
assert.Equal(t, "World!", addExclamation("World"))
assert.Equal(t, "!", addExclamation(""))
})
t.Run("with subtraction (non-commutative)", func(t *testing.T) {
sub := MakeSemigroup(func(a, b int) int { return a - b })
appendTo := AppendTo(sub)
// Fix right operand to 3
subtract3 := appendTo(3)
assert.Equal(t, 7, subtract3(10)) // 10 - 3 = 7
assert.Equal(t, 2, subtract3(5)) // 5 - 3 = 2
assert.Equal(t, -3, subtract3(0)) // 0 - 3 = -3
assert.Equal(t, -8, subtract3(-5)) // -5 - 3 = -8
})
t.Run("with First semigroup", func(t *testing.T) {
first := First[string]()
appendTo := AppendTo(first)
// Fix right operand to "second"
alwaysFirst := appendTo("second")
assert.Equal(t, "first", alwaysFirst("first"))
assert.Equal(t, "other", alwaysFirst("other"))
assert.Equal(t, "", alwaysFirst(""))
})
t.Run("with Last semigroup", func(t *testing.T) {
last := Last[int]()
appendTo := AppendTo(last)
// Fix right operand to 42
always42 := appendTo(42)
assert.Equal(t, 42, always42(1))
assert.Equal(t, 42, always42(100))
assert.Equal(t, 42, always42(0))
})
t.Run("currying behavior", func(t *testing.T) {
mul := MakeSemigroup(func(a, b int) int { return a * b })
appendTo := AppendTo(mul)
// Create multiple partially applied functions
multiplyBy2 := appendTo(2)
multiplyBy3 := appendTo(3)
multiplyBy4 := appendTo(4)
assert.Equal(t, 10, multiplyBy2(5)) // 5 * 2 = 10
assert.Equal(t, 15, multiplyBy3(5)) // 5 * 3 = 15
assert.Equal(t, 20, multiplyBy4(5)) // 5 * 4 = 20
})
t.Run("with complex types", func(t *testing.T) {
type Point struct {
X, Y int
}
pointAdd := MakeSemigroup(func(a, b Point) Point {
return Point{X: a.X + b.X, Y: a.Y + b.Y}
})
appendTo := AppendTo(pointAdd)
// Fix right operand to offset
addOffset := appendTo(Point{X: 10, Y: 20})
assert.Equal(t, Point{X: 15, Y: 25}, addOffset(Point{X: 5, Y: 5}))
assert.Equal(t, Point{X: 10, Y: 20}, addOffset(Point{X: 0, Y: 0}))
})
}
// Test ConcatWith vs AppendTo difference
func TestConcatWithVsAppendTo(t *testing.T) {
t.Run("demonstrates order difference with non-commutative operation", func(t *testing.T) {
sub := MakeSemigroup(func(a, b int) int { return a - b })
concatWith := ConcatWith(sub)
appendTo := AppendTo(sub)
// ConcatWith fixes left operand first
subtract10From := concatWith(10) // 10 - x
assert.Equal(t, 7, subtract10From(3)) // 10 - 3 = 7
// AppendTo fixes right operand first
subtract3From := appendTo(3) // x - 3
assert.Equal(t, 7, subtract3From(10)) // 10 - 3 = 7
// Same result but different partial application order
assert.Equal(t, subtract10From(3), subtract3From(10))
})
t.Run("demonstrates order difference with string concatenation", func(t *testing.T) {
concat := MakeSemigroup(func(a, b string) string { return a + b })
concatWith := ConcatWith(concat)
appendTo := AppendTo(concat)
// ConcatWith: prefix is fixed
addPrefix := concatWith("Hello, ")
assert.Equal(t, "Hello, World", addPrefix("World"))
// AppendTo: suffix is fixed
addSuffix := appendTo("!")
assert.Equal(t, "Hello!", addSuffix("Hello"))
// Different results due to different order
assert.NotEqual(t, addPrefix("test"), addSuffix("test"))
})
}
// Test composition with ConcatWith and AppendTo
func TestConcatWithAppendToComposition(t *testing.T) {
t.Run("composing multiple operations", func(t *testing.T) {
add := MakeSemigroup(func(a, b int) int { return a + b })
// Create a pipeline: add 5, then add 3
concatWith := ConcatWith(add)
appendTo := AppendTo(add)
add5 := concatWith(5)
add3 := appendTo(3)
// Apply both operations
result := add3(add5(2)) // (2 + 5) + 3 = 10
assert.Equal(t, 10, result)
})
}
// Benchmark ConcatWith
func BenchmarkConcatWith(b *testing.B) {
add := MakeSemigroup(func(a, b int) int { return a + b })
concatWith := ConcatWith(add)
add5 := concatWith(5)
b.ResetTimer()
for b.Loop() {
add5(3)
}
}
// Benchmark AppendTo
func BenchmarkAppendTo(b *testing.B) {
add := MakeSemigroup(func(a, b int) int { return a + b })
appendTo := AppendTo(add)
addTo5 := appendTo(5)
b.ResetTimer()
for b.Loop() {
addTo5(3)
}
}