Move internals into internal directory (#49)

Author: ekalinin

cmd/gh-md-toc/main.go

@@ -1,13 +1,13 @@
 package main
 
 import (
-	"fmt"
 	"io"
 	"os"
 
 	"gopkg.in/alecthomas/kingpin.v2"
 
 	ghtoc "github.com/ekalinin/github-markdown-toc.go"
+	"github.com/ekalinin/github-markdown-toc.go/internal"
 )
 
 var (
@@ -51,10 +51,7 @@ func processPaths() {
 	}
 
 	if !*hideHeader && pathsCount == 1 {
-		fmt.Println()
-		fmt.Println("Table of Contents")
-		fmt.Println("=================")
-		fmt.Println()
+		internal.ShowHeader(os.Stdout)
 	}
 
 	for i := 1; i <= pathsCount; i++ {
@@ -83,7 +80,7 @@ func processSTDIN() {
 
 // Entry point
 func main() {
-	kingpin.Version(ghtoc.Version)
+	kingpin.Version(internal.Version)
 	kingpin.Parse()
 
 	if *token == "" {
@@ -101,6 +98,6 @@ func main() {
 	}
 
 	if !*hideFooter {
-		fmt.Println("Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc.go)")
+		internal.ShowFooter(os.Stdout)
 	}
 }

ghdoc.go

@@ -9,6 +9,8 @@ import (
 	"regexp"
 	"strconv"
 	"strings"
+
+	"github.com/ekalinin/github-markdown-toc.go/internal"
 )
 
 // Print TOC to the console
@@ -59,8 +61,8 @@ func NewGHDoc(Path string, AbsPaths bool, StartDepth int, Depth int, Escape bool
 		Debug:      Debug,
 		html:       "",
 		logger:     log.New(os.Stderr, "", log.LstdFlags),
-		httpGetter: httpGet,
-		httpPoster: httpPost,
+		httpGetter: internal.HttpGet,
+		httpPoster: internal.HttpPost,
 		ghURL:      "https://api.github.com",
 	}
 }
@@ -114,7 +116,7 @@ func (doc *GHDoc) Convert2HTML() error {
 		// if not a plain text - return the result (should be html)
 		if strings.Split(ContentType, ";")[0] != "text/plain" {
 			doc.html = string(htmlBody)
-			doc.d("Convert2HTML: not a plain text, body" + string(htmlBody)[:200])
+			doc.d("Convert2HTML: not a plain text, body")
 			return nil
 		}
 
@@ -163,7 +165,7 @@ func (doc *GHDoc) GrabToc() *GHToc {
 		`href="(?P<href>[^"]+)">\s*` +
 		`(?P<name>.*?)<span`
 	r := regexp.MustCompile(re)
-	listIndentation := generateListIndentation(doc.Indent)
+	listIndentation := internal.GenerateListIndentation(doc.Indent)
 
 	toc := GHToc{}
 	minHeaderNum := 6
@@ -178,7 +180,7 @@ func (doc *GHDoc) GrabToc() *GHToc {
 				continue
 			}
 			doc.d("GrabToc: process group: " + name + ": " + match[i] + " ...")
-			group[name] = removeStuff(match[i])
+			group[name] = internal.RemoveStuff(match[i])
 		}
 		// update minimum header number
 		n, _ := strconv.Atoi(group["num"])
@@ -206,9 +208,9 @@ func (doc *GHDoc) GrabToc() *GHToc {
 			link = doc.Path + link
 		}
 
-		tmpSection = removeStuff(group["name"])
+		tmpSection = internal.RemoveStuff(group["name"])
 		if doc.Escape {
-			tmpSection = EscapeSpecChars(tmpSection)
+			tmpSection = internal.EscapeSpecChars(tmpSection)
 		}
 		tocItem := strings.Repeat(listIndentation(), n-minHeaderNum-doc.StartDepth) + "* " +
 			"[" + tmpSection + "]" +

internals.go renamed to internal/utils.go

@@ -1,20 +1,15 @@
-package ghtoc
+package internal
 
 import (
 	"bytes"
 	"errors"
+	"fmt"
 	"io"
 	"net/http"
 	"os"
 	"strings"
 )
 
-const (
-	// Version is a current app version
-	Version   = "1.3.0"
-	userAgent = "github-markdown-toc.go v" + Version
-)
-
 // doHTTPReq executes a particular http request
 func doHTTPReq(req *http.Request) ([]byte, string, error) {
 	req.Header.Set("User-Agent", userAgent)
@@ -37,17 +32,27 @@ func doHTTPReq(req *http.Request) ([]byte, string, error) {
 	return body, resp.Header.Get("Content-type"), nil
 }
 
-// Executes HTTP GET request
-func httpGet(urlPath string) ([]byte, string, error) {
+// HttpGet executes HTTP GET request.
+func HttpGet(urlPath string) ([]byte, string, error) {
+	req, err := http.NewRequest("GET", urlPath, nil)
+	if err != nil {
+		return []byte{}, "", err
+	}
+	return doHTTPReq(req)
+}
+
+func HttpGetJson(urlPath string) ([]byte, string, error) {
 	req, err := http.NewRequest("GET", urlPath, nil)
+	req.Header.Set("Content-type", "application/json")
+	req.Header.Set("Accept", "application/json")
 	if err != nil {
 		return []byte{}, "", err
 	}
 	return doHTTPReq(req)
 }
 
-// httpPost executes HTTP POST with file content
-func httpPost(urlPath, filePath, token string) (string, error) {
+// HttpPost executes HTTP POST with file content.
+func HttpPost(urlPath, filePath, token string) (string, error) {
 	file, err := os.Open(filePath)
 	if err != nil {
 		return "", err
@@ -74,8 +79,8 @@ func httpPost(urlPath, filePath, token string) (string, error) {
 	return string(resp), err
 }
 
-// removeStuff trims spaces, removes new lines and code tag from a string
-func removeStuff(s string) string {
+// RemoveStuff trims spaces, removes new lines and code tag from a string.
+func RemoveStuff(s string) string {
 	res := strings.Replace(s, "\n", "", -1)
 	res = strings.Replace(res, "<code>", "", -1)
 	res = strings.Replace(res, "</code>", "", -1)
@@ -84,15 +89,13 @@ func removeStuff(s string) string {
 	return res
 }
 
-// generate func of custom spaces indentation
-func generateListIndentation(spaces int) func() string {
+// Generate func of custom spaces indentation.
+func GenerateListIndentation(spaces int) func() string {
 	return func() string {
 		return strings.Repeat(" ", spaces)
 	}
 }
 
-// Public
-
 // EscapeSpecChars Escapes special characters
 func EscapeSpecChars(s string) string {
 	specChar := []string{"\\", "`", "*", "_", "{", "}", "#", "+", "-", ".", "!"}
@@ -103,3 +106,16 @@ func EscapeSpecChars(s string) string {
 	}
 	return res
 }
+
+// ShowHeader shows header befor TOC.
+func ShowHeader(w io.Writer) {
+	fmt.Fprintln(w)
+	fmt.Fprintln(w, "Table of Contents")
+	fmt.Fprintln(w, "=================")
+	fmt.Fprintln(w)
+}
+
+// ShowFooter shows footer after TOC.
+func ShowFooter(w io.Writer) {
+	fmt.Fprintln(w, "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc.go)")
+}

internal_test.go renamed to internal/utils_test.go

@@ -1,4 +1,4 @@
-package ghtoc
+package internal
 
 import (
 	"fmt"
@@ -19,7 +19,7 @@ func TestHttpGet(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	body, _, err := httpGet(srv.URL)
+	body, _, err := HttpGet(srv.URL)
 	got := string(body)
 
 	if err != nil {
@@ -41,7 +41,7 @@ func TestHttpGetForbidden(t *testing.T) {
 	}))
 	defer srv.Close()
 
-	_, _, err := httpGet(srv.URL)
+	_, _, err := HttpGet(srv.URL)
 	if err == nil {
 		t.Error("Should not not be nil")
 	}
@@ -86,7 +86,7 @@ func TestHttpPost(t *testing.T) {
 	}
 	defer os.Remove(fileName)
 
-	_, err = httpPost(srv.URL, fileName, token)
+	_, err = HttpPost(srv.URL, fileName, token)
 	if err != nil {
 		t.Error("Should not be err", err)
 	}

internal/version.go

@@ -0,0 +1,7 @@
+package internal
+
+const (
+	// Version is a current app version
+	Version   = "1.3.0"
+	userAgent = "github-markdown-toc.go v" + Version
+)