add {AncestorNodes, ChildNodes, DescendantNodes}() (#34)

Author: sunshineplan

README.md

@@ -137,6 +137,16 @@ type HtmlNode interface {
 	// NextNodes return all of the nodes that was parsed after this node.
 	NextNodes() []Node
 
+	// AncestorNodes returns an iterator over the ancestors of n,
+	// starting with n.Parent.
+	AncestorNodes() iter.Seq[Node]
+	// ChildNodes returns an iterator over the immediate children of n,
+	// starting with n.FirstChild.
+	ChildNodes() iter.Seq[Node]
+	// DescendantNodes returns an iterator over all nodes recursively
+	// beneath n, excluding n itself. Nodes are visited in depth-first preorder.
+	DescendantNodes() iter.Seq[Node]
+
 	// Finder includes a set of find methods.
 	Finder
 }

go.mod

@@ -1,15 +1,15 @@
 module github.com/sunshineplan/node
 
-go 1.21
+go 1.23
 
 require (
 	github.com/antchfx/htmlquery v1.3.3
 	github.com/antchfx/xpath v1.3.2
 	github.com/ericchiang/css v1.4.0
-	golang.org/x/net v0.30.0
+	golang.org/x/net v0.31.0
 )
 
 require (
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	golang.org/x/text v0.19.0 // indirect
+	golang.org/x/text v0.20.0 // indirect
 )

go.sum

@@ -17,8 +17,8 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/net v0.0.0-20211216030914-fe4d6282115f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
-golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
-golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
+golang.org/x/net v0.31.0 h1:68CPQngjLL0r2AlUKiSxtQFKvzRVbnzLwMUn5SzcLHo=
+golang.org/x/net v0.31.0/go.mod h1:P4fl1q7dY2hnZFxEk4pPSkDHF+QqjitcnDjUQyMM+pM=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -36,8 +36,8 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
-golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/text v0.20.0 h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=
+golang.org/x/text v0.20.0/go.mod h1:D4IsuqiFMhST5bX19pQ9ikHC2GsaKyk/oF+pn3ducp4=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=

node.go

@@ -2,6 +2,7 @@ package node
 
 import (
 	"io"
+	"iter"
 	"strings"
 
 	"golang.org/x/net/html"
@@ -92,6 +93,16 @@ type HtmlNode interface {
 	// NextNodes return all of the nodes that was parsed after this node.
 	NextNodes() []Node
 
+	// AncestorNodes returns an iterator over the ancestors of n,
+	// starting with n.Parent.
+	AncestorNodes() iter.Seq[Node]
+	// ChildNodes returns an iterator over the immediate children of n,
+	// starting with n.FirstChild.
+	ChildNodes() iter.Seq[Node]
+	// DescendantNodes returns an iterator over all nodes recursively
+	// beneath n, excluding n itself. Nodes are visited in depth-first preorder.
+	DescendantNodes() iter.Seq[Node]
+
 	// Finder includes a set of find methods.
 	Finder
 }
@@ -213,34 +224,23 @@ func (n *htmlNode) NextNode() Node {
 }
 
 func (n *htmlNode) Parents() (parents []Node) {
-	parent := n.Parent()
-	for parent != nil {
+	for parent := range n.AncestorNodes() {
 		parents = append(parents, parent)
-		parent = parent.Parent()
 	}
 	return
 }
 
 func (n *htmlNode) Children() (children []Node) {
-	child := n.FirstChild()
-	for child != nil {
+	for child := range n.ChildNodes() {
 		children = append(children, child)
-		child = child.NextSibling()
 	}
 	return
 }
 
 func (n *htmlNode) Descendants() (nodes []Node) {
-	var f func(Node)
-	f = func(node Node) {
-		if node.Raw() != n.Raw() {
-			nodes = append(nodes, node)
-		}
-		for node := node.FirstChild(); node != nil; node = node.NextSibling() {
-			f(node)
-		}
+	for node := range n.DescendantNodes() {
+		nodes = append(nodes, node)
 	}
-	f(n.ToNode())
 	return
 }
 
@@ -280,6 +280,36 @@ func (n *htmlNode) NextNodes() (nextNodes []Node) {
 	return
 }
 
+func (n *htmlNode) AncestorNodes() iter.Seq[Node] {
+	return func(yield func(Node) bool) {
+		for c := range n.Ancestors() {
+			if !yield(NewNode(c)) {
+				return
+			}
+		}
+	}
+}
+
+func (n *htmlNode) ChildNodes() iter.Seq[Node] {
+	return func(yield func(Node) bool) {
+		for c := range n.Node.ChildNodes() {
+			if !yield(NewNode(c)) {
+				return
+			}
+		}
+	}
+}
+
+func (n *htmlNode) DescendantNodes() iter.Seq[Node] {
+	return func(yield func(Node) bool) {
+		for c := range n.Node.Descendants() {
+			if !yield(NewNode(c)) {
+				return
+			}
+		}
+	}
+}
+
 type node struct {
 	*htmlNode
 }