tests: add names to dump test cases

.github/workflows/assign.yaml

@@ -0,0 +1,21 @@
+name: Assign
+
+on:
+  issues:
+    types: [opened, reopened]
+  pull_request_target:
+    types: [opened, reopened]
+
+jobs:
+  assign:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.issues.addAssignees({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              assignees: ['thockin']
+            })

.github/workflows/lint.yaml

@@ -0,0 +1,21 @@
+name: Run lint
+
+on: [ push, pull_request ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          # version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: latest
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
+          # Read args from .golangci.yaml
+          # args:

.github/workflows/tests.yaml

@@ -0,0 +1,22 @@
+name: Run tests
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        version: [ '1.15', '1.16', '1.17', '1.18' ]
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.platform }}
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.version }}
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Build
+      run: go build -v ./...
+    - name: Test
+      run: go test -v -race ./...

.golangci.yaml

@@ -0,0 +1,28 @@
+run:
+  timeout: 1m
+  tests: true
+
+linters:
+  disable-all: true
+  enable:
+    - asciicheck
+    - deadcode
+    - forcetypeassert
+    - gocritic
+    - gofmt
+    - goimports
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - revive
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck
+
+issues:
+  exclude-use-default: false
+  max-issues-per-linter: 0
+  max-same-issues: 10

go.mod

@@ -0,0 +1,3 @@
+module github.com/thockin/go-spew
+
+go 1.18

spew/TODO

@@ -0,0 +1,9 @@
+benchmark
+optimize
+ - avoid reflect first
+use `string` where possible in tests
+comprehend tests
+remove linewraps in tests
+update docs
+OmitNilValues
+  - if I have a `[]*Foo{&Foo{}, &Foo{}, nil}` - should still print nil

spew/bypass.go

@@ -18,6 +18,7 @@
 // tag is deprecated and thus should not be used.
 // Go versions prior to 1.4 are disabled because they use a different layout
 // for interfaces which make the implementation of unsafeReflectValue more complex.
+//go:build !js && !appengine && !safe && !disableunsafe && go1.4
 // +build !js,!appengine,!safe,!disableunsafe,go1.4
 
 package spew
@@ -31,9 +32,6 @@ const (
 	// UnsafeDisabled is a build-time constant which specifies whether or
 	// not access to the unsafe package is available.
 	UnsafeDisabled = false
-
-	// ptrSize is the size of a pointer on the current arch.
-	ptrSize = unsafe.Sizeof((*byte)(nil))
 )
 
 type flag uintptr

spew/common.go

@@ -34,11 +34,16 @@ var (
 	trueBytes             = []byte("true")
 	falseBytes            = []byte("false")
 	interfaceBytes        = []byte("(interface {})")
+	commaBytes            = []byte(",")
 	commaNewlineBytes     = []byte(",\n")
 	newlineBytes          = []byte("\n")
 	openBraceBytes        = []byte("{")
 	openBraceNewlineBytes = []byte("{\n")
 	closeBraceBytes       = []byte("}")
+	emptyBracesBytes      = []byte("{}")
+	openListNewlineBytes  = []byte("[\n")
+	closeListBytes        = []byte("]")
+	emptyListBytes        = []byte("[]")
 	asteriskBytes         = []byte("*")
 	colonBytes            = []byte(":")
 	colonSpaceBytes       = []byte(": ")
@@ -100,7 +105,7 @@ func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool)
 	// Choose whether or not to do error and Stringer interface lookups against
 	// the base type or a pointer to the base type depending on settings.
 	// Technically calling one of these methods with a pointer receiver can
-	// mutate the value, however, types which choose to satisify an error or
+	// mutate the value, however, types which choose to satisfy an error or
 	// Stringer interface with a pointer receiver should not be mutating their
 	// state inside these interface methods.
 	if !cs.DisablePointerMethods && !UnsafeDisabled && !v.CanAddr() {
@@ -114,27 +119,35 @@ func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool)
 	switch iface := v.Interface().(type) {
 	case error:
 		defer catchPanic(w, v)
+		s := iface.Error()
+		if cs.QuoteStrings {
+			s = strconv.Quote(s)
+		}
 		if cs.ContinueOnMethod {
 			w.Write(openParenBytes)
-			w.Write([]byte(iface.Error()))
+			w.Write([]byte(s))
 			w.Write(closeParenBytes)
 			w.Write(spaceBytes)
 			return false
 		}
 
-		w.Write([]byte(iface.Error()))
+		w.Write([]byte(s))
 		return true
 
 	case fmt.Stringer:
 		defer catchPanic(w, v)
+		s := iface.String()
+		if cs.QuoteStrings {
+			s = strconv.Quote(s)
+		}
 		if cs.ContinueOnMethod {
 			w.Write(openParenBytes)
-			w.Write([]byte(iface.String()))
+			w.Write([]byte(s))
 			w.Write(closeParenBytes)
 			w.Write(spaceBytes)
 			return false
 		}
-		w.Write([]byte(iface.String()))
+		w.Write([]byte(s))
 		return true
 	}
 	return false
@@ -254,7 +267,7 @@ func newValuesSorter(values []reflect.Value, cs *ConfigState) sort.Interface {
 // directly, or whether it should be considered for sorting by surrogate keys
 // (if the ConfigState allows it).
 func canSortSimply(kind reflect.Kind) bool {
-	// This switch parallels valueSortLess, except for the default case.
+	// This switch parallels valueLessEqual, except for the default case.
 	switch kind {
 	case reflect.Bool:
 		return true
@@ -289,43 +302,55 @@ func (s *valuesSorter) Swap(i, j int) {
 	}
 }
 
-// valueSortLess returns whether the first value should sort before the second
+// valueLessEqual returns whether the first value should sort before the second
 // value.  It is used by valueSorter.Less as part of the sort.Interface
 // implementation.
-func valueSortLess(a, b reflect.Value) bool {
+func valueLessEqual(a, b reflect.Value) (less, equal bool) {
 	switch a.Kind() {
 	case reflect.Bool:
-		return !a.Bool() && b.Bool()
+		av, bv := a.Bool(), b.Bool()
+		return !av && bv, av == bv
 	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
-		return a.Int() < b.Int()
+		av, bv := a.Int(), b.Int()
+		return av < bv, av == bv
 	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
-		return a.Uint() < b.Uint()
+		av, bv := a.Uint(), b.Uint()
+		return av < bv, av == bv
 	case reflect.Float32, reflect.Float64:
-		return a.Float() < b.Float()
+		av, bv := a.Float(), b.Float()
+		return av < bv, av == bv
 	case reflect.String:
-		return a.String() < b.String()
+		av, bv := a.String(), b.String()
+		return av < bv, av == bv
 	case reflect.Uintptr:
-		return a.Uint() < b.Uint()
+		av, bv := a.Uint(), b.Uint()
+		return av < bv, av == bv
 	case reflect.Array:
 		// Compare the contents of both arrays.
 		l := a.Len()
 		for i := 0; i < l; i++ {
 			av := a.Index(i)
 			bv := b.Index(i)
-			if av.Interface() == bv.Interface() {
+
+			less, equal := valueLessEqual(av, bv)
+			if equal {
 				continue
 			}
-			return valueSortLess(av, bv)
+
+			return less, false
 		}
 	}
-	return a.String() < b.String()
+
+	av, bv := a.String(), b.String()
+	return av < bv, av == bv
 }
 
 // Less returns whether the value at index i should sort before the
 // value at index j.  It is part of the sort.Interface implementation.
 func (s *valuesSorter) Less(i, j int) bool {
 	if s.strings == nil {
-		return valueSortLess(s.values[i], s.values[j])
+		less, _ := valueLessEqual(s.values[i], s.values[j])
+		return less
 	}
 	return s.strings[i] < s.strings[j]
 }