ci: add workflows and go mod

Add GitHub workflows to lint and test the code and fix lint issues.

Add go mod definition.

Author: stevenh

.github/workflows/go.yml

@@ -0,0 +1,55 @@
+name: Go build, test and lint
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+permissions:
+  contents: read
+
+jobs:
+  go:
+    strategy:
+      matrix:
+        go: [1.20]
+        golangcli: [1.52.2]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    name: lint
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go }}
+          cache: false
+
+      - name: Validate go generate / mod
+        if: runner.os != 'Windows'
+        run: |
+          go mod tidy
+          git --no-pager diff && [[ 0 -eq $(git status --porcelain | wc -l) ]]
+
+      - name: Go Lint Standard
+        if: runner.os != 'Windows'
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: ${{ matrix.golangci }}
+          args: "--out-${NO_FUTURE}format colored-line-number"
+
+      - name: Go Lint Windows
+        if: runner.os == 'Windows'
+        uses: golangci/golangci-lint-action@v3
+        env:
+          outformat: out-format
+        with:
+          version: ${{ matrix.golangci }}
+          args: "--%outformat% colored-line-number"
+
+      - name: Go Test
+        run: go test -race ./...

.golangci.yml

@@ -0,0 +1,71 @@
+run:
+  concurrency: 4
+  deadline: 5m
+
+linters-settings:
+  govet:
+    check-shadowing: false
+  gocyclo:
+    min-complexity: 20
+  maligned:
+    suggest-new: true
+  dupl:
+    threshold: 100
+  goconst:
+    min-len: 2
+    min-occurrences: 4
+  cyclop:
+    max-complexity: 15
+  misspell:
+    ignore-words:
+      - ect
+  ireturn:
+    allow:
+      - anon
+      - error
+      - empty
+      - stdlib
+      - (or|er)$
+      - tempFile
+
+linters:
+  enable-all: true
+  disable:
+    - interfacer
+    - gas
+    - megacheck
+    - structcheck
+    - staticcheck
+    - varnamelen
+    - gochecknoglobals
+    - scopelint
+    - funlen
+    - godox
+    - exhaustivestruct
+    - goerr113
+    - wsl
+    - nlreturn
+    - gomnd
+    - paralleltest
+    - wrapcheck
+    - testpackage
+    - golint
+    - maligned
+    - gofumpt
+    - forbidigo
+    - exhaustruct
+    - nonamedreturns
+    - tagliatelle
+    - gomoddirectives
+    - ifshort
+    - ireturn
+    - nosnakecase
+    - deadcode
+    - varcheck
+    - rowserrcheck
+    - sqlclosecheck
+    - wastedassign
+
+issues:
+  exclude-use-default: false
+  max-same-issues: 0

example_test.go

@@ -7,12 +7,14 @@ import (
 	"github.com/multiplay/go-cticker"
 )
 
-// TODO(steve): remove this nolint when go tool vet is fixed.
-// nolint: vet
 func ExampleTicker() {
+	// Create a ticker that ticks on the minute with 1 second accuracy.
 	t := cticker.New(time.Minute, time.Second)
-	for tick := range t.C {
-		// Process tick
-		fmt.Println("tick:", tick)
-	}
+	defer t.Stop()
+
+	<-t.C
+
+	// Process tick
+	fmt.Println("tick")
+	// Output: tick
 }

go.mod

@@ -0,0 +1,11 @@
+module github.com/multiplay/go-cticker
+
+go 1.20
+
+require github.com/stretchr/testify v1.8.3
+
+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,10 @@
+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/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.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
+github.com/stretchr/testify v1.8.3/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=

ticker.go

@@ -84,7 +84,6 @@ func New(d, accuracy time.Duration) *Ticker {
 			t.ticker = newTicker(accuracy)
 			go t.tick(c)
 		}
-
 	}()
 
 	return t

ticker_test.go

@@ -61,7 +61,7 @@ func TestTickerDrift(t *testing.T) {
 	ticks := make([]time.Time, 0, 4)
 	ticks = addTicks(ticks, now, now.Add(time.Minute*3), d, a)
 
-	last := testTicker(t, now, d, a, times, ticks)
+	last := testTicker(t, d, a, times, ticks)
 	now = time.Now()
 	assert.True(t, now.Before(last), fmt.Sprintln(now, "is not before", last))
 }
@@ -79,7 +79,7 @@ func TestTickerAdjustment(t *testing.T) {
 	ticks = append(ticks, now.Truncate(d).Add(d))
 	ticks = addTicks(ticks, summer.Add(d*2), summer.Add(d*4), d, a)
 
-	last := testTicker(t, now, d, a, times, ticks)
+	last := testTicker(t, d, a, times, ticks)
 	now = time.Now()
 	assert.True(t, now.After(last), fmt.Sprintln(now, "is not after", last))
 }
@@ -104,7 +104,7 @@ func TestTickerLostTick(t *testing.T) {
 		}
 	}
 
-	last := testTicker(t, now, d, a, times, ticks)
+	last := testTicker(t, d, a, times, ticks)
 	now = time.Now()
 	assert.True(t, now.Before(last), fmt.Sprintln(now, "is not before", last))
 }
@@ -133,7 +133,9 @@ func addTicks(ticks []time.Time, start, end time.Time, d, a time.Duration) []tim
 	return ticks
 }
 
-func testTicker(t *testing.T, now time.Time, d, a time.Duration, times, ticks []time.Time) time.Time {
+func testTicker(t *testing.T, d, a time.Duration, times, ticks []time.Time) time.Time {
+	t.Helper()
+
 	newTicker = func(d time.Duration) ticker {
 		t := &mockTicker{
 			c:      make(chan time.Time, 4),