some minor UX updates (spinner), and update how comment funcs return results (via cb)

Author: patrickdevivo

cmd/commands/helpers.go

@@ -9,14 +9,14 @@ import (
 func validateDir(dir string) {
 	if dir == "" {
 		cwd, err := os.Getwd()
-		handleError(err)
+		handleError(err, nil)
 		dir = cwd
 	}
 
 	abs, err := filepath.Abs(filepath.Join(dir, ".git"))
-	handleError(err)
+	handleError(err, nil)
 
 	if _, err := os.Stat(abs); os.IsNotExist(err) {
-		handleError(fmt.Errorf("%s is not a git repository", abs))
+		handleError(fmt.Errorf("%s is not a git repository", abs), nil)
 	}
 }

cmd/commands/root.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/briandowns/spinner"
 	"github.com/spf13/cobra"
 )
 
@@ -14,9 +15,15 @@ var rootCmd = &cobra.Command{
 }
 
 // TODO clean this up
-func handleError(err error) {
+func handleError(err error, spinner *spinner.Spinner) {
 	if err != nil {
-		fmt.Println(err)
+		if spinner != nil {
+			// spinner.Suffix = ""
+			spinner.FinalMSG = err.Error()
+			spinner.Stop()
+		} else {
+			fmt.Println(err)
+		}
 		os.Exit(1)
 	}
 }

cmd/commands/status.go

@@ -20,26 +20,26 @@ var statusCmd = &cobra.Command{
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		cwd, err := os.Getwd()
-		handleError(err)
+		handleError(err, nil)
 
 		dir := cwd
 		if len(args) == 1 {
 			dir, err = filepath.Rel(cwd, args[0])
-			handleError(err)
+			handleError(err, nil)
 		}
 
 		validateDir(dir)
 
 		r, err := git.PlainOpen(dir)
-		handleError(err)
+		handleError(err, nil)
 
 		ref, err := r.Head()
-		handleError(err)
+		handleError(err, nil)
 
 		commit, err := r.CommitObject(ref.Hash())
-		handleError(err)
+		handleError(err, nil)
 
 		err = tickgit.WriteStatus(commit, os.Stdout)
-		handleError(err)
+		handleError(err, nil)
 	},
 }

cmd/commands/todos.go

@@ -2,6 +2,7 @@ package commands
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"path/filepath"
 	"sort"
@@ -24,36 +25,44 @@ var todosCmd = &cobra.Command{
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		s := spinner.New(spinner.CharSets[9], 100*time.Millisecond)
+		s.HideCursor = true
 		s.Suffix = " finding TODOs"
 		s.Writer = os.Stderr
 		s.Start()
 
 		cwd, err := os.Getwd()
-		handleError(err)
+		handleError(err, s)
 
 		dir := cwd
 		if len(args) == 1 {
 			dir, err = filepath.Rel(cwd, args[0])
-			handleError(err)
+			handleError(err, s)
 		}
 
 		validateDir(dir)
 
-		comments, err := comments.SearchDir(dir)
-		handleError(err)
-
-		t := todos.NewToDos(comments)
+		foundToDos := make(todos.ToDos, 0)
+		err = comments.SearchDir(dir, func(comment *comments.Comment) {
+			todo := todos.NewToDo(*comment)
+			if todo != nil {
+				foundToDos = append(foundToDos, todo)
+				s.Suffix = fmt.Sprintf(" %d TODOs found", len(foundToDos))
+			}
+		})
+		handleError(err, s)
 
+		s.Suffix = fmt.Sprintf(" blaming %d TODOs", len(foundToDos))
 		ctx := context.Background()
 		// timeout after 30 seconds
 		// ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
 		// defer cancel()
-		err = t.FindBlame(ctx, dir)
-		sort.Sort(&t)
+		err = foundToDos.FindBlame(ctx, dir)
+		sort.Sort(&foundToDos)
 
-		handleError(err)
+		handleError(err, s)
 
 		s.Stop()
-		todos.WriteTodos(t, os.Stdout)
+
+		todos.WriteTodos(foundToDos, os.Stdout)
 	},
 }

pkg/comments/comments.go

@@ -1,9 +1,7 @@
 package comments
 
 import (
-	"bytes"
 	"io"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -71,41 +69,39 @@ type Comment struct {
 }
 
 // SearchFile searches a file for comments. It infers the language
-func SearchFile(filePath string, reader io.Reader) (Comments, error) {
-	src, err := ioutil.ReadAll(reader)
-	if err != nil {
-		return nil, err
-	}
-	lang := Language(enry.GetLanguage(filepath.Base(filePath), src))
+func SearchFile(filePath string, reader io.Reader, cb func(*Comment)) error {
+	// src, err := ioutil.ReadAll(reader)
+	// if err != nil {
+	// 	return nil, err
+	// }
+	lang := Language(enry.GetLanguage(filepath.Base(filePath), nil))
 	if enry.IsVendor(filePath) {
-		return nil, nil
+		return nil
 	}
 	options, ok := LanguageParseOptions[lang]
 	if !ok { // TODO provide a default parse option?
-		return nil, nil
+		return nil
 	}
 	commentParser, err := lege.NewParser(options)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
-	collections, err := commentParser.Parse(bytes.NewReader(src))
+	collections, err := commentParser.Parse(reader)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
-	comments := make(Comments, 0)
 	for _, c := range collections {
 		comment := Comment{*c, filePath}
-		comments = append(comments, &comment)
+		cb(&comment)
 	}
 
-	return comments, nil
+	return nil
 }
 
 // SearchDir searches a directory for comments
-func SearchDir(dirPath string) (Comments, error) {
-	found := make(Comments, 0)
+func SearchDir(dirPath string, cb func(comment *Comment)) error {
 	err := godirwalk.Walk(dirPath, &godirwalk.Options{
 		Callback: func(path string, de *godirwalk.Dirent) error {
 			localPath, err := filepath.Rel(dirPath, path)
@@ -130,36 +126,32 @@ func SearchDir(dirPath string) (Comments, error) {
 				if err != nil {
 					return err
 				}
-				defer f.Close()
-				t, err := SearchFile(localPath, f)
+				err = SearchFile(localPath, f, cb)
 				if err != nil {
 					return err
 				}
-				c := Comments(t)
-				found = append(found, c...)
+				f.Close()
 			}
 			return nil
 		},
 		Unsorted: true,
 	})
 	if err != nil {
-		return nil, err
+		return err
 	}
-	return found, nil
+	return nil
 }
 
 // SearchCommit searches all files in the tree of a given commit
-func SearchCommit(commit *object.Commit) (Comments, error) {
-	found := make(Comments, 0)
-	t, err := commit.Tree()
-	if err != nil {
-		return nil, err
-	}
-
+func SearchCommit(commit *object.Commit, cb func(*Comment)) error {
 	var wg sync.WaitGroup
 	errs := make(chan error)
 
-	fileIter := t.Files()
+	fileIter, err := commit.Files()
+	if err != nil {
+		return err
+	}
+	defer fileIter.Close()
 	fileIter.ForEach(func(file *object.File) error {
 		if file.Mode.IsFile() {
 			wg.Add(1)
@@ -171,20 +163,17 @@ func SearchCommit(commit *object.Commit) (Comments, error) {
 					errs <- err
 					return
 				}
-				c, err := SearchFile(file.Name, r)
+				err = SearchFile(file.Name, r, cb)
 				if err != nil {
 					errs <- err
 					return
 				}
 
-				for _, comment := range c {
-					found = append(found, comment)
-				}
 			}()
 		}
 		return nil
 	})
 
 	wg.Wait()
-	return found, nil
+	return nil
 }