Merge pull request #85 from acuarica/submodule

Submodule

Author: mschenk42

.gitignore

@@ -5,7 +5,8 @@
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*
@@ -72,3 +73,5 @@ Session.vim
 tags
 
 .vimrc
+
+/.idea/

command/record.go

@@ -78,11 +78,12 @@ func (c RecordCmd) Run(args []string) int {
 
 	fileToRecord := ""
 	if terminal {
-		projPath, err := scm.RootPath()
+		projPath, err := scm.GitRepoPath()
 		if err != nil {
 			// if not found, ignore error
 			return 0
 		}
+		projPath, _ = scm.Workdir(projPath)
 		fileToRecord = filepath.Join(projPath, ".gtm", "terminal.app")
 	} else {
 		fileToRecord = cmdFlags.Args()[0]

command/report.go

@@ -136,7 +136,8 @@ func (c ReportCmd) Run(args []string) int {
 			}
 			commits = append(commits, scanner.Text())
 		}
-		curProjPath, err := scm.RootPath()
+		curProjPath, err := scm.GitRepoPath()
+		curProjPath, _ = scm.Workdir(curProjPath)
 		if err != nil {
 			c.Ui.Error(err.Error())
 			return 1
@@ -152,7 +153,8 @@ func (c ReportCmd) Run(args []string) int {
 			}
 			commits = append(commits, a)
 		}
-		curProjPath, err := scm.RootPath()
+		curProjPath, err := scm.GitRepoPath()
+		curProjPath, _ = scm.Workdir(curProjPath)
 		if err != nil {
 			c.Ui.Error(err.Error())
 			return 1

gtmdebug/gtmdebug.go

@@ -0,0 +1,13 @@
+
+package gtmdebug
+
+import (
+	"log"
+	"fmt"
+)
+
+func Debugf(module string, format string, v ...interface{}) {
+	if false {
+		log.Printf(fmt.Sprintf("[%s] ", module)+format, v...)
+	}
+}

main.go

@@ -8,13 +8,15 @@ import (
 	"os"
 
 	"github.com/git-time-metric/gtm/command"
+	"github.com/git-time-metric/gtm/gtmdebug"
 	"github.com/mitchellh/cli"
 )
 
 // Version is the released version set during the release build process
 var Version = "0.0.0"
 
 func main() {
+	gtmdebug.Debugf("main.go", "Starting main %s", Version)
 	ui := &cli.ColoredUi{ErrorColor: cli.UiColorRed, Ui: &cli.BasicUi{Writer: os.Stdout, Reader: os.Stdin}}
 	c := cli.NewCLI("gtm", Version)
 	c.Args = os.Args[1:]

project/project.go

@@ -19,7 +19,8 @@ import (
 
 	"github.com/git-time-metric/gtm/scm"
 	"github.com/git-time-metric/gtm/util"
-	isatty "github.com/mattn/go-isatty"
+	"github.com/git-time-metric/gtm/gtmdebug"
+	"github.com/mattn/go-isatty"
 )
 
 var (
@@ -83,23 +84,31 @@ The following items have been removed.
 // Initialize initializes a git repo for time tracking
 func Initialize(terminal bool, tags []string, clearTags bool) (string, error) {
 	wd, err := os.Getwd()
+	gtmdebug.Debugf("[command/project.go] wd=%s", wd)
+
 	if err != nil {
 		return "", err
 	}
 
-	projRoot, err := scm.RootPath(wd)
+	gitRepoPath, err := scm.GitRepoPath(wd)
+	gtmdebug.Debugf("[command/project.go::Initialize] gitRepoPath=%s", gitRepoPath)
 	if err != nil {
 		return "", fmt.Errorf(
-			"Unable to intialize Git Time Metric, Git repository not found in %s", projRoot)
+			"Unable to intialize Git Time Metric, Git repository not found in '%s'", gitRepoPath)
+	}
+	if _, err := os.Stat(gitRepoPath); os.IsNotExist(err) {
+		return "", fmt.Errorf(
+			"Unable to intialize Git Time Metric, Git repository not found in %s", gitRepoPath)
 	}
 
-	gitPath := filepath.Join(projRoot, ".git")
-	if _, err := os.Stat(gitPath); os.IsNotExist(err) {
+	workDirRoot, err := scm.Workdir(gitRepoPath)
+	gtmdebug.Debugf("[command/project.go::Initialize] workDirRoot=%s", workDirRoot)
+	if _, err := os.Stat(workDirRoot); os.IsNotExist(err) {
 		return "", fmt.Errorf(
-			"Unable to intialize Git Time Metric, Git repository not found in %s", gitPath)
+			"Unable to intialize Git Time Metric, Git working tree root not found in %s", workDirRoot)
 	}
 
-	gtmPath := filepath.Join(projRoot, GTMDir)
+	gtmPath := filepath.Join(workDirRoot, GTMDir)
 	if _, err := os.Stat(gtmPath); os.IsNotExist(err) {
 		if err := os.MkdirAll(gtmPath, 0700); err != nil {
 			return "", err
@@ -130,15 +139,15 @@ func Initialize(terminal bool, tags []string, clearTags bool) (string, error) {
 		os.Remove(filepath.Join(gtmPath, "terminal.app"))
 	}
 
-	if err := scm.SetHooks(GitHooks, projRoot); err != nil {
+	if err := scm.SetHooks(GitHooks, gitRepoPath); err != nil {
 		return "", err
 	}
 
-	if err := scm.ConfigSet(GitConfig, projRoot); err != nil {
+	if err := scm.ConfigSet(GitConfig, gitRepoPath); err != nil {
 		return "", err
 	}
 
-	if err := scm.IgnoreSet(GitIgnore, projRoot); err != nil {
+	if err := scm.IgnoreSet(GitIgnore, workDirRoot); err != nil {
 		return "", err
 	}
 
@@ -161,7 +170,7 @@ func Initialize(terminal bool, tags []string, clearTags bool) (string, error) {
 		}{
 			strings.Join(tags, " "),
 			headerFormat,
-			projRoot,
+			workDirRoot,
 			GitHooks,
 			GitConfig,
 			GitIgnore,
@@ -177,7 +186,7 @@ func Initialize(terminal bool, tags []string, clearTags bool) (string, error) {
 		return "", err
 	}
 
-	index.add(projRoot)
+	index.add(workDirRoot)
 	err = index.save()
 	if err != nil {
 		return "", err
@@ -193,24 +202,25 @@ func Uninitialize() (string, error) {
 		return "", err
 	}
 
-	projRoot, err := scm.RootPath(wd)
+	gitRepoPath, err := scm.GitRepoPath(wd)
 	if err != nil {
 		return "", fmt.Errorf(
-			"Unable to unintialize Git Time Metric, Git repository not found in %s", projRoot)
+			"Unable to unintialize Git Time Metric, Git repository not found in %s", gitRepoPath)
 	}
 
-	gtmPath := filepath.Join(projRoot, GTMDir)
+	workDir, _ := scm.Workdir(gitRepoPath)
+	gtmPath := filepath.Join(workDir, 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 {
+	if err := scm.RemoveHooks(GitHooks, gitRepoPath); err != nil {
 		return "", err
 	}
-	if err := scm.ConfigRemove(GitConfig, projRoot); err != nil {
+	if err := scm.ConfigRemove(GitConfig, gitRepoPath); err != nil {
 		return "", err
 	}
-	if err := scm.IgnoreRemove(GitIgnore, projRoot); err != nil {
+	if err := scm.IgnoreRemove(GitIgnore, workDir); err != nil {
 		return "", err
 	}
 	if err := os.RemoveAll(gtmPath); err != nil {
@@ -232,7 +242,7 @@ func Uninitialize() (string, error) {
 			GitIgnore    string
 		}{
 			headerFormat,
-			projRoot,
+			workDir,
 			GitHooks,
 			GitConfig,
 			GitIgnore})
@@ -246,7 +256,7 @@ func Uninitialize() (string, error) {
 		return "", err
 	}
 
-	index.remove(projRoot)
+	index.remove(workDir)
 	err = index.save()
 	if err != nil {
 		return "", err
@@ -262,11 +272,13 @@ func Clean(dr util.DateRange, terminalOnly bool) error {
 		return err
 	}
 
-	projRoot, err := scm.RootPath(wd)
+	gitRepoPath, err := scm.GitRepoPath(wd)
 	if err != nil {
-		return fmt.Errorf("Unable to clean, Git repository not found in %s", projRoot)
+		return fmt.Errorf("Unable to clean, Git repository not found in %s", gitRepoPath)
 	}
 
+	projRoot, _ := scm.Workdir(gitRepoPath)
+
 	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)
@@ -310,17 +322,18 @@ func Paths(wd ...string) (string, string, error) {
 	util.TimeTrack(time.Now(), "project.Paths")
 
 	var (
-		repoPath string
+		gitRepoPath string
 		err      error
 	)
 	if len(wd) > 0 {
-		repoPath, err = scm.RootPath(wd[0])
+		gitRepoPath, err = scm.GitRepoPath(wd[0])
 	} else {
-		repoPath, err = scm.RootPath()
+		gitRepoPath, err = scm.GitRepoPath()
 	}
 	if err != nil {
 		return "", "", ErrNotInitialized
 	}
+	repoPath, _ := scm.Workdir(gitRepoPath)
 
 	gtmPath := filepath.Join(repoPath, GTMDir)
 	if _, err := os.Stat(gtmPath); os.IsNotExist(err) {

scm/git.go

@@ -17,18 +17,39 @@ import (
 	"time"
 
 	"github.com/git-time-metric/gtm/util"
+	"github.com/git-time-metric/gtm/gtmdebug"
 	"github.com/libgit2/git2go"
 )
 
-// RootPath discovers the base directory for a git repo
-func RootPath(path ...string) (string, error) {
-	defer util.TimeTrack(time.Now(), "scm.RootPath")
+func Workdir(gitRepoPath string) (string, error) {
+	gtmdebug.Debugf("scm/git.go::Workdir", "gitRepoPath=%s", gitRepoPath)
+
+	var err error
+	var repo *git.Repository
+	repo, err = git.OpenRepository(gitRepoPath)
+	if err != nil {
+		return "", err
+	}
+
+	var workDir string
+	workDir = repo.Workdir()
+	gtmdebug.Debugf("[scm/git.go::Workdir] workDir=%s", workDir)
+	if !strings.HasSuffix(workDir, "/") {
+		fmt.Errorf("ASSERT failed: Expecting suffix of work tree to be '/'. workDir=%s", workDir)
+	}
+	workDir = filepath.Dir(workDir)
+
+	return workDir, nil
+}
+
+// GitRepoPath discovers the base directory for a git repo
+func GitRepoPath(path ...string) (string, error) {
+	defer util.TimeTrack(time.Now(), "scm.GitRootPath")
 	var (
 		wd  string
-		p   string
+		gitRepoPath   string
 		err error
 	)
-
 	if len(path) > 0 {
 		wd = path[0]
 	} else {
@@ -37,19 +58,15 @@ func RootPath(path ...string) (string, error) {
 			return "", err
 		}
 	}
-
-	p, err = git.Discover(wd, false, []string{})
+	//TODO: benchmark the call to git.Discover
+	//TODO: optionally print result with -debug flag
+	gitRepoPath, err = git.Discover(wd, false, []string{})
+	gtmdebug.Debugf("[scm/git.go::GitRepoPath] gitRepoPath=%s", gitRepoPath)
 	if err != nil {
 		return "", err
 	}
 
-	x := strings.Index(filepath.ToSlash(p), `/.git/modules/`)
-	if x != -1 {
-		// removing the submodule from path and return git parent
-		p = p[:x]
-	}
-
-	return strings.TrimSuffix(filepath.ToSlash(p), `/.git/`), err
+	return gitRepoPath, nil
 }
 
 // CommitLimiter struct filter commits by criteria
@@ -536,8 +553,6 @@ func ConfigSet(settings map[string]string, wd ...string) error {
 	} else {
 		repo, err = openRepository()
 	}
-	//FIXME: check err
-	//FIXME: defer repo.free()
 
 	cfg, err = repo.Config()
 	defer cfg.Free()
@@ -564,8 +579,6 @@ func ConfigRemove(settings map[string]string, wd ...string) error {
 	} else {
 		repo, err = openRepository()
 	}
-	//FIXME: check err
-	//FIXME: defer repo.free()
 
 	cfg, err = repo.Config()
 	defer cfg.Free()
@@ -625,13 +638,14 @@ func SetHooks(hooks map[string]GitHook, wd ...string) error {
 		if len(wd) > 0 {
 			p = wd[0]
 		} else {
+
 			p, err = os.Getwd()
 			if err != nil {
 				return err
 			}
 		}
-		fp := filepath.Join(p, ".git", "hooks", ghfile)
-		hooksDir := filepath.Join(p, ".git", "hooks")
+		fp := filepath.Join(p, "hooks", ghfile)
+		hooksDir := filepath.Join(p, "hooks")
 
 		var output string
 
@@ -682,12 +696,13 @@ func RemoveHooks(hooks map[string]GitHook, wd ...string) error {
 		if len(wd) > 0 {
 			p = wd[0]
 		} else {
+			return fmt.Errorf("RemoveHooks using getwd not supported")
 			p, err = os.Getwd()
 			if err != nil {
 				return err
 			}
 		}
-		fp := filepath.Join(p, ".git", "hooks", ghfile)
+		fp := filepath.Join(p, "hooks", ghfile)
 
 		if _, err := os.Stat(fp); os.IsNotExist(err) {
 			continue
@@ -803,9 +818,9 @@ func openRepository(wd ...string) (*git.Repository, error) {
 	)
 
 	if len(wd) > 0 {
-		p, err = RootPath(wd[0])
+		p, err = GitRepoPath(wd[0])
 	} else {
-		p, err = RootPath()
+		p, err = GitRepoPath()
 	}
 	if err != nil {
 		return nil, err