Initial commit

Author: Anoop Kunjuraman

Godeps/Godeps.json

@@ -0,0 +1,35 @@
+
+
+# How to build
+
+Enable vendor experiment in Go:
+
+```export GO15VENDOREXPERIMENT=1```
+
+To build:
+
+```go build```
+
+# Adding Dependencies
+
+First get the godep package
+
+```go get github.com/tools/godep```
+
+Use go get as usual to get the dependency. And then from the root project folder, run:
+
+```export GO15VENDOREXPERIMENT=1```
+
+And
+
+```godep save```
+
+# TODO
+- Auto detection of platform
+- Check in common if platform command not found
+- Check /usr/share/ location by default and switch back to ~/.tldr if not found
+- RPM, DEB packages
+- Windows support
+
+- better error handling
+- Proxy support

Godeps/Readme

@@ -0,0 +1,143 @@
+package app
+
+import (
+	"archive/zip"
+	"io"
+	"net/http"
+	"os"
+	"os/user"
+	"path/filepath"
+
+	"github.com/Sirupsen/logrus"
+)
+
+func UpdateCache(config Config) error {
+	LOG.Info("Downloading fresh tldr's from " + config.SourceURL)
+	cacheLocation := getCacheLocation()
+	if err := os.RemoveAll(cacheLocation); err != nil {
+		LOG.Fatal(err)
+	}
+	LOG.Debug("Deleted cache location, if it had existed ")
+	if err := os.MkdirAll(cacheLocation, 0755); err != nil {
+		LOG.Fatal(err)
+	}
+	LOG.Debug("Created cache location")
+
+	zipLocation := filepath.Join(cacheLocation, "master.zip")
+	out, err := os.Create(zipLocation)
+	if err != nil {
+		LOG.Fatal(err)
+	}
+	defer out.Close()
+	resp, err := http.Get(config.SourceURL)
+	if err != nil {
+		LOG.Fatal(err)
+	}
+	defer resp.Body.Close()
+	io.Copy(out, resp.Body)
+	LOG.Debug("Download complete")
+	if err := Unzip(zipLocation, cacheLocation); err != nil {
+		LOG.Fatal(err)
+	}
+	os.Remove(zipLocation)
+	LOG.Debug("Unzip completed")
+	return nil
+}
+
+func LocalCacheAvailable() bool {
+	LOG.Debug("In localCacheAvailable()")
+	path := filepath.Join(getCacheLocation(), "tldr-master", "pages", "index.json")
+
+	LOG.WithFields(logrus.Fields{
+		"index.json.path": path,
+	}).Debug("Printing index.json.path")
+
+	if _, err := os.Stat(path); err == nil {
+		LOG.Debug("Local cache exists. Returning true")
+		return true
+	}
+	LOG.Info("Local cached tldr's doesn't exist. Will have to download now.")
+	return false
+}
+
+func getCacheLocation() string {
+	usr, err := user.Current()
+	if err != nil {
+		LOG.Fatal(err)
+	}
+	LOG.WithFields(logrus.Fields{
+		"usr.HomeDir": usr.HomeDir,
+	}).Debug("Printing usr.HomeDir")
+
+	path := filepath.Join(usr.HomeDir, ".tldr", "cache")
+	return path
+}
+
+func getPageLocation(command, platform string) (string, error) {
+	path := filepath.Join(getCacheLocation(), "tldr-master", "pages", platform, command+".md")
+	if _, err := os.Stat(path); err == nil {
+		LOG.WithFields(logrus.Fields{
+			"path": path,
+		}).Debug("Page available")
+		return path, nil
+	}
+	return "", COMMAND_NOT_FOUND
+}
+
+func Unzip(src, dest string) error {
+	r, err := zip.OpenReader(src)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err := r.Close(); err != nil {
+			panic(err)
+		}
+	}()
+
+	os.MkdirAll(dest, 0755)
+
+	// Closure to address file descriptors issue with all the deferred .Close() methods
+	extractAndWriteFile := func(f *zip.File) error {
+		rc, err := f.Open()
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if err := rc.Close(); err != nil {
+				panic(err)
+			}
+		}()
+
+		path := filepath.Join(dest, f.Name)
+
+		if f.FileInfo().IsDir() {
+			os.MkdirAll(path, f.Mode())
+		} else {
+			f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
+			if err != nil {
+				return err
+			}
+			defer func() {
+				if err := f.Close(); err != nil {
+					panic(err)
+				}
+			}()
+
+			_, err = io.Copy(f, rc)
+			if err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+
+	for _, f := range r.File {
+		err := extractAndWriteFile(f)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

README.md

@@ -0,0 +1,21 @@
+package app
+
+import "github.com/codegangsta/cli"
+
+type Config struct {
+	SourceURL      string
+	Debug          bool
+	NoRender       bool
+	RenderOnTermUI bool
+	UpdateCache    bool
+}
+
+func populateConfig(c *cli.Context) (config Config) {
+	config.Debug = c.Bool("debug")
+	config.SourceURL = c.String("source")
+	config.NoRender = c.Bool("no-render")
+	config.RenderOnTermUI = c.Bool("termui")
+	config.UpdateCache = c.Bool("update-cache")
+
+	return config
+}

app/cache.go

@@ -0,0 +1,6 @@
+package app
+
+import "errors"
+
+var COMMAND_NOT_PROVIDED = errors.New("Command not provided in the command line")
+var COMMAND_NOT_FOUND = errors.New("Command not found in the cache")

app/config.go

@@ -0,0 +1,61 @@
+package app
+
+import (
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+	"strings"
+
+	"github.com/Sirupsen/logrus"
+	"github.com/codegangsta/cli"
+)
+
+func Execute(c *cli.Context) {
+	config := populateConfig(c)
+	InitializeLogging(config)
+	LOG.WithFields(logrus.Fields{
+		"config": config,
+	}).Debug("Printing config")
+	command, err := getCommand()
+	if err != nil {
+		fmt.Errorf("Command name is missing in the input")
+		cli.ShowAppHelp(c)
+		return
+	}
+
+	if config.UpdateCache || !LocalCacheAvailable() {
+		if err := UpdateCache(config); err != nil {
+			log.Fatal(err)
+		}
+	}
+	LOG.WithFields(logrus.Fields{
+		"command": command,
+	}).Debug("Printing command")
+	path, err := getPageLocation(command, "common")
+	LOG.WithFields(logrus.Fields{
+		"path": path,
+	}).Debug("Printing path")
+
+	content, err := ioutil.ReadFile(path)
+	if err != nil {
+		LOG.Fatal(err)
+	}
+
+	if config.NoRender {
+		fmt.Println(string(content))
+	} else {
+		Render(config, content)
+	}
+}
+
+func getCommand() (string, error) {
+	if len(os.Args) < 2 {
+		return "", COMMAND_NOT_PROVIDED
+	}
+	command := os.Args[len(os.Args)-1]
+	if strings.HasPrefix(command, "-") {
+		return "", COMMAND_NOT_PROVIDED
+	}
+	return command, nil
+}

app/errors.go

@@ -0,0 +1,11 @@
+package app
+
+import "github.com/Sirupsen/logrus"
+
+var LOG = logrus.New()
+
+func InitializeLogging(config Config) {
+	if config.Debug {
+		LOG.Level = logrus.DebugLevel
+	}
+}

app/execute.go

@@ -0,0 +1,31 @@
+package app
+
+import (
+	"bytes"
+
+	"github.com/Sirupsen/logrus"
+)
+
+const WIDTH = 80
+
+func Render(config Config, input []byte) error {
+	tldr := NewTLDR(input)
+	LOG.WithFields(logrus.Fields{
+		"tldr": tldr,
+	}).Debug("Printing tldr")
+
+	if config.RenderOnTermUI {
+		return RenderOnTermUI(tldr)
+	} else {
+		return RenderOnTermbox(tldr)
+	}
+}
+
+func getNumberOfLines(input []byte) int {
+	lineSep := []byte{'\n'}
+	count := bytes.Count(input, lineSep)
+	if count == 0 {
+		return 1
+	}
+	return count
+}