Merge pull request #35 from IBM/cleue-mostly-adequate-capter10

Add more examples for mostly-adequate

README.md

@@ -73,7 +73,7 @@ This library aims to provide a set of data types and functions that make it easy
 
 The library itself also comprises many small functions, but it's admittedly harder to maintain than code that uses it. However this asymmetry is intended because it offloads complexity from users into a central component.
 
-## Comparation to Idiomatic Go
+## Comparison to Idiomatic Go
 
 In this section we discuss how the functional APIs differ from idiomatic go function signatures and how to convert back and forth.
 
@@ -181,7 +181,7 @@ The `Map` operation for `ReaderIOEither` is defined as:
 func Map[R, E, A, B any](f func(A) B) func(fa ReaderIOEither[R, E, A]) ReaderIOEither[R, E, B]
 ```
 
-and in fact the equivalent operations for all other mondas follow the same pattern, we could try to introduce a new type for `ReaderIOEither` (without a parameter) as a HKT, e.g. like so (made-up syntax, does not work in go):
+and in fact the equivalent operations for all other monads follow the same pattern, we could try to introduce a new type for `ReaderIOEither` (without a parameter) as a HKT, e.g. like so (made-up syntax, does not work in go):
 
 ```go
 func Map[HKT, R, E, A, B any](f func(A) B) func(HKT[R, E, A]) HKT[R, E, B]

context/readerioeither/http/request_test.go

@@ -21,6 +21,13 @@ import (
 	"testing"
 
 	H "net/http"
+
+	R "github.com/IBM/fp-go/context/readerioeither"
+	E "github.com/IBM/fp-go/either"
+	"github.com/IBM/fp-go/errors"
+	F "github.com/IBM/fp-go/function"
+	IOE "github.com/IBM/fp-go/ioeither"
+	"github.com/stretchr/testify/assert"
 )
 
 type PostItem struct {
@@ -30,6 +37,47 @@ type PostItem struct {
 	Body   string `json:"body"`
 }
 
+func getTitle(item PostItem) string {
+	return item.Title
+}
+
+type simpleRequestBuilder struct {
+	method  string
+	url     string
+	headers H.Header
+}
+
+func requestBuilder() simpleRequestBuilder {
+	return simpleRequestBuilder{method: "GET"}
+}
+
+func (b simpleRequestBuilder) WithURL(url string) simpleRequestBuilder {
+	b.url = url
+	return b
+}
+
+func (b simpleRequestBuilder) WithHeader(key, value string) simpleRequestBuilder {
+	if b.headers == nil {
+		b.headers = make(H.Header)
+	} else {
+		b.headers = b.headers.Clone()
+	}
+	b.headers.Set(key, value)
+	return b
+}
+
+func (b simpleRequestBuilder) Build() R.ReaderIOEither[*H.Request] {
+	return func(ctx context.Context) IOE.IOEither[error, *H.Request] {
+		return IOE.TryCatchError(func() (*H.Request, error) {
+			req, err := H.NewRequestWithContext(ctx, b.method, b.url, nil)
+			if err == nil {
+				req.Header = b.headers
+			}
+			return req, err
+		})
+	}
+}
+
 func TestSendSingleRequest(t *testing.T) {
 
 	client := MakeClient(H.DefaultClient)
@@ -40,7 +88,70 @@ func TestSendSingleRequest(t *testing.T) {
 
 	resp1 := readItem(req1)
 
-	resE := resp1(context.Background())()
+	resE := resp1(context.TODO())()
 
 	fmt.Println(resE)
 }
+
+// setHeaderUnsafe updates a header value in a request object by mutating the request object
+func setHeaderUnsafe(key, value string) func(*H.Request) *H.Request {
+	return func(req *H.Request) *H.Request {
+		req.Header.Set(key, value)
+		return req
+	}
+}
+
+func TestSendSingleRequestWithHeaderUnsafe(t *testing.T) {
+
+	client := MakeClient(H.DefaultClient)
+
+	// this is not safe from a puristic perspective, because the map call mutates the request object
+	req1 := F.Pipe2(
+		"https://jsonplaceholder.typicode.com/posts/1",
+		MakeGetRequest,
+		R.Map(setHeaderUnsafe("Content-Type", "text/html")),
+	)
+
+	readItem := ReadJson[PostItem](client)
+
+	resp1 := F.Pipe2(
+		req1,
+		readItem,
+		R.Map(getTitle),
+	)
+
+	res := F.Pipe1(
+		resp1(context.TODO())(),
+		E.GetOrElse(errors.ToString),
+	)
+
+	assert.Equal(t, "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", res)
+}
+
+func TestSendSingleRequestWithHeaderSafe(t *testing.T) {
+
+	client := MakeClient(H.DefaultClient)
+
+	// the request builder assembles config values to construct
+	// the final http request. Each `With` step creates a copy of the settings
+	// so the flow is pure
+	request := requestBuilder().
+		WithURL("https://jsonplaceholder.typicode.com/posts/1").
+		WithHeader("Content-Type", "text/html").
+		Build()
+
+	readItem := ReadJson[PostItem](client)
+
+	response := F.Pipe2(
+		request,
+		readItem,
+		R.Map(getTitle),
+	)
+
+	res := F.Pipe1(
+		response(context.TODO())(),
+		E.GetOrElse(errors.ToString),
+	)
+
+	assert.Equal(t, "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", res)
+}

function/cache.go

@@ -0,0 +1,30 @@
+// Copyright (c) 2023 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 function
+
+import (
+	G "github.com/IBM/fp-go/function/generic"
+)
+
+// Cache converts a unary function into a unary function that caches the value depending on the parameter
+func Cache[K comparable, T any](f func(K) T) func(K) T {
+	return G.Cache(f)
+}
+
+// ContramapCache converts a unary function into a unary function that caches the value depending on the parameter
+func ContramapCache[A any, K comparable, T any](kf func(A) K) func(func(A) T) func(A) T {
+	return G.ContramapCache[func(A) T](kf)
+}

function/cache_test.go

@@ -0,0 +1,50 @@
+// Copyright (c) 2023 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 function
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCache(t *testing.T) {
+	var count int
+
+	withSideEffect := func(n int) int {
+		count++
+		return n
+	}
+
+	cached := Cache(withSideEffect)
+
+	assert.Equal(t, 0, count)
+
+	assert.Equal(t, 10, cached(10))
+	assert.Equal(t, 1, count)
+
+	assert.Equal(t, 10, cached(10))
+	assert.Equal(t, 1, count)
+
+	assert.Equal(t, 20, cached(20))
+	assert.Equal(t, 2, count)
+
+	assert.Equal(t, 20, cached(20))
+	assert.Equal(t, 2, count)
+
+	assert.Equal(t, 10, cached(10))
+	assert.Equal(t, 2, count)
+}

function/generic/cache.go

@@ -0,0 +1,65 @@
+// Copyright (c) 2023 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 generic
+
+import (
+	"sync"
+
+	L "github.com/IBM/fp-go/internal/lazy"
+)
+
+// Cache converts a unary function into a unary function that caches the value depending on the parameter
+func Cache[F ~func(K) T, K comparable, T any](f F) F {
+	return ContramapCache[F](func(k K) K { return k })(f)
+}
+
+// ContramapCache converts a unary function into a unary function that caches the value depending on the parameter
+func ContramapCache[F ~func(A) T, KF func(A) K, A any, K comparable, T any](kf KF) func(F) F {
+	return CacheCallback[F](kf, getOrCreate[K, T]())
+}
+
+// getOrCreate is a naive implementation of a cache, without bounds
+func getOrCreate[K comparable, T any]() func(K, func() func() T) func() T {
+	cache := make(map[K]func() T)
+	var l sync.Mutex
+
+	return func(k K, cb func() func() T) func() T {
+		// only lock to access a lazy accessor to the value
+		l.Lock()
+		existing, ok := cache[k]
+		if !ok {
+			existing = cb()
+			cache[k] = existing
+		}
+		l.Unlock()
+		// compute the value outside of the lock
+		return existing
+	}
+}
+
+// CacheCallback converts a unary function into a unary function that caches the value depending on the parameter
+func CacheCallback[F ~func(A) T, KF func(A) K, C ~func(K, func() func() T) func() T, A any, K comparable, T any](kf KF, getOrCreate C) func(F) F {
+	return func(f F) F {
+		return func(a A) T {
+			// cache entry
+			return getOrCreate(kf(a), func() func() T {
+				return L.Memoize[func() T](func() T {
+					return f(a)
+				})
+			})()
+		}
+	}
+}

internal/lazy/memoize.go

@@ -0,0 +1,34 @@
+// Copyright (c) 2023 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 lazy
+
+import "sync"
+
+// Memoize computes the value of the provided IO monad lazily but exactly once
+func Memoize[GA ~func() A, A any](ma GA) GA {
+	// synchronization primitives
+	var once sync.Once
+	var result A
+	// callback
+	gen := func() {
+		result = ma()
+	}
+	// returns our memoized wrapper
+	return func() A {
+		once.Do(gen)
+		return result
+	}
+}

io/generic/io.go

@@ -16,11 +16,11 @@
 package generic
 
 import (
-	"sync"
 	"time"
 
 	F "github.com/IBM/fp-go/function"
 	C "github.com/IBM/fp-go/internal/chain"
+	L "github.com/IBM/fp-go/internal/lazy"
 )
 
 // type IO[A any] = func() A
@@ -119,18 +119,7 @@ func Flatten[GA ~func() A, GAA ~func() GA, A any](mma GAA) GA {
 
 // Memoize computes the value of the provided IO monad lazily but exactly once
 func Memoize[GA ~func() A, A any](ma GA) GA {
-	// synchronization primitives
-	var once sync.Once
-	var result A
-	// callback
-	gen := func() {
-		result = ma()
-	}
-	// returns our memoized wrapper
-	return func() A {
-		once.Do(gen)
-		return result
-	}
+	return L.Memoize[GA, A](ma)
 }
 
 // Delay creates an operation that passes in the value after some delay

lazy/lazy.go

@@ -83,7 +83,7 @@ func Flatten[A any](mma Lazy[Lazy[A]]) Lazy[A] {
 	return G.Flatten(mma)
 }
 
-// Memoize computes the value of the provided IO monad lazily but exactly once
+// Memoize computes the value of the provided [Lazy] monad lazily but exactly once
 func Memoize[A any](ma Lazy[A]) Lazy[A] {
 	return G.Memoize(ma)
 }

number/integer/string.go

@@ -0,0 +1,23 @@
+// Copyright (c) 2023 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 integer
+
+import "strconv"
+
+var (
+	// ToString converts an integer to a string
+	ToString = strconv.Itoa
+)

number/magma.go

@@ -24,3 +24,9 @@ func MagmaSub[A Number]() M.Magma[A] {
 		return first - second
 	})
 }
+
+func MagmaDiv[A Number]() M.Magma[A] {
+	return M.MakeMagma(func(first A, second A) A {
+		return first / second
+	})
+}

number/monoid.go

@@ -19,6 +19,7 @@ import (
 	M "github.com/IBM/fp-go/monoid"
 )
 
+// MonoidSum is the [Monoid] that adds elements with a zero empty element
 func MonoidSum[A Number]() M.Monoid[A] {
 	s := SemigroupSum[A]()
 	return M.MakeMonoid(
@@ -26,3 +27,12 @@ func MonoidSum[A Number]() M.Monoid[A] {
 		0,
 	)
 }
+
+// MonoidProduct is the [Monoid] that multiplies elements with a one empty element
+func MonoidProduct[A Number]() M.Monoid[A] {
+	s := SemigroupProduct[A]()
+	return M.MakeMonoid(
+		s.Concat,
+		1,
+	)
+}

number/semigroup.go

@@ -24,3 +24,9 @@ func SemigroupSum[A Number]() S.Semigroup[A] {
 		return first + second
 	})
 }
+
+func SemigroupProduct[A Number]() S.Semigroup[A] {
+	return S.MakeSemigroup(func(first A, second A) A {
+		return first * second
+	})
+}

number/utils.go

@@ -24,16 +24,30 @@ type Number interface {
 }
 
 // Add is a curried function used to add two numbers
-func Add[T Number](left T) func(T) T {
-	return func(right T) T {
+func Add[T Number](right T) func(T) T {
+	return func(left T) T {
 		return left + right
 	}
 }
 
-// Mul is a curried function used to add two numbers
-func Mul[T Number](coeff T) func(T) T {
-	return func(value T) T {
-		return coeff * value
+// Sub is a curried function used to subtract two numbers
+func Sub[T Number](right T) func(T) T {
+	return func(left T) T {
+		return left - right
+	}
+}
+
+// Mul is a curried function used to multiply two numbers
+func Mul[T Number](right T) func(T) T {
+	return func(left T) T {
+		return left * right
+	}
+}
+
+// Div is a curried function used to divide two numbers
+func Div[T Number](right T) func(T) T {
+	return func(left T) T {
+		return left / right
 	}
 }
 

ord/ord.go

@@ -131,9 +131,7 @@ func FromStrictCompare[A C.Ordered]() Ord[A] {
 	return MakeOrd(strictCompare[A], strictEq[A])
 }
 
-/**
- * Test whether one value is _strictly less than_ another
- */
+// Lt tests whether one value is strictly less than another
 func Lt[A any](O Ord[A]) func(A) func(A) bool {
 	return func(second A) func(A) bool {
 		return func(first A) bool {
@@ -142,9 +140,7 @@ func Lt[A any](O Ord[A]) func(A) func(A) bool {
 	}
 }
 
-/**
- * Test whether one value is less or equal than_ another
- */
+// Leq Tests whether one value is less or equal than another
 func Leq[A any](O Ord[A]) func(A) func(A) bool {
 	return func(second A) func(A) bool {
 		return func(first A) bool {
@@ -154,7 +150,7 @@ func Leq[A any](O Ord[A]) func(A) func(A) bool {
 }
 
 /**
- * Test whether one value is _strictly greater than_ another
+ * Test whether one value is strictly greater than another
  */
 func Gt[A any](O Ord[A]) func(A) func(A) bool {
 	return func(second A) func(A) bool {
@@ -164,9 +160,7 @@ func Gt[A any](O Ord[A]) func(A) func(A) bool {
 	}
 }
 
-/**
- * Test whether one value is greater or equal than_ another
- */
+// Geq tests whether one value is greater or equal than another
 func Geq[A any](O Ord[A]) func(A) func(A) bool {
 	return func(second A) func(A) bool {
 		return func(first A) bool {

samples/mostly-adequate/README.md

@@ -0,0 +1,6 @@
+# Mostly Adequate: fp-go Companion Guide
+
+This resource is meant to serve as a go "companion" resource to Professor [Frisby's Mostly Adequate Guide](https://github.com/MostlyAdequate/mostly-adequate-guide).  
+
+It is a port of the [mostly-adequate-fp-ts](https://github.com/ChuckJonas/mostly-adequate-fp-ts/) book.
+

samples/mostly-adequate/chapter01_test.go

@@ -0,0 +1,47 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import "fmt"
+
+type Flock struct {
+	Seagulls int
+}
+
+func MakeFlock(n int) Flock {
+	return Flock{Seagulls: n}
+}
+
+func (f *Flock) Conjoin(other *Flock) *Flock {
+	f.Seagulls += other.Seagulls
+	return f
+}
+
+func (f *Flock) Breed(other *Flock) *Flock {
+	f.Seagulls = f.Seagulls * other.Seagulls
+	return f
+}
+
+func Example_flock() {
+
+	flockA := MakeFlock(4)
+	flockB := MakeFlock(2)
+	flockC := MakeFlock(0)
+
+	fmt.Println(flockA.Conjoin(&flockC).Breed(&flockB).Conjoin(flockA.Breed(&flockB)).Seagulls)
+
+	// Output: 32
+}

samples/mostly-adequate/chapter02_firstclassfunctions_test.go

@@ -0,0 +1,38 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import "fmt"
+
+func Hi(name string) string {
+	return fmt.Sprintf("Hi %s", name)
+}
+
+func Greeting(name string) string {
+	return Hi(name)
+}
+
+func Example_greeting() {
+	// functions are first class objects
+	greet := Hi
+
+	fmt.Println(Greeting("times"))
+	fmt.Println(greet("times"))
+
+	// Output:
+	// Hi times
+	// Hi times
+}

samples/mostly-adequate/chapter04_currying_test.go

@@ -0,0 +1,83 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"fmt"
+	"math"
+	"regexp"
+	"strings"
+
+	A "github.com/IBM/fp-go/array"
+	F "github.com/IBM/fp-go/function"
+	N "github.com/IBM/fp-go/number"
+	I "github.com/IBM/fp-go/number/integer"
+	S "github.com/IBM/fp-go/string"
+)
+
+var (
+	Match   = F.Curry2((*regexp.Regexp).FindStringSubmatch)
+	Matches = F.Curry2((*regexp.Regexp).MatchString)
+	Split   = F.Curry2(F.Bind3of3((*regexp.Regexp).Split)(-1))
+
+	Add      = N.Add[int]
+	ToString = I.ToString
+	ToLower  = strings.ToLower
+	ToUpper  = strings.ToUpper
+	Concat   = F.Curry2(S.Monoid.Concat)
+)
+
+// Replace cannot be generated via [F.Curry3] because the order of parameters does not match our desired curried order
+func Replace(search *regexp.Regexp) func(replace string) func(s string) string {
+	return func(replace string) func(s string) string {
+		return func(s string) string {
+			return search.ReplaceAllString(s, replace)
+		}
+	}
+}
+
+func Example_solution04A() {
+	// words :: String -> [String]
+	words := Split(regexp.MustCompile(` `))
+
+	fmt.Println(words("Jingle bells Batman smells"))
+
+	// Output:
+	// [Jingle bells Batman smells]
+}
+
+func Example_solution04B() {
+	// filterQs :: [String] -> [String]
+	filterQs := A.Filter(Matches(regexp.MustCompile(`q`)))
+
+	fmt.Println(filterQs(A.From("quick", "camels", "quarry", "over", "quails")))
+
+	// Output:
+	// [quick quarry quails]
+}
+
+func Example_solution04C() {
+
+	keepHighest := N.Max[int]
+
+	// max :: [Number] -> Number
+	max := A.Reduce(keepHighest, math.MinInt)
+
+	fmt.Println(max(A.From(323, 523, 554, 123, 5234)))
+
+	// Output:
+	// 5234
+}

samples/mostly-adequate/chapter05_composing_test.go

@@ -0,0 +1,110 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"fmt"
+	"regexp"
+
+	A "github.com/IBM/fp-go/array"
+	F "github.com/IBM/fp-go/function"
+	I "github.com/IBM/fp-go/number/integer"
+	O "github.com/IBM/fp-go/option"
+	"github.com/IBM/fp-go/ord"
+	S "github.com/IBM/fp-go/string"
+)
+
+var (
+	Exclaim   = S.Format[string]("%s!")
+	Shout     = F.Flow2(ToUpper, Exclaim)
+	Dasherize = F.Flow4(
+		Replace(regexp.MustCompile(`\s{2,}`))(" "),
+		Split(regexp.MustCompile(` `)),
+		A.Map(ToLower),
+		A.Intercalate(S.Monoid)("-"),
+	)
+)
+
+func Example_shout() {
+	fmt.Println(Shout("send in the clowns"))
+
+	// Output: SEND IN THE CLOWNS!
+}
+
+func Example_dasherize() {
+	fmt.Println(Dasherize("The world is a vampire"))
+
+	// Output: the-world-is-a-vampire
+}
+
+func Example_pipe() {
+	output := F.Pipe2(
+		"send in the clowns",
+		ToUpper,
+		Exclaim,
+	)
+
+	fmt.Println(output)
+
+	// Output: SEND IN THE CLOWNS!
+}
+
+func Example_solution05A() {
+	IsLastInStock := F.Flow2(
+		A.Last[Car],
+		O.Map(Car.getInStock),
+	)
+
+	fmt.Println(IsLastInStock(Cars[0:3]))
+	fmt.Println(IsLastInStock(Cars[3:]))
+
+	// Output:
+	// Some[bool](true)
+	// Some[bool](false)
+}
+
+func Example_solution05B() {
+	// averageDollarValue :: [Car] -> Int
+	averageDollarValue := F.Flow2(
+		A.Map(Car.getDollarValue),
+		average,
+	)
+
+	fmt.Println(averageDollarValue(Cars))
+
+	// Output:
+	// 790700
+}
+
+func Example_solution05C() {
+	// order by horsepower
+	ordByHorsepower := ord.Contramap(Car.getHorsepower)(I.Ord)
+
+	// fastestCar :: [Car] -> Option[String]
+	fastestCar := F.Flow3(
+		A.Sort(ordByHorsepower),
+		A.Last[Car],
+		O.Map(F.Flow2(
+			Car.getName,
+			S.Format[string]("%s is the fastest"),
+		)),
+	)
+
+	fmt.Println(fastestCar(Cars))
+
+	// Output:
+	// Some[string](Aston Martin One-77 is the fastest)
+}

samples/mostly-adequate/chapter06_exampleapplication_test.go

@@ -0,0 +1,115 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"regexp"
+
+	A "github.com/IBM/fp-go/array"
+	E "github.com/IBM/fp-go/either"
+	F "github.com/IBM/fp-go/function"
+	J "github.com/IBM/fp-go/json"
+	S "github.com/IBM/fp-go/string"
+
+	R "github.com/IBM/fp-go/context/readerioeither"
+	H "github.com/IBM/fp-go/context/readerioeither/http"
+)
+
+type (
+	FlickrMedia struct {
+		Link string `json:"m"`
+	}
+
+	FlickrItem struct {
+		Media FlickrMedia `json:"media"`
+	}
+
+	FlickrFeed struct {
+		Items []FlickrItem `json:"items"`
+	}
+)
+
+func (f FlickrMedia) getLink() string {
+	return f.Link
+}
+
+func (f FlickrItem) getMedia() FlickrMedia {
+	return f.Media
+}
+
+func (f FlickrFeed) getItems() []FlickrItem {
+	return f.Items
+}
+
+func Example_application() {
+	// pure
+	host := "api.flickr.com"
+	path := "/services/feeds/photos_public.gne"
+	query := S.Format[string]("?tags=%s&format=json&jsoncallback=?")
+	url := F.Flow2(
+		query,
+		S.Format[string](fmt.Sprintf("https://%s%s%%s", host, path)),
+	)
+	// flick returns jsonP, we extract the JSON body, this is handled by jquery in the original code
+	sanitizeJsonP := Replace(regexp.MustCompile(`(?s)^\s*\((.*)\)\s*$`))("$1")
+	// parse jsonP
+	parseJsonP := F.Flow3(
+		sanitizeJsonP,
+		S.ToBytes,
+		J.Unmarshal[FlickrFeed],
+	)
+	// markup
+	img := S.Format[string]("<img src='%s'/>")
+	// lenses
+	mediaUrl := F.Flow2(
+		FlickrItem.getMedia,
+		FlickrMedia.getLink,
+	)
+	mediaUrls := F.Flow2(
+		FlickrFeed.getItems,
+		A.Map(mediaUrl),
+	)
+	images := F.Flow2(
+		mediaUrls,
+		A.Map(img),
+	)
+
+	client := H.MakeClient(http.DefaultClient)
+
+	// func(string) R.ReaderIOEither[[]string]
+	app := F.Flow5(
+		url,
+		H.MakeGetRequest,
+		H.ReadText(client),
+		R.ChainEitherK(parseJsonP),
+		R.Map(images),
+	)
+
+	// R.ReaderIOEither[[]string]
+	// this is the managed effect that can be called to download and render the images
+	catImageEffect := app("cats")
+
+	// impure, actually executes the effect
+	catImages := catImageEffect(context.TODO())()
+	fmt.Println(E.IsRight(catImages))
+
+	// Output:
+	// true
+
+}

samples/mostly-adequate/chapter08_tupperware_test.go

@@ -0,0 +1,276 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"fmt"
+	"time"
+
+	A "github.com/IBM/fp-go/array"
+	E "github.com/IBM/fp-go/either"
+	"github.com/IBM/fp-go/errors"
+	F "github.com/IBM/fp-go/function"
+	I "github.com/IBM/fp-go/identity"
+	IOE "github.com/IBM/fp-go/ioeither"
+	N "github.com/IBM/fp-go/number"
+	O "github.com/IBM/fp-go/option"
+	"github.com/IBM/fp-go/ord"
+	S "github.com/IBM/fp-go/string"
+)
+
+type Account struct {
+	Balance float32
+}
+
+func MakeAccount(b float32) Account {
+	return Account{Balance: b}
+}
+
+func getBalance(a Account) float32 {
+	return a.Balance
+}
+
+type (
+	Chapter08User struct {
+		Id     int
+		Name   string
+		Active bool
+		Saved  bool
+	}
+)
+
+var (
+	albert08 = Chapter08User{
+		Id:     1,
+		Active: true,
+		Name:   "Albert",
+	}
+
+	gary08 = Chapter08User{
+		Id:     2,
+		Active: false,
+		Name:   "Gary",
+	}
+
+	theresa08 = Chapter08User{
+		Id:     3,
+		Active: true,
+		Name:   "Theresa",
+	}
+
+	yi08 = Chapter08User{Id: 4, Name: "Yi", Active: true}
+)
+
+func (u Chapter08User) getName() string {
+	return u.Name
+}
+
+func (u Chapter08User) isActive() bool {
+	return u.Active
+}
+
+var (
+	ordFloat32       = ord.FromStrictCompare[float32]()
+	UpdateLedger     = F.Identity[Account]
+	RemainingBalance = F.Flow2(
+		getBalance,
+		S.Format[float32]("Your balance is $%0.2f"),
+	)
+	FinishTransaction = F.Flow2(
+		UpdateLedger,
+		RemainingBalance,
+	)
+	getTwenty = F.Flow2(
+		Withdraw(20),
+		O.Fold(F.Constant("You're broke!"), FinishTransaction),
+	)
+
+	// showWelcome :: User -> String
+	showWelcome = F.Flow2(
+		Chapter08User.getName,
+		S.Format[string]("Welcome %s"),
+	)
+
+	// checkActive :: User -> Either error User
+	checkActive = E.FromPredicate(Chapter08User.isActive, F.Constant1[Chapter08User](fmt.Errorf("Your account is not active")))
+
+	// validateUser :: (User -> Either String ()) -> User -> Either String User
+	validateUser = F.Curry2(func(validate func(Chapter08User) E.Either[error, any], user Chapter08User) E.Either[error, Chapter08User] {
+		return F.Pipe2(
+			user,
+			validate,
+			E.MapTo[error, any](user),
+		)
+	})
+
+	// save :: User -> IOEither error User
+	save = func(user Chapter08User) IOE.IOEither[error, Chapter08User] {
+		return IOE.FromIO[error](func() Chapter08User {
+			var u = user
+			u.Saved = true
+			return u
+		})
+	}
+)
+
+func Withdraw(amount float32) func(account Account) O.Option[Account] {
+
+	return F.Flow3(
+		getBalance,
+		O.FromPredicate(ord.Geq(ordFloat32)(amount)),
+		O.Map(F.Flow2(
+			N.Add(-amount),
+			MakeAccount,
+		)))
+}
+
+type User struct {
+	BirthDate string
+}
+
+func getBirthDate(u User) string {
+	return u.BirthDate
+}
+
+func MakeUser(d string) User {
+	return User{BirthDate: d}
+}
+
+var parseDate = F.Bind1of2(E.Eitherize2(time.Parse))(time.DateOnly)
+
+func GetAge(now time.Time) func(User) E.Either[error, float64] {
+	return F.Flow3(
+		getBirthDate,
+		parseDate,
+		E.Map[error](F.Flow3(
+			now.Sub,
+			time.Duration.Hours,
+			N.Mul(1/24.0),
+		)),
+	)
+}
+
+func Example_widthdraw() {
+	fmt.Println(getTwenty(MakeAccount(200)))
+	fmt.Println(getTwenty(MakeAccount(10)))
+
+	// Output:
+	// Your balance is $180.00
+	// You're broke!
+}
+
+func Example_getAge() {
+	now, err := time.Parse(time.DateOnly, "2023-09-01")
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(GetAge(now)(MakeUser("2005-12-12")))
+	fmt.Println(GetAge(now)(MakeUser("July 4, 2001")))
+
+	fortune := F.Flow3(
+		N.Add(365.0),
+		S.Format[float64]("%0.0f"),
+		Concat("If you survive, you will be "),
+	)
+
+	zoltar := F.Flow3(
+		GetAge(now),
+		E.Map[error](fortune),
+		E.GetOrElse(errors.ToString),
+	)
+
+	fmt.Println(zoltar(MakeUser("2005-12-12")))
+
+	// Output:
+	// Right[<nil>, float64](6472)
+	// Left[*time.ParseError, float64](parsing time "July 4, 2001" as "2006-01-02": cannot parse "July 4, 2001" as "2006")
+	// If you survive, you will be 6837
+}
+
+func Example_solution08A() {
+	incrF := I.Map(N.Add(1))
+
+	fmt.Println(incrF(I.Of(2)))
+
+	// Output: 3
+}
+
+func Example_solution08B() {
+	// initial :: User -> Option rune
+	initial := F.Flow3(
+		Chapter08User.getName,
+		S.ToRunes,
+		A.Head[rune],
+	)
+
+	fmt.Println(initial(albert08))
+
+	// Output:
+	// Some[int32](65)
+}
+
+func Example_solution08C() {
+
+	// eitherWelcome :: User -> Either String String
+	eitherWelcome := F.Flow2(
+		checkActive,
+		E.Map[error](showWelcome),
+	)
+
+	fmt.Println(eitherWelcome(gary08))
+	fmt.Println(eitherWelcome(theresa08))
+
+	// Output:
+	// Left[*errors.errorString, string](Your account is not active)
+	// Right[<nil>, string](Welcome Theresa)
+}
+
+func Example_solution08D() {
+
+	// // validateName :: User -> Either String ()
+	validateName := F.Flow3(
+		Chapter08User.getName,
+		E.FromPredicate(F.Flow2(
+			S.Size,
+			ord.Gt(ord.FromStrictCompare[int]())(3),
+		), errors.OnSome[string]("Your name %s is larger than 3 characters")),
+		E.Map[error](F.ToAny[string]),
+	)
+
+	saveAndWelcome := F.Flow2(
+		save,
+		IOE.Map[error](showWelcome),
+	)
+
+	register := F.Flow3(
+		validateUser(validateName),
+		IOE.FromEither[error, Chapter08User],
+		IOE.Chain(saveAndWelcome),
+	)
+
+	fmt.Println(validateName(gary08))
+	fmt.Println(validateName(yi08))
+
+	fmt.Println(register(albert08)())
+	fmt.Println(register(yi08)())
+
+	// Output:
+	// Right[<nil>, string](Gary)
+	// Left[*errors.errorString, <nil>](Your name Yi is larger than 3 characters)
+	// Right[<nil>, string](Welcome Albert)
+	// Left[*errors.errorString, string](Your name Yi is larger than 3 characters)
+}

samples/mostly-adequate/chapter09_monadiconions_test.go

@@ -0,0 +1,149 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"fmt"
+	"path"
+
+	A "github.com/IBM/fp-go/array"
+	F "github.com/IBM/fp-go/function"
+	"github.com/IBM/fp-go/io"
+	O "github.com/IBM/fp-go/option"
+	S "github.com/IBM/fp-go/string"
+)
+
+type (
+	Street struct {
+		Name   string
+		Number int
+	}
+
+	Address struct {
+		Street   Street
+		Postcode string
+	}
+
+	AddressBook struct {
+		Addresses []Address
+	}
+
+	Chapter09User struct {
+		Id      int
+		Name    string
+		Address Address
+	}
+)
+
+var (
+	albert09 = Chapter09User{
+		Id:   1,
+		Name: "Albert",
+		Address: Address{
+			Street: Street{
+				Number: 22,
+				Name:   "Walnut St",
+			},
+		},
+	}
+
+	gary09 = Chapter09User{
+		Id:   2,
+		Name: "Gary",
+		Address: Address{
+			Street: Street{
+				Number: 14,
+			},
+		},
+	}
+
+	theresa09 = Chapter09User{
+		Id:   3,
+		Name: "Theresa",
+	}
+)
+
+func (ab AddressBook) getAddresses() []Address {
+	return ab.Addresses
+}
+
+func (s Address) getStreet() Street {
+	return s.Street
+}
+
+func (s Street) getName() string {
+	return s.Name
+}
+
+func (u Chapter09User) getAddress() Address {
+	return u.Address
+}
+
+var (
+	FirstAddressStreet = F.Flow3(
+		AddressBook.getAddresses,
+		A.Head[Address],
+		O.Map(Address.getStreet),
+	)
+
+	// getFile :: IO String
+	getFile = io.Of("/home/mostly-adequate/ch09.md")
+
+	// pureLog :: String -> IO ()
+	pureLog = io.Logf[string]("%s")
+)
+
+func Example_street() {
+	s := FirstAddressStreet(AddressBook{
+		Addresses: A.From(Address{Street: Street{Name: "Mulburry", Number: 8402}, Postcode: "WC2N"}),
+	})
+	fmt.Println(s)
+
+	// Output:
+	// Some[mostlyadequate.Street]({Mulburry 8402})
+}
+
+func Example_solution09A() {
+	// // getStreetName :: User -> Maybe String
+	getStreetName := F.Flow4(
+		Chapter09User.getAddress,
+		Address.getStreet,
+		Street.getName,
+		O.FromPredicate(S.IsNonEmpty),
+	)
+
+	fmt.Println(getStreetName(albert09))
+	fmt.Println(getStreetName(gary09))
+	fmt.Println(getStreetName(theresa09))
+
+	// Output:
+	// Some[string](Walnut St)
+	// None[string]
+	// None[string]
+
+}
+
+func Example_solution09B() {
+	logFilename := F.Flow2(
+		io.Map(path.Base),
+		io.ChainFirst(pureLog),
+	)
+
+	fmt.Println(logFilename(getFile)())
+
+	// Output:
+	// ch09.md
+}

samples/mostly-adequate/chapter10_applicativefunctor_test.go

@@ -0,0 +1,73 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	R "github.com/IBM/fp-go/context/readerioeither"
+	H "github.com/IBM/fp-go/context/readerioeither/http"
+	F "github.com/IBM/fp-go/function"
+)
+
+type PostItem struct {
+	UserId uint   `json:"userId"`
+	Id     uint   `json:"id"`
+	Title  string `json:"title"`
+	Body   string `json:"body"`
+}
+
+func getTitle(item PostItem) string {
+	return item.Title
+}
+
+func idxToUrl(idx int) string {
+	return fmt.Sprintf("https://jsonplaceholder.typicode.com/posts/%d", idx+1)
+}
+
+func renderString(destinations string) func(string) string {
+	return func(events string) string {
+		return fmt.Sprintf("<div>Destinations: [%s], Events: [%s]</div>", destinations, events)
+	}
+}
+
+func Example_renderPage() {
+	// prepare the http client
+	client := H.MakeClient(http.DefaultClient)
+
+	// get returns the title of the nth item from the REST service
+	get := F.Flow4(
+		idxToUrl,
+		H.MakeGetRequest,
+		H.ReadJson[PostItem](client),
+		R.Map(getTitle),
+	)
+
+	res := F.Pipe2(
+		R.Of(renderString),                // start with a function with 2 unresolved arguments
+		R.Ap[func(string) string](get(1)), // resolve the first argument
+		R.Ap[string](get(2)),              // in parallel resolve the second argument
+	)
+
+	// finally invoke in context and start
+	fmt.Println(res(context.TODO())())
+
+	// Output:
+	// Right[<nil>, string](<div>Destinations: [qui est esse], Events: [ea molestias quasi exercitationem repellat qui ipsa sit aut]</div>)
+
+}

samples/mostly-adequate/doc.go

@@ -0,0 +1,19 @@
+// Copyright (c) 2023 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 mostlyadequate is meant to serve as a go "companion" resource to Professor [Frisby's Mostly Adequate Guide].
+//
+// [Frisby's Mostly Adequate Guide]: https://github.com/MostlyAdequate/mostly-adequate-guide
+package mostlyadequate

samples/mostly-adequate/support.go

@@ -0,0 +1,89 @@
+// Copyright (c) 2023 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 mostlyadequate
+
+import (
+	A "github.com/IBM/fp-go/array"
+	F "github.com/IBM/fp-go/function"
+	N "github.com/IBM/fp-go/number"
+)
+
+type (
+	Car struct {
+		Name        string
+		Horsepower  int
+		DollarValue float32
+		InStock     bool
+	}
+)
+
+func (car Car) getInStock() bool {
+	return car.InStock
+}
+
+func (car Car) getDollarValue() float32 {
+	return car.DollarValue
+}
+
+func (car Car) getHorsepower() int {
+	return car.Horsepower
+}
+
+func (car Car) getName() string {
+	return car.Name
+}
+
+func average(val []float32) float32 {
+	return F.Pipe2(
+		val,
+		A.Fold(N.MonoidSum[float32]()),
+		N.Div(float32(len(val))),
+	)
+}
+
+var (
+	Cars = A.From(Car{
+		Name:        "Ferrari FF",
+		Horsepower:  660,
+		DollarValue: 700000,
+		InStock:     true,
+	}, Car{
+		Name:        "Spyker C12 Zagato",
+		Horsepower:  650,
+		DollarValue: 648000,
+		InStock:     false,
+	}, Car{
+		Name:        "Jaguar XKR-S",
+		Horsepower:  550,
+		DollarValue: 132000,
+		InStock:     true,
+	}, Car{
+		Name:        "Audi R8",
+		Horsepower:  525,
+		DollarValue: 114200,
+		InStock:     false,
+	}, Car{
+		Name:        "Aston Martin One-77",
+		Horsepower:  750,
+		DollarValue: 1850000,
+		InStock:     true,
+	}, Car{
+		Name:        "Pagani Huayra",
+		Horsepower:  700,
+		DollarValue: 1300000,
+		InStock:     false,
+	})
+)

string/string.go

@@ -20,7 +20,7 @@ import (
 	"strings"
 
 	F "github.com/IBM/fp-go/function"
-	O "github.com/IBM/fp-go/ord"
+	"github.com/IBM/fp-go/ord"
 )
 
 var (
@@ -31,7 +31,7 @@ var (
 	ToLowerCase = strings.ToLower
 
 	// Ord implements the default ordering for strings
-	Ord = O.FromStrictCompare[string]()
+	Ord = ord.FromStrictCompare[string]()
 )
 
 func Eq(left string, right string) bool {
@@ -42,6 +42,10 @@ func ToBytes(s string) []byte {
 	return []byte(s)
 }
 
+func ToRunes(s string) []rune {
+	return []rune(s)
+}
+
 func IsEmpty(s string) bool {
 	return len(s) == 0
 }