bunch of refactoring, get the report to spit out

Author: patrickdevivo

cmd/commands/todos.go

@@ -4,6 +4,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/augmentable-dev/tickgit/pkg/comments"
 	"github.com/augmentable-dev/tickgit/pkg/todos"
 	"github.com/spf13/cobra"
 )
@@ -26,18 +27,11 @@ var todosCmd = &cobra.Command{
 			dir, err = filepath.Rel(cwd, args[0])
 			handleError(err)
 		}
-		found := make([]*todos.TODO, 0)
-		err = filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
-			if !info.IsDir() {
-				p, err := filepath.Rel(dir, path)
-				handleError(err)
-				t, err := todos.SearchFile(p)
-				handleError(err)
-				found = append(found, t...)
-			}
-			return nil
-		})
+
+		comments, err := comments.SearchDir(dir)
 		handleError(err)
-		todos.WriteTodos(found, os.Stdout)
+
+		t := todos.NewToDos(comments)
+		todos.WriteTodos(t, os.Stdout)
 	},
 }

go.mod

@@ -5,6 +5,7 @@ go 1.13
 require (
 	github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e
 	github.com/hashicorp/hcl/v2 v2.0.0
+	github.com/iafan/cwalk v0.0.0-20190614202238-fa18e8c290ff
 	github.com/spf13/cobra v0.0.5
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/enry/v2 v2.1.0

go.sum

@@ -39,6 +39,8 @@ github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/hashicorp/hcl/v2 v2.0.0 h1:efQznTz+ydmQXq3BOnRa3AXzvCeTq1P4dKj/z5GLlY8=
 github.com/hashicorp/hcl/v2 v2.0.0/go.mod h1:oVVDG71tEinNGYCxinCYadcmKU9bglqW9pV3txagJ90=
+github.com/iafan/cwalk v0.0.0-20190614202238-fa18e8c290ff h1:9ZihPWeTUmSv9RPU8FOn+WgJCT4fmK/gjgPMyKtAHSk=
+github.com/iafan/cwalk v0.0.0-20190614202238-fa18e8c290ff/go.mod h1:qVux82tax0171OVITiCxp2fPNmpP4jv3/RHLcqZ0Pf4=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=

pkg/comments/comments.go

@@ -0,0 +1,132 @@
+package comments
+
+import (
+	"bytes"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/augmentable-dev/lege"
+	"github.com/src-d/enry/v2"
+)
+
+// CStyleCommentOptions ...
+var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
+	Boundaries: []lege.Boundary{
+		lege.Boundary{
+			Starts: []string{"//"},
+			Ends:   []string{"\n"},
+		},
+		lege.Boundary{
+			Starts: []string{"/*"},
+			Ends:   []string{"*/"},
+		},
+	},
+}
+
+// HashStyleCommentOptions ...
+var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
+	Boundaries: []lege.Boundary{
+		lege.Boundary{
+			Starts: []string{"#"},
+			Ends:   []string{"\n"},
+		},
+	},
+}
+
+// Language is a source language (i.e. "Go")
+type Language string
+
+// LanguageParseOptions keeps track of source languages and their corresponding comment options
+var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.ParseOptions{
+	"Go":         CStyleCommentOptions,
+	"Java":       CStyleCommentOptions,
+	"C":          CStyleCommentOptions,
+	"C++":        CStyleCommentOptions,
+	"C#":         CStyleCommentOptions,
+	"JavaScript": CStyleCommentOptions,
+	"Python":     HashStyleCommentOptions,
+	"Ruby":       HashStyleCommentOptions,
+	"PHP":        CStyleCommentOptions,
+}
+
+// Comments is a list of comments
+type Comments []Comment
+
+// Comment represents a comment in a source code file
+type Comment struct {
+	lege.Collection
+	FilePath string
+}
+
+// SearchFile searches a file for comments. It infers the language
+func SearchFile(filePath string) (Comments, error) {
+	src, err := ioutil.ReadFile(filePath)
+	if err != nil {
+		return nil, err
+	}
+	lang := Language(enry.GetLanguage(filepath.Base(filePath), src))
+	if enry.IsVendor(filePath) {
+		return nil, nil
+	}
+	options, ok := LanguageParseOptions[lang]
+	if !ok {
+		return nil, nil
+	}
+	commentParser, err := lege.NewParser(options)
+	if err != nil {
+		return nil, err
+	}
+
+	collections, err := commentParser.Parse(bytes.NewReader(src))
+	if err != nil {
+		return nil, err
+	}
+
+	comments := make(Comments, 0)
+	for _, c := range collections {
+		comment := Comment{*c, filePath}
+		comments = append(comments, comment)
+	}
+
+	return comments, nil
+}
+
+// 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)
+			if err != nil {
+				return err
+			}
+			t, err := SearchFile(p)
+			if err != nil {
+				return err
+			}
+			c := Comments(t)
+			found = append(found, c...)
+		}
+		return nil
+	})
+	if err != nil {
+		return nil, err
+	}
+	return found, nil
+}

pkg/todos/report.go

@@ -7,23 +7,27 @@ import (
 
 // DefaultTemplate is the default report template
 const DefaultTemplate = `
-{{- range . }}
-=== 📋 {{ .String }}
-  --- {{ .FilePath }}:{{ .Line }}:{{ .Position }}
-{{- else }}
+{{- range $index, $todo := . }}
+{{ print "\u001b[33m" }}TODO{{ print "\u001b[0m" }}{{ .String }}
+  => {{ with .Comment }}{{ .FilePath }}:{{ .StartLocation.Line }}:{{ .StartLocation.Pos }}{{ end }}
+{{ else }}
 no todos 🎉
 {{- end }}
+{{ .Count }} TODOs Found 📝
 `
 
 // WriteTodos renders a report of todos
-func WriteTodos(todos []*TODO, writer io.Writer) error {
+func WriteTodos(todos ToDos, writer io.Writer) error {
 
 	t, err := template.New("todos").Parse(DefaultTemplate)
 	if err != nil {
 		return err
 	}
 
-	t.Execute(writer, todos)
+	err = t.Execute(writer, todos)
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

pkg/todos/todos.go

@@ -1,103 +1,46 @@
 package todos
 
 import (
-	"bytes"
-	"io/ioutil"
-	"path/filepath"
 	"strings"
 
-	"github.com/augmentable-dev/lege"
-	"github.com/src-d/enry/v2"
+	"github.com/augmentable-dev/tickgit/pkg/comments"
 )
 
-// CStyleCommentOptions ...
-var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	Boundaries: []lege.Boundary{
-		lege.Boundary{
-			Starts: []string{"//"},
-			Ends:   []string{"\n"},
-		},
-		lege.Boundary{
-			Starts: []string{"/*"},
-			Ends:   []string{"*/"},
-		},
-	},
-}
-
-// HashStyleCommentOptions ...
-var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	Boundaries: []lege.Boundary{
-		lege.Boundary{
-			Starts: []string{"#"},
-			Ends:   []string{"\n"},
-		},
-	},
+// ToDo represents a ToDo item
+type ToDo struct {
+	comments.Comment
+	String string
 }
 
-// Language is a source language (i.e. "Go")
-type Language string
+// ToDos represents a list of ToDo items
+type ToDos []ToDo
 
-// LanguageParseOptions keeps track of source languages and their corresponding comment options
-var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.ParseOptions{
-	"Go":         CStyleCommentOptions,
-	"Java":       CStyleCommentOptions,
-	"C":          CStyleCommentOptions,
-	"C++":        CStyleCommentOptions,
-	"C#":         CStyleCommentOptions,
-	"JavaScript": CStyleCommentOptions,
-	"Python":     HashStyleCommentOptions,
-	"Ruby":       HashStyleCommentOptions,
-	"PHP":        CStyleCommentOptions,
-}
-
-// ToDo represents a ToDo item
-type ToDo struct {
-	FilePath string
-	Line     int
-	Position int
-	String   string
+// Count returns the number of todos
+func (t ToDos) Count() int {
+	return len(t)
 }
 
-// SearchFile searches a file for comments. It infers the language
-func SearchFile(filePath string) ([]*ToDo, error) {
-	todos := make([]*ToDo, 0)
-	src, err := ioutil.ReadFile(filePath)
-	if err != nil {
-		return nil, err
-	}
-	lang := Language(enry.GetLanguage(filepath.Base(filePath), src))
-	if enry.IsVendor(filePath) {
-		return nil, nil
-	}
-	options, ok := LanguageParseOptions[lang]
-	if !ok {
-		return nil, nil
-	}
-	commentParser, err := lege.NewParser(options)
-	if err != nil {
-		return nil, err
-	}
-	comments, err := commentParser.Parse(bytes.NewReader(src))
-	if err != nil {
-		return nil, err
+// NewToDo produces a pointer to a ToDo from a comment
+func NewToDo(comment comments.Comment) *ToDo {
+	s := comment.String()
+	if !strings.Contains(s, "TODO") {
+		return nil
 	}
+	s = strings.Replace(comment.String(), "TODO", "", 1)
+	s = strings.Trim(s, " ")
 
+	todo := ToDo{Comment: comment, String: s}
+	return &todo
+}
+
+// NewToDos produces a list of ToDos from a list of comments
+func NewToDos(comments comments.Comments) ToDos {
+	todos := make(ToDos, 0)
 	for _, comment := range comments {
-		s := comment.String()
-		if !strings.Contains(s, "TODO") {
-			continue
+		todo := NewToDo(comment)
+		if todo != nil {
+			todos = append(todos, *todo)
 		}
-		s = strings.Replace(comment.String(), "TODO", "", 1)
-		s = strings.Trim(s, " ")
-		// fmt.Printf("%q\n", s)
-		todo := &ToDo{
-			FilePath: filePath,
-			Line:     comment.StartLocation.Line,
-			Position: comment.StartLocation.Pos,
-			String:   s,
-		}
-		todos = append(todos, todo)
 	}
-
-	return todos, nil
+	return todos
 }