Uninit and Clean CLI commands

- Uninit removes GTM tracking for a git repo
- Clean removes uncommitted time data

Author: mschenk42

command/clean.go

@@ -0,0 +1,67 @@
+package command
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/git-time-metric/gtm/project"
+	"github.com/mitchellh/cli"
+)
+
+type CleanCmd struct {
+}
+
+func NewClean() (cli.Command, error) {
+	return CleanCmd{}, nil
+}
+
+func (v CleanCmd) Help() string {
+	return v.Synopsis()
+}
+
+func (v CleanCmd) Run(args []string) int {
+
+	cleanFlags := flag.NewFlagSet("clean", flag.ExitOnError)
+	yes := cleanFlags.Bool(
+		"yes",
+		false,
+		"Automatically confirm yes for cleaning uncommitted time data")
+	if err := cleanFlags.Parse(os.Args[2:]); err != nil {
+		fmt.Println(err)
+		return 1
+	}
+
+	confirm := *yes
+	if !confirm {
+		var response string
+		fmt.Printf("\nClean uncommitted time data (y/n)? ")
+		_, err := fmt.Scanln(&response)
+		if err != nil {
+			fmt.Println(err)
+			return 1
+		}
+		confirm = strings.TrimSpace(strings.ToLower(response)) == "y"
+	}
+
+	if confirm {
+		var (
+			m   string
+			err error
+		)
+		if m, err = project.Clean(); err != nil {
+			fmt.Println(err)
+			return 1
+		}
+		fmt.Println(m)
+	}
+	return 0
+}
+
+func (v CleanCmd) Synopsis() string {
+	return `
+	Usage: gtm clean [-yes]
+	Cleans uncommitted time data by removing all event and metric files from the .gtm directory
+	`
+}

command/report.go

@@ -65,7 +65,7 @@ func (r ReportCmd) Run(args []string) int {
 		commits = append(commits, a)
 	}
 
-	// if running from within a MINGW console isatty does not work
+	// TODO: if running from within a MINGW console isatty does not work
 	// https://github.com/mintty/mintty/issues/482
 	if !isatty.IsTerminal(os.Stdin.Fd()) && len(commits) == 0 && *limit == 0 {
 		scanner := bufio.NewScanner(os.Stdin)

command/uninit.go

@@ -0,0 +1,68 @@
+package command
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/git-time-metric/gtm/project"
+	"github.com/mitchellh/cli"
+)
+
+type UninitCmd struct {
+}
+
+func NewUninit() (cli.Command, error) {
+	return UninitCmd{}, nil
+}
+
+func (v UninitCmd) Help() string {
+	return v.Synopsis()
+}
+
+func (v UninitCmd) Run(args []string) int {
+
+	uninitFlags := flag.NewFlagSet("uninit", flag.ExitOnError)
+	yes := uninitFlags.Bool(
+		"yes",
+		false,
+		"Automatically confirm yes to remove GTM tracking for the current Git repository")
+	if err := uninitFlags.Parse(os.Args[2:]); err != nil {
+		fmt.Println(err)
+		return 1
+	}
+
+	confirm := *yes
+	if !confirm {
+		var response string
+		fmt.Printf("\nRemove GTM tracking for the current git repository (y/n)? ")
+		_, err := fmt.Scanln(&response)
+		if err != nil {
+			fmt.Println(err)
+			return 1
+		}
+		confirm = strings.TrimSpace(strings.ToLower(response)) == "y"
+	}
+
+	if confirm {
+		var (
+			m   string
+			err error
+		)
+		if m, err = project.Uninitialize(); err != nil {
+			fmt.Println(err)
+			return 1
+		}
+		fmt.Println(m)
+	}
+	return 0
+}
+
+func (v UninitCmd) Synopsis() string {
+	return `
+	Usage: gtm uninit [-yes]
+	Remove GTM tracking for the current git repository 
+	Note - this removes uncommitted time data but does not remove time data that is committed
+	`
+}

command/verify.go

@@ -41,6 +41,7 @@ func (v VerifyCmd) Synopsis() string {
 	return `
 	Usage: gtm verify <version constraint>
 	Verify gtm satisfies the version constraint
+	This is typically invoked by plug-ins to determine if GTM needs to be upgraded
 	`
 }
 

main.go

@@ -9,7 +9,8 @@ import (
 	"github.com/mitchellh/cli"
 )
 
-var Version string = "0.0.0"
+// Version is the released version set during the release build process
+var Version = "0.0.0"
 
 func main() {
 	c := cli.NewCLI("gtm", Version)
@@ -21,6 +22,8 @@ func main() {
 		"report": command.NewReport,
 		"status": command.NewStatus,
 		"verify": command.NewVerify(Version),
+		"uninit": command.NewUninit,
+		"clean":  command.NewClean,
 	}
 
 	exitStatus, err := c.Run()

project/project.go

@@ -4,9 +4,11 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
+	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
+	"strings"
 	"text/template"
 	"time"
 
@@ -45,6 +47,19 @@ const (
 const initMsgTpl string = `
 {{print "Git Time Metric initialized for " (.ProjectPath) | printf (.HeaderFormat) }}
 
+{{ range $hook, $command := .GitHooks -}}
+	{{- $hook | printf "%16s" }}: {{ $command }}
+{{ end -}}
+{{ range $key, $val := .GitConfig -}}
+	{{- $key | printf "%16s" }}: {{ $val }}
+{{end -}}
+{{ print ".gitignore:" | printf "%17s" }} {{ .GitIgnore }}
+`
+const removeMsgTpl string = `
+{{print "Git Time Metric uninitialized for " (.ProjectPath) | printf (.HeaderFormat) }}
+
+The following items have been removed.
+
 {{ range $hook, $command := .GitHooks -}}
 	{{- $hook | printf "%16s" }}: {{ $command }}
 {{ end -}}
@@ -60,35 +75,39 @@ var Now = func() time.Time { return time.Now() }
 
 // Initialize initializes a git repo for time tracking
 func Initialize() (string, error) {
-	var fp string
-
 	wd, err := os.Getwd()
 	if err != nil {
 		return "", err
 	}
 
-	fp = filepath.Join(wd, ".git")
-	if _, err := os.Stat(fp); os.IsNotExist(err) {
+	projRoot, err := scm.RootPath(wd)
+	if err != nil {
+		return "", fmt.Errorf(
+			"Unable to intialize Git Time Metric, Git repository not found in %s", projRoot)
+	}
+
+	gitPath := filepath.Join(projRoot, ".git")
+	if _, err := os.Stat(gitPath); os.IsNotExist(err) {
 		return "", fmt.Errorf(
-			"Unable to intialize Git Time Metric, Git repository not found in %s", wd)
+			"Unable to intialize Git Time Metric, Git repository not found in %s", gitPath)
 	}
 
-	fp = filepath.Join(wd, GTMDir)
-	if _, err := os.Stat(fp); os.IsNotExist(err) {
-		if err := os.MkdirAll(fp, 0700); err != nil {
+	gtmPath := filepath.Join(projRoot, GTMDir)
+	if _, err := os.Stat(gtmPath); os.IsNotExist(err) {
+		if err := os.MkdirAll(gtmPath, 0700); err != nil {
 			return "", err
 		}
 	}
 
-	if err := scm.SetHooks(GitHooks); err != nil {
+	if err := scm.SetHooks(GitHooks, projRoot); err != nil {
 		return "", err
 	}
 
-	if err := scm.Config(GitConfig); err != nil {
+	if err := scm.ConfigSet(GitConfig, projRoot); err != nil {
 		return "", err
 	}
 
-	if err := scm.Ignore(GitIgnore); err != nil {
+	if err := scm.IgnoreSet(GitIgnore, projRoot); err != nil {
 		return "", err
 	}
 
@@ -108,7 +127,7 @@ func Initialize() (string, error) {
 			GitIgnore    string
 		}{
 			headerFormat,
-			wd,
+			projRoot,
 			GitHooks,
 			GitConfig,
 			GitIgnore})
@@ -120,6 +139,100 @@ func Initialize() (string, error) {
 	return b.String(), nil
 }
 
+//Uninitialize remove GTM tracking from the project in the current working directory
+func Uninitialize() (string, error) {
+	wd, err := os.Getwd()
+	if err != nil {
+		return "", err
+	}
+
+	projRoot, err := scm.RootPath(wd)
+	if err != nil {
+		return "", fmt.Errorf(
+			"Unable to unintialize Git Time Metric, Git repository not found in %s", projRoot)
+	}
+
+	gtmPath := filepath.Join(projRoot, GTMDir)
+	if _, err := os.Stat(gtmPath); os.IsNotExist(err) {
+		return "", fmt.Errorf(
+			"Unable to uninitialize Git Time Metric, %s directory not found", gtmPath)
+	}
+	if err := scm.RemoveHooks(GitHooks, projRoot); err != nil {
+		return "", err
+	}
+	if err := scm.ConfigRemove(GitConfig, projRoot); err != nil {
+		return "", err
+	}
+	if err := scm.IgnoreRemove(GitIgnore, projRoot); err != nil {
+		return "", err
+	}
+	if err := os.RemoveAll(gtmPath); err != nil {
+		return "", err
+	}
+
+	headerFormat := "%s"
+	if terminal.IsTerminal(int(os.Stdout.Fd())) {
+		headerFormat = "\x1b[1m%s\x1b[0m"
+	}
+	b := new(bytes.Buffer)
+	t := template.Must(template.New("msg").Parse(removeMsgTpl))
+	err = t.Execute(b,
+		struct {
+			HeaderFormat string
+			ProjectPath  string
+			GitHooks     map[string]string
+			GitConfig    map[string]string
+			GitIgnore    string
+		}{
+			headerFormat,
+			projRoot,
+			GitHooks,
+			GitConfig,
+			GitIgnore})
+
+	if err != nil {
+		return "", err
+	}
+
+	return b.String(), nil
+}
+
+//Clean removes any event or metrics files from project in the current working directory
+func Clean() (string, error) {
+	wd, err := os.Getwd()
+	if err != nil {
+		return "", err
+	}
+
+	projRoot, err := scm.RootPath(wd)
+	if err != nil {
+		return "", fmt.Errorf(
+			"Unable to clean, Git repository not found in %s", projRoot)
+	}
+
+	gtmPath := filepath.Join(projRoot, GTMDir)
+	if _, err := os.Stat(gtmPath); os.IsNotExist(err) {
+		return "", fmt.Errorf(
+			"Unable to clean GTM data, %s directory not found", gtmPath)
+	}
+
+	files, err := ioutil.ReadDir(gtmPath)
+	if err != nil {
+		return "", err
+	}
+	for _, f := range files {
+		if !strings.HasSuffix(f.Name(), ".event") &&
+			!strings.HasSuffix(f.Name(), ".metric") {
+			continue
+		}
+		if err := os.Remove(filepath.Join(gtmPath, f.Name())); err != nil {
+			return "", err
+		}
+	}
+
+	return "", nil
+}
+
 // Paths returns the root git repo and gtm paths
 func Paths(wd ...string) (string, string, error) {
 	var (