Shifted packages around for nicer method call signature

Author: thomshutt

README.md

@@ -34,7 +34,7 @@ import (
 	"io/ioutil"
 	"log"
 
-	"github.com/zencoder/go-smile/decode"
+	"github.com/zencoder/go-smile/smile"
 )
 
 func main() {
@@ -45,7 +45,7 @@ func main() {
 		log.Fatal("Error reading Smile file:", smileFile)
 	}
 
-	j, err := decode.DecodeToJSON(b)
+	j, err := smile.DecodeToJSON(b)
 	if err != nil {
 		log.Fatal("Error decoding Smile file:", smileFile)
 	}
@@ -61,5 +61,5 @@ $ go run main.go
 
 The following convenience method is also provided for decoding to a Go representation of the JSON:
 ```go
-obj, err := decode.DecodeToObject(b)
+obj, err := smile.DecodeToObject(b)
 ```

decode/decoder.go

@@ -1,42 +1,14 @@
 package decode
 
 import (
-	"encoding/json"
 	"fmt"
-
-	"github.com/zencoder/go-smile/domain"
 )
 
-func DecodeToJSON(smile []byte) (string, error) {
-	obj, err := DecodeToObject(smile)
-	if err != nil {
-		return "", err
-	}
-
-	jsonBytes, err := json.Marshal(obj)
-	if err != nil {
-		return "", err
-	}
-
-	return string(jsonBytes), nil
-}
-
-func DecodeToObject(smile []byte) (interface{}, error) {
-	header, err := domain.DecodeHeader(smile)
-	if err != nil {
-		return "", err
-	}
-
-	var d decoder
-	_, b, err := d.decodeBytes(smile[header.SizeBytes:])
-	return b, err
-}
-
-type decoder struct {
+type Decoder struct {
 	sharedState SharedState
 }
 
-func (d *decoder) decodeBytes(smileBytes []byte) ([]byte, interface{}, error) {
+func (d *Decoder) DecodeBytes(smileBytes []byte) ([]byte, interface{}, error) {
 	var token = smileBytes[0]
 	var tokenClass = token >> 5
 	switch tokenClass {
@@ -86,7 +58,7 @@ func (d *decoder) decodeBytes(smileBytes []byte) ([]byte, interface{}, error) {
 	return []byte{}, "", fmt.Errorf("unrecognised token: %X (Token Class %d)", token, tokenClass)
 }
 
-func (d *decoder) parseBinaryLongTextStructureValues(smileBytes []byte) ([]byte, interface{}, error) {
+func (d *Decoder) parseBinaryLongTextStructureValues(smileBytes []byte) ([]byte, interface{}, error) {
 	nextByte := smileBytes[0]
 	switch nextByte {
 	case START_OBJECT:
@@ -105,7 +77,7 @@ func (d *decoder) parseBinaryLongTextStructureValues(smileBytes []byte) ([]byte,
 				return smileBytes, object, err
 			}
 
-			smileBytes, value, err = d.decodeBytes(smileBytes)
+			smileBytes, value, err = d.DecodeBytes(smileBytes)
 			if err != nil {
 				return smileBytes, object, err
 			}
@@ -121,7 +93,7 @@ func (d *decoder) parseBinaryLongTextStructureValues(smileBytes []byte) ([]byte,
 		for smileBytes[0] != END_ARRAY {
 			var obj interface{}
 			var err error
-			smileBytes, obj, err = d.decodeBytes(smileBytes)
+			smileBytes, obj, err = d.DecodeBytes(smileBytes)
 			if err != nil {
 				return smileBytes, obj, err
 			}

decode/key.go

@@ -32,7 +32,7 @@ Byte ranges are divides in 4 main sections (64 byte values each):
     0xFC - 0xFF: reserved for framing, not used in key mode (used in value mode)
 
 */
-func (d *decoder) parseKey(smileBytes []byte) ([]byte, interface{}, error) {
+func (d *Decoder) parseKey(smileBytes []byte) ([]byte, interface{}, error) {
 	nextByte := smileBytes[0]
 
 	if nextByte == EMPTY_STRING {
@@ -71,13 +71,13 @@ func readShortUTF8Key(smileBytes []byte) ([]byte, interface{}, error) {
 	return smileBytes[length:], string(smileBytes[:length]), nil
 }
 
-func (d *decoder) readLongSharedKey(smileBytes []byte) ([]byte, interface{}, error) {
+func (d *Decoder) readLongSharedKey(smileBytes []byte) ([]byte, interface{}, error) {
 	var ref = (int(smileBytes[0]&0x03) << 8) | int(smileBytes[1])
 	key, err := d.sharedState.GetSharedKey(ref)
 	return smileBytes[2:], key, err
 }
 
-func (d *decoder) readShortSharedKey(smileBytes []byte) ([]byte, interface{}, error) {
+func (d *Decoder) readShortSharedKey(smileBytes []byte) ([]byte, interface{}, error) {
 	var ref = int(smileBytes[0] & 0x3f)
 	key, err := d.sharedState.GetSharedKey(ref)
 	return smileBytes[1:], key, err

smile/smile.go

@@ -0,0 +1,33 @@
+package smile
+
+import (
+	"encoding/json"
+
+	"github.com/zencoder/go-smile/decode"
+	"github.com/zencoder/go-smile/domain"
+)
+
+func DecodeToJSON(smile []byte) (string, error) {
+	obj, err := DecodeToObject(smile)
+	if err != nil {
+		return "", err
+	}
+
+	jsonBytes, err := json.Marshal(obj)
+	if err != nil {
+		return "", err
+	}
+
+	return string(jsonBytes), nil
+}
+
+func DecodeToObject(smile []byte) (interface{}, error) {
+	header, err := domain.DecodeHeader(smile)
+	if err != nil {
+		return "", err
+	}
+
+	var d decode.Decoder
+	_, b, err := d.DecodeBytes(smile[header.SizeBytes:])
+	return b, err
+}

test/decode_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"github.com/zencoder/go-smile/decode"
+	"github.com/zencoder/go-smile/smile"
 	"github.com/zencoder/go-smile/test/testdata"
 )
 
@@ -19,7 +19,7 @@ func TestDecode(t *testing.T) {
 			jsonFile := testdata.LoadTestFile(t, f+".json")
 			smileFile := testdata.LoadTestFile(t, f+".smile")
 
-			actualJSON, err := decode.DecodeToJSON(smileFile)
+			actualJSON, err := smile.DecodeToJSON(smileFile)
 			require.NoError(t, err, "Error while decoding %q", f)
 
 			require.JSONEq(t, string(jsonFile), actualJSON, "Decoding %q didn't produce the expected result", f)