init commit (#1)

Author: Wing924

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+    - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: 'stable'
+
+    - name: Go Format
+      run: |
+        if [ -n "$(gofmt -l .)" ]; then
+          echo "Go code is not formatted:"
+          gofmt -d .
+          exit 1
+        fi
+
+    - name: Go Test
+      run: go test -v -race -coverprofile=coverage.txt -covermode=atomic
+
+    - name: Codecov
+      run: bash <(curl -s https://codecov.io/bash)

README.md

@@ -1,2 +1,129 @@
 # go-jsonstream
 JSON Stream (JSON Lines, JSON Array) Go Library
+
+### Installation
+
+```bash
+go get github.com/Wing924/go-jsonstream
+```
+
+## How to use
+
+### Encode
+
+```go
+// encode as JSON Lines stream
+out := bytes.NewBuffer(nil)
+
+sender := NewJSONLinesEncoder(out)
+sender.Send("foo")
+sender.Send(map[string]string{"bar": "baz"})
+sender.Send(123)
+sender.Done()
+
+fmt.Println(out.String())
+// Will output:
+// "foo"
+// {"bar":"baz"}
+// 123
+```
+
+```go
+// encode as JSON Array stream
+out := bytes.NewBuffer(nil)
+
+sender := NewJSONArrayEncoder(out)
+sender.Send("foo")
+sender.Send(map[string]string{"bar": "baz"})
+sender.Send(123)
+sender.Done()
+
+fmt.Println(out.String())
+// Will output:
+// [
+// "foo"
+// ,{"bar":"baz"}
+// ,123
+// ]
+```
+
+### Decode
+
+```go
+// encode as JSON Lines stream
+in := bytes.NewBufferString(`
+{"name":"Barbie"}
+{"name":"Barbie"}
+{"name":"Ken"}
+`)
+
+var data struct{
+    Name string `json:"name"`
+}
+
+receiver := jsonstream.NewJSONLinesDecoder(in)
+for {
+    err := receiver.Receive(&data)
+    if err != nil {
+        if err == io.EOF {
+            break
+        }
+        panic(err)
+    }
+    fmt.Printf("%+v\n", data)
+}
+
+// will output
+// {Name:Barbie}
+// {Name:Barbie}
+// {Name:Ken}
+```
+
+```go
+// encode as JSON Array stream
+in := bytes.NewBufferString(`[{"name":"Barbie"},{"name":"Barbie"},{"name":"Ken"}]`)
+
+var data struct{
+Name string `json:"name"`
+}
+
+receiver := jsonstream.NewJSONArrayDecoder(in)
+for {
+    err := receiver.Receive(&data)
+    if err != nil {
+        if err == io.EOF {
+            break
+        }
+        panic(err)
+    }
+    fmt.Printf("%+v\n", data)
+}
+
+// will output
+// {Name:Barbie}
+// {Name:Barbie}
+// {Name:Ken}
+```
+
+### Use [go-json](https://github.com/goccy/go-json) instead of `encoding/json`
+
+The `go-json` is fast JSON encoder/decoder compatible with `encoding/json` for Go.
+
+```go
+// Change the global
+jsonstream.DefaultConfig = jsonstream.GoJSONConfig
+
+// now use go-json to encode/decode JSON
+jsonstream.NewJSONArrayEncoder(out)
+jsonstream.NewJSONArrayDecoder(in)
+jsonstream.NewJSONLinesEncoder(out)
+jsonstream.NewJSONLinesDecoder(in)
+```
+
+```go
+// Change individual
+jsonstream.NewJSONArrayEncoderWithConfig(out, jsonstream.GoJSONConfig)
+jsonstream.NewJSONArrayDecoderWithConfig(in, jsonstream.GoJSONConfig)
+jsonstream.NewJSONLinesEncoderWithConfig(out, jsonstream.GoJSONConfig)
+jsonstream.NewJSONLinesDecoderWithConfig(in, jsonstream.GoJSONConfig)
+```

bench_test.go

@@ -0,0 +1,83 @@
+package jsonstream
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"testing"
+)
+
+type Format int
+
+const (
+	FormatJSONLines Format = iota
+	FormatJSONArray
+)
+
+var formatNames = map[Format]string{
+	FormatJSONLines: "JSON Lines",
+	FormatJSONArray: "JSON Array",
+}
+
+func (f Format) String() string {
+	return formatNames[f]
+}
+
+func NewEncoder(out io.Writer, format Format, cfg *Config) Sender {
+	switch format {
+	case FormatJSONLines:
+		return NewJSONLinesEncoderWithConfig(out, cfg)
+	case FormatJSONArray:
+		return NewJSONArrayEncoderWithConfig(out, cfg)
+	default:
+		panic(fmt.Errorf("unknown format: %v", format))
+	}
+}
+
+func NewDecoder(in io.Reader, format Format, cfg *Config) Receiver {
+	switch format {
+	case FormatJSONLines:
+		return NewJSONLinesDecoderWithConfig(in, cfg)
+	case FormatJSONArray:
+		return NewJSONArrayDecoderWithConfig(in, cfg)
+	default:
+		panic(fmt.Errorf("unknown format: %v", format))
+	}
+}
+
+func BenchmarkEncoder(b *testing.B) {
+	for _, c := range configs[1:] {
+		for _, f := range []Format{FormatJSONLines, FormatJSONArray} {
+			b.Run(c.name+"_"+f.String(), func(b *testing.B) {
+				sender := NewEncoder(io.Discard, f, c.config)
+				for i := 0; i < b.N; i++ {
+					_ = sender.Send(benchSample)
+				}
+				_ = sender.Done()
+			})
+		}
+	}
+}
+
+func BenchmarkDecoder(b *testing.B) {
+	for _, c := range configs[1:] {
+		for _, f := range []Format{FormatJSONLines, FormatJSONArray} {
+			b.Run(c.name+"_"+f.String(), func(b *testing.B) {
+				input := bytes.NewBuffer(nil)
+				sender := NewEncoder(input, f, c.config)
+				for i := 0; i < b.N; i++ {
+					_ = sender.Send(benchSample)
+				}
+				_ = sender.Done()
+
+				var data Small
+				receiver := NewDecoder(input, f, c.config)
+				b.ResetTimer()
+				for i := 0; i < b.N; i++ {
+					_ = receiver.Receive(&data)
+				}
+
+			})
+		}
+	}
+}

config.go

@@ -0,0 +1,24 @@
+package jsonstream
+
+import (
+	"io"
+)
+
+type (
+	Config struct {
+		NewEncoder func(out io.Writer) JSONEncoder
+		NewDecoder func(in io.Reader) JSONDecoder
+	}
+
+	JSONEncoder interface {
+		Encode(v any) error
+	}
+
+	JSONDecoder interface {
+		More() bool
+		RuneToken() (token rune, others any, err error)
+		Decode(v any) error
+	}
+)
+
+var DefaultConfig = StdConfig

config_gojson.go

@@ -0,0 +1,34 @@
+package jsonstream
+
+import (
+	"github.com/goccy/go-json"
+	"io"
+)
+
+var GoJSONConfig = &Config{
+	NewEncoder: NewGoJSONEncoder,
+	NewDecoder: NewGoJSONDecoder,
+}
+
+func NewGoJSONEncoder(out io.Writer) JSONEncoder {
+	return json.NewEncoder(out)
+}
+
+type goJSONDecoder struct {
+	*json.Decoder
+}
+
+func NewGoJSONDecoder(in io.Reader) JSONDecoder {
+	return &goJSONDecoder{json.NewDecoder(in)}
+}
+
+func (d *goJSONDecoder) RuneToken() (token rune, others any, err error) {
+	t, err := d.Decoder.Token()
+	if err != nil {
+		return 0, nil, err
+	}
+	if d, ok := t.(json.Delim); ok {
+		return rune(d), nil, nil
+	}
+	return 0, t, nil
+}

config_std.go

@@ -0,0 +1,34 @@
+package jsonstream
+
+import (
+	"encoding/json"
+	"io"
+)
+
+var StdConfig = &Config{
+	NewEncoder: NewStdJSONEncoder,
+	NewDecoder: NewStdJSONDecoder,
+}
+
+func NewStdJSONEncoder(out io.Writer) JSONEncoder {
+	return json.NewEncoder(out)
+}
+
+type stdJSONDecoder struct {
+	*json.Decoder
+}
+
+func NewStdJSONDecoder(in io.Reader) JSONDecoder {
+	return &stdJSONDecoder{json.NewDecoder(in)}
+}
+
+func (d *stdJSONDecoder) RuneToken() (token rune, others any, err error) {
+	t, err := d.Decoder.Token()
+	if err != nil {
+		return 0, nil, err
+	}
+	if d, ok := t.(json.Delim); ok {
+		return rune(d), nil, nil
+	}
+	return 0, t, nil
+}

go.mod

@@ -0,0 +1,14 @@
+module github.com/Wing924/go-jsonstream
+
+go 1.21.0
+
+require (
+	github.com/goccy/go-json v0.10.2
+	github.com/stretchr/testify v1.8.4
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,12 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
+github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

stream.go

@@ -0,0 +1,12 @@
+package jsonstream
+
+type (
+	Receiver interface {
+		Receive(data any) error
+	}
+
+	Sender interface {
+		Send(data any) error
+		Done() error
+	}
+)