Merge pull request #22 from augmentable-dev/todo-history

add ability to parse when a TODO was added, include in report

Author: patrickdevivo

cmd/commands/todos.go

@@ -1,13 +1,19 @@
 package commands
 
 import (
+	"context"
+	"fmt"
 	"os"
 	"path/filepath"
+	"sort"
+	"time"
 
 	"github.com/augmentable-dev/tickgit/pkg/comments"
 	"github.com/augmentable-dev/tickgit/pkg/todos"
+	"github.com/briandowns/spinner"
 	"github.com/spf13/cobra"
 	"gopkg.in/src-d/go-git.v4"
+	"gopkg.in/src-d/go-git.v4/plumbing/object"
 )
 
 func init() {
@@ -20,6 +26,11 @@ var todosCmd = &cobra.Command{
 	Long:  `Scans a given git repository looking for any code comments with TODOs. Displays a report of all the TODO items found.`,
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
+		s := spinner.New(spinner.CharSets[9], 100*time.Millisecond)
+		s.Suffix = " finding TODOs"
+		s.Writer = os.Stderr
+		s.Start()
+
 		cwd, err := os.Getwd()
 		handleError(err)
 
@@ -47,6 +58,21 @@ var todosCmd = &cobra.Command{
 		// handleError(err)
 
 		t := todos.NewToDos(comments)
+
+		ctx := context.Background()
+		// timeout after 30 seconds
+		ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
+		defer cancel()
+		_, err = t.FindBlame(ctx, r, commit, func(commit *object.Commit, remaining int) {
+			total := len(t)
+			s.Suffix = fmt.Sprintf(" (%d/%d) %s: %s", total-remaining, total, commit.Hash, commit.Author.When)
+		})
+
+		sort.Sort(&t)
+
+		handleError(err)
+
+		s.Stop()
 		todos.WriteTodos(t, os.Stdout)
 	},
 }

go.mod

@@ -5,6 +5,8 @@ go 1.13
 require (
 	github.com/agext/levenshtein v1.2.2 // indirect
 	github.com/augmentable-dev/lege v0.0.0-20191028004410-79cb985065a1
+	github.com/briandowns/spinner v1.7.0
+	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/mitchellh/go-wordwrap v1.0.0 // indirect

go.sum

@@ -15,6 +15,8 @@ github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPd
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/augmentable-dev/lege v0.0.0-20191028004410-79cb985065a1 h1:NBe2//2MA/Z7X4wuKnHSIN+xI/oBTLYMJVc8VCwXK4o=
 github.com/augmentable-dev/lege v0.0.0-20191028004410-79cb985065a1/go.mod h1:DtuvAW6+SE9e44O6eLaMJp8PFiadmk6NfXslCKYCiB0=
+github.com/briandowns/spinner v1.7.0 h1:aan1hBBOoscry2TXAkgtxkJiq7Se0+9pt+TUWaPrB4g=
+github.com/briandowns/spinner v1.7.0/go.mod h1://Zf9tMcxfRUA36V23M6YGEAv+kECGfvpnLTnb8n4XQ=
 github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
 github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
 github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
@@ -23,8 +25,12 @@ github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7Do
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo=
+github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
 github.com/emirpasic/gods v1.12.0 h1:QAUIPSaCu4G+POclxeqb3F+WPpdKqFGlw36+yOzGlrg=
 github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 h1:BHsljHzVlRcyQhjrss6TZTdY2VfCqZPbv5k3iBFa2ZQ=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=
@@ -60,6 +66,10 @@ github.com/kylelemons/godebug v0.0.0-20170820004349-d65d576e9348 h1:MtvEpTB6LX3v
 github.com/kylelemons/godebug v0.0.0-20170820004349-d65d576e9348/go.mod h1:B69LEHPfb2qLo0BaaOLcbitczOKLWTsrBG9LczfCD4k=
 github.com/magiconair/properties v1.8.0 h1:LLgXmsheXeRoUOBOjtwPQCWIYqM/LU1ayDtDePerRcY=
 github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
+github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU=
+github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
+github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE=
+github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7 h1:DpOJ2HYzCv8LZP15IdmG+YdwD2luVPHITV96TkirNBM=
@@ -133,6 +143,7 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190502175342-a43fa875dd82/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e h1:D5TXcfTk7xF7hvieo4QErS3qqCB4teTffacDWr7CI+0=

pkg/comments/comments.go

@@ -61,7 +61,7 @@ var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.Pa
 }
 
 // Comments is a list of comments
-type Comments []Comment
+type Comments []*Comment
 
 // Comment represents a comment in a source code file
 type Comment struct {
@@ -96,7 +96,7 @@ func SearchFile(filePath string, reader io.ReadCloser) (Comments, error) {
 	comments := make(Comments, 0)
 	for _, c := range collections {
 		comment := Comment{*c, filePath}
-		comments = append(comments, comment)
+		comments = append(comments, &comment)
 	}
 
 	return comments, nil

pkg/todos/report.go

@@ -9,11 +9,14 @@ import (
 const DefaultTemplate = `
 {{- range $index, $todo := . }}
 {{ print "\u001b[33m" }}TODO{{ print "\u001b[0m" }}: {{ .String }}
-  => {{ with .Comment }}{{ .FilePath }}:{{ .StartLocation.Line }}:{{ .StartLocation.Pos }}{{ end }}
+  => {{ .Comment.FilePath }}:{{ .Comment.StartLocation.Line }}:{{ .Comment.StartLocation.Pos }}
+  {{- if .Commit }}
+  => added {{ .TimeAgo }} by {{ .Commit.Author }} in {{ .Commit.Hash }}
+  {{- end }}
 {{ else }}
 no todos 🎉
 {{- end }}
-{{ .Count }} TODOs Found 📝
+{{ len . }} TODOs Found 📝
 `
 
 // WriteTodos renders a report of todos

pkg/todos/todos.go

@@ -1,24 +1,34 @@
 package todos
 
 import (
+	"context"
 	"regexp"
 	"strings"
+	"sync"
 
 	"github.com/augmentable-dev/tickgit/pkg/comments"
+	"github.com/dustin/go-humanize"
+	"gopkg.in/src-d/go-git.v4"
+	"gopkg.in/src-d/go-git.v4/plumbing/object"
+	"gopkg.in/src-d/go-git.v4/plumbing/storer"
 )
 
 // ToDo represents a ToDo item
 type ToDo struct {
 	comments.Comment
 	String string
+	Commit *object.Commit
 }
 
 // ToDos represents a list of ToDo items
-type ToDos []ToDo
+type ToDos []*ToDo
 
-// Count returns the number of todos
-func (t ToDos) Count() int {
-	return len(t)
+// TimeAgo returns a human readable string indicating the time since the todo was added
+func (t *ToDo) TimeAgo() string {
+	if t.Commit == nil {
+		return "<unknown>"
+	}
+	return humanize.Time(t.Commit.Author.When)
 }
 
 // NewToDo produces a pointer to a ToDo from a comment
@@ -39,10 +49,117 @@ func NewToDo(comment comments.Comment) *ToDo {
 func NewToDos(comments comments.Comments) ToDos {
 	todos := make(ToDos, 0)
 	for _, comment := range comments {
-		todo := NewToDo(comment)
+		todo := NewToDo(*comment)
 		if todo != nil {
-			todos = append(todos, *todo)
+			todos = append(todos, todo)
 		}
 	}
 	return todos
 }
+
+// Len returns the number of todos
+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]
+	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
+}
+
+// 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 {
+		if todo.Commit != nil {
+			count++
+		}
+	}
+	return count
+}
+
+func (t *ToDo) existsInCommit(commit *object.Commit) (bool, error) {
+	f, err := commit.File(t.FilePath)
+	if err != nil {
+		if err == object.ErrFileNotFound {
+			return false, nil
+		}
+		return false, err
+	}
+	c, err := f.Contents()
+	if err != nil {
+		return false, err
+	}
+	contains := strings.Contains(c, t.Comment.String())
+	return contains, nil
+}
+
+// FindBlame sets the blame information on each todo in a set of todos
+func (t *ToDos) FindBlame(ctx context.Context, repo *git.Repository, from *object.Commit, cb func(*object.Commit, int)) error {
+	commitIter, err := repo.Log(&git.LogOptions{
+		From: from.Hash,
+	})
+	if err != nil {
+		return err
+	}
+	defer commitIter.Close()
+
+	remainingTodos := *t
+	prevCommit := from
+	err = commitIter.ForEach(func(commit *object.Commit) error {
+		if len(remainingTodos) == 0 {
+			return storer.ErrStop
+		}
+		if commit.NumParents() > 1 {
+			return nil
+		}
+		select {
+		case <-ctx.Done():
+			return nil
+		default:
+			newRemainingTodos := make(ToDos, 0)
+			errs := make(chan error)
+			var wg sync.WaitGroup
+			var mux sync.Mutex
+			for _, todo := range remainingTodos {
+				wg.Add(1)
+				go func(todo *ToDo, commit *object.Commit, errs chan error) {
+					defer wg.Done()
+					mux.Lock()
+					exists, err := todo.existsInCommit(commit)
+					if err != nil {
+						errs <- err
+					}
+					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
+					} else { // if the todo does exist in this commit, add it to the new list of remaining todos
+						newRemainingTodos = append(newRemainingTodos, todo)
+					}
+				}(todo, commit, errs)
+			}
+			wg.Wait()
+			if cb != nil {
+				cb(commit, len(newRemainingTodos))
+			}
+			prevCommit = commit
+			remainingTodos = newRemainingTodos
+			return nil
+		}
+	})
+	if err != nil {
+		return err
+	}
+	return nil
+}