release 1.4.1

add examples for NewDocumentFromReader (#254 )
fix example indentation
2024-04-21 12:31:36 +00:00 · 2018-06-07 11:06:10 -04:00 · 2018-06-07 11:04:59 -04:00 · 2018-03-24 12:22:12 -04:00 · 2018-03-24 12:12:09 -04:00
2 changed files with 67 additions and 2 deletions
@@ -37,6 +37,7 @@ Please note that because of the net/html dependency, goquery requires Go1.1+.

 **Note that goquery's API is now stable, and will not break.**

+*    **2018-06-07 (v1.4.1)** : Add `NewDocumentFromReader` examples.
 *    **2018-03-24 (v1.4.0)** : Deprecate `NewDocument(url)` and `NewDocumentFromResponse(response)`.
 *    **2018-01-28 (v1.3.0)** : Add `ToEnd` constant to `Slice` until the end of the selection (thanks to @davidjwilkins for raising the issue).
 *    **2018-01-11 (v1.2.0)** : Add `AddBack*` and deprecate `AndSelf` (thanks to @davidjwilkins).
@@ -95,12 +96,24 @@ package main
 import (
  "fmt"
  "log"
+  "net/http"

  "github.com/PuerkitoBio/goquery"
 )

 func ExampleScrape() {
-  doc, err := goquery.NewDocument("http://metalsucks.net")
+  // Request the HTML page.
+  res, err := http.Get("http://metalsucks.net")
+  if err != nil {
+    log.Fatal(err)
+  }
+  defer res.Body.Close()
+  if res.StatusCode != 200 {
+    log.Fatalf("status code error: %d %s", res.StatusCode, res.Status)
+  }
+
+  // Load the HTML document
+  doc, err := goquery.NewDocumentFromReader(res.Body)
  if err != nil {
    log.Fatal(err)
  }
@@ -3,14 +3,27 @@ package goquery_test
 import (
 	"fmt"
 	"log"
+	"net/http"
+	"os"
+	"strings"

 	"github.com/PuerkitoBio/goquery"
 )

 // This example scrapes the reviews shown on the home page of metalsucks.net.
 func Example() {
+	// Request the HTML page.
+	res, err := http.Get("http://metalsucks.net")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer res.Body.Close()
+	if res.StatusCode != 200 {
+		log.Fatalf("status code error: %d %s", res.StatusCode, res.Status)
+	}
+
 	// Load the HTML document
-	doc, err := goquery.NewDocument("http://metalsucks.net")
+	doc, err := goquery.NewDocumentFromReader(res.Body)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -28,3 +41,42 @@ func Example() {

 	// xOutput: voluntarily fail the Example output.
 }
+
+// This example shows how to use NewDocumentFromReader from a file.
+func ExampleNewDocumentFromReader_file() {
+	// create from a file
+	f, err := os.Open("some/file.html")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer f.Close()
+	doc, err := goquery.NewDocumentFromReader(f)
+	if err != nil {
+		log.Fatal(err)
+	}
+	// use the goquery document...
+	_ = doc.Find("h1")
+}
+
+// This example shows how to use NewDocumentFromReader from a string.
+func ExampleNewDocumentFromReader_string() {
+	// create from a string
+	data := `
+<html>
+	<head>
+		<title>My document</title>
+	</head>
+	<body>
+		<h1>Header</h1>
+	</body>
+</html>`
+
+	doc, err := goquery.NewDocumentFromReader(strings.NewReader(data))
+	if err != nil {
+		log.Fatal(err)
+	}
+	header := doc.Find("h1").Text()
+	fmt.Println(header)
+
+	// Output: Header
+}
Author	SHA1	Message	Date
Martin Angers	dc2ec5c7ca	release 1.4.1	2018-06-07 11:06:10 -04:00
Martin AngersandGitHub	7757e27950	add examples for NewDocumentFromReader (#254 )	2018-06-07 11:04:59 -04:00
Martin Angers	ea1bc64a63	fix example indentation	2018-03-24 12:22:12 -04:00
Martin Angers	dd77530fdb	update examples to use the preferred NewDocumentFromReader approach	2018-03-24 12:12:09 -04:00