Merge branch 'v2'

Author: BooleanCat

.github/pull_request_template.md

@@ -13,8 +13,6 @@ If there is no such issue, consider creating one first. Discussions concerning p
 _Replace the space in each box with "X" to check it off._
 
 - [ ] I have read and understood the CONTRIBUTING guidelines
-- [ ] My code is formatted (`make check`)
-- [ ] I have run tests (`make test`)
 - [ ] All commits in my PR conform to the commit hygiene section
 - [ ] I have added relevant tests
 - [ ] I have not added any dependencies

.github/workflows/test.yaml

@@ -1,48 +1,33 @@
 name: test
 on:
-  push: { branches: [main] }
-  pull_request: {}
+  push: { branches: [v2] }
+  pull_request: { branches: [v2] }
 jobs:
   check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "1.22"
+          go-version: 1.23.0-rc.1
           cache: false
       - run: make check
         env: { SKIP_LINT: true }
-      - uses: golangci/golangci-lint-action@v5
-        with: { version: "latest" }
+      # - uses: golangci/golangci-lint-action@v4
+      #   with: { version: "latest" }
       - run: make cov
+        env: { GOEXPERIMENT: rangefunc }
       - uses: codecov/codecov-action@v4
         env: { CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}" }
   test:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        go-version: ["1.21", "1.22"]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "${{ matrix.go-version }}"
+          go-version: 1.23.0-rc.1
           cache: false
       - run: make test
-  test-v2:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: "1.22"
-          cache: false
-      - run: |
-          go work init .
-          go work use v2
-          make test-v2

.gitignore

@@ -1,3 +1,4 @@
 coverage.txt
 .vscode/
-go.work
+go.work
+.envrc

Makefile

@@ -1,7 +1,9 @@
 .phony: test check lint
 
+GO_BINARY ?= go
+
 check: lint
-	@go vet ./...
+	@$(GO_BINARY) vet ./...
 	@gofmt -l .
 	@test -z "$$( gofmt -l . )"
 
@@ -11,13 +13,8 @@ ifndef SKIP_LINT
 endif
 
 test:
-	go test -race -v ./...
-
-test-v2: export GOEXPERIMENT = rangefunc
-test-v2:
-	go vet ./v2/...
-	go test -v -race ./v2/...
+	$(GO_BINARY) test -race -v ./...
 
 cov: SHELL:=/bin/bash
 cov:
-	go test -race -coverprofile=coverage.txt -covermode=atomic $$( go list ./... | grep -v internal )
+	$(GO_BINARY) test -race -coverprofile=coverage.txt -covermode=atomic $$( $(GO_BINARY) list ./... | grep -v assert )

README.md

@@ -2,65 +2,19 @@
 
 [![GitHub release (with filter)](https://img.shields.io/github/v/release/BooleanCat/go-functional?sort=semver&logo=Go&color=%23007D9C)](https://github.com/BooleanCat/go-functional/releases) [![Actions Status](https://github.com/BooleanCat/go-functional/workflows/test/badge.svg)](https://github.com/BooleanCat/go-functional/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/BooleanCat/go-functional.svg)](https://pkg.go.dev/github.com/BooleanCat/go-functional) [![Go Report Card](https://goreportcard.com/badge/github.com/BooleanCat/go-functional)](https://goreportcard.com/report/github.com/BooleanCat/go-functional) [![codecov](https://codecov.io/gh/BooleanCat/go-functional/branch/main/graph/badge.svg?token=N2E43RSR14)](https://codecov.io/gh/BooleanCat/go-functional)
 
-A general purpose library offering functional helpers for Golang.
+A library of iterators for use with `iter.Seq`.
 
 ```go
-// Find the first 5 even numbers
-evens := iter.Count().Filter(filters.IsEven).Take(5).Collect()
-reflect.DeepEqual(evens, []int{0, 2, 4, 6, 8})
-```
-
-_[Read the docs.](https://pkg.go.dev/github.com/BooleanCat/go-functional)_
-
-## Core concepts
-
-This library introduces two core concepts, the `Iterator` and the `Option`.
-Using these two concepts this library derives many pre-defined iterators for
-use.
-
-### The `Option`
-
-The `Option` is simply a type that represents the presence or absence of a
-value. Options behave somewhat like enumerations with two variants:
-`Some(value)` and `None`.
-
-### The `Iterator`
-
-```go
-type Iterator[T any] interface {
-	Next() option.Option[T]
-}
-```
+// The first 5 natural numbers
+numbers := slices.Collect(
+	it.Take(it.Count(), 5),
+)
 
-The `Iterator` is an interface that defines the behaviour of some type that
-"yields" values. Each call to `Next()` on an `Iterator` will yield another
-value as defined by that specific `Iterator`. For example, the iterator
-`iter.Count()` yields 0, 1, 2, 3, etc. and onwards to infinity (or the integer
-limit!).
+// All even numbers
+evens := it.Filter(it.Count(), filter.IsEven)
 
-Iterators will yield `Some(value)` for as long as they have values to yield.
-Iterators that have exhausted all their values will then always yield `None`.
-
-This library defines many iterators and a few are demonstrated below. For the
-entire set simply visit the
-[package documentation](https://pkg.go.dev/github.com/BooleanCat/go-functional/iter).
-
-### Iterator showcase
-
-Here are a few trivial example of what's possible using the iterators in this
-library.
-
-```go
-// All odd natural numbers (1, 3, 5, 7...)
-odds := iter.Count().Drop(1).Filter(filters.IsOdd).Collect()
+// String representations of integers
+numbers := it.Map(it.Count(), strconv.Itoa)
 ```
 
-```go
-// All lines from a file
-lines := iter.LinesString(file).CollectResults().Unwrap()
-```
-
-```go
-// String representations of numbers
-numbers := iter.Map(iter.Count(), strconv.Itoa)
-```
+_[Read the docs](https://pkg.go.dev/github.com/BooleanCat/go-functional)_ to see the full iterator library.

constraints/constraints.go

@@ -1,3 +1,3 @@
-module github.com/BooleanCat/go-functional
+module github.com/BooleanCat/go-functional/v2
 
-go 1.20
+go 1.23

go.mod

@@ -2,62 +2,70 @@ package assert
 
 import "testing"
 
-func Equal[T comparable](t *testing.T, a, b T) {
+func True(t *testing.T, value bool) {
 	t.Helper()
 
-	if a != b {
-		t.Errorf("expected `%v` to equal `%v`", a, b)
+	if !value {
+		t.Error("expected true")
 	}
 }
 
-func True(t *testing.T, b bool) {
+func False(t *testing.T, value bool) {
 	t.Helper()
 
-	if !b {
-		t.Error("expected `false` to be `true`")
+	if value {
+		t.Error("expected false")
 	}
 }
 
-func False(t *testing.T, b bool) {
+func Equal[T comparable](t *testing.T, a, b T) {
 	t.Helper()
 
-	if b {
-		t.Error("expected `true` to be `false`")
+	if a != b {
+		t.Errorf("expected `%v` to equal `%v`", a, b)
 	}
 }
 
-func Nil(t *testing.T, v interface{}) {
+func SliceEqual[T comparable](t *testing.T, a, b []T) {
 	t.Helper()
 
-	if v != nil {
-		t.Errorf("expected `%v` to equal `nil`", v)
+	if len(a) != len(b) {
+		t.Errorf("expected `%v` to equal `%v` but lengths differ", a, b)
+		return
 	}
-}
-
-func NotNil(t *testing.T, v interface{}) {
-	t.Helper()
 
-	if v == nil {
-		t.Error("expected `nil` not to equal `nil`")
+	for i, v := range a {
+		if v != b[i] {
+			t.Errorf("expected `%v` to equal `%v`", a, b)
+		}
 	}
 }
 
-func SliceEqual[T comparable](t *testing.T, a, b []T) {
+func EqualElements[T comparable](t *testing.T, a, b []T) {
 	t.Helper()
 
 	if len(a) != len(b) {
 		t.Errorf("expected `%v` to equal `%v` but lengths differ", a, b)
 		return
 	}
 
-	for i, v := range a {
-		if v != b[i] {
-			t.Errorf("expected `%v` to equal `%v`", a, b)
+	for _, v := range a {
+		found := false
+
+		for _, w := range b {
+			if v == w {
+				found = true
+				break
+			}
+		}
+
+		if !found {
+			t.Errorf("expected `%v` to contain the same elements as `%v`", a, b)
 		}
 	}
 }
 
-func Empty[S any, T []S | ~string](t *testing.T, items T) {
+func Empty[E any, Slice ~[]E | ~string](t *testing.T, items Slice) {
 	t.Helper()
 
 	if len(items) != 0 {