Move non-API packages to internal

stilvoid · stilvoid · commit 56ae7b8ed5e7 · 2022-11-24T12:32:22.000Z
diff --git a/format/bash.go b/format/bash.go
@@ -1,11 +1,11 @@
-package formatters
+package format
 
 import (
 	"bytes"
 	"fmt"
 	"strings"
 
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 func wrapObj(in string) string {
@@ -25,7 +25,7 @@ func formatBashInternal(in interface{}, buf *bytes.Buffer) {
 
 	switch v := in.(type) {
 	case map[string]interface{}:
-		keys := common.SortedKeys(v)
+		keys := internal.SortedKeys(v)
 
 		buf.WriteByte('(')
 
@@ -51,8 +51,8 @@ func formatBashInternal(in interface{}, buf *bytes.Buffer) {
 }
 
 func formatBash(in interface{}) (string, error) {
-	in = common.ArraysToMaps(in)
-	in = common.ForceStringKeys(in)
+	in = internal.ArraysToMaps(in)
+	in = internal.ForceStringKeys(in)
 
 	var buf bytes.Buffer
 
diff --git a/format/bash_test.go b/format/bash_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/benchmark_test.go b/format/benchmark_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/doc.go b/format/doc.go
@@ -1,4 +1,4 @@
 /*
 Package formatters houses the build-in formatter functions that are registered with please
 */
-package formatters
+package format
diff --git a/format/dot.go b/format/dot.go
@@ -1,22 +1,13 @@
-package formatters
+package format
 
 import (
 	"bytes"
 	"fmt"
-	"regexp"
 	"strings"
 
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
-var escapeRe *regexp.Regexp
-var newlineRe *regexp.Regexp
-
-func init() {
-	escapeRe = regexp.MustCompile(`(\\|\")`)
-	newlineRe = regexp.MustCompile(`\n`)
-}
-
 func wrap(in string) string {
 	out := strings.Replace(in, `\`, `\\`, -1)
 	out = strings.Replace(out, `"`, `\"`, -1)
@@ -86,7 +77,7 @@ func flatten(in interface{}, parent string, name string, buf *bytes.Buffer) {
 }
 
 func formatDot(in interface{}) (string, error) {
-	in = common.ForceStringKeys(in)
+	in = internal.ForceStringKeys(in)
 
 	var buf bytes.Buffer
 
diff --git a/format/dot_test.go b/format/dot_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/formatters.go b/format/formatters.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import (
 	"fmt"
@@ -23,7 +23,7 @@ func init() {
 func Names() []string {
 	names := make([]string, 0, len(formatters))
 
-	for name, _ := range formatters {
+	for name := range formatters {
 		names = append(names, name)
 	}
 
diff --git a/format/json.go b/format/json.go
@@ -1,13 +1,13 @@
-package formatters
+package format
 
 import (
 	"encoding/json"
 
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 func formatJSON(in interface{}) (string, error) {
-	in = common.ForceStringKeys(in)
+	in = internal.ForceStringKeys(in)
 
 	bytes, err := json.MarshalIndent(in, "", "  ")
 
diff --git a/format/json_test.go b/format/json_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/query.go b/format/query.go
@@ -1,10 +1,10 @@
-package formatters
+package format
 
 import (
 	"fmt"
 	"net/url"
 
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 func formatQueryInternal(in interface{}) string {
@@ -37,8 +37,8 @@ func formatQueryInternal(in interface{}) string {
 }
 
 func formatQuery(in interface{}) (string, error) {
-	in = common.ArraysToMaps(in)
-	in = common.ForceStringKeys(in)
+	in = internal.ArraysToMaps(in)
+	in = internal.ForceStringKeys(in)
 
 	return formatQueryInternal(in), nil
 }
diff --git a/format/query_test.go b/format/query_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/test.go b/format/test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 var testCases = []interface{}{
 	123,
diff --git a/format/xml.go b/format/xml.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import (
 	"bytes"
@@ -7,7 +7,7 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 const INDENT = "  "
@@ -132,7 +132,7 @@ func formatXMLInternal(in interface{}, parent string, indent int, buf *bytes.Buf
 }
 
 func formatXML(in interface{}) (string, error) {
-	in = common.ForceStringKeys(in)
+	in = internal.ForceStringKeys(in)
 
 	if _, ok := in.([]interface{}); ok {
 		in = map[string]interface{}{
diff --git a/format/xml_test.go b/format/xml_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/format/yaml.go b/format/yaml.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "gopkg.in/yaml.v2"
 
diff --git a/format/yaml_test.go b/format/yaml_test.go
@@ -1,4 +1,4 @@
-package formatters
+package format
 
 import "testing"
 
diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go
diff --git a/internal/cmd/identify.go b/internal/cmd/identify.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/andrew-d/go-termutil"
 	"github.com/pborman/getopt"
-	"github.com/stilvoid/please/parsers"
+	"github.com/stilvoid/please/parse"
 )
 
 func init() {
@@ -39,7 +39,7 @@ func identifyCommand(args []string) {
 		os.Exit(1)
 	}
 
-	format, _, err := parsers.Identify(input)
+	format, _, err := parse.Identify(input)
 
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
diff --git a/internal/cmd/parse.go b/internal/cmd/parse.go
@@ -8,8 +8,8 @@ import (
 	"github.com/andrew-d/go-termutil"
 	"github.com/jmespath/go-jmespath"
 	"github.com/pborman/getopt"
-	"github.com/stilvoid/please/formatters"
-	"github.com/stilvoid/please/parsers"
+	"github.com/stilvoid/please/format"
+	"github.com/stilvoid/please/parse"
 )
 
 func init() {
@@ -27,12 +27,12 @@ func parseHelp() {
 	fmt.Println()
 	fmt.Println("Available input types:")
 	fmt.Printf("    auto\n")
-	for _, format := range parsers.Names() {
+	for _, format := range parse.Names() {
 		fmt.Printf("    %s\n", format)
 	}
 	fmt.Println()
 	fmt.Println("Available output types:")
-	for _, format := range formatters.Names() {
+	for _, format := range format.Names() {
 		fmt.Printf("    %s\n", format)
 	}
 }
@@ -67,10 +67,10 @@ func parseCommand(args []string) {
 
 	// Deal with format detection
 	if *inFormat == "auto" {
-		*inFormat, parsed, err = parsers.Identify(input)
+		*inFormat, parsed, err = parse.Identify(input)
 	} else {
 		// Try parsing
-		parser, innerErr := parsers.Get(*inFormat)
+		parser, innerErr := parse.Get(*inFormat)
 
 		if innerErr != nil {
 			fmt.Fprintln(os.Stderr, innerErr)
@@ -100,7 +100,7 @@ func parseCommand(args []string) {
 	}
 
 	// ...and format back out :)
-	formatter, err := formatters.Get(*outFormat)
+	formatter, err := format.Get(*outFormat)
 
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
diff --git a/internal/cmd/request.go b/internal/cmd/request.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/andrew-d/go-termutil"
 	"github.com/pborman/getopt"
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 var requestAliases = []string{
@@ -76,14 +76,14 @@ func requestCommand(args []string) {
 		input = os.Stdin
 	}
 
-	resp, err := common.MakeRequest(method, url, input, *headersIncluded)
+	resp, err := internal.MakeRequest(method, url, input, *headersIncluded)
 
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
 
-	err = common.WriteResponse(os.Stdout, resp, *includeHeaders, *includeStatus)
+	err = internal.WriteResponse(os.Stdout, resp, *includeHeaders, *includeStatus)
 
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
diff --git a/internal/cmd/respond.go b/internal/cmd/respond.go
@@ -12,7 +12,7 @@ import (
 
 	"github.com/andrew-d/go-termutil"
 	"github.com/pborman/getopt"
-	"github.com/stilvoid/please/common"
+	"github.com/stilvoid/please/internal"
 )
 
 type responder struct {
@@ -48,7 +48,7 @@ func respondHelp() {
 func (h responder) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	defer h.listener.Close()
 
-	err := common.WriteRequest(os.Stdout, req, h.includeMethod, h.includeUrl, h.includeHeaders)
+	err := internal.WriteRequest(os.Stdout, req, h.includeMethod, h.includeUrl, h.includeHeaders)
 	os.Stdout.Close()
 
 	if err != nil {
diff --git a/internal/http.go b/internal/http.go
@@ -1,5 +1,5 @@
 // Package common provides some utility functions for dealing with HTTP requests and responses
-package common
+package internal
 
 import (
 	"bufio"
diff --git a/internal/map.go b/internal/map.go
@@ -1,4 +1,4 @@
-package common
+package internal
 
 import (
 	"fmt"
diff --git a/internal/map_test.go b/internal/map_test.go
@@ -1,4 +1,4 @@
-package common
+package internal
 
 import (
 	"reflect"
diff --git a/internal/munge.go b/internal/munge.go
@@ -1,4 +1,4 @@
-package common
+package internal
 
 import (
 	"math"
@@ -40,7 +40,7 @@ func munge(left, right reflect.Value, f FilterFunc) reflect.Value {
 			if right.Type().Elem().AssignableTo(left.Type().Elem()) {
 				out = reflect.MakeSlice(left.Type(), max, max)
 			} else {
-				out = reflect.ValueOf(make([]interface{}, max, max))
+				out = reflect.ValueOf(make([]interface{}, max))
 			}
 
 			for i := 0; i < max; i++ {
diff --git a/internal/munge_test.go b/internal/munge_test.go
@@ -1,4 +1,4 @@
-package common
+package internal
 
 import (
 	"reflect"
diff --git a/main.go b/main.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/stilvoid/please/cmd"
+	"github.com/stilvoid/please/internal/cmd"
 )
 
 func printHelp() {
diff --git a/parse/benchmark_test.go b/parse/benchmark_test.go
@@ -1,4 +1,4 @@
-package parsers
+package parse
 
 import "testing"
 
diff --git a/parse/csv.go b/parse/csv.go
@@ -1,4 +1,4 @@
-package parsers
+package parse
 
 import (
 	"bytes"
diff --git a/parse/csv_test.go b/parse/csv_test.go
@@ -1,4 +1,4 @@
-package parsers
+package parse
 
 import (
 	"reflect"
diff --git a/parse/doc.go b/parse/doc.go
@@ -1,4 +1,4 @@
 /*
 Package parsers houses the build-in parser functions that are registered with please
 */
-package parsers
+package parse
diff --git a/parse/html.go b/parse/html.go
@@ -1,4 +1,4 @@
-package parsers
+package parse
 
 import (
 	"bytes"
diff --git a/parse/html_test.go b/parse/html_test.go
diff --git a/parse/identify.go b/parse/identify.go
diff --git a/parse/json.go b/parse/json.go
diff --git a/parse/json_test.go b/parse/json_test.go
diff --git a/parse/mime.go b/parse/mime.go
diff --git a/parse/mime_test.go b/parse/mime_test.go
diff --git a/parse/parsers.go b/parse/parsers.go
diff --git a/parse/query.go b/parse/query.go
diff --git a/parse/query_test.go b/parse/query_test.go
diff --git a/parse/xml.go b/parse/xml.go
diff --git a/parse/xml_test.go b/parse/xml_test.go
diff --git a/parse/yaml.go b/parse/yaml.go
diff --git a/parse/yaml_test.go b/parse/yaml_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package formatters`
	`1`	`+package format`
`2`	`2`
`3`	`3`	`import "testing"`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-package formatters`
	`1`	`+package format`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`
`5`	`5`	`"net/url"`
`6`	`6`
`7`		`- "github.com/stilvoid/please/common"`
	`7`	`+ "github.com/stilvoid/please/internal"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`func formatQueryInternal(in interface{}) string {`
`@@ -37,8 +37,8 @@ func formatQueryInternal(in interface{}) string {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`func formatQuery(in interface{}) (string, error) {`
`40`		`- in = common.ArraysToMaps(in)`
`41`		`- in = common.ForceStringKeys(in)`
	`40`	`+ in = internal.ArraysToMaps(in)`
	`41`	`+ in = internal.ForceStringKeys(in)`
`42`	`42`
`43`	`43`	`return formatQueryInternal(in), nil`
`44`	`44`	`}`