Merge pull request #6 from augmentable-dev/todos

Implement basic TODO searching

Author: patrickdevivo

cmd/commands/root.go

@@ -7,9 +7,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var cfgFile string
-
-// rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "tickgit",
 	Short: "Tickets as config",
@@ -23,7 +20,3 @@ func Execute() {
 		os.Exit(1)
 	}
 }
-
-func init() {
-
-}

cmd/commands/status.go

@@ -13,6 +13,7 @@ func init() {
 	rootCmd.AddCommand(statusCmd)
 }
 
+// TODO clean this up
 func handleError(err error) {
 	if err != nil {
 		panic(err)

cmd/commands/todos.go

@@ -0,0 +1,37 @@
+package commands
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/augmentable-dev/tickgit/pkg/comments"
+	"github.com/augmentable-dev/tickgit/pkg/todos"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(todosCmd)
+}
+
+var todosCmd = &cobra.Command{
+	Use:   "todos",
+	Short: "Print a report of current TODOs",
+	Long:  ``,
+	Args:  cobra.MaximumNArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		cwd, err := os.Getwd()
+		handleError(err)
+
+		dir := cwd
+		if len(args) == 1 {
+			dir, err = filepath.Rel(cwd, args[0])
+			handleError(err)
+		}
+
+		comments, err := comments.SearchDir(dir)
+		handleError(err)
+
+		t := todos.NewToDos(comments)
+		todos.WriteTodos(t, os.Stdout)
+	},
+}

go.mod

@@ -3,9 +3,11 @@ module github.com/augmentable-dev/tickgit
 go 1.13
 
 require (
+	github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e
 	github.com/hashicorp/hcl/v2 v2.0.0
 	github.com/spf13/cobra v0.0.5
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/src-d/enry/v2 v2.1.0
 	golang.org/x/sys v0.0.0-20191010194322-b09406accb47 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/src-d/go-billy.v4 v4.3.2

go.sum

@@ -11,6 +11,8 @@ github.com/apparentlymart/go-textseg v1.0.0/go.mod h1:z96Txxhf3xSFMPmb5X/1W05FF/
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
+github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e h1:geKUZgzslZzV3VHxeMCwRhS4Zs/ocu2mTer4+dB3094=
+github.com/augmentable-dev/lege v0.0.0-20191023021623-869a91bc405e/go.mod h1:DtuvAW6+SE9e44O6eLaMJp8PFiadmk6NfXslCKYCiB0=
 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=
@@ -85,13 +87,19 @@ github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/spf13/viper v1.3.2 h1:VUFqw5KcqRf7i70GOzW7N+Q7+gxVBkSSqiXB12+JQ4M=
 github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
+github.com/src-d/enry/v2 v2.1.0 h1:z1L8t+B8bh3mmjPkJrgOTnVRpFGmTPJsplHX9wAn6BI=
+github.com/src-d/enry/v2 v2.1.0/go.mod h1:qQeCMRwzMF3ckeGr+h0tJLdxXnq+NVZsIDMELj0t028=
 github.com/src-d/gcfg v1.4.0 h1:xXbNR5AlLSA315x2UO+fTSSAXCDf+Ar38/6oyGbDKQ4=
 github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
+github.com/src-d/go-oniguruma v1.1.0 h1:EG+Nm5n2JqWUaCjtM0NtutPxU7ZN5Tp50GWrrV8bTww=
+github.com/src-d/go-oniguruma v1.1.0/go.mod h1:chVbff8kcVtmrhxtZ3yBVLLquXbzCS6DrxQaAK/CeqM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
 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/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=
 github.com/vmihailenco/msgpack v3.3.3+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk=
 github.com/xanzy/ssh-agent v0.2.1 h1:TCbipTQL2JiiCprBWx9frJ2eJlCYT00NmctrHxVAr70=
@@ -138,6 +146,8 @@ gopkg.in/src-d/go-git-fixtures.v3 v3.5.0 h1:ivZFOIltbce2Mo8IjzUHAFoq/IylO9WHhNOA
 gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g=
 gopkg.in/src-d/go-git.v4 v4.13.1 h1:SRtFyV8Kxc0UP7aCHcijOMQGPxHSmMOPrzulQWolkYE=
 gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8=
+gopkg.in/toqueteos/substring.v1 v1.0.2 h1:urLqCeMm6x/eTuQa1oZerNw8N1KNOIp5hD5kGL7lFsE=
+gopkg.in/toqueteos/substring.v1 v1.0.2/go.mod h1:Eb2Z1UYehlVK8LYW2WBVR2rwbujsz3aX8XDrM1vbNew=
 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=

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

@@ -0,0 +1,33 @@
+package todos
+
+import (
+	"io"
+	"text/template"
+)
+
+// DefaultTemplate is the default report template
+const DefaultTemplate = `
+{{- 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 ToDos, writer io.Writer) error {
+
+	t, err := template.New("todos").Parse(DefaultTemplate)
+	if err != nil {
+		return err
+	}
+
+	err = t.Execute(writer, todos)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/todos/todos.go

@@ -0,0 +1,46 @@
+package todos
+
+import (
+	"strings"
+
+	"github.com/augmentable-dev/tickgit/pkg/comments"
+)
+
+// ToDo represents a ToDo item
+type ToDo struct {
+	comments.Comment
+	String string
+}
+
+// ToDos represents a list of ToDo items
+type ToDos []ToDo
+
+// Count returns the number of todos
+func (t ToDos) Count() int {
+	return len(t)
+}
+
+// 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 {
+		todo := NewToDo(comment)
+		if todo != nil {
+			todos = append(todos, *todo)
+		}
+	}
+	return todos
+}