Added some comments and renamed things

gbbr · gbbr · commit b9bfab350735 · 2014-11-03T18:40:48.000Z
diff --git a/chapter7/patterns/search/search.go b/chapter7/patterns/search/search.go
@@ -19,27 +19,38 @@ type Searcher interface {
 	Search(searchTerm string, searchResults chan<- []Result)
 }
 
+// searchSession holds information about the current search submission.
+// It contains options, searchers and a channel down which we will receive
+// results.
 type searchSession struct {
 	searchers  map[string]Searcher
 	first      bool
 	resultChan chan []Result
 }
 
+// Google search will be added to the search session if this option
+// is provided.
 func Google(s *searchSession) {
 	log.Println("search : Submit : Info : Adding Google")
 	s.searchers["google"] = google{}
 }
 
+// Bing search will be added to this search session if this option
+// is provided.
 func Bing(s *searchSession) {
 	log.Println("search : Submit : Info : Adding Bing")
 	s.searchers["bing"] = bing{}
 }
 
+// Yahoo search will be enabled if this option is provided as an argument
+// to Submit.
 func Yahoo(s *searchSession) {
 	log.Println("search : Submit : Info : Adding Yahoo")
 	s.searchers["yahoo"] = yahoo{}
 }
 
+// OnlyFirst is an option that will restrict the search session to just the
+// first result.
 func OnlyFirst(s *searchSession) { s.first = true }
 
 // Submit uses goroutines and channels to perform a search against the three
diff --git a/chapter7/patterns/search/searchers.go b/chapter7/patterns/search/searchers.go
@@ -20,8 +20,8 @@ type google struct{}
 
 // Search implements the Searcher interface. It performs a search
 // against Google.
-func (g google) Search(searchTerm string, searchResults chan<- []Result) {
-	log.Printf("Google : Search : Started : searchTerm[%s]\n", searchTerm)
+func (g google) Search(term string, resChan chan<- []Result) {
+	log.Printf("Google : Search : Started : search term[%s]\n", term)
 
 	// Slice for the results.
 	var results []Result
@@ -38,16 +38,16 @@ func (g google) Search(searchTerm string, searchResults chan<- []Result) {
 	})
 
 	log.Printf("Google : Search : Completed : Found[%d]\n", len(results))
-	searchResults <- results
+	resChan <- results
 }
 
 // Bing provides support for Bing searches.
 type bing struct{}
 
 // Search implements the Searcher interface. It performs a search
 // against Bing.
-func (b bing) Search(searchTerm string, searchResults chan<- []Result) {
-	log.Printf("Bing : Search : Started : searchTerm[%s]\n", searchTerm)
+func (b bing) Search(term string, resChan chan<- []Result) {
+	log.Printf("Bing : Search : Started : search term [%s]\n", term)
 
 	// Slice for the results.
 	var results []Result
@@ -64,31 +64,31 @@ func (b bing) Search(searchTerm string, searchResults chan<- []Result) {
 	})
 
 	log.Printf("Bing : Search : Completed : Found[%d]\n", len(results))
-	searchResults <- results
+	resChan <- results
 }
 
 // Yahoo provides support for Yahoo searches.
 type yahoo struct{}
 
 // Search implements the Searcher interface. It performs a search
 // against Yahoo.
-func (y yahoo) Search(searchTerm string, searchResults chan<- []Result) {
-	log.Printf("Yahoo : Search : Started : searchTerm[%s]\n", searchTerm)
+func (y yahoo) Search(term string, results chan<- []Result) {
+	log.Printf("Yahoo : Search : Started : search term [%s]\n", term)
 
 	// Slice for the results.
-	var results []Result
+	var r []Result
 
 	// Simulate an amount of time for the search.
 	time.Sleep(time.Millisecond * time.Duration(rand.Int63n(900)))
 
 	// Simulate a result for the search.
-	results = append(results, Result{
+	r = append(r, Result{
 		Engine:      "Yahoo",
 		Title:       "Go Playground",
 		Description: "The Go Playground is a web service that runs on golang.org's servers",
 		Link:        "http://play.golang.org/",
 	})
 
-	log.Printf("Yahoo : Search : Completed : Found[%d]\n", len(results))
-	searchResults <- results
+	log.Printf("Yahoo : Search : Completed : Found[%d]\n", len(r))
+	results <- r
 }
