first version (#1)

cornelk · web-flow · commit f24e36ed8741 · 2022-08-29T04:54:44.000+03:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**System (please complete the following information):**
+ - OS:
+ - Version / Commit:
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/workflows/codecov.yaml b/.github/workflows/codecov.yaml
@@ -0,0 +1,34 @@
+name: codecov
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  codecov:
+    timeout-minutes: 15
+
+    name: Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Get dependencies
+        run: go mod download
+
+      - name: Run tests with coverage
+        run: make test-coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          file: ./.testCoverage
diff --git a/.github/workflows/go.yaml b/.github/workflows/go.yaml
@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    if: "!contains(github.event.commits[0].message, '[skip ci]')"
+    timeout-minutes: 15
+
+    name: Build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: [1.17, 1.18, 1.19]
+
+    steps:
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Install linters
+        run: make install-linters
+
+      - name: Get dependencies
+        run: go mod download
+
+      - name: Run tests
+        run: make test
+
+      - name: Run linter
+        run: make lint
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+*.exe
+.idea
+.vscode
+*.iml
+*.local
+/*.log
+*.out
+*.prof
+*.test
+.DS_Store
+*.dmp
+*.db
+
+.testCoverage
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,58 @@
+run:
+  deadline: 5m
+
+linters:
+  enable:
+    - asasalint # check for pass []any as any in variadic func(...any)
+    - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
+    - bidichk # Checks for dangerous unicode character sequences
+    - containedctx # detects struct contained context.Context field
+    - contextcheck # check the function whether use a non-inherited context
+    - cyclop # checks function and package cyclomatic complexity
+    - decorder # check declaration order and count of types, constants, variables and functions
+    - depguard # Go linter that checks if package imports are in a list of acceptable packages
+    - dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
+    - durationcheck # check for two durations multiplied together
+    - errcheck # checking for unchecked errors
+    - errname # Checks that errors are prefixed with the `Err` and error types are suffixed with the `Error`
+    - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
+    - exportloopref # checks for pointers to enclosing loop variables
+    - funlen # Tool for detection of long functions
+    - gci # controls golang package import order and makes it always deterministic
+    - gocognit # Computes and checks the cognitive complexity of functions
+    - gocritic # Provides diagnostics that check for bugs, performance and style issues
+    - gocyclo # Computes and checks the cyclomatic complexity of functions
+    - godot # Check if comments end in a period
+    - goerr113 # Golang linter to check the errors handling expressions
+    - gosimple # Linter for Go source code that specializes in simplifying a code
+    - govet # reports suspicious constructs, such as Printf calls with wrong arguments
+    - ineffassign # Detects when assignments to existing variables are not used
+    - maintidx # measures the maintainability index of each function
+    - makezero # Finds slice declarations with non-zero initial length
+    - misspell # Finds commonly misspelled English words in comments
+    - nakedret # Finds naked returns in functions
+    - nestif # Reports deeply nested if statements
+    - nilerr # Finds the code that returns nil even if it checks that the error is not nil
+    - nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value
+    - prealloc # Finds slice declarations that could potentially be preallocated
+    - predeclared # find code that shadows one of Go's predeclared identifiers
+    - revive # drop-in replacement of golint
+    - staticcheck # drop-in replacement of go vet
+    - stylecheck # Stylecheck is a replacement for golint
+    - tenv # detects using os.Setenv instead of t.Setenv
+    - thelper # checks the consistency of test helpers
+    - tparallel # detects inappropriate usage of t.Parallel()
+    - typecheck # parses and type-checks Go code
+    - unconvert # Remove unnecessary type conversions
+    - unparam # Reports unused function parameters
+    - unused # Checks Go code for unused constants, variables, functions and types
+    - usestdlibvars # detect the possibility to use variables/constants from the Go standard library
+    - wastedassign # finds wasted assignment statements
+    - whitespace # detects leading and trailing whitespace
+
+issues:
+  exclude-use-default: false
+  exclude-rules:
+    - linters:
+        - goerr113
+      text: "do not define dynamic errors"
diff --git a/Makefile b/Makefile
@@ -0,0 +1,18 @@
+help: ## show help, shown by default if no target is specified
+	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+lint: ## run code linters
+	golangci-lint run
+
+test: ## run tests
+	go test -race ./...
+
+test-coverage: ## run unit tests and create test coverage
+	go test ./... -coverprofile .testCoverage -covermode=atomic -coverpkg=./...
+
+test-coverage-web: test-coverage ## run unit tests and show test coverage in browser
+	go tool cover -func .testCoverage | grep total | awk '{print "Total coverage: "$$3}'
+	go tool cover -html=.testCoverage
+
+install-linters: ## install all used linters
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.49.0
diff --git a/README.md b/README.md
@@ -1 +1,27 @@
-# orderedmap
+# orderedmap
+
+[![Build status](https://github.com/cornelk/orderedmap/actions/workflows/go.yaml/badge.svg?branch=main)](https://github.com/cornelk/orderedmap/actions)
+[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/cornelk/orderedmap)
+[![Go Report Card](https://goreportcard.com/badge/github.com/cornelk/orderedmap)](https://goreportcard.com/report/github.com/cornelk/orderedmap)
+[![codecov](https://codecov.io/gh/cornelk/orderedmap/branch/main/graph/badge.svg?token=NS5UY28V3A)](https://codecov.io/gh/cornelk/orderedmap)
+
+## Overview
+
+A Golang Map that keeps track of the insert order of items.
+
+The current version can be used as a replacement for `map[string]interface{}` and allows JSON unmarshalling into it.
+No manual adding of items is currently possible.
+
+## Usage
+
+Unmarshall and marshall JSON:
+
+```
+var m Map
+input := `{"423":"abc","231":"dbh","152":"xyz"}`
+
+m.UnmarshalJSON([]byte(input))
+
+output, _ := m.MarshalJSON()
+# unlike the standard Golang map, the output will be exact the same and not in random key order
+```
diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/cornelk/orderedmap
+
+go 1.17
diff --git a/go.sum b/go.sum
diff --git a/map.go b/map.go
@@ -0,0 +1,79 @@
+// Package orderedmap provides a Map that preserves the order of key value pairs.
+package orderedmap
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"sort"
+)
+
+// Map implements a map that keeps the item order.
+type Map struct {
+	// Data holds the map entries in unsorted order.
+	Data map[string]Entry
+	// Keys contains the map keys in sorted order.
+	Keys []string
+}
+
+// Len returns the number of elements within the map.
+func (m *Map) Len() int {
+	return len(m.Keys)
+}
+
+// Range calls f sequentially for each key and value present in the map.
+// If f returns false, range stops the iteration.
+func (m *Map) Range(f func(key string, value interface{}) bool) {
+	for _, key := range m.Keys {
+		entry := m.Data[key]
+		if !f(key, entry.Value) {
+			return
+		}
+	}
+}
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
+func (m *Map) UnmarshalJSON(b []byte) error {
+	if err := json.Unmarshal(b, &m.Data); err != nil {
+		return err
+	}
+
+	m.rebuildKeys()
+	return nil
+}
+
+// MarshalJSON implements the json.Marshaler interface.
+func (m *Map) MarshalJSON() ([]byte, error) {
+	var buf bytes.Buffer
+	buf.WriteString("{")
+
+	for i, key := range m.Keys {
+		buf.WriteString(fmt.Sprintf("%q:", key))
+
+		value := m.Data[key].Value
+		b, err := json.Marshal(value)
+		if err != nil {
+			return nil, fmt.Errorf("marshalling entry: %w", err)
+		}
+		buf.Write(b)
+
+		if i < len(m.Keys)-1 {
+			buf.WriteString(",")
+		}
+	}
+
+	buf.WriteString("}")
+	return buf.Bytes(), nil
+}
+
+// rebuildKeys build the sorted keys slice.
+func (m *Map) rebuildKeys() {
+	m.Keys = []string{}
+	for name := range m.Data {
+		m.Keys = append(m.Keys, name)
+	}
+
+	sort.SliceStable(m.Keys, func(i, j int) bool {
+		return m.Data[m.Keys[i]].index < m.Data[m.Keys[j]].index
+	})
+}
diff --git a/map_test.go b/map_test.go
@@ -0,0 +1,64 @@
+package orderedmap
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestJSON(t *testing.T) {
+	input := `{"423":"abc","231":"dbh","152":"xyz"}`
+
+	var m Map
+	if err := m.UnmarshalJSON([]byte(input)); err != nil {
+		t.Fatal(err)
+	}
+
+	output, err := m.MarshalJSON()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	got := string(output)
+	if input != got {
+		t.Errorf("expected: %v, got: %v", input, got)
+	}
+}
+
+func TestLen(t *testing.T) {
+	input := `{"423":"abc","231":"dbh","152":"xyz"}`
+
+	var m Map
+	if err := m.UnmarshalJSON([]byte(input)); err != nil {
+		t.Fatal(err)
+	}
+
+	if got, expected := m.Len(), 3; expected != got {
+		t.Errorf("expected: %v, got: %v", expected, got)
+	}
+}
+
+func TestRange(t *testing.T) {
+	input := `{"423":"abc","231":"dbh","152":"xyz"}`
+
+	var m Map
+	if err := m.UnmarshalJSON([]byte(input)); err != nil {
+		t.Fatal(err)
+	}
+
+	var items []map[string]interface{}
+	m.Range(func(key string, value interface{}) bool {
+		entry := map[string]interface{}{key: value}
+		items = append(items, entry)
+		return true
+	})
+
+	expected := []map[string]interface{}{
+		{"423": "abc"},
+		{"231": "dbh"},
+		{"152": "xyz"},
+	}
+
+	if !reflect.DeepEqual(items, expected) {
+		t.Errorf("expected: %v, got: %v", expected, items)
+	}
+}
diff --git a/map_value.go b/map_value.go
diff --git a/sequencer.go b/sequencer.go

-Original file line number
+Diff line change
@@ @@ -0,0 +1,14 @@ @@
 +*.exe
 +.idea
 +.vscode
 +*.iml
 +*.local
 +/*.log
 +*.out
 +*.prof
 +*.test
 +.DS_Store
 +*.dmp
 +*.db
++
 +.testCoverage
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/cornelk/orderedmap`
	`2`	`+`
	`3`	`+go 1.17`