Merge pull request #23 from augmentable-dev/refactoring

Some general refactoring

Author: patrickdevivo

cmd/commands/todos.go

@@ -51,12 +51,9 @@ var todosCmd = &cobra.Command{
 		commit, err := r.CommitObject(ref.Hash())
 		handleError(err)
 
-		comments, err := comments.SearchCommit(commit)
+		comments, err := comments.SearchDir(dir)
 		handleError(err)
 
-		// comments, err := comments.SearchDir(dir)
-		// handleError(err)
-
 		t := todos.NewToDos(comments)
 
 		ctx := context.Background()
@@ -67,7 +64,6 @@ var todosCmd = &cobra.Command{
 			total := len(t)
 			s.Suffix = fmt.Sprintf(" (%d/%d) %s: %s", total-remaining, total, commit.Hash, commit.Author.When)
 		})
-
 		sort.Sort(&t)
 
 		handleError(err)

go.mod

@@ -9,14 +9,17 @@ require (
 	github.com/dustin/go-humanize v1.0.0
 	github.com/google/go-cmp v0.3.1 // indirect
 	github.com/hashicorp/hcl/v2 v2.0.0
+	github.com/karrick/godirwalk v1.13.0
 	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
 	github.com/spf13/cobra v0.0.5
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/enry/v2 v2.1.0
+	github.com/stretchr/testify v1.4.0 // indirect
 	golang.org/x/crypto v0.0.0-20191029031824-8986dd9e96cf // indirect
 	golang.org/x/net v0.0.0-20191028085509-fe3aa8a45271 // indirect
 	golang.org/x/sys v0.0.0-20191029155521-f43be2a4598c // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/src-d/go-billy.v4 v4.3.2
 	gopkg.in/src-d/go-git.v4 v4.13.1
+	gopkg.in/yaml.v2 v2.2.4 // indirect
 )

go.sum

@@ -54,6 +54,8 @@ github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANyt
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/karrick/godirwalk v1.13.0 h1:GJq8GHQEAPsjwqfGhLNXBO5P0dS2HYdDRVWe+P4E/EQ=
+github.com/karrick/godirwalk v1.13.0/go.mod h1:H5KPZjojv4lE+QYImBI8xVtrBRgYrIVsaRPx4tDPEn4=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
@@ -114,6 +116,8 @@ github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoH
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/toqueteos/trie v1.0.0 h1:8i6pXxNUXNRAqP246iibb7w/pSFquNTQ+uNfriG7vlk=
 github.com/toqueteos/trie v1.0.0/go.mod h1:Ywk48QhEqhU1+DwhMkJ2x7eeGxDHiGkAdc9+0DYcbsM=
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
@@ -173,3 +177,5 @@ gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
 gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.4 h1:/eiJrUcujPVeJ3xlSWaiNi3uSVmDGBK1pDHUHAnao1I=
+gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

pkg/comments/comments.go

@@ -10,6 +10,7 @@ import (
 	"sync"
 
 	"github.com/augmentable-dev/lege"
+	"github.com/karrick/godirwalk"
 	"github.com/src-d/enry/v2"
 	"gopkg.in/src-d/go-git.v4/plumbing/object"
 )
@@ -70,7 +71,7 @@ type Comment struct {
 }
 
 // SearchFile searches a file for comments. It infers the language
-func SearchFile(filePath string, reader io.ReadCloser) (Comments, error) {
+func SearchFile(filePath string, reader io.Reader) (Comments, error) {
 	src, err := ioutil.ReadAll(reader)
 	if err != nil {
 		return nil, err
@@ -105,38 +106,41 @@ func SearchFile(filePath string, reader io.ReadCloser) (Comments, error) {
 // SearchDir searches a directory for comments
 func SearchDir(dirPath string) (Comments, error) {
 	found := make(Comments, 0)
-	// TODO let's see what we can do concurrently here to speed up the processing
-	err := filepath.Walk(dirPath, func(path string, info os.FileInfo, err error) error {
-		localPath, err := filepath.Rel(dirPath, path)
-		if err != nil {
-			return err
-		}
-		pathComponents := strings.Split(localPath, string(os.PathSeparator))
-		// let's ignore git directories TODO: figure out a more generic way to set ignores
-		matched, err := filepath.Match(".git", pathComponents[0])
-		if err != nil {
-			return err
-		}
-		if matched {
-			return nil
-		}
-		if !info.IsDir() {
-			p, err := filepath.Abs(path)
+	err := godirwalk.Walk(dirPath, &godirwalk.Options{
+		Callback: func(path string, de *godirwalk.Dirent) error {
+			localPath, err := filepath.Rel(dirPath, path)
 			if err != nil {
 				return err
 			}
-			f, err := os.Open(p)
+			pathComponents := strings.Split(localPath, string(os.PathSeparator))
+			// let's ignore git directories TODO: figure out a more generic way to set ignores
+			matched, err := filepath.Match(".git", pathComponents[0])
 			if err != nil {
 				return err
 			}
-			t, err := SearchFile(p, f)
-			if err != nil {
-				return err
+			if matched {
+				return nil
 			}
-			c := Comments(t)
-			found = append(found, c...)
-		}
-		return nil
+			if de.IsRegular() {
+				p, err := filepath.Abs(path)
+				if err != nil {
+					return err
+				}
+				f, err := os.Open(p)
+				if err != nil {
+					return err
+				}
+				defer f.Close()
+				t, err := SearchFile(p, f)
+				if err != nil {
+					return err
+				}
+				c := Comments(t)
+				found = append(found, c...)
+			}
+			return nil
+		},
+		Unsorted: true,
 	})
 	if err != nil {
 		return nil, err

pkg/todos/todos.go

@@ -2,9 +2,11 @@ package todos
 
 import (
 	"context"
+	"fmt"
 	"regexp"
 	"strings"
 	"sync"
+	"time"
 
 	"github.com/augmentable-dev/tickgit/pkg/comments"
 	"github.com/dustin/go-humanize"
@@ -17,7 +19,24 @@ import (
 type ToDo struct {
 	comments.Comment
 	String string
-	Commit *object.Commit
+	Commit *Commit
+}
+
+// Commit represents the commit a todo originated in
+type Commit struct {
+	Hash string
+	Author
+}
+
+// Author represents the authoring of the commit a todo originated in
+type Author struct {
+	Name  string
+	Email string
+	When  time.Time
+}
+
+func (a *Author) String() string {
+	return fmt.Sprintf("%s <%s>", a.Name, a.Email)
 }
 
 // ToDos represents a list of ToDo items
@@ -58,30 +77,30 @@ func NewToDos(comments comments.Comments) ToDos {
 }
 
 // Len returns the number of todos
-func (t *ToDos) Len() int {
-	return len(*t)
+func (t ToDos) Len() int {
+	return len(t)
 }
 
 // Less compares two todos by their creation time
-func (t *ToDos) Less(i, j int) bool {
-	first := (*t)[i]
-	second := (*t)[j]
+func (t ToDos) Less(i, j int) bool {
+	first := t[i]
+	second := t[j]
 	if first.Commit == nil || second.Commit == nil {
 		return false
 	}
 	return first.Commit.Author.When.Before(second.Commit.Author.When)
 }
 
 // Swap swaps two todoss
-func (t *ToDos) Swap(i, j int) {
-	temp := (*t)[i]
-	(*t)[i] = (*t)[j]
-	(*t)[j] = temp
+func (t ToDos) Swap(i, j int) {
+	temp := t[i]
+	t[i] = t[j]
+	t[j] = temp
 }
 
 // CountWithCommits returns the number of todos with an associated commit (in which that todo was added)
-func (t *ToDos) CountWithCommits() (count int) {
-	for _, todo := range *t {
+func (t ToDos) CountWithCommits() (count int) {
+	for _, todo := range t {
 		if todo.Commit != nil {
 			count++
 		}
@@ -143,7 +162,14 @@ func (t *ToDos) FindBlame(ctx context.Context, repo *git.Repository, from *objec
 					}
 					mux.Unlock()
 					if !exists { // if the todo doesn't exist in this commit, it was added in the previous commit (previous wrt the iterator, more recent in time)
-						todo.Commit = prevCommit
+						todo.Commit = &Commit{
+							Hash: prevCommit.Hash.String(),
+							Author: Author{
+								Name:  prevCommit.Author.Name,
+								Email: prevCommit.Author.Email,
+								When:  prevCommit.Author.When,
+							},
+						}
 					} else { // if the todo does exist in this commit, add it to the new list of remaining todos
 						newRemainingTodos = append(newRemainingTodos, todo)
 					}