add v3 compatible with simplelru

v2 had most of the required functions, so this change adds missing ones
to satisfy the simplelru interface.

To do that, RemoveOldest started returning parameters, unlike being void
as before.

Also, GetExpiration is added.

.github/workflows/ci-v2.yml

@@ -18,13 +18,13 @@ jobs:
 
     steps:
       - name: set up go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@5
         with:
           go-version: "1.20"
         id: go
 
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@4
 
       - name: build and test
         run: |
@@ -33,7 +33,7 @@ jobs:
         working-directory: v2
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: latest
           working-directory: v2

.github/workflows/ci-v3.yml

@@ -0,0 +1,47 @@
+name: build-v3
+
+on:
+  push:
+    branches:
+    tags:
+    paths:
+      - ".github/workflows/ci-v3.yml"
+      - "v3/**"
+  pull_request:
+    paths:
+      - ".github/workflows/ci-v3.yml"
+      - "v3/**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: set up go
+        uses: actions/setup-go@5
+        with:
+          go-version: "1.20"
+        id: go
+
+      - name: checkout
+        uses: actions/checkout@4
+
+      - name: build and test
+        run: |
+          go test -timeout=60s -race -covermode=atomic -coverprofile=$GITHUB_WORKSPACE/profile.cov
+          go build -race
+        working-directory: v3
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: latest
+          working-directory: v3
+
+      - name: install goveralls, submit coverage
+        run: |
+          go install github.com/mattn/goveralls@latest
+          goveralls -service="github" -coverprofile=$GITHUB_WORKSPACE/profile.cov
+        env:
+          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        working-directory: v3

.github/workflows/ci.yml

@@ -6,33 +6,37 @@ on:
     tags:
     paths-ignore:
       - ".github/workflows/ci-v2.yml"
+      - ".github/workflows/ci-v3.yml"
       - "v2/**"
+      - "v3/**"
   pull_request:
     paths-ignore:
       - ".github/workflows/ci-v2.yml"
+      - ".github/workflows/ci-v3.yml"
       - "v2/**"
+      - "v3/**"
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
       - name: set up go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@5
         with:
           go-version: "1.20"
         id: go
 
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@4
 
       - name: build and test
         run: |
           go test -timeout=60s -race -covermode=atomic -coverprofile=$GITHUB_WORKSPACE/profile.cov
           go build -race
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
           version: latest
 

README.md

@@ -18,7 +18,7 @@ either using LRC or LRU eviction.
 run cache.DeleteExpired periodically using [time.Ticker](https://golang.org/pkg/time/#Ticker),
 advisable period is 1/2 of TTL.
 
-This cache is heavily inspired by [hashicorp/golang-lru](https://github.com/hashicorp/golang-lru) _simplelru_ implementation. Key differences are:
+This cache is heavily inspired by [hashicorp/golang-lru](https://github.com/hashicorp/golang-lru) _simplelru_ implementation. v3 implements `simplelru.LRUCache` interface, so if you use a subset of functions, so you can use all functions except for that interchangeable and switch between this package and `github.com/hashicorp/golang-lru/v2/simplelru` or `github.com/hashicorp/golang-lru/v2/expirable` without any changes in your code. Key differences are:
 
 - Support LRC (Least Recently Created) in addition to LRU and TTL-based eviction
 - Supports per-key TTL setting

v3/.golangci.yml

@@ -0,0 +1,44 @@
+linters-settings:
+  govet:
+    check-shadowing: true
+  gocyclo:
+    min-complexity: 15
+  misspell:
+    locale: US
+  gocritic:
+    enabled-tags:
+      - performance
+      - style
+      - experimental
+    disabled-checks:
+      - wrapperFunc
+
+linters:
+  enable:
+    - gocritic
+    - megacheck
+    - revive
+    - govet
+    - unconvert
+    - megacheck
+    - gas
+    - gocyclo
+    - dupl
+    - misspell
+    - unused
+    - typecheck
+    - ineffassign
+    - stylecheck
+    - gochecknoinits
+    - exportloopref
+    - nakedret
+    - gosimple
+    - prealloc
+  fast: false
+  disable-all: true
+
+run:
+  output:
+    format: tab
+  skip-dirs:
+    - vendor