Updated the documentation and add example codes

Author: udan-jayanith

FUTURE-CHANGELOG.md

@@ -1,3 +1,10 @@
 ## v0.0.3
 - Write test for (closest, QuerySelector, QuerySelectorAll)
 - Serializer bug fix
+
+## TODO
+* Document Combinator and CombinatorEl struct.
+* Document TokenizeSelectorsAndCombinators and show a example for it.
+* Document Tokenizers and Selectors
+* Update the the readme example and change the CHANGELOG
+

classList.go

@@ -68,7 +68,7 @@ func (classList ClassList) Encode() string {
 	return classes
 }
 
-// EncodeTo encode className for the node.
+// EncodeTo encodes classNames for the node.
 // If node is nil EncodeTo does nothing.
 func (classList ClassList) EncodeTo(node *Node){
 	if node == nil {

classList_test.go

@@ -1,31 +1,63 @@
 package GoHtml_test
 
-import(
+import (
+	"fmt"
 	"testing"
-	"github.com/udan-jayanith/GoHTML"
+
+	GoHtml "github.com/udan-jayanith/GoHTML"
 )
 
-func TestClasses(t *testing.T){
+func TestClasses(t *testing.T) {
 	node := GoHtml.CreateNode("div")
 	node.SetAttribute("class", "div-container main")
 
 	classList := GoHtml.NewClassList()
 	classList.DecodeFrom(node)
-	if !classList.Contains("main"){
+	if !classList.Contains("main") {
 		t.Fatal("")
 		return
 	}
 	classList.DeleteClass("main")
-	if classList.Contains("main"){
+	if classList.Contains("main") {
 		t.Fatal("")
 		return
 	}
 
 	classList.AppendClass("main-div")
-	if !classList.Contains("main-div"){
+	if !classList.Contains("main-div") {
 		t.Fatal("")
 		return
 	}
 
 	classList.EncodeTo(node)
+}
+
+func ExampleClassList_Contains() {
+	//Creates a div that has classes video-container and main-contents
+	div := GoHtml.CreateNode("div")
+	div.SetAttribute("class", "video-container main-contents")
+
+	classList := GoHtml.NewClassList()
+	//Add the classes in the div to the class list
+	classList.DecodeFrom(div)
+
+	//Checks wether the following classes exists in the classList
+	fmt.Println(classList.Contains("container"))
+	fmt.Println(classList.Contains("video-container"))
+
+	//Output:
+	//false
+	//true
+}
+
+func ExampleClassList_Encode(){
+	classList := GoHtml.NewClassList()
+
+	//Add classes to the class list
+	classList.AppendClass("container")
+	classList.AppendClass("warper")
+	classList.AppendClass("main-content")
+
+	//This would output something like this "warper container main-content". Order of the output is not guaranteed.
+	fmt.Println(classList.Encode())
 }

node-list.go

@@ -5,7 +5,7 @@ import (
 	"iter"
 )
 
-//NodeList can store nodes by appended order.
+//NodeList can store nodes by appended order and can iterate over the node list by invoking IterNodeList method.
 type NodeList struct {
 	list      *list.List
 	currentEl *list.Element

node-list_test.go

@@ -1,6 +1,7 @@
 package GoHtml_test
 
 import (
+	"fmt"
 	"os"
 	"testing"
 
@@ -40,4 +41,20 @@ func TestIterNodeList2(t *testing.T){
 	for node := range iter{
 		t.Log(node)
 	}
+}
+
+func ExampleNodeList(){
+	nodeList := GoHtml.NewNodeList()
+	nodeList.Append(GoHtml.CreateNode("br"))
+	nodeList.Append(GoHtml.CreateNode("hr"))
+	nodeList.Append(GoHtml.CreateNode("div"))
+
+	iter := nodeList.IterNodeList()
+	for node := range iter{
+		fmt.Println(node.GetTagName())
+	}
+	//Output: 
+	//br
+	//hr 
+	//div
 }

node-tree.go

@@ -39,7 +39,7 @@ func (node *Node) SetPreviousNode(previousNode *Node) {
 	node.previousNode = previousNode
 }
 
-// GetChildNode returns the first child elements of this node.
+// GetChildNode returns the first child node of this node.
 func (node *Node) GetChildNode() *Node {
 	return node.childNode
 }

parser.go

@@ -3,17 +3,17 @@ package GoHtml
 import (
 	"io"
 	"strings"
+
 	"golang.org/x/net/html"
 )
 
-
 // Decode reads from rd and create a node-tree. Then returns the root node and nil.
 func Decode(r io.Reader) (*Node, error) {
 	t := NewTokenizer(r)
 	nodeTreeBuilder := NewNodeTreeBuilder()
 	for {
 		tt := t.Advanced()
-		if tt == html.ErrorToken{
+		if tt == html.ErrorToken {
 			break
 		}
 
@@ -30,4 +30,3 @@ func HTMLToNodeTree(html string) (*Node, error) {
 	return node, err
 }
 
-

parser_test.go

@@ -1,6 +1,7 @@
 package GoHtml_test
 
 import (
+	"fmt"
 	"os"
 	"strings"
 	"testing"
@@ -25,3 +26,31 @@ func TestDecode(t *testing.T) {
 	var builder strings.Builder
 	GoHtml.Encode(&builder, node)
 }
+
+func ExampleDecode() {
+	r := strings.NewReader(`
+	<!DOCTYPE html>
+	<html lang="en">
+		<head>
+			<meta charset="UTF-8">
+			<meta name="viewport" content="width=device-width, initial-scale=1.0">
+			<title>User Profile</title>
+		</head>
+		<body>
+			<h1 class="username">Udan</h1>
+			<p class="email">udanjayanith@gmail.com</p>
+			<p>Joined: 01/08/2024</p>
+		</body>
+	</html>
+	`)
+
+	rootNode, _ := GoHtml.Decode(r)
+
+	titleNode := rootNode.QuerySelector("title")
+	title := ""
+	if titleNode != nil {
+		title = titleNode.GetInnerText()
+	}
+	fmt.Println(title)
+	//Output: User Profile
+}

querying_test.go

@@ -1,6 +1,8 @@
 package GoHtml_test
 
 import (
+	"fmt"
+	"net/http"
 	"os"
 	"testing"
 
@@ -165,14 +167,13 @@ func TestQuerySelector(t *testing.T) {
 	}
 	//TODO: write test for testcases below.
 	/*
-	t.Log(rootNode.QuerySelector("body p"))
-	t.Log(rootNode.QuerySelector("html head > title"))
-	t.Log(rootNode.QuerySelector("section+ul"))
-	t.Log(rootNode.QuerySelector(".item~.last-item"))
+		t.Log(rootNode.QuerySelector("body p"))
+		t.Log(rootNode.QuerySelector("html head > title"))
+		t.Log(rootNode.QuerySelector("section+ul"))
+		t.Log(rootNode.QuerySelector(".item~.last-item"))
 	*/
 }
 
-
 func TestQuerySelectorAll(t *testing.T) {
 	rootNode, err := testFile5NodeTree()
 	if err != nil {
@@ -200,3 +201,38 @@ func TestQuerySelectorAll(t *testing.T) {
 	}
 
 }
+
+func ExampleNode_QuerySelector() {
+	res, err := http.Get("https://example.com/")
+	if err != nil || res.StatusCode != http.StatusOK {
+		return
+	}
+	defer res.Body.Close()
+
+	rootNode, _ := GoHtml.Decode(res.Body)
+	res.Body.Close()
+
+	title := rootNode.QuerySelector("title")
+	if title != nil {
+		fmt.Println(title.GetInnerText())
+		//Example Domain
+	}
+}
+
+func ExampleQuerySearch() {
+	//Request the html
+	res, err := http.Get("https://example.com/")
+	if err != nil || res.StatusCode != http.StatusOK {
+		return
+	}
+	defer res.Body.Close()
+
+	//Decode the html
+	rootNode, _ := GoHtml.Decode(res.Body)
+
+	//Iterate over every node that matches the query.
+	for node := range GoHtml.QuerySearch(rootNode, ".event-columns .column .event-block h4 a") {
+		//Convert the node and it's children nodes to text html and print it.
+		fmt.Println(GoHtml.NodeTreeToHTML(node))
+	}
+}

tokenizer.go

@@ -26,7 +26,7 @@ func (t *Tokenizer) Advanced() html.TokenType {
 }
 
 // CurrentNode returns the current node.
-// Returned value can be nil regardless of tt.
+// Returned value can be nil regardless of token type.
 func (t *Tokenizer) GetCurrentNode() *Node {
 	currentToken := t.z.Token()
 	if strings.TrimSpace(currentToken.Data) == "" {