Merge pull request #85 from egandro/golang-port

Golang port

Author: WebReflection

.github/workflows/golang.yml

@@ -0,0 +1,63 @@
+name: Go
+
+on: [push, pull_request]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install System Dependencies
+      run: |
+        sudo apt-get update && sudo apt-get install -y binutils build-essential jq make
+
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Go
+      uses: actions/setup-go@v6
+      with:
+        go-version: '1.26.0'
+        cache-dependency-path: golang/go.sum
+
+    - name: Check Formatting
+      run: |
+        if [ -n "$(gofmt -l .)" ]; then
+          echo "Go code is not formatted:"
+          gofmt -d .
+          exit 1
+        fi
+      working-directory: ./golang
+
+    - name: GolangCI-Lint
+      uses: golangci/golangci-lint-action@v9
+      with:
+        version: latest
+        working-directory: ./golang
+      env:
+        GOFLAGS: "-buildvcs=false"
+
+    - name: Run Gosec Security Scanner
+      run: |
+        go install github.com/securego/gosec/v2/cmd/gosec@latest
+        gosec ./...
+      working-directory: ./golang
+      env:
+        GOTOOLCHAIN: auto
+
+    - name: Run govulncheck
+      run: |
+        go install golang.org/x/vuln/cmd/govulncheck@latest
+        govulncheck ./...
+      working-directory: ./golang
+
+    - name: Build
+      run: make build
+      working-directory: ./golang
+
+    - name: Test
+      run: go test -v -race -coverprofile=coverage.out ./...
+      working-directory: ./golang
+
+    - name: Run Integration Test
+      run: bash ./test-dummy.sh

.gitignore

@@ -3,3 +3,7 @@
 node_modules/
 coverage/
 __pycache__
+
+# Go artifacts
+*.test
+*.out

README.md

@@ -12,6 +12,8 @@ Available also for **[PHP](./php/flatted.php)**.
 
 Available also for **[Python](./python/flatted.py)**.
 
+Available also for **[Go](./golang/README.md)**.
+
 - - -
 
 ## Announcement 📣

golang/.gitignore

@@ -0,0 +1 @@
+/flatted

golang/Makefile

@@ -0,0 +1,21 @@
+BINARY_NAME=flatted
+
+build:
+	go build -o $(BINARY_NAME) main.go
+
+test:
+	go clean -testcache
+	go test -v -race ./...
+
+lint:
+	golangci-lint run ./...
+	gosec ./...
+	govulncheck ./...
+	gofmt -l .
+
+check: test lint
+
+clean:
+	rm -f $(BINARY_NAME)
+
+.PHONY: build test clean

golang/README.md

@@ -0,0 +1,60 @@
+# flatted (Go)
+
+A super light and fast circular JSON parser.
+
+## Usage
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/WebReflection/flatted/golang/pkg/flatted"
+)
+
+type Group struct {
+	Name string `json:"name"`
+}
+
+type User struct {
+	Name   string `json:"name"`
+	Friend *User  `json:"friend"`
+	Group  *Group `json:"group"`
+}
+
+func main() {
+	group := &Group{Name: "Developers"}
+	alice := &User{Name: "Alice", Group: group}
+	bob := &User{Name: "Bob", Group: group}
+
+	alice.Friend = bob
+	bob.Friend = alice // Circular reference
+
+	// Stringify Alice
+	s, _ := flatted.Stringify(alice)
+	fmt.Println(s)
+	// Output: [{"name":"Alice","friend":"1","group":"2"},{"name":"Bob","friend":"0","group":"2"},{"name":"Developers"}]
+
+	// Flattening in action:
+	// Index "0" is Alice, Index "1" is Bob, Index "2" is the shared Group.
+
+	// Parse back into a generic map structure
+	res, _ := flatted.Parse(s)
+	aliceMap := res.(map[string]any)
+	fmt.Println(aliceMap["name"]) // Alice
+}
+```
+
+## CLI
+
+Build the binary using the provided Makefile:
+
+```bash
+make build
+```
+
+Then use it to parse flatted JSON from stdin:
+
+```bash
+echo '[{"a":"1"},"b"]' | ./flatted
+```

golang/go.mod

@@ -0,0 +1,3 @@
+module github.com/WebReflection/flatted/golang
+
+go 1.26.0

golang/main.go

@@ -0,0 +1,97 @@
+package main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+
+	"github.com/WebReflection/flatted/golang/pkg/flatted"
+)
+
+// flatten reads standard JSON from r and writes flatted JSON to w.
+func flatten(r io.Reader, w io.Writer) error {
+	input, err := io.ReadAll(r)
+	if err != nil {
+		return err
+	}
+	var data any
+	if err := json.Unmarshal(input, &data); err != nil {
+		return fmt.Errorf("invalid JSON input: %w", err)
+	}
+	s, err := flatted.Stringify(data, nil, nil)
+	if err != nil {
+		return err
+	}
+	if _, err := w.Write([]byte(s)); err != nil {
+		return err
+	}
+	_, err = w.Write([]byte("\n"))
+	return err
+}
+
+// unflatten reads flatted JSON from r and writes standard JSON to w.
+func unflatten(r io.Reader, w io.Writer) error {
+	input, err := io.ReadAll(r)
+	if err != nil {
+		return err
+	}
+	parsed, err := flatted.Parse(string(input), nil)
+	if err != nil {
+		return fmt.Errorf("invalid flatted input: %w", err)
+	}
+	output, err := json.MarshalIndent(parsed, "", "  ")
+	if err != nil {
+		return err
+	}
+	if _, err := w.Write(output); err != nil {
+		return err
+	}
+	_, err = w.Write([]byte("\n"))
+	return err
+}
+
+func main() {
+	exe := filepath.Base(os.Args[0])
+	var decompress bool
+	flag.BoolVar(&decompress, "d", false, "decompress (unflatten)")
+	flag.BoolVar(&decompress, "decompress", false, "decompress (unflatten)")
+	flag.BoolVar(&decompress, "unflatten", false, "decompress (unflatten)")
+
+	flag.Usage = func() {
+		fmt.Fprintf(os.Stderr, "Usage: %s [OPTION]... [FILE]\n", exe)
+		fmt.Fprintln(os.Stderr, "Flatten or unflatten circular JSON structures.")
+		fmt.Fprintln(os.Stderr, "")
+		fmt.Fprintln(os.Stderr, "Options:")
+		flag.PrintDefaults()
+		fmt.Fprintln(os.Stderr, "")
+		fmt.Fprintln(os.Stderr, "If no FILE is provided, or if FILE is -, read from standard input.")
+	}
+
+	flag.Parse()
+
+	var r io.Reader = os.Stdin
+	if flag.NArg() > 0 && flag.Arg(0) != "-" {
+		f, err := os.Open(flag.Arg(0))
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", exe, err) // #nosec G705
+			os.Exit(1)
+		}
+		defer func() { _ = f.Close() }()
+		r = f
+	}
+
+	var err error
+	if decompress {
+		err = unflatten(r, os.Stdout)
+	} else {
+		err = flatten(r, os.Stdout)
+	}
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s: %v\n", exe, err) // #nosec G705
+		os.Exit(1)
+	}
+}

golang/pkg/flatted/bench_test.go

@@ -0,0 +1,83 @@
+package flatted
+
+import (
+	"encoding/json"
+	"os"
+	"testing"
+)
+
+func BenchmarkFlatted(b *testing.B) {
+	// Create a circular structure for benchmarking
+	a := &[]any{map[string]any{}}
+	for i := 0; i < 10; i++ {
+		*a = append(*a, map[string]any{"id": i, "ref": a})
+	}
+	(*a)[0].(map[string]any)["root"] = a
+
+	s, _ := Stringify(a, nil, nil)
+
+	b.Run("Stringify", func(b *testing.B) {
+		b.ReportAllocs()
+		for i := 0; i < b.N; i++ {
+			_, err := Stringify(a, nil, nil)
+			if err != nil {
+				b.Fatal(err)
+			}
+		}
+	})
+
+	b.Run("Parse", func(b *testing.B) {
+		b.ReportAllocs()
+		for i := 0; i < b.N; i++ {
+			_, _ = Parse(s, nil)
+		}
+	})
+}
+
+func BenchmarkCompare(b *testing.B) {
+	// Non-circular data for comparison
+	data := map[string]any{
+		"name": "test",
+		"list": []any{1, 2, 3, 4, 5},
+		"nested": map[string]any{
+			"x": 1.0,
+			"y": 2.0,
+		},
+	}
+
+	b.Run("Flatted", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			_, _ = Stringify(data, nil, nil)
+		}
+	})
+
+	b.Run("JSON", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			_, _ = json.Marshal(data)
+		}
+	})
+}
+
+func BenchmarkLargeFile(b *testing.B) {
+	data, err := os.ReadFile("../test/65515.json")
+	if err != nil {
+		b.Skip("Skipping large file benchmark: file not found")
+	}
+	var raw map[string]any
+	_ = json.Unmarshal(data, &raw)
+	toolData := raw["toolData"]
+	strBytes, _ := json.Marshal(toolData)
+	str := string(strBytes)
+	obj, _ := Parse(str, nil)
+
+	b.Run("Stringify", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			_, _ = Stringify(obj, nil, nil)
+		}
+	})
+	b.Run("Parse", func(b *testing.B) {
+		for i := 0; i < b.N; i++ {
+			_, _ = Parse(str, nil)
+		}
+	})
+}