Update package to v2

README.md

@@ -4,10 +4,10 @@
 
 A curated collection of utility functions and types absent from the Go standard library that make life easier.
 
-See documentation: https://pkg.go.dev/github.com/jpfourny/papaya
+See documentation: https://pkg.go.dev/github.com/jpfourny/papaya/v2
 
 See tests and examples for usage.
 
 ## Installation
 
-`go get github.com/jpfourny/papaya`
+`go get github.com/jpfourny/papaya/v2`

examples/people.go

@@ -3,7 +3,7 @@ package examples
 import (
 	"fmt"
 
-	"github.com/jpfourny/papaya/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
 )
 
 type Person struct {

examples/stream/map_test.go

@@ -2,11 +2,11 @@ package stream
 
 import (
 	"fmt"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
 	"testing"
 
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/stream"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/stream"
 )
 
 func TestMapIntToString(t *testing.T) {

examples/stream/sort_test.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/jpfourny/papaya/examples"
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/stream"
+	"github.com/jpfourny/papaya/v2/examples"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/stream"
 )
 
 func TestSort(t *testing.T) {

go.mod

@@ -1,3 +1,3 @@
-module github.com/jpfourny/papaya
+module github.com/jpfourny/papaya/v2
 
 go 1.23

internal/kvstore/kvstore.go

@@ -1,8 +1,8 @@
 package kvstore
 
 import (
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 	"slices"
 )
 

internal/kvstore/kvstore_test.go

@@ -1,9 +1,9 @@
 package kvstore
 
 import (
-	"github.com/jpfourny/papaya/internal/assert"
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/internal/assert"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 	"testing"
 )
 

pkg/cmp/comparer.go

@@ -4,8 +4,8 @@ import (
 	stdcmp "cmp"
 	"time"
 
-	"github.com/jpfourny/papaya/pkg/constraint"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/constraint"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 // Comparer is a function that compares two values of the same type E and returns an integer.

pkg/cmp/comparer_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/ptr"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/ptr"
 )
 
 type Person struct {

pkg/env/env.go

@@ -1,11 +1,11 @@
 package env
 
 import (
-	"github.com/jpfourny/papaya/pkg/constraint"
-	"github.com/jpfourny/papaya/pkg/opt"
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/stream"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/pkg/constraint"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/stream"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
 	"os"
 	"strings"
 	"time"

pkg/env/env_test.go

@@ -1,8 +1,8 @@
 package env
 
 import (
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/stream"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/stream"
 	"os"
 	"testing"
 	"time"

pkg/ptr/pointer.go

@@ -1,6 +1,6 @@
 package ptr
 
-import "github.com/jpfourny/papaya/pkg/opt"
+import "github.com/jpfourny/papaya/v2/pkg/opt"
 
 // Nil returns a nil pointer to the type parameter V.
 func Nil[V any]() *V {

pkg/res/failure.go

@@ -2,7 +2,7 @@ package res
 
 import (
 	"fmt"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 )
 
 // Failure represents a failed result.

pkg/res/partial_success.go

@@ -2,7 +2,7 @@ package res
 
 import (
 	"fmt"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 )
 
 // PartialSuccess represents a partially-successful result.

pkg/res/result.go

@@ -2,7 +2,7 @@ package res
 
 import (
 	"fmt"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 )
 
 // Result represents the result of an operation that may have a value and/or an error.

pkg/res/success.go

@@ -2,7 +2,7 @@ package res
 
 import (
 	"fmt"
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 )
 
 // Success represents a successful result.

pkg/stream/aggregate.go

@@ -1,11 +1,11 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/constraint"
-	"github.com/jpfourny/papaya/pkg/opt"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
-	"github.com/jpfourny/papaya/pkg/stream/reducer"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/constraint"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/pkg/stream/reducer"
 )
 
 // Reducer represents a function that takes two inputs of type E and returns an output of type E.

pkg/stream/aggregate_test.go

@@ -1,10 +1,10 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
 	"testing"
 
-	"github.com/jpfourny/papaya/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
 )
 
 func TestReduce(t *testing.T) {

pkg/stream/collect.go

@@ -2,9 +2,9 @@ package stream
 
 import (
 	"context"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
 
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 // CollectSlice returns a slice containing all elements from the stream.

pkg/stream/collect_test.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"testing"
 
-	"github.com/jpfourny/papaya/internal/assert"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/internal/assert"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 func TestCollectSlice(t *testing.T) {

pkg/stream/combine.go

@@ -2,11 +2,11 @@ package stream
 
 import (
 	"context"
-	"github.com/jpfourny/papaya/pkg/constraint"
-	"github.com/jpfourny/papaya/pkg/opt"
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
-	"github.com/jpfourny/papaya/pkg/stream/pred"
+	"github.com/jpfourny/papaya/v2/pkg/constraint"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/pkg/stream/pred"
 )
 
 // Combiner represents a function that combines two elements of type E1 and E2 into an element of type F.

pkg/stream/combine_test.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/jpfourny/papaya/internal/assert"
-	"github.com/jpfourny/papaya/pkg/opt"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/internal/assert"
+	"github.com/jpfourny/papaya/v2/pkg/opt"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 func TestCombine(t *testing.T) {

pkg/stream/consumer.go

@@ -0,0 +1,18 @@
+package stream
+
+// Consumer represents a function that accepts a yielded element of type E and returns a boolean value.
+// The boolean value indicates whether the consumer wishes to continue accepting elements.
+// If the consumer returns false, the caller must stop yielding elements.
+type Consumer[E any] func(yield E) (cont bool)
+
+func stopSensingConsumer[E any](c Consumer[E]) (Consumer[E], *bool) {
+	stopped := new(bool)
+	c2 := func(e E) bool {
+		if c(e) {
+			return true
+		}
+		*stopped = true
+		return false
+	}
+	return c2, stopped
+}

pkg/stream/consumer_test.go

@@ -0,0 +1,44 @@
+package stream
+
+import (
+	"slices"
+	"testing"
+)
+
+func Test_stopSensingConsumer(t *testing.T) {
+	t.Run("stream-exhausted", func(t *testing.T) {
+		s := Of(1, 2, 3)
+		var saw []int
+		c1 := func(e int) bool {
+			saw = append(saw, e)
+			return true
+		}
+		c2, stopped := stopSensingConsumer(c1)
+		s(c2)
+		if *stopped {
+			t.Errorf("expected stopped to be false; got true")
+		}
+		want := []int{1, 2, 3}
+		if !slices.Equal(saw, want) {
+			t.Errorf("expected to see %v; got %v", want, saw)
+		}
+	})
+
+	t.Run("consumer-stopped", func(t *testing.T) {
+		s := Of(1, 2, 3)
+		var saw []int
+		c1 := func(e int) bool {
+			saw = append(saw, e)
+			return false
+		}
+		c2, stopped := stopSensingConsumer(c1)
+		s(c2)
+		if !*stopped {
+			t.Errorf("expected stopped to be true; got false")
+		}
+		want := []int{1}
+		if !slices.Equal(saw, want) {
+			t.Errorf("expected to see %v; got %v", want, saw)
+		}
+	})
+}

pkg/stream/filter.go

@@ -1,9 +1,9 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/internal/kvstore"
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/internal/kvstore"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 // Predicate is a function that accepts a value of type E and returns a boolean.

pkg/stream/filter_test.go

@@ -1,11 +1,11 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 	"testing"
 
-	"github.com/jpfourny/papaya/internal/assert"
+	"github.com/jpfourny/papaya/v2/internal/assert"
 )
 
 func TestFilter(t *testing.T) {

pkg/stream/from.go

@@ -3,7 +3,7 @@ package stream
 import (
 	"context"
 
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 // FromSlice creates a stream that iterates over the elements of the given slice.

pkg/stream/from_test.go

@@ -6,8 +6,8 @@ import (
 	"sync"
 	"testing"
 
-	"github.com/jpfourny/papaya/internal/assert"
-	"github.com/jpfourny/papaya/pkg/pair"
+	"github.com/jpfourny/papaya/v2/internal/assert"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
 )
 
 func TestFromSlice(t *testing.T) {

pkg/stream/generate_test.go

@@ -1,7 +1,7 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/internal/assert"
+	"github.com/jpfourny/papaya/v2/internal/assert"
 	"math/rand"
 	"testing"
 )

pkg/stream/group.go

@@ -1,11 +1,11 @@
 package stream
 
 import (
-	"github.com/jpfourny/papaya/internal/kvstore"
-	"github.com/jpfourny/papaya/pkg/cmp"
-	"github.com/jpfourny/papaya/pkg/constraint"
-	"github.com/jpfourny/papaya/pkg/pair"
-	"github.com/jpfourny/papaya/pkg/stream/mapper"
+	"github.com/jpfourny/papaya/v2/internal/kvstore"
+	"github.com/jpfourny/papaya/v2/pkg/cmp"
+	"github.com/jpfourny/papaya/v2/pkg/constraint"
+	"github.com/jpfourny/papaya/v2/pkg/pair"
+	"github.com/jpfourny/papaya/v2/pkg/stream/mapper"
 )
 
 // GroupByKey returns a stream that values key-value pairs by key.