Support generics (#3)

* quick POC for generic implementation * disable non-1.18 compat linters * fix Example * embed options into Cache interface Co-authored-by: Dmitry Verkhoturov <[email protected]>
go-pkgz · Sep 3, 2022 · a198afa · a198afa
1 parent e9d36b6
commit a198afa
Show file tree

Hide file tree

Showing 10 changed files with 664 additions and 14 deletions.
diff --git a/.github/workflows/ci-v2.yml b/.github/workflows/ci-v2.yml
@@ -0,0 +1,48 @@
+name: build-v2
+
+on:
+  push:
+    branches:
+    tags:
+    paths:
+      - ".github/workflows/ci-v2.yml"
+      - "v2/**"
+  pull_request:
+    paths:
+      - ".github/workflows/ci-v2.yml"
+      - "v2/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: set up go 1.18
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.18
+        id: go
+
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: build and test
+        run: |
+          go test -timeout=60s -race -covermode=atomic -coverprofile=$GITHUB_WORKSPACE/profile.cov
+          go build -race
+        working-directory: v2
+
+      - name: install golangci-lint and goveralls
+        run: |
+          curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $GITHUB_WORKSPACE v1.46.2
+          GO111MODULE=off go get -u -v github.com/mattn/goveralls
+
+      - name: run linters
+        run: $GITHUB_WORKSPACE/golangci-lint run --out-format=github-actions
+        working-directory: v2
+
+      - name: submit coverage
+        run: $(go env GOPATH)/bin/goveralls -service="github" -coverprofile=$GITHUB_WORKSPACE/profile.cov
+        env:
+          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        working-directory: v2
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,17 +4,23 @@ on:
   push:
     branches:
     tags:
+    paths-ignore:
+      - ".github/workflows/ci-v2.yml"
+      - "v2/**"
   pull_request:
+    paths-ignore:
+      - ".github/workflows/ci-v2.yml"
+      - "v2/**"
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      - name: set up go 1.14
-        uses: actions/setup-go@v1
+      - name: set up go 1.18
+        uses: actions/setup-go@v2
         with:
-          go-version: 1.14
+          go-version: 1.18
         id: go
 
       - name: checkout
@@ -27,7 +33,7 @@ jobs:
 
       - name: install golangci-lint and goveralls
         run: |
-          curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $GITHUB_WORKSPACE v1.25.0
+          curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $GITHUB_WORKSPACE v1.46.2
           GO111MODULE=off go get -u -v github.com/mattn/goveralls
 
       - name: run linters

diff --git a/.golangci.yml b/.golangci.yml
@@ -1,8 +1,6 @@
 linters-settings:
   govet:
     check-shadowing: true
-  golint:
-    min-confidence: 0
   gocyclo:
     min-complexity: 15
   maligned:
@@ -25,7 +23,7 @@ linters-settings:
 linters:
   enable:
     - megacheck
-    - golint
+    - revive
     - govet
     - unconvert
     - megacheck
@@ -42,7 +40,7 @@ linters:
     - varcheck
     - stylecheck
     - gochecknoinits
-    - scopelint
+    - exportloopref
     - gocritic
     - nakedret
     - gosimple
@@ -57,8 +55,4 @@ run:
     - vendor
 
 issues:
-  exclude-rules:
-    - text: "should have a package comment, unless it's in another file for this package"
-      linters:
-        - golint
   exclude-use-default: false
diff --git a/README.md b/README.md
@@ -29,12 +29,12 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/go-pkgz/expirable-cache"
+	"github.com/go-pkgz/expirable-cache/v2"
 )
 
 func main() {
 	// make cache with short TTL and 3 max keys
-	c, _ := cache.NewCache(cache.MaxKeys(3), cache.TTL(time.Millisecond*10))
+	c := cache.NewCache[string, string]().WithMaxKeys(3).WithTTL(time.Millisecond * 10)
 
 	// set value under key1.
 	// with 0 ttl (last parameter) will use cache-wide setting instead (10ms).

diff --git a/v2/.golangci.yml b/v2/.golangci.yml
@@ -0,0 +1,64 @@
+linters-settings:
+  govet:
+    check-shadowing: true
+  golint:
+    min-confidence: 0
+  gocyclo:
+    min-complexity: 15
+  maligned:
+    suggest-new: true
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  misspell:
+    locale: US
+  lll:
+    line-length: 140
+  gocritic:
+    enabled-tags:
+      - performance
+      - style
+      - experimental
+    disabled-checks:
+      - wrapperFunc
+
+linters:
+  enable:
+    - megacheck
+    - revive
+    - govet
+    - unconvert
+    - megacheck
+    #- structcheck
+    - gas
+    - gocyclo
+    - dupl
+    - misspell
+    #- unparam
+    - varcheck
+    - deadcode
+    - typecheck
+    - ineffassign
+    - varcheck
+    - stylecheck
+    - gochecknoinits
+    - exportloopref
+    #- gocritic
+    - nakedret
+    - gosimple
+    - prealloc
+  fast: false
+  disable-all: true
+
+run:
+  output:
+    format: tab
+  skip-dirs:
+    - vendor
+
+issues:
+  exclude-rules:
+    - text: "should have a package comment, unless it's in another file for this package"
+      linters:
+        - golint
+  exclude-use-default: false