feat(spec)!: use seq.Iter and rename Iter methods

Author: crhntr

document.go

@@ -1,6 +1,7 @@
 package dom
 
 import (
+	"iter"
 	"strings"
 
 	"github.com/andybalholm/cascadia"
@@ -37,10 +38,10 @@ func (d *Document) QuerySelectorAll(query string) spec.NodeList[spec.Element] {
 	return querySelectorAll(d.node, query, false)
 }
 
-func (d *Document) QuerySelectorEach(query string) spec.NodeIterator[spec.Element] {
+func (d *Document) QuerySelectorSequence(query string) iter.Seq[spec.Element] {
 	m := cascadia.MustCompile(query)
 	return func(yield func(spec.Element) bool) {
-		querySelectorEach(d.node, m, yield)
+		querySelectorSequence(d.node, m, yield)
 	}
 }
 

element.go

@@ -2,6 +2,7 @@ package dom
 
 import (
 	"bytes"
+	"iter"
 	"strings"
 
 	"github.com/andybalholm/cascadia"
@@ -14,10 +15,10 @@ type Element struct {
 	node *html.Node
 }
 
-func (e *Element) QuerySelectorEach(query string) spec.NodeIterator[spec.Element] {
+func (e *Element) QuerySelectorSequence(query string) iter.Seq[spec.Element] {
 	m := cascadia.MustCompile(query)
 	return func(yield func(spec.Element) bool) {
-		querySelectorEach(e.node, m, yield)
+		querySelectorSequence(e.node, m, yield)
 	}
 }
 

fragment.go

@@ -2,6 +2,7 @@ package dom
 
 import (
 	"bytes"
+	"iter"
 	"slices"
 
 	"github.com/andybalholm/cascadia"
@@ -129,7 +130,7 @@ func (d *DocumentFragment) QuerySelectorAll(query string) spec.NodeList[spec.Ele
 	return slices.Clip(list)
 }
 
-func (d *DocumentFragment) QuerySelectorEach(query string) spec.NodeIterator[spec.Element] {
+func (d *DocumentFragment) QuerySelectorSequence(query string) iter.Seq[spec.Element] {
 	m := cascadia.MustCompile(query)
 	return func(yield func(spec.Element) bool) {
 		for _, n := range d.nodes {
@@ -138,7 +139,7 @@ func (d *DocumentFragment) QuerySelectorEach(query string) spec.NodeIterator[spe
 					return
 				}
 			}
-			if !querySelectorEach(n, m, yield) {
+			if !querySelectorSequence(n, m, yield) {
 				return
 			}
 		}

fragment_test.go

@@ -322,17 +322,17 @@ func TestDocumentFragment_QuerySelector(t *testing.T) {
 	})
 	t.Run("tree of nested results", func(t *testing.T) {
 		fragment := parseDocumentFragment(t,
-			/* language=html */ `<div id="n0">
-	<div id="n1">
-		<div id="n2"></div>
+			/* language=html */ `<div id='n0'>
+	<div id='n1'>
+		<div id='n2'></div>
 	</div>
-	<div id="n3"></div>
+	<div id='n3'></div>
 </div>
-<div id="n4">
-	<div id="n5">
-		<div id="n6"></div>
+<div id='n4'>
+	<div id='n5'>
+		<div id='n6'></div>
 	</div>
-	<div id="n7"></div>
+	<div id='n7'></div>
 </div>`)
 		results := fragment.QuerySelectorAll("div")
 		require.NotNil(t, results)
@@ -395,7 +395,7 @@ func TestDocumentFragment_QuerySelectorEach(t *testing.T) {
 
 	for stopOnCall := 1; stopOnCall <= 7; stopOnCall++ {
 		callCount := 0
-		dom.NewDocumentFragment(fragment).QuerySelectorEach("[id]")(func(el spec.Element) bool {
+		dom.NewDocumentFragment(fragment).QuerySelectorSequence("[id]")(func(el spec.Element) bool {
 			callCount++
 			assert.NotNil(t, el)
 			if callCount == stopOnCall {

node.go

@@ -440,7 +440,7 @@ func querySelectorAll(node *html.Node, query string, includeParent bool) nodeLis
 	if includeParent && m.Match(node) {
 		results = slices.Insert(results, 0, node)
 	}
-	querySelectorEach(node, m, func(element spec.Element) bool {
+	querySelectorSequence(node, m, func(element spec.Element) bool {
 		el := element.(*Element)
 		results = append(results, el.node)
 		return true
@@ -494,14 +494,14 @@ func getAttribute(node *html.Node, name string) string {
 	return ""
 }
 
-func querySelectorEach(n *html.Node, m cascadia.Matcher, yield func(spec.Element) bool) bool {
+func querySelectorSequence(n *html.Node, m cascadia.Matcher, yield func(spec.Element) bool) bool {
 	for c := n.FirstChild; c != nil; c = c.NextSibling {
 		if m.Match(c) {
 			if !yield(&Element{node: c}) {
 				return false
 			}
 		}
-		if !querySelectorEach(c, m, yield) {
+		if !querySelectorSequence(c, m, yield) {
 			return false
 		}
 	}

spec/interfaces.go

@@ -1,5 +1,7 @@
 package spec
 
+import "iter"
+
 // Node is based on a subset of the methods and types in
 // https://dom.spec.whatwg.org/#interface-node as of 2021-12-10
 //
@@ -263,12 +265,6 @@ type Comment interface {
 	SetData() string
 }
 
-type (
-	NodeIterator[N Node] func(func(N) bool)
-
-	// QuerySelectorIterator is a first draft node iterator for Go 1.23 range func iteration.
-	// I am not sure if I like the name.
-	QuerySelectorIterator interface {
-		QuerySelectorEach(query string) NodeIterator[Element]
-	}
-)
+type QuerySelectorIterator interface {
+	QuerySelectorSequence(query string) iter.Seq[Element]
+}