Merge pull request #132 from winebarrel/IterFrom_Iter

IterFrom -> Iter

Author: winebarrel

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.1.2] - 2025-11-16
+
+### Changed
+
+* [breaking change] Rename `IterFrom()` to `Iter()`. [pull#132](https://github.com/winebarrel/cronplan/pull/132)
+
 ## [2.1.1] - 2025-11-16
 
 ### Added

README.md

@@ -74,14 +74,20 @@ func main() {
 	)
 	//=> [2022-11-03 10:00:00 +0000 UTC 2022-11-04 10:00:00 +0000 UTC]
 
-	iter := cron.IterFrom(time.Date(2022, 11, 3, 10, 0, 0, 0, time.UTC))
+	iter := cron.Iter(time.Date(2022, 11, 3, 10, 0, 0, 0, time.UTC))
 
 	for i := range 3 {
 		fmt.Println(i, iter.Next())
 		//=> 0 2022-11-03 10:00:00 +0000 UTC
 		//=> 1 2022-11-04 10:00:00 +0000 UTC
 		//=> 2 2022-11-05 10:00:00 +0000 UTC
 	}
+
+	for next := range iter.Seq() {
+		fmt.Println(next)
+		//=> 2022-11-03 10:00:00 +0000 UTC
+		break
+	}
 }
 ```
 

_example/basic/main.go

@@ -39,12 +39,18 @@ func main() {
 	)
 	//=> [2022-11-03 10:00:00 +0000 UTC 2022-11-04 10:00:00 +0000 UTC]
 
-	iter := cron.IterFrom(time.Date(2022, 11, 3, 10, 0, 0, 0, time.UTC))
+	iter := cron.Iter(time.Date(2022, 11, 3, 10, 0, 0, 0, time.UTC))
 
 	for i := range 3 {
 		fmt.Println(i, iter.Next())
 		//=> 0 2022-11-03 10:00:00 +0000 UTC
 		//=> 1 2022-11-04 10:00:00 +0000 UTC
 		//=> 2 2022-11-05 10:00:00 +0000 UTC
 	}
+
+	for next := range iter.Seq() {
+		fmt.Println(next)
+		//=> 2022-11-03 10:00:00 +0000 UTC
+		break
+	}
 }

_example/cron/main.go

@@ -17,7 +17,7 @@ func cron(expr string, from time.Time, proc func()) (<-chan struct{}, error) {
 	waiter := make(chan struct{})
 
 	go func() {
-		for next := range cron.IterFrom(from).Seq() {
+		for next := range cron.Iter(from).Seq() {
 			<-time.After(time.Until(next))
 			go proc()
 		}

iter.go

@@ -37,7 +37,7 @@ func (iter *Iterator) Seq() iter.Seq[time.Time] {
 	}
 }
 
-func (v *Expression) IterFrom(from time.Time) *Iterator {
+func (v *Expression) Iter(from time.Time) *Iterator {
 	iter := &Iterator{
 		expr: v,
 		from: from,

test/cronplan/iter_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/winebarrel/cronplan/v2"
 )
 
-func TestIterFrom(t *testing.T) {
+func TestIter(t *testing.T) {
 	assert := assert.New(t)
 
 	tt := []struct {
@@ -207,7 +207,7 @@ func TestIterFrom(t *testing.T) {
 	for _, test := range tt {
 		cron, err := cronplan.Parse(test.exp)
 		assert.NoError(err)
-		iter := cron.IterFrom(test.from)
+		iter := cron.Iter(test.from)
 
 		for _, e := range test.expected {
 			next := iter.Next()
@@ -244,7 +244,7 @@ func TestIterHasNext(t *testing.T) {
 	for _, test := range tt {
 		cron, err := cronplan.Parse(test.exp)
 		assert.NoError(err)
-		iter := cron.IterFrom(test.from)
+		iter := cron.Iter(test.from)
 
 		for _, e := range test.expected {
 			next := iter.HasNext()
@@ -447,7 +447,7 @@ func TestIterSeq(t *testing.T) {
 	for _, test := range tt {
 		cron, err := cronplan.Parse(test.exp)
 		assert.NoError(err)
-		iter := cron.IterFrom(test.from)
+		iter := cron.Iter(test.from)
 
 		i := 0