From cbfd1c62866c6f4b20a566ed42910169835d7045 Mon Sep 17 00:00:00 2001
From: Sianao Luo <luosianao@gmail.com>
Date: Tue, 16 Jul 2024 01:28:57 +0800
Subject: [PATCH] add ForEachCondition implement (#485)

* add ForEachCondition implement

* add example and test code

* rename ForEachCondition() to ForEachWhile()

* update test and example code

* rename ExampleForForEachWhile() to ExampleForEachWhile()
---
 slice.go              | 10 ++++++++++
 slice_example_test.go | 14 ++++++++++++++
 slice_test.go         | 23 +++++++++++++++++++++++
 3 files changed, 47 insertions(+)

diff --git a/slice.go b/slice.go
index 38b50e82..431aaf04 100644
--- a/slice.go
+++ b/slice.go
@@ -94,6 +94,16 @@ func ForEach[T any](collection []T, iteratee func(item T, index int)) {
 	}
 }
 
+// ForEachWhile iterates over elements of collection and invokes iteratee for each element
+// collection  return value  decide to continue or break ,just like do while()
+func ForEachWhile[T any](collection []T, iteratee func(item T, index int) (goon bool)) {
+	for i := range collection {
+		if !iteratee(collection[i], i) {
+			break
+		}
+	}
+}
+
 // Times invokes the iteratee n times, returning an array of the results of each invocation.
 // The iteratee is invoked with index as argument.
 // Play: https://go.dev/play/p/vgQj3Glr6lT
diff --git a/slice_example_test.go b/slice_example_test.go
index 1ee90ced..0d64d8f0 100644
--- a/slice_example_test.go
+++ b/slice_example_test.go
@@ -88,7 +88,21 @@ func ExampleForEach() {
 	// 3
 	// 4
 }
+func ExampleForEachWhile() {
+	list := []int64{1, 2, -math.MaxInt, 4}
 
+	ForEachWhile(list, func(x int64, _ int) bool {
+		if x < 0 {
+			return false
+		}
+		fmt.Println(x)
+		return true
+	})
+
+	// Output:
+	// 1
+	// 2
+}
 func ExampleTimes() {
 	result := Times(3, func(i int) string {
 		return strconv.FormatInt(int64(i), 10)
diff --git a/slice_test.go b/slice_test.go
index f13e129c..abb9450e 100644
--- a/slice_test.go
+++ b/slice_test.go
@@ -157,6 +157,29 @@ func TestForEach(t *testing.T) {
 	is.IsIncreasing(callParams2)
 }
 
+func TestForEachWhile(t *testing.T) {
+	t.Parallel()
+	is := assert.New(t)
+
+	// check of callback is called for every element and in proper order
+
+	var callParams1 []string
+	var callParams2 []int
+
+	ForEachWhile([]string{"a", "b", "c"}, func(item string, i int) bool {
+		if item == "c" {
+			return false
+		}
+		callParams1 = append(callParams1, item)
+		callParams2 = append(callParams2, i)
+		return true
+	})
+
+	is.ElementsMatch([]string{"a", "b"}, callParams1)
+	is.ElementsMatch([]int{0, 1}, callParams2)
+	is.IsIncreasing(callParams2)
+}
+
 func TestUniq(t *testing.T) {
 	t.Parallel()
 	is := assert.New(t)