Add readme and license

complete implementation of subcommands

Author: Eric Crosson

cmd/add.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"os"
+	"fmt"
+	"errors"
+	"regexp"
+	"strings"
+	"path/filepath"
+
+	"github.com/urfave/cli"
+	"github.com/codeskyblue/go-sh"
+	"github.com/git-hook/git-ledger"
+)
+
+// Get remote of the first remote listed by `git remote` for project.
+func getRemote(project string) string {
+	session := sh.NewSession()
+	session.SetDir(project)
+	remote, err := session.Command("git", "remote").Command("head", "-n", "1").Output()
+	// pipe makes this code unreachable
+	if err != nil {
+		panic(err)
+	}
+	return strings.TrimSpace(string(remote))
+}
+
+// Get the slug of the first remote listed by `git remote` for project.
+func getSlug(project string) (string, error) {
+	if !ledger.IsGitProject(project) {
+		return "", errors.New(fmt.Sprintf("Cannot add %s: not a git project", project))
+	}
+	session := sh.NewSession()
+	session.SetDir(project)
+	out, err := session.Command("git", "remote", "get-url", getRemote(project)).Output()
+	if err != nil {
+		return "", err
+	}
+	output := strings.TrimSpace(string(out))
+	reg := regexp.MustCompile(`[^/:]*/[^/:]*$`)
+	res := reg.FindStringSubmatch(output)
+	return res[0], nil
+}
+
+// Add specified path to the ledger.
+func add(c *cli.Context) error {
+	project := c.Args().First()
+
+	slug, err := getSlug(project)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		return err
+	}
+	absolutePath, _ := filepath.Abs(project)
+
+	record := ledger.Record{Path: absolutePath, Slug: slug}
+	record.RemoveFromLedger()
+	record.AddToLedger()
+
+	return nil
+}

cmd/find.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"os"
+	"fmt"
+	"path/filepath"
+
+	"github.com/urfave/cli"
+	"github.com/git-hook/git-ledger"
+)
+
+// Find path associated with specified path or slug from the ledger.
+func find(c *cli.Context) error {
+	input := c.Args().First()
+
+	record, err := ledger.GetBySlug(input)
+	if err != nil {
+		absolutePath, _ := filepath.Abs(input)
+		record, err = ledger.GetByPath(absolutePath)
+	}
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		return err
+	}
+	fmt.Println(record.Path)
+
+	return nil
+}

src/cmd/git-ledger/ls.go renamed to cmd/ls.go

@@ -1,23 +1,28 @@
 package main
 
 import (
+	"os"
 	"fmt"
 
 	"github.com/urfave/cli"
-	"github.com/git-hook/git-ledger/src/git-ledger"
+	"github.com/git-hook/git-ledger"
 )
 
+// List all records in the git-ledger.
 func ls(c *cli.Context) error {
 	records, err := ledger.GetRecords()
 	if err != nil {
-		// TODO: stderr time
-		// TODO exit code
-		panic(err)
+		fmt.Fprintf(os.Stderr, "%s", err)
+		return err
 	}
 
 	for _, rec := range records {
 		fmt.Println(fmt.Sprintf("%s: %s", rec.Slug, rec.Path))
 	}
-	// TODO: handle no size, print "none" to stderr? if git does something similar
+
+	// Ledger is empty
+	if len(records) == 0 {
+		fmt.Fprintf(os.Stderr, "Ledger is empty\n")
+	}
 	return nil
 }

src/cmd/git-ledger/main.go renamed to cmd/main.go

@@ -21,13 +21,13 @@ func main () {
 		{
 			Name:   "add",
 			Usage:  "Start tracking an existing repository.",
-			ArgsUsage: "[<path>]",
+			ArgsUsage: "[path]",
 			Action: add,
 		},
 		{
 			Name:   "find",
 			Usage:  "Print the location of a tracked repository.",
-			ArgsUsage: "[<path>]",
+			ArgsUsage: "[path]",
 			Action: find,
 		},
 		{
@@ -38,7 +38,7 @@ func main () {
 		{
 			Name:   "rm",
 			Usage:  "Stop tracking an existing repository.",
-			ArgsUsage: "[<path>]",
+			ArgsUsage: "[path]",
 			Action: rm,
 		},
 	}

cmd/rm.go

@@ -0,0 +1,34 @@
+package main
+
+import (
+	"os"
+	"fmt"
+	"path/filepath"
+
+	"github.com/urfave/cli"
+	"github.com/git-hook/git-ledger"
+)
+
+// Remove specified path or slug from the ledger.
+func rm(c *cli.Context) error {
+	input := c.Args().First()
+
+	// Obtain record by slug or, if DNE, path
+	record, err := ledger.GetBySlug(input)
+	if err != nil {
+		absolutePath, _ := filepath.Abs(input)
+		record, err = ledger.GetByPath(absolutePath)
+	}
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		return err
+	}
+
+	err = record.RemoveFromLedger()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		return err
+	}
+
+	return nil
+}

src/git-ledger/ledger.go renamed to ledger.go

@@ -1,3 +1,5 @@
+// Package ledger provides primitives for operating on the user's
+// git-ledger.
 package ledger
 
 import (
@@ -12,22 +14,34 @@ import (
 	"github.com/BurntSushi/toml"
 )
 
+// Record entry in the git-ledger.
 type Record struct {
 	Path string
 	Slug string
 }
 
-type Records struct {
+// Struct of Records, for toml parsing.
+type records struct {
 	Record []Record
 }
 
+// Get the path of the git-ledger.
 func Path() string {
 	home, _ := pathutil.HomeDir()
 	return path.Join(home, ".git-ledger")
 }
 
+// Return true if dir contains a .git directory.
+func IsGitProject(dir string) bool {
+	stat, err := os.Stat(path.Join(dir, ".git"))
+	isProject := err == nil && stat.IsDir()
+	return isProject
+}
+
+
+// Get a list of records currently in the git-ledger.
 func GetRecords() ([]Record, error) {
-	var ledger Records
+	var ledger records
 
 	b, err := ioutil.ReadFile(Path())
 	if err != nil {
@@ -41,6 +55,7 @@ func GetRecords() ([]Record, error) {
 	return ledger.Record, err
 }
 
+// Look-up a record from the git-ledger by slug.
 func GetBySlug(slug string) (Record, error) {
 	var match Record
 
@@ -56,12 +71,29 @@ func GetBySlug(slug string) (Record, error) {
 	return match, errors.New(fmt.Sprintf("Unknown project: %s", slug))
 }
 
-// fixme: remove duplicated code
+// Look-up a record from the git-ledger by path.
+func GetByPath(path string) (Record, error) {
+	var match Record
+
+	records, err := GetRecords()
+	if err != nil {
+		return match, err
+	}
+	for _, r := range records {
+		if r.Path == path {
+			return r, nil
+		}
+	}
+	return match, errors.New(fmt.Sprintf("Unknown project: %s", path))
+}
+
+// Return the current record as a toml string.
 func (r Record) String() string {
 	return fmt.Sprintf("[[Record]]\npath = \"%s\"\nslug = \"%s\"\n\n", r.Path, r.Slug)
 }
 
-// comparison by Path
+// Remove record from the git-ledger.  Will remove all records
+// matching this records path from the ledger.
 func (r Record) RemoveFromLedger() error {
 	records, err := GetRecords()
 	if err != nil {
@@ -79,6 +111,7 @@ func (r Record) RemoveFromLedger() error {
 	return nil
 }
 
+// Add record to the git-ledger.
 func (r Record) AddToLedger() {
 	f, err := os.OpenFile(Path(), os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0644)
 	if err != nil {

license

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) Eric Crosson <esc@ericcrosson.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme.md

@@ -0,0 +1,42 @@
+# git-ledger
+
+> Track your local git clones
+
+**git-ledger** acts as a simple key-value store, remembering the
+location of git-repositories on local filesystems.
+
+## Install
+
+WIP
+```bash
+go get github.com/git-hook/git-ledger
+cd $GOPATH/src/github.com/git-hook/git-ledger
+go build .
+go get .
+```
+
+## API
+
+### add [path-or-slug]
+
+Start tracking an existing repository.
+
+### find [path-or-slug]
+
+Print the location of a tracked repository.
+
+### ls
+
+Print all tracked repositories.
+
+### rm [path-or-slug]
+
+Stop tracking an existing repository.
+
+## Related
+
+- [grit](https://github.com/jmalloc/grit)
+
+## License
+
+MIT © Eric Crosson