Renaming EncodeDecoder to MarshalUnmarshaler

README.md

@@ -8,9 +8,6 @@ Storm is a simple and powerful ORM for [BoltDB](https://github.com/boltdb/bolt).
 
 In addition to the examples below, see also the [examples in the GoDoc](https://godoc.org/github.com/asdine/storm#pkg-examples).
 
-**NEWS**
-*Update: JSON is the new default codec and replaces Gob. To keep using gob use the [`storm.Codec` option](#provided-codecs) below*
-
 ## Getting Started
 
 ```bash
@@ -279,9 +276,9 @@ You can change this behavior by using `BoltOptions`
 db, err := storm.Open("my.db", storm.BoltOptions(0600, &bolt.Options{Timeout: 1 * time.Second}))
 ```
 
-#### EncodeDecoder
+#### MarshalUnmarshaler
 
-To store the data in BoltDB, Storm encodes it in JSON by default. If you wish to change this behavior you can pass a codec that implements [`codec.EncodeDecoder`](https://godoc.org/github.com/asdine/storm/codec#EncodeDecoder) via the [`storm.Codec`](https://godoc.org/github.com/asdine/storm#Codec) option:
+To store the data in BoltDB, Storm marshals it in JSON by default. If you wish to change this behavior you can pass a codec that implements [`codec.MarshalUnmarshaler`](https://godoc.org/github.com/asdine/storm/codec#MarshalUnmarshaler) via the [`storm.Codec`](https://godoc.org/github.com/asdine/storm#Codec) option:
 
 ```go
 db := storm.Open("my.db", storm.Codec(myCodec))
@@ -289,7 +286,7 @@ db := storm.Open("my.db", storm.Codec(myCodec))
 
 ##### Provided Codecs
 
-You can easily implement your own `EncodeDecoder`, but Storm comes with built-in support for [JSON](https://godoc.org/github.com/asdine/storm/codec/json) (default), [GOB](https://godoc.org/github.com/asdine/storm/codec/gob),  [Sereal](https://godoc.org/github.com/asdine/storm/codec/sereal) and [Protocol Buffers](https://godoc.org/github.com/asdine/storm/codec/protobuf)
+You can easily implement your own `MarshalUnmarshaler`, but Storm comes with built-in support for [JSON](https://godoc.org/github.com/asdine/storm/codec/json) (default), [GOB](https://godoc.org/github.com/asdine/storm/codec/gob),  [Sereal](https://godoc.org/github.com/asdine/storm/codec/sereal) and [Protocol Buffers](https://godoc.org/github.com/asdine/storm/codec/protobuf)
 
 These can be used by importing the relevant package and use that codec to configure Storm. The example below shows all three (without proper error handling):
 

all.go

@@ -79,7 +79,7 @@ func (n *node) allByIndex(tx *bolt.Tx, fieldName string, info *modelInfo, ref *r
 			return ErrNotFound
 		}
 
-		err = n.s.codec.Decode(raw, results.Index(i).Addr().Interface())
+		err = n.s.codec.Unmarshal(raw, results.Index(i).Addr().Interface())
 		if err != nil {
 			return err
 		}

codec/codec.go

@@ -2,8 +2,8 @@
 // to encode and decode entities in Storm.
 package codec
 
-// EncodeDecoder represents a codec used to encode and decode entities.
-type EncodeDecoder interface {
-	Encode(v interface{}) ([]byte, error)
-	Decode(b []byte, v interface{}) error
+// MarshalUnmarshaler represents a codec used to marshal and unmarshal entities.
+type MarshalUnmarshaler interface {
+	Marshal(v interface{}) ([]byte, error)
+	Unmarshal(b []byte, v interface{}) error
 }

codec/gob/gob.go

@@ -12,7 +12,7 @@ var Codec = new(gobCodec)
 
 type gobCodec int
 
-func (c gobCodec) Encode(v interface{}) ([]byte, error) {
+func (c gobCodec) Marshal(v interface{}) ([]byte, error) {
 	var b bytes.Buffer
 	enc := gob.NewEncoder(&b)
 	err := enc.Encode(v)
@@ -22,7 +22,7 @@ func (c gobCodec) Encode(v interface{}) ([]byte, error) {
 	return b.Bytes(), nil
 }
 
-func (c gobCodec) Decode(b []byte, v interface{}) error {
+func (c gobCodec) Unmarshal(b []byte, v interface{}) error {
 	r := bytes.NewReader(b)
 	dec := gob.NewDecoder(r)
 	return dec.Decode(v)

codec/internal/test_helpers.go

@@ -12,8 +12,8 @@ type testStruct struct {
 	Name string
 }
 
-// RoundtripTester is a test helper to test a EncodeDecoder
-func RoundtripTester(t *testing.T, c codec.EncodeDecoder, vals ...interface{}) {
+// RoundtripTester is a test helper to test a MarshalUnmarshaler
+func RoundtripTester(t *testing.T, c codec.MarshalUnmarshaler, vals ...interface{}) {
 	var val, to interface{}
 	if len(vals) > 0 {
 		if len(vals) != 2 {
@@ -26,11 +26,11 @@ func RoundtripTester(t *testing.T, c codec.EncodeDecoder, vals ...interface{}) {
 		to = &testStruct{}
 	}
 
-	encoded, err := c.Encode(val)
+	encoded, err := c.Marshal(val)
 	if err != nil {
 		t.Fatal("Encode error:", err)
 	}
-	err = c.Decode(encoded, to)
+	err = c.Unmarshal(encoded, to)
 	if err != nil {
 		t.Fatal("Decode error:", err)
 	}

codec/json/json.go

@@ -10,10 +10,10 @@ var Codec = new(jsonCodec)
 
 type jsonCodec int
 
-func (j jsonCodec) Encode(v interface{}) ([]byte, error) {
+func (j jsonCodec) Marshal(v interface{}) ([]byte, error) {
 	return json.Marshal(v)
 }
 
-func (j jsonCodec) Decode(b []byte, v interface{}) error {
+func (j jsonCodec) Unmarshal(b []byte, v interface{}) error {
 	return json.Unmarshal(b, v)
 }

codec/protobuf/protobuf.go

@@ -18,20 +18,20 @@ type protobufCodec int
 
 // Encode value with protocol buffer.
 // If type isn't a Protocol buffer Message, gob encoder will be used instead.
-func (c protobufCodec) Encode(v interface{}) ([]byte, error) {
+func (c protobufCodec) Marshal(v interface{}) ([]byte, error) {
 	message, ok := v.(proto.Message)
 	if !ok {
 		// toBytes() may need to encode non-protobuf type, if that occurs use json
-		return json.Codec.Encode(v)
+		return json.Codec.Marshal(v)
 	}
 	return proto.Marshal(message)
 }
 
-func (c protobufCodec) Decode(b []byte, v interface{}) error {
+func (c protobufCodec) Unmarshal(b []byte, v interface{}) error {
 	message, ok := v.(proto.Message)
 	if !ok {
 		// toBytes() may have encoded non-protobuf type, if that occurs use json
-		return json.Codec.Decode(b, v)
+		return json.Codec.Unmarshal(b, v)
 	}
 	return proto.Unmarshal(b, message)
 }

codec/sereal/sereal.go

@@ -12,10 +12,10 @@ var Codec = new(serealCodec)
 
 type serealCodec int
 
-func (c serealCodec) Encode(v interface{}) ([]byte, error) {
+func (c serealCodec) Marshal(v interface{}) ([]byte, error) {
 	return sereal.Marshal(v)
 }
 
-func (c serealCodec) Decode(b []byte, v interface{}) error {
+func (c serealCodec) Unmarshal(b []byte, v interface{}) error {
 	return sereal.Unmarshal(b, v)
 }

index/unique_test.go

@@ -132,38 +132,38 @@ func TestUniqueIndexRange(t *testing.T) {
 		assert.NoError(t, err)
 
 		for i := 0; i < 10; i++ {
-			val, _ := gob.Codec.Encode(i)
+			val, _ := gob.Codec.Marshal(i)
 			err = idx.Add(val, val)
 			assert.NoError(t, err)
 		}
 
-		min, _ := gob.Codec.Encode(3)
-		max, _ := gob.Codec.Encode(5)
+		min, _ := gob.Codec.Marshal(3)
+		max, _ := gob.Codec.Marshal(5)
 		list, err := idx.Range(min, max, nil)
 		assert.Len(t, list, 3)
 		assert.NoError(t, err)
 		assertEncodedIntListEqual(t, []int{3, 4, 5}, list)
 
-		min, _ = gob.Codec.Encode(11)
-		max, _ = gob.Codec.Encode(20)
+		min, _ = gob.Codec.Marshal(11)
+		max, _ = gob.Codec.Marshal(20)
 		list, err = idx.Range(min, max, nil)
 		assert.Len(t, list, 0)
 		assert.NoError(t, err)
 
-		min, _ = gob.Codec.Encode(7)
-		max, _ = gob.Codec.Encode(2)
+		min, _ = gob.Codec.Marshal(7)
+		max, _ = gob.Codec.Marshal(2)
 		list, err = idx.Range(min, max, nil)
 		assert.Len(t, list, 0)
 		assert.NoError(t, err)
 
-		min, _ = gob.Codec.Encode(-5)
-		max, _ = gob.Codec.Encode(2)
+		min, _ = gob.Codec.Marshal(-5)
+		max, _ = gob.Codec.Marshal(2)
 		list, err = idx.Range(min, max, nil)
 		assert.Len(t, list, 0)
 		assert.NoError(t, err)
 
-		min, _ = gob.Codec.Encode(3)
-		max, _ = gob.Codec.Encode(7)
+		min, _ = gob.Codec.Marshal(3)
+		max, _ = gob.Codec.Marshal(7)
 		opts := index.NewOptions()
 		opts.Skip = 2
 		list, err = idx.Range(min, max, opts)
@@ -194,7 +194,7 @@ func assertEncodedIntListEqual(t *testing.T, expected []int, actual [][]byte) {
 	ints := make([]int, len(actual))
 
 	for i, e := range actual {
-		err := gob.Codec.Decode(e, &ints[i])
+		err := gob.Codec.Unmarshal(e, &ints[i])
 		assert.NoError(t, err)
 	}
 

kv.go

@@ -45,7 +45,7 @@ func (n *node) get(tx *bolt.Tx, bucketName string, id []byte, to interface{}) er
 		return ErrNotFound
 	}
 
-	return n.s.codec.Decode(raw, to)
+	return n.s.codec.Unmarshal(raw, to)
 }
 
 // Set a key/value pair into a bucket
@@ -61,7 +61,7 @@ func (n *node) Set(bucketName string, key interface{}, value interface{}) error
 
 	var data []byte
 	if value != nil {
-		data, err = n.s.codec.Encode(value)
+		data, err = n.s.codec.Marshal(value)
 		if err != nil {
 			return err
 		}

node.go

@@ -32,11 +32,11 @@ type Node interface {
 	// Begin starts a new transaction.
 	Begin(writable bool) (Node, error)
 
-	// Codec returns the EncodeDecoder used by this instance of Storm
-	Codec() codec.EncodeDecoder
+	// Codec used by this instance of Storm
+	Codec() codec.MarshalUnmarshaler
 
 	// WithCodec returns a New Storm Node that will use the given Codec.
-	WithCodec(codec codec.EncodeDecoder) Node
+	WithCodec(codec codec.MarshalUnmarshaler) Node
 
 	// WithBatch returns a new Storm Node with the batch mode enabled.
 	WithBatch(enabled bool) Node
@@ -53,7 +53,7 @@ type node struct {
 	tx *bolt.Tx
 
 	// Codec of this node
-	codec codec.EncodeDecoder
+	codec codec.MarshalUnmarshaler
 
 	// Enable batch mode for read-write transaction, instead of update mode
 	batchMode bool
@@ -73,7 +73,7 @@ func (n node) WithTransaction(tx *bolt.Tx) Node {
 }
 
 // WithCodec returns a new Storm Node that will use the given Codec.
-func (n node) WithCodec(codec codec.EncodeDecoder) Node {
+func (n node) WithCodec(codec codec.MarshalUnmarshaler) Node {
 	n.codec = codec
 	return &n
 }
@@ -91,7 +91,7 @@ func (n *node) Bucket() []string {
 }
 
 // Codec returns the EncodeDecoder used by this instance of Storm
-func (n *node) Codec() codec.EncodeDecoder {
+func (n *node) Codec() codec.MarshalUnmarshaler {
 	return n.codec
 }
 

one.go

@@ -91,7 +91,7 @@ func (n *node) one(tx *bolt.Tx, bucketName, fieldName, tag string, to interface{
 		return ErrNotFound
 	}
 
-	return n.s.codec.Decode(raw, to)
+	return n.s.codec.Unmarshal(raw, to)
 }
 
 // One returns one record by the specified index

options.go

@@ -18,7 +18,7 @@ func BoltOptions(mode os.FileMode, options *bolt.Options) func(*DB) error {
 }
 
 // Codec used to set a custom encoder and decoder. The default is JSON.
-func Codec(c codec.EncodeDecoder) func(*DB) error {
+func Codec(c codec.MarshalUnmarshaler) func(*DB) error {
 	return func(d *DB) error {
 		d.codec = c
 		return nil

save.go

@@ -37,7 +37,7 @@ func (n *node) Save(data interface{}) error {
 	var raw []byte
 	// postpone encoding if AutoIncrement mode if enabled
 	if !n.s.autoIncrement {
-		raw, err = n.s.codec.Encode(data)
+		raw, err = n.s.codec.Marshal(data)
 		if err != nil {
 			return err
 		}
@@ -68,7 +68,7 @@ func (n *node) save(tx *bolt.Tx, info *modelInfo, id []byte, raw []byte, data in
 
 	if data != nil {
 		if n.s.autoIncrement {
-			raw, err = n.s.codec.Encode(data)
+			raw, err = n.s.codec.Marshal(data)
 			if err != nil {
 				return err
 			}

save_test.go

@@ -59,7 +59,7 @@ func TestSave(t *testing.T) {
 		val := bucket.Get(i)
 		assert.NotNil(t, val)
 
-		content, err := db.codec.Encode(&v)
+		content, err := db.codec.Marshal(&v)
 		assert.NoError(t, err)
 		assert.Equal(t, content, val)
 		return nil

sink.go

@@ -21,7 +21,7 @@ type reflectSink interface {
 
 func filter(s reflectSink, node Node, tree q.Matcher, bucket *bolt.Bucket, k, v []byte) (bool, error) {
 	newElem := s.elem()
-	err := node.Codec().Decode(v, newElem.Interface())
+	err := node.Codec().Unmarshal(v, newElem.Interface())
 	if err != nil {
 		return false, err
 	}

storm.go

@@ -64,7 +64,7 @@ type DB struct {
 	Path string
 
 	// Handles encoding and decoding of objects
-	codec codec.EncodeDecoder
+	codec codec.MarshalUnmarshaler
 
 	// Bolt is still easily accessible
 	Bolt *bolt.DB
@@ -114,12 +114,12 @@ func (s *DB) Close() error {
 }
 
 // Codec returns the EncodeDecoder used by this instance of Storm
-func (s *DB) Codec() codec.EncodeDecoder {
+func (s *DB) Codec() codec.MarshalUnmarshaler {
 	return s.codec
 }
 
 // WithCodec returns a New Storm Node that will use the given Codec.
-func (s *DB) WithCodec(codec codec.EncodeDecoder) Node {
+func (s *DB) WithCodec(codec codec.MarshalUnmarshaler) Node {
 	n := s.From().(*node)
 	n.codec = codec
 	return n
@@ -148,7 +148,7 @@ func (s *DB) checkVersion() error {
 }
 
 // toBytes turns an interface into a slice of bytes
-func toBytes(key interface{}, encoder codec.EncodeDecoder) ([]byte, error) {
+func toBytes(key interface{}, codec codec.MarshalUnmarshaler) ([]byte, error) {
 	if key == nil {
 		return nil, nil
 	}
@@ -159,5 +159,5 @@ func toBytes(key interface{}, encoder codec.EncodeDecoder) ([]byte, error) {
 		return []byte(k), nil
 	}
 
-	return encoder.Encode(key)
+	return codec.Marshal(key)
 }

storm_test.go

@@ -96,20 +96,20 @@ func TestBoltDB(t *testing.T) {
 
 type dummyCodec int
 
-func (c dummyCodec) Encode(v interface{}) ([]byte, error) {
+func (c dummyCodec) Marshal(v interface{}) ([]byte, error) {
 	return []byte("dummy"), nil
 }
 
-func (c dummyCodec) Decode(b []byte, v interface{}) error {
+func (c dummyCodec) Unmarshal(b []byte, v interface{}) error {
 	return nil
 }
 
 func TestCodec(t *testing.T) {
 	u1 := &SimpleUser{Name: "John"}
-	encoded, err := defaultCodec.Encode(u1)
+	encoded, err := defaultCodec.Marshal(u1)
 	assert.Nil(t, err)
 	u2 := &SimpleUser{}
-	err = defaultCodec.Decode(encoded, u2)
+	err = defaultCodec.Unmarshal(encoded, u2)
 	assert.Nil(t, err)
 	if !reflect.DeepEqual(u1, u2) {
 		t.Fatal("Codec mismatch")

update.go

@@ -93,7 +93,7 @@ func (n *node) update(data interface{}, fn func(*reflect.Value, *reflect.Value,
 		return err
 	}
 
-	raw, err := ntx.s.codec.Encode(current.Interface())
+	raw, err := ntx.s.codec.Marshal(current.Interface())
 	if err != nil {
 		return err
 	}