update workflows, go version and expose map sorting

.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+name: Continuous Integration
+on:
+  push:
+    branches:
+      - main
+      - develop
+
+  pull_request:
+    branches:
+      - main
+      - develop
+    types:
+      - opened
+      - synchronize
+      - ready_for_review
+    paths:
+      - "**.go"
+      - "**.mod"
+      - "**.sum"
+      - ".github/workflows/**.yaml"
+
+  workflow_call: {}
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    uses: ./.github/workflows/lint.yaml
+
+  test:
+    name: Test
+    needs: lint
+    uses: ./.github/workflows/test.yaml

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint
+on:
+  workflow_dispatch: {}
+  workflow_call: {}
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: GolangCI Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Go 1.20
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+          cache: false
+
+      - name: Run Golang CI Lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.52.2
+          skip-cache: true
+          skip-pkg-cache: true
+          skip-build-cache: true

.github/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: Test
+on:
+  workflow_dispatch: {}
+  workflow_call: {}
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Go 1.20
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+          cache: false
+
+      - name: Run Golang Tests
+        run: go test ./... -v -race

.golangci.yml

@@ -0,0 +1,67 @@
+run:
+  tests: true
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 5m
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+linters:
+  disable-all: true
+  enable:
+    - dogsled
+    - dupl
+    - depguard
+    - errname
+    - errorlint
+    - forcetypeassert
+    - exportloopref
+    - goconst
+    - gocritic
+    - gofumpt
+    - gosec
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - lll
+    - makezero
+    - misspell
+    - nakedret
+    - nolintlint
+    - predeclared
+    - prealloc
+    - staticcheck
+    - stylecheck
+    - tparallel
+    - thelper
+    - typecheck
+    - unconvert
+    - unused
+    - whitespace
+    - wsl
+
+issues:
+  exclude-rules:
+    - text: "Use of weak random number generator"
+      linters:
+        - gosec
+
+  max-issues-per-linter: 10000
+  max-same-issues: 10000
+
+linters-settings:
+  dogsled:
+    max-blank-identifiers: 3
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+  nolintlint:
+    allow-unused: false # to be set to false once all issues are addressed, any exceptions needed to be added above
+    allow-leading-space: true
+    require-explanation: false # nice to have as true
+    require-specific: false
+  depguard:
+    Main:
+      allow:
+        - $github.com/sarvalabs/*
+        - github.com/pkg/errors

bench_test.go

@@ -82,7 +82,6 @@ func BenchmarkEncoding(b *testing.B) {
 			})
 		})
 	})
-
 }
 
 func BenchmarkDocument(b *testing.B) {

bufferread.go

@@ -104,7 +104,7 @@ func (rb readbuffer) decodeBool() (bool, error) {
 		return false, nil
 	// Default Value
 	case WireNull:
-		return false, nilValue
+		return false, errNilValue
 	default:
 		return false, IncompatibleWireType(rb.wire, WireNull, WireTrue, WireFalse)
 	}
@@ -116,7 +116,7 @@ func (rb readbuffer) decodeBytes() ([]byte, error) {
 		return rb.data, nil
 	// Nil Byte Slice (Default)
 	case WireNull:
-		return nil, nilValue
+		return nil, errNilValue
 	default:
 		return nil, IncompatibleWireType(rb.wire, WireNull, WireWord)
 	}
@@ -155,7 +155,7 @@ func (rb readbuffer) decodeBytesFromPack() ([]byte, error) {
 
 	// Nil Byte Slice (Default)
 	case WireNull:
-		return nil, nilValue
+		return nil, errNilValue
 	default:
 		return nil, IncompatibleWireType(rb.wire, WireNull, WirePack)
 	}
@@ -168,7 +168,7 @@ func (rb readbuffer) decodeString() (string, error) {
 		return string(rb.data), nil
 	// Empty String (Default)
 	case WireNull:
-		return "", nilValue
+		return "", errNilValue
 	default:
 		return "", IncompatibleWireType(rb.wire, WireNull, WireWord)
 	}
@@ -188,7 +188,7 @@ func (rb readbuffer) decodeUint64() (uint64, error) {
 		return number, nil
 
 	case WireNull:
-		return 0, nilValue
+		return 0, errNilValue
 	default:
 		return 0, IncompatibleWireType(rb.wire, WireNull, WirePosInt)
 	}
@@ -262,7 +262,7 @@ func (rb readbuffer) decodeInt64() (decoded int64, err error) {
 		return int64(number), nil
 
 	case WireNull:
-		return 0, nilValue
+		return 0, errNilValue
 	default:
 		return 0, IncompatibleWireType(rb.wire, WireNull, WirePosInt, WireNegInt)
 	}
@@ -327,7 +327,7 @@ func (rb readbuffer) decodeFloat32() (float32, error) {
 
 	// 0 (Default)
 	case WireNull:
-		return 0, nilValue
+		return 0, errNilValue
 	default:
 		return 0, IncompatibleWireType(rb.wire, WireNull, WireFloat)
 	}
@@ -350,7 +350,7 @@ func (rb readbuffer) decodeFloat64() (float64, error) {
 
 	// 0 (Default)
 	case WireNull:
-		return 0, nilValue
+		return 0, errNilValue
 	default:
 		return 0, IncompatibleWireType(rb.wire, WireNull, WireFloat)
 	}
@@ -365,7 +365,7 @@ func (rb readbuffer) decodeBigInt() (*big.Int, error) {
 
 	// Nil big.Int
 	case WireNull:
-		return nil, nilValue
+		return nil, errNilValue
 	default:
 		return nil, IncompatibleWireType(rb.wire, WireNull, WirePosInt, WireNegInt)
 	}

depolorizer.go

@@ -88,7 +88,7 @@ func (depolorizer *Depolorizer) Depolorize(object any) error {
 
 	// Handle Errors or Nils
 	switch {
-	case err != nil && errors.Is(err, nilValue):
+	case err != nil && errors.Is(err, errNilValue):
 		return nil
 	case err != nil:
 		return err
@@ -98,6 +98,7 @@ func (depolorizer *Depolorizer) Depolorize(object any) error {
 
 	// Convert and set the decoded value
 	value.Elem().Set(result.Convert(target))
+
 	return nil
 }
 
@@ -119,7 +120,7 @@ func (depolorizer *Depolorizer) DepolorizeNull() error {
 }
 
 func allowNilValue[V any](value V, err error) (V, error) {
-	if errors.Is(err, nilValue) {
+	if errors.Is(err, errNilValue) {
 		return value, nil
 	}
 
@@ -520,7 +521,7 @@ func (depolorizer *Depolorizer) depolorizeMapValue(target reflect.Type) (reflect
 
 			// Depolorize the raw value for the key into map's value type
 			val, err := decoder.depolorizeValue(valType)
-			if err != nil && !errors.Is(err, nilValue) {
+			if err != nil && !errors.Is(err, errNilValue) {
 				return zeroVal, err
 			}
 
@@ -575,7 +576,9 @@ func (depolorizer *Depolorizer) depolorizeStructValue(target reflect.Type) (refl
 			// Depolorize the next object from the pack into the map key type
 			val, err := pack.depolorizeValue(field.Type)
 			if err != nil {
-				return zeroVal, IncompatibleWireError{fmt.Sprintf("struct field [%v.%v <%v>]: %v", target, field.Name, field.Type, err)}
+				return zeroVal, IncompatibleWireError{
+					fmt.Sprintf("struct field [%v.%v <%v>]: %v", target, field.Name, field.Type, err),
+				}
 			}
 
 			if val != zeroVal {
@@ -630,8 +633,10 @@ func (depolorizer *Depolorizer) depolorizeStructValue(target reflect.Type) (refl
 			}
 
 			fieldVal, err := object.depolorizeValue(field.Type)
-			if err != nil && !errors.Is(err, nilValue) {
-				return zeroVal, IncompatibleWireError{fmt.Sprintf("struct field [%v.%v <%v>]: %v", target, field.Name, field.Type, err)}
+			if err != nil && !errors.Is(err, errNilValue) {
+				return zeroVal, IncompatibleWireError{
+					fmt.Sprintf("struct field [%v.%v <%v>]: %v", target, field.Name, field.Type, err),
+				}
 			}
 
 			if fieldVal != zeroVal {
@@ -656,7 +661,7 @@ func (depolorizer *Depolorizer) depolorizePointer(target reflect.Type) (reflect.
 	value, err := depolorizer.depolorizeValue(target.Elem())
 
 	switch {
-	case err != nil && errors.Is(err, nilValue):
+	case err != nil && errors.Is(err, errNilValue):
 		return zeroVal, nil
 	case err != nil:
 		return zeroVal, err
@@ -686,7 +691,7 @@ func (depolorizer *Depolorizer) depolorizeDepolorizable(target reflect.Type) (re
 	// Call the Depolorize method of Depolorizable (accepts a Depolorizer and returns an error)
 	outputs := value.MethodByName("Depolorize").Call([]reflect.Value{reflect.ValueOf(inner)})
 	if !outputs[0].IsNil() {
-		return zeroVal, outputs[0].Interface().(error)
+		return zeroVal, outputs[0].Interface().(error) //nolint:forcetypeassert
 	}
 
 	return value.Elem(), nil
@@ -701,7 +706,6 @@ func (depolorizer *Depolorizer) depolorizeValue(target reflect.Type) (reflect.Va
 	}
 
 	switch kind := target.Kind(); kind {
-
 	// Pointer Value
 	case reflect.Ptr:
 		return depolorizer.depolorizePointer(target)