fix directoy structure

Author: danielpaulus

Diff for: archiver.go

@@ -0,0 +1,16 @@
+package nskeyedarchiver
+
+/*
+type NSKeyedObject struct {
+	isPrimitive bool
+	primitive   interface{}
+}
+
+Todo:
+func ArchiveXML([]NSKeyedObject) string {
+	return ""
+}
+func ArchiveBin([]NSKeyedObject) []byte {
+	return make([]byte, 0)
+}
+*/

Diff for: archiver_test.go

@@ -0,0 +1,74 @@
+package nskeyedarchiver_test
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"log"
+	"testing"
+
+	archiver "github.com/danielpaulus/nskeyedarchiver"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDecoder(t *testing.T) {
+	testCases := map[string]struct {
+		filename string
+		expected string
+	}{
+		"test one value":       {"onevalue", "[true]"},
+		"test all primitives":  {"primitives", "[1,1,1,1.5,\"YXNkZmFzZGZhZHNmYWRzZg==\",true,\"Hello, World!\",\"Hello, World!\",\"Hello, World!\",false,false,42]"},
+		"test arrays and sets": {"arrays", "[[1,1,1,1.5,\"YXNkZmFzZGZhZHNmYWRzZg==\",true,\"Hello, World!\",\"Hello, World!\",\"Hello, World!\",false,false,42],[true,\"Hello, World!\",42],[true],[42,true,\"Hello, World!\"]]"},
+		"test nested arrays":   {"nestedarrays", "[[[true],[42,true,\"Hello, World!\"]]]"},
+		"test dictionaries":    {"dict", "[{\"array\":[true,\"Hello, World!\",42],\"int\":1,\"string\":\"string\"}]"},
+	}
+
+	for _, tc := range testCases {
+		dat, err := ioutil.ReadFile("fixtures/" + tc.filename + ".xml")
+		if err != nil {
+			log.Fatal(err)
+		}
+		objects, err := archiver.Unarchive(dat)
+		assert.NoError(t, err)
+		assert.Equal(t, tc.expected, convertToJSON(objects))
+
+		dat, err = ioutil.ReadFile("fixtures/" + tc.filename + ".bin")
+		if err != nil {
+			log.Fatal(err)
+		}
+		objects, err = archiver.Unarchive(dat)
+		assert.Equal(t, tc.expected, convertToJSON(objects))
+	}
+}
+
+func TestValidation(t *testing.T) {
+
+	testCases := map[string]struct {
+		filename string
+	}{
+		"$archiver key is missing":         {"missing_archiver"},
+		"$archiver is not nskeyedarchiver": {"wrong_archiver"},
+		"$top key is missing":              {"missing_top"},
+		"$objects key is missing":          {"missing_objects"},
+		"$version key is missing":          {"missing_version"},
+		"$version is wrong":                {"wrong_version"},
+		"plist is invalid":                 {"broken_plist"},
+	}
+
+	for _, tc := range testCases {
+		dat, err := ioutil.ReadFile("fixtures/" + tc.filename + ".xml")
+		if err != nil {
+			log.Fatal(err)
+		}
+		_, err = archiver.Unarchive(dat)
+		assert.Error(t, err)
+	}
+}
+
+func convertToJSON(obj interface{}) string {
+	b, err := json.Marshal(obj)
+	if err != nil {
+		fmt.Println("error:", err)
+	}
+	return string(b)
+}

Diff for: archiverconstants.go

@@ -0,0 +1,26 @@
+package nskeyedarchiver
+
+const (
+	archiverKey     = "$archiver"
+	nsKeyedArchiver = "NSKeyedArchiver"
+	versionKey      = "$version"
+	topKey          = "$top"
+	objectsKey      = "$objects"
+	nsObjects       = "NS.objects"
+	nsKeys          = "NS.keys"
+	class           = "$class"
+	className       = "$classname"
+	versionValue    = 100000
+)
+
+const (
+	nsArray        = "NSArray"
+	nsMutableArray = "NSMutableArray"
+	nsSet          = "NSSet"
+	nsMutableSet   = "NSMutableSet"
+)
+
+const (
+	nsDictionary        = "NSDictionary"
+	nsMutableDictionary = "NSMutableDictionary"
+)

Diff for: archiverutils.go

@@ -0,0 +1,79 @@
+package nskeyedarchiver
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"log"
+
+	plist "howett.net/plist"
+)
+
+//toUidList type asserts a []interface{} to a []plist.UID by iterating through the list.
+func toUidList(list []interface{}) []plist.UID {
+	l := len(list)
+	result := make([]plist.UID, l)
+	for i := 0; i < l; i++ {
+		result[i] = list[i].(plist.UID)
+	}
+	return result
+}
+
+//plistFromBytes decodes a binary or XML based PLIST using the amazing github.com/DHowett/go-plist library and returns an interface{} or propagates the error raised by the library.
+func plistFromBytes(plistBytes []byte) (interface{}, error) {
+	var test interface{}
+	decoder := plist.NewDecoder(bytes.NewReader(plistBytes))
+
+	err := decoder.Decode(&test)
+	if err != nil {
+		return test, err
+	}
+	return test, nil
+}
+
+//ToPlist converts a given struct to a Plist using the
+//github.com/DHowett/go-plist library. Make sure your struct is exported.
+//It returns a string containing the plist.
+func ToPlist(data interface{}) string {
+	buf := &bytes.Buffer{}
+	encoder := plist.NewEncoder(buf)
+	encoder.Encode(data)
+	return buf.String()
+}
+
+//Print an object as JSON for debugging purposes, careful log.Fatals on error
+func printAsJSON(obj interface{}) {
+	b, err := json.MarshalIndent(obj, "", "  ")
+	if err != nil {
+		log.Fatalf("Error while marshalling Json:%s", err)
+	}
+	fmt.Print(string(b))
+}
+
+//verifyCorrectArchiver makes sure the nsKeyedArchived plist has all the right keys and values and returns an error otherwise
+func verifyCorrectArchiver(nsKeyedArchiverData map[string]interface{}) error {
+	if val, ok := nsKeyedArchiverData[archiverKey]; !ok {
+		return fmt.Errorf("Invalid NSKeyedAchiverObject, missing key '%s'", archiverKey)
+	} else {
+		if stringValue := val.(string); stringValue != nsKeyedArchiver {
+			return fmt.Errorf("Invalid value: %s for key '%s', expected: '%s'", stringValue, archiverKey, nsKeyedArchiver)
+		}
+	}
+	if _, ok := nsKeyedArchiverData[topKey]; !ok {
+		return fmt.Errorf("Invalid NSKeyedAchiverObject, missing key '%s'", topKey)
+	}
+
+	if _, ok := nsKeyedArchiverData[objectsKey]; !ok {
+		return fmt.Errorf("Invalid NSKeyedAchiverObject, missing key '%s'", objectsKey)
+	}
+
+	if val, ok := nsKeyedArchiverData[versionKey]; !ok {
+		return fmt.Errorf("Invalid NSKeyedAchiverObject, missing key '%s'", versionKey)
+	} else {
+		if stringValue := val.(uint64); stringValue != versionValue {
+			return fmt.Errorf("Invalid value: %d for key '%s', expected: '%d'", stringValue, versionKey, versionValue)
+		}
+	}
+
+	return nil
+}