From 39fe2a3e4e059c4235f2e1692e240058fccc0ea3 Mon Sep 17 00:00:00 2001
From: unclejack <unclejacksons@gmail.com>
Date: Mon, 6 Oct 2014 22:00:58 +0300
Subject: [PATCH] pkg/truncindex: lint and add comments

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
---
 api/server/server.go         |  2 +-
 pkg/truncindex/truncindex.go | 32 ++++++++++++++++++++------------
 2 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/api/server/server.go b/api/server/server.go
index 27fe305106..1fa2cf3f19 100644
--- a/api/server/server.go
+++ b/api/server/server.go
@@ -92,7 +92,7 @@ func httpError(w http.ResponseWriter, err error) {
 	// FIXME: this is brittle and should not be necessary.
 	// If we need to differentiate between different possible error types, we should
 	// create appropriate error types with clearly defined meaning.
-	if strings.Contains(err.Error(), "No such") {
+	if strings.Contains(err.Error(), "no such") {
 		statusCode = http.StatusNotFound
 	} else if strings.Contains(err.Error(), "Bad parameter") {
 		statusCode = http.StatusBadRequest
diff --git a/pkg/truncindex/truncindex.go b/pkg/truncindex/truncindex.go
index 89aa88d6b7..c5b71752b5 100644
--- a/pkg/truncindex/truncindex.go
+++ b/pkg/truncindex/truncindex.go
@@ -10,7 +10,9 @@ import (
 )
 
 var (
-	ErrNoID = errors.New("prefix can't be empty")
+	// ErrNoID is thrown when attempting to use empty prefixes
+	ErrNoID        = errors.New("prefix can't be empty")
+	errDuplicateID = errors.New("multiple IDs were found")
 )
 
 func init() {
@@ -27,56 +29,62 @@ type TruncIndex struct {
 	ids  map[string]struct{}
 }
 
+// NewTruncIndex creates a new TruncIndex and initializes with a list of IDs
 func NewTruncIndex(ids []string) (idx *TruncIndex) {
 	idx = &TruncIndex{
 		ids:  make(map[string]struct{}),
 		trie: patricia.NewTrie(),
 	}
 	for _, id := range ids {
-		idx.addId(id)
+		idx.addID(id)
 	}
 	return
 }
 
-func (idx *TruncIndex) addId(id string) error {
+func (idx *TruncIndex) addID(id string) error {
 	if strings.Contains(id, " ") {
-		return fmt.Errorf("Illegal character: ' '")
+		return fmt.Errorf("illegal character: ' '")
 	}
 	if id == "" {
 		return ErrNoID
 	}
 	if _, exists := idx.ids[id]; exists {
-		return fmt.Errorf("Id already exists: '%s'", id)
+		return fmt.Errorf("id already exists: '%s'", id)
 	}
 	idx.ids[id] = struct{}{}
 	if inserted := idx.trie.Insert(patricia.Prefix(id), struct{}{}); !inserted {
-		return fmt.Errorf("Failed to insert id: %s", id)
+		return fmt.Errorf("failed to insert id: %s", id)
 	}
 	return nil
 }
 
+// Add adds a new ID to the TruncIndex
 func (idx *TruncIndex) Add(id string) error {
 	idx.Lock()
 	defer idx.Unlock()
-	if err := idx.addId(id); err != nil {
+	if err := idx.addID(id); err != nil {
 		return err
 	}
 	return nil
 }
 
+// Delete removes an ID from the TruncIndex. If there are multiple IDs
+// with the given prefix, an error is thrown.
 func (idx *TruncIndex) Delete(id string) error {
 	idx.Lock()
 	defer idx.Unlock()
 	if _, exists := idx.ids[id]; !exists || id == "" {
-		return fmt.Errorf("No such id: '%s'", id)
+		return fmt.Errorf("no such id: '%s'", id)
 	}
 	delete(idx.ids, id)
 	if deleted := idx.trie.Delete(patricia.Prefix(id)); !deleted {
-		return fmt.Errorf("No such id: '%s'", id)
+		return fmt.Errorf("no such id: '%s'", id)
 	}
 	return nil
 }
 
+// Get retrieves an ID from the TruncIndex. If there are multiple IDs
+// with the given prefix, an error is thrown.
 func (idx *TruncIndex) Get(s string) (string, error) {
 	idx.RLock()
 	defer idx.RUnlock()
@@ -90,17 +98,17 @@ func (idx *TruncIndex) Get(s string) (string, error) {
 		if id != "" {
 			// we haven't found the ID if there are two or more IDs
 			id = ""
-			return fmt.Errorf("we've found two entries")
+			return errDuplicateID
 		}
 		id = string(prefix)
 		return nil
 	}
 
 	if err := idx.trie.VisitSubtree(patricia.Prefix(s), subTreeVisitFunc); err != nil {
-		return "", fmt.Errorf("No such id: %s", s)
+		return "", fmt.Errorf("no such id: %s", s)
 	}
 	if id != "" {
 		return id, nil
 	}
-	return "", fmt.Errorf("No such id: %s", s)
+	return "", fmt.Errorf("no such id: %s", s)
 }