fix gometalinter reports (#8)

* update version to 1.2.0

add change log and todo list
fix gometalinter reports

Author: vipally

.travis.yml

@@ -4,8 +4,11 @@ go:
 before_install:
   - go get github.com/mattn/goveralls
   - go get golang.org/x/tools/cmd/cover
+  #- go get github.com/alecthomas/gometalinter
+  #- $HOME/gopath/bin/gometalinter --install --update
   - go get github.com/vipally/binary
 script:
   - go vet
   - go test
   - $HOME/gopath/bin/goveralls -repotoken X9dt3MTIoRZ1nTCVh5ueEJeGrPFDQr23z
+  #- $HOME/gopath/bin/gometalinter ./...

README.md

@@ -1,6 +1,6 @@
 # binary 
 
-[![Build Status](https://travis-ci.org/vipally/binary.svg?branch=master)](https://travis-ci.org/vipally/binary) [![Coverage Status](https://coveralls.io/repos/github/vipally/binary/badge.svg?branch=master)](https://coveralls.io/github/vipally/binary?branch=master) [![GoDoc](https://godoc.org/github.com/vipally/binary?status.svg)](https://godoc.org/github.com/vipally/binary) ![Version](https://img.shields.io/badge/version-1.2.0-green.svg)
+![Version][version-img] [![Build status][travis-img]][travis-url] [![Coverage Status][coverage-img]][coverage-url] [![Go Report Card][report-img]][report-url] [![GoDoc][doc-img]][doc-url] [![License][license-img]][license-url]
 
 ***
 
@@ -17,16 +17,18 @@
 
 ***
 
-CopyRight 2017 @Ally Dale. All rights reserved.
-	
-Author  : [Ally Dale(vipally@gmail.com)](mailto://vipally@gmail.com)
+## Install
 
-Blog    : [http://blog.csdn.net/vipally](http://blog.csdn.net/vipally)
+```bash
+$ go get -u github.com/vipally/binary
+```
+	import(
+		"github.com/vipally/binary"
+	)
 
-Site    : [https://github.com/vipally](https://github.com/vipally)
+***
 
-****
-# change log:
+# Change log:
 ## v1.2.0
 	1.use field tag `binary:"packed"` to encode ints value as varint/uvarint 
 	  for reged structs.
@@ -45,10 +47,23 @@ Site    : [https://github.com/vipally](https://github.com/vipally)
 	6.take both advantages of std.binary and gob.
 	7.recommended using in net protocol serialization and DB serialization.
 
-# TODO:
+# Todo:
 	1.[Encoder/Decoder].RegStruct to speed up local Coder.
 	2.[Encoder/Decoder].RegSerializer to speed up BinarySerializer search.
 	3.reg interface to using BinarySerializer interface.
+
+***
+
+## CopyRight
+
+CopyRight 2017 @Ally Dale. All rights reserved.
+
+Author  : [Ally Dale(vipally@gmail.com)](mailto://vipally@gmail.com)
+
+Blog    : [http://blog.csdn.net/vipally](http://blog.csdn.net/vipally)
+
+Site    : [https://github.com/vipally](https://github.com/vipally)
+
 ****
 
 # 1. Support all serialize-able basic types:
@@ -274,9 +289,22 @@ Site    : [https://github.com/vipally](https://github.com/vipally)
 
 # License.
 	Under MIT license.
-
+	
 	Copyright (c) 2017 Ally Dale<vipally@gmail.com>
 	Author  : Ally Dale<vipally@gmail.com>
 	Site    : https://github.com/vipally
 	Origin  : https://github.com/vipally/binary
 
+[travis-img]: https://travis-ci.org/vipally/binary.svg?branch=master
+[travis-url]: https://travis-ci.org/vipally/binary
+[coverage-img]: https://coveralls.io/repos/github/vipally/binary/badge.svg?branch=master
+[coverage-url]: https://coveralls.io/github/vipally/binary?branch=master
+[license-img]: http://img.shields.io/badge/license-MIT-green.svg?style=flat-square
+[license-url]: http://opensource.org/licenses/MIT
+[doc-img2]: http://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square
+[doc-img]: https://godoc.org/github.com/vipally/binary?status.svg
+[doc-url]: https://godoc.org/github.com/vipally/binary
+[report-img]: https://goreportcard.com/badge/github.com/vipally/binary
+[report-url]: https://goreportcard.com/report/github.com/vipally/binary
+[version-img]: https://img.shields.io/badge/version-1.2.0-green.svg
+

bench_test.go

@@ -168,20 +168,20 @@ func BenchmarkUnackString(b *testing.B) {
 	testBenchDecode(b, &data, &strW, "BenchmarkUnackString")
 }
 
-func newSame(v reflect.Value) (value reflect.Value) {
-	vv := reflect.Indirect(v)
-	t := vv.Type()
-	switch t.Kind() {
-	case reflect.Bool, reflect.Int8, reflect.Uint8, reflect.Int16,
-		reflect.Uint16, reflect.Int32, reflect.Uint32, reflect.Int64,
-		reflect.Uint64, reflect.Float32, reflect.Float64, reflect.Complex64,
-		reflect.Complex128, reflect.String, reflect.Array, reflect.Struct:
-		value = reflect.New(t)
-	case reflect.Slice:
-		value = reflect.MakeSlice(t, 0, 0).Addr() //make a default slice
-	}
-	return
-}
+//func newSame(v reflect.Value) (value reflect.Value) {
+//	vv := reflect.Indirect(v)
+//	t := vv.Type()
+//	switch t.Kind() {
+//	case reflect.Bool, reflect.Int8, reflect.Uint8, reflect.Int16,
+//		reflect.Uint16, reflect.Int32, reflect.Uint32, reflect.Int64,
+//		reflect.Uint64, reflect.Float32, reflect.Float64, reflect.Complex64,
+//		reflect.Complex128, reflect.String, reflect.Array, reflect.Struct:
+//		value = reflect.New(t)
+//	case reflect.Slice:
+//		value = reflect.MakeSlice(t, 0, 0).Addr() //make a default slice
+//	}
+//	return
+//}
 
 func testBenchGobEncode(b *testing.B, data interface{}, caseName string) {
 	buffer.Reset()

binary_test.go

@@ -147,8 +147,10 @@ func TestWriteSlice(t *testing.T) {
 }
 
 func TestReadBool(t *testing.T) {
-	var res bool
-	var err error
+	var (
+		res bool
+		err error
+	)
 	err = Read(bytes.NewReader([]byte{0}), BigEndian, &res)
 	checkResult(t, "ReadBool", BigEndian, err, res, false)
 	res = false
@@ -403,10 +405,10 @@ func testPutUint64SmallSliceLengthPanics() (panicked bool) {
 }
 
 func TestEarlyBoundsChecks(t *testing.T) {
-	if testUint64SmallSliceLengthPanics() != true {
+	if !testUint64SmallSliceLengthPanics() {
 		t.Errorf("binary.LittleEndian.Uint64 expected to panic for small slices, but didn't")
 	}
-	if testPutUint64SmallSliceLengthPanics() != true {
+	if !testPutUint64SmallSliceLengthPanics() {
 		t.Errorf("binary.LittleEndian.PutUint64 expected to panic for small slices, but didn't")
 	}
 }

coder.go

@@ -7,6 +7,7 @@ import (
 )
 
 var (
+	// ErrNotEnoughSpace buffer not enough
 	ErrNotEnoughSpace = errors.New("not enough space")
 )
 
@@ -19,70 +20,76 @@ type coder struct {
 	endian  Endian
 }
 
+func (cder *coder) setEndian(endian Endian) {
+	cder.endian = endian
+}
+
 // Buffer returns the byte slice that has been encoding/decoding.
-func (this *coder) Buffer() []byte {
-	return this.buff[:this.pos]
+func (cder *coder) Buffer() []byte {
+	return cder.buff[:cder.pos]
 }
 
 // Len returns unmber of bytes that has been encoding/decoding.
-func (this *coder) Len() int {
-	return this.pos
+func (cder *coder) Len() int {
+	return cder.pos
 }
 
-// Cap returns number total bytes of this coder buffer.
-func (this *coder) Cap() int {
-	return len(this.buff)
+// Cap returns number total bytes of cder coder buffer.
+func (cder *coder) Cap() int {
+	return len(cder.buff)
 }
 
 // Skip ignore the next size of bytes for encoding/decoding and
 // set skiped bytes to 0.
 // It will panic if space not enough.
 // It will return -1 if size <= 0.
-func (this *coder) Skip(size int) int {
-	newPos := this.pos + size
-	if size >= 0 && newPos <= this.Cap() {
-		for i, b := int(size-1), this.buff[this.pos:newPos]; i >= 0; i-- { //zero skiped bytes
+func (cder *coder) Skip(size int) int {
+	newPos := cder.pos + size
+	if size >= 0 && newPos <= cder.Cap() {
+		for i, b := size-1, cder.buff[cder.pos:newPos]; i >= 0; i-- { //zero skiped bytes
 			b[i] = 0
 		}
-		this.pos = newPos
+		cder.pos = newPos
 		return size
 	}
 	return -1
 }
 
 // Reset move the read/write pointer to the beginning of buffer
 // and set all reseted bytes to 0.
-func (this *coder) Reset() {
-	for i := int(this.pos - 1); i >= 0; i-- { //zero encoded bytes
-		this.buff[i] = 0
+func (cder *coder) Reset() {
+	for i := cder.pos - 1; i >= 0; i-- { //zero encoded bytes
+		cder.buff[i] = 0
 	}
-	this.pos = 0
-	this.resetBoolCoder()
+	cder.pos = 0
+	cder.resetBoolCoder()
 }
 
 // reset the state of bool coder
-func (this *coder) resetBoolCoder() {
-	this.boolPos = -1
-	this.boolBit = 0
+func (cder *coder) resetBoolCoder() {
+	cder.boolPos = -1
+	cder.boolBit = 0
 }
 
 // reserve returns next size bytes for encoding/decoding.
 // it will panic if not enough space.
-func (this *coder) reserve(size int) []byte {
-	newPos := this.pos + size
-	if newPos > this.Cap() {
-		panic(fmt.Errorf("binary.Coder:buffer overflow pos=%d cap=%d require=%d, not enough space!", this.pos, this.Cap(), size))
+func (cder *coder) reserve(size int) []byte {
+	newPos := cder.pos + size
+	if newPos > cder.Cap() {
+		panic(fmt.Errorf("binary.Coder:buffer overflow pos=%d cap=%d require=%d, not enough space", cder.pos, cder.Cap(), size))
 	}
-	if size > 0 && newPos <= this.Cap() {
-		b := this.buff[this.pos:newPos]
-		this.pos = newPos
+	if size > 0 && newPos <= cder.Cap() {
+		b := cder.buff[cder.pos:newPos]
+		cder.pos = newPos
 		return b
 	}
 	return nil
 }
 
+// BytesReader transform bytes as Reader
 type BytesReader []byte
 
+// Read from bytes
 func (p *BytesReader) Read(data []byte) (n int, err error) {
 	n = copy(data, *p)
 	if n == len(*p) {
@@ -92,8 +99,10 @@ func (p *BytesReader) Read(data []byte) (n int, err error) {
 	return
 }
 
+// BytesWriter transform bytes as Writer
 type BytesWriter []byte
 
+// Write to bytes
 func (p *BytesWriter) Write(data []byte) (n int, err error) {
 	n = copy(*p, data)
 	if n < len(data) {

coder_test.go

@@ -361,6 +361,33 @@ func TestEncode(t *testing.T) {
 	//}
 }
 
+func TestEncodeBig(t *testing.T) {
+	v := reflect.ValueOf(full)
+	vt := v.Type()
+	n := v.NumField()
+	check := bigFull
+	for i := 0; i < n; i++ {
+		if !validField(vt.Field(i)) {
+			continue
+		}
+		size := Sizeof(v.Field(i).Interface())
+		encoder := NewEncoderEndian(size, BigEndian)
+		err := encoder.Value(v.Field(i).Interface())
+		b := encoder.Buffer()
+		c := check[:len(b)]
+		check = check[len(b):]
+		if err != nil {
+			t.Error(err)
+		}
+		//fmt.Printf("//field#%d|%s|%#v\n$% x,\n", i+1, vt.Field(i).Name, v.Field(i).Interface(), b)
+		if vt.Field(i).Type.Kind() != reflect.Map && //map keys will be got as unspecified order, byte order may change but it doesn't matter
+			!reflect.DeepEqual(b, c) {
+			//fmt.Printf("%d %s\ngot%#v\n%need#v\n", i, vt.Field(i).Type.String(), b, c)
+			t.Errorf("field %d %s got %+v\nneed %+v\n", i, vt.Field(i).Name, b, c)
+		}
+	}
+}
+
 func TestDecode(t *testing.T) {
 	var v fullStruct
 	err := Decode(littleFullAll, &v)
@@ -819,17 +846,17 @@ func TestDecodeUvarintOverflow(t *testing.T) {
 
 type sizerOnly struct{ A uint8 }
 
-func (this sizerOnly) Size() int { return 1 }
+func (obj sizerOnly) Size() int { return 1 }
 
 type encoderOnly struct{ B uint8 }
 
-func (this encoderOnly) Encode(buffer []byte) ([]byte, error) { return nil, nil }
+func (obj encoderOnly) Encode(buffer []byte) ([]byte, error) { return nil, nil }
 
 type decoderOnly struct {
 	C uint8
 }
 
-func (this *decoderOnly) Decode(buffer []byte) error { return nil }
+func (obj *decoderOnly) Decode(buffer []byte) error { return nil }
 
 type sizeencoderOnly struct {
 	sizerOnly
@@ -852,7 +879,7 @@ type fullSerializerError struct {
 	fullSerializer
 }
 
-func (this *fullSerializerError) Decode(buffer []byte) error {
+func (obj *fullSerializerError) Decode(buffer []byte) error {
 	return fmt.Errorf("expected error")
 }