Add unsafe (#4)

- Add unsafe package with BytesToString and StringToBytes functions
- Fix lint error on LimitReader error, had to bump to v6 because of this.
- updated to use GitHub Action for CI

Author: Dean Karn

.github/workflows/go.yml

@@ -0,0 +1,35 @@
+name: Lint & Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.14.x,1.13.x]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v1
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Priming Cache
+        uses: actions/cache@v1
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-v1-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-v1-go-
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Lint
+        if: matrix.platform == 'ubuntu-latest' && matrix.go-version == '1.14.x'
+        run: |
+          export PATH=$PATH:$(go env GOPATH)/bin # temporary fix. See https://github.com/actions/setup-go/issues/14
+          go get -u golang.org/x/lint/golint
+          golint -set_exit_status ./...
+
+      - name: Test
+        run: go test ./...

.travis.yml

@@ -1,14 +1,5 @@
 GOCMD=GO111MODULE=on go
 
-linters-install:
-	@golangci-lint --version >/dev/null 2>&1 || { \
-		echo "installing linting tools..."; \
-		$(GOCMD) get github.com/golangci/golangci-lint/cmd/golangci-lint; \
-	}
-
-lint: linters-install
-	golangci-lint run
-
 test:
 	$(GOCMD) test -cover -race ./...
 

Makefile

@@ -1,15 +1,15 @@
 # pkg
-![Project status](https://img.shields.io/badge/version-4.0.0-green.svg)
+![Project status](https://img.shields.io/badge/version-5.0.0-green.svg)
 [![Build Status](https://travis-ci.org/go-playground/pkg.svg?branch=master)](https://travis-ci.org/go-playground/pkg)
 [![Coverage Status](https://coveralls.io/repos/github/go-playground/pkg/badge.svg?branch=master)](https://coveralls.io/github/go-playground/pkg?branch=master)
-[![GoDoc](https://godoc.org/github.com/go-playground/pkg?status.svg)](https://godoc.org/github.com/go-playground/pkg)
+[![GoDoc](https://godoc.org/github.com/go-playground/pkg?status.svg)](https://pkg.go.dev/mod/github.com/go-playground/pkg/v5)
 ![License](https://img.shields.io/dub/l/vibe-d.svg)
 
-pkg extends the core go packages with missing or additional functionality built in. All packages correspond to the std go package name with an additional suffix of `ext` to avoid naming conflicts.
+pkg extends the core Go packages with missing or additional functionality built in. All packages correspond to the std go package name with an additional suffix of `ext` to avoid naming conflicts.
 
 Motivation
 ----------
-This is a place to put comman reusable code that is not quite a library but extends upon the core library or it's failings.
+This is a place to put common reusable code that is not quite a library but extends upon the core library, or it's failings.
 
 How to Contribute
 ------

README.md

@@ -1,8 +1,9 @@
-module github.com/go-playground/pkg/v4
+module github.com/go-playground/pkg/v5
 
 require (
+	github.com/go-playground/assert v1.2.1 // indirect
 	github.com/go-playground/assert/v2 v2.0.1
-	github.com/go-playground/form/v4 v4.0.0
+	github.com/go-playground/form/v4 v4.1.1
 )
 
-go 1.13
+go 1.14

go.mod

@@ -4,3 +4,5 @@ github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBY
 github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
 github.com/go-playground/form/v4 v4.0.0 h1:vUKi2K1Hqlc4rpBc0tCclgs9zSfbY5yMKsL106db/eY=
 github.com/go-playground/form/v4 v4.0.0/go.mod h1:bodWfd97U9PVMZFcDsbVzSbQQTtaWrebnTwQtWjSW1M=
+github.com/go-playground/form/v4 v4.1.1 h1:1T9lGt3WRHuDwT5uwx7RYQZfxVwWZhF0DC1ovKyNnWY=
+github.com/go-playground/form/v4 v4.1.1/go.mod h1:q1a2BY+AQUUzhl6xA/6hBetay6dEIhMHjgvJiGo6K7U=

go.sum

@@ -6,21 +6,21 @@ import (
 )
 
 var (
-	// LimitedReaderEOF is an error returned by LimitedReader to give feedback to the fact that we did not hit an
+	// ErrLimitedReaderEOF is an error returned by LimitedReader to give feedback to the fact that we did not hit an
 	// EOF of the Reader but hit the limit imposed by the LimitedReader.
-	LimitedReaderEOF = errors.New("LimitedReader EOF: limit reached")
+	ErrLimitedReaderEOF = errors.New("LimitedReader EOF: limit reached")
 )
 
 // LimitReader returns a LimitedReader that reads from r
-// but stops with LimitedReaderEOF after n bytes.
+// but stops with ErrLimitedReaderEOF after n bytes.
 func LimitReader(r io.Reader, n int64) *LimitedReader {
 	return &LimitedReader{R: r, N: n}
 }
 
 // A LimitedReader reads from R but limits the amount of
 // data returned to just N bytes. Each call to Read
 // updates N to reflect the new amount remaining.
-// Read returns LimitedReaderEOF when N <= 0 or when the underlying R returns EOF.
+// Read returns ErrLimitedReaderEOF when N <= 0 or when the underlying R returns EOF.
 // Unlike the std io.LimitedReader this provides feedback
 // that the limit was reached through the returned error.
 type LimitedReader struct {
@@ -38,7 +38,7 @@ func (l *LimitedReader) Read(p []byte) (n int, err error) {
 		return
 	}
 	if l.N < 0 {
-		return n, LimitedReaderEOF
+		return n, ErrLimitedReaderEOF
 	}
 	return
 }

io/limit_reader.go

@@ -11,12 +11,13 @@ import (
 	"path/filepath"
 	"strings"
 
-	ioext "github.com/go-playground/pkg/v4/io"
+	ioext "github.com/go-playground/pkg/v5/io"
 )
 
 // QueryParamsOption represents the options for including query parameters during Decode helper functions
 type QueryParamsOption uint8
 
+// QueryParamsOption's
 const (
 	QueryParams QueryParamsOption = iota
 	NoQueryParams

net/http/helpers.go

@@ -0,0 +1,23 @@
+package unsafeext
+
+import (
+	"reflect"
+	"unsafe"
+)
+
+// BytesToString converts an array of bytes into a string without allocating.
+// The byte slice passed to this function is not to be used after this call as it's unsafe; you have been warned.
+func BytesToString(b []byte) string {
+	return *(*string)(unsafe.Pointer(&b))
+}
+
+// StringToBytes converts an existing string into an []byte without allocating.
+// The string passed to this functions is not to be used again after this call as it's unsafe; you have been warned.
+func StringToBytes(s string) (b []byte) {
+	strHdr := (*reflect.StringHeader)(unsafe.Pointer(&s))
+	sliceHdr := (*reflect.SliceHeader)(unsafe.Pointer(&b))
+	sliceHdr.Data = strHdr.Data
+	sliceHdr.Cap = strHdr.Len
+	sliceHdr.Len = strHdr.Len
+	return
+}

unsafe/conversions.go

@@ -0,0 +1,21 @@
+package unsafeext
+
+import "testing"
+
+func TestBytesToString(t *testing.T) {
+	b := []byte{'g', 'o', '-', 'p', 'l', 'a', 'y', 'g', 'r', 'o', 'u', 'n', 'd'}
+	s := BytesToString(b)
+	expected := string(b)
+	if s != expected {
+		t.Fatalf("expected '%s' got '%s'", expected, s)
+	}
+}
+
+func TestStringToBytes(t *testing.T) {
+	s := "go-playground"
+	b := StringToBytes(s)
+
+	if string(b) != s {
+		t.Fatalf("expected '%s' got '%s'", s, string(b))
+	}
+}