Added search functionality to find paragraphs based on a query string

Author: Matthew Borders

parse.go

@@ -9,18 +9,36 @@ import (
 	"os"
 	"path"
 	"runtime"
+	"strings"
 
 	"github.com/derekparker/trie"
 )
 
+type SearchNode struct {
+	Part      *Part
+	Article   *Article
+	Section   *Section
+	Paragraph *Paragraph
+}
+
+// String creates a string representation for the SearchNode,
+// ex. Part 1, Article 1, Section 1, Paragraph 1
+func (s *SearchNode) String() string {
+	return fmt.Sprintf("Part %d, Article %d, Section %d, Paragraph %d",
+		s.Part.PartNumber,
+		s.Article.ArticleNumber,
+		s.Section.SectionNumber,
+		s.Paragraph.ParagraphNumber);
+}
+
 const catechismTar = "catechism.tar.gz"
 const catechismFilename = "catechism.json"
 
 func NewCatechism() *Catechism {
 	_, currFile, _, _ := runtime.Caller(0)
 	filename := fmt.Sprintf("%s/%s", path.Dir(currFile), catechismTar)
 
-	c := &Catechism{
+	catechism := &Catechism{
 		searchTree: trie.New(),
 	}
 
@@ -41,15 +59,55 @@ func NewCatechism() *Catechism {
 
 		switch h.Name {
 		case catechismFilename:
-			c.Parts = decode(tr)
+			catechism.Parts = decode(tr)
 		}
 	}
 
-	return c
+	// Build search tree
+	for i := range catechism.Parts {
+		p := catechism.Parts[i]
+		for j := range p.Articles {
+			a := p.Articles[j]
+			for k := range a.Sections {
+				s := a.Sections[k]
+				for l := range s.Paragraphs {
+					par := s.Paragraphs[l]
+					t := strings.ToLower(par.Text)
+					catechism.searchTree.Add(t, SearchNode{
+						Part:      &p,
+						Article:   &a,
+						Section:   &s,
+						Paragraph: &par,
+					})
+				}
+			}
+		}
+	}
+
+	return catechism
 }
 
 func decode(r io.Reader) []Part {
 	var parts []Part
 	json.NewDecoder(r).Decode(&parts)
 	return parts
 }
+
+// Search finds top matching verses based on the given query.
+// The number of search results are restricted by maxResults
+func (c *Catechism) Search(query string, maxResults int) []SearchNode {
+	t := c.searchTree
+	keys := t.FuzzySearch(strings.ToLower(query))
+	var nodes []SearchNode
+
+	for k := range keys {
+		res, _ := t.Find(keys[k])
+		nodes = append(nodes, res.Meta().(SearchNode))
+
+		if len(nodes) >= maxResults {
+			break
+		}
+	}
+
+	return nodes
+}

parse_test.go

@@ -80,3 +80,10 @@ func TestCatechism_GetParagraph_InvalidParagraph(t *testing.T) {
 	_, err := c.GetParagraph(1, 1, 1, 100)
 	assert.Equal(t, "invalid paragraph number", err.Error())
 }
+
+func TestCatechism_Search(t *testing.T) {
+	p := c.Search("I believe", 10)
+
+	assert.NotEmpty(t, p)
+	assert.Equal(t, "Part 4, Article 3, Section 4, Paragraph 1", p[0].String())
+}