add test cover rate

Author: lixizan

README.md

@@ -1,6 +1,14 @@
 # memorycache
 
-[![Build Status](https://github.com/lxzan/memorycache/workflows/Go%20Test/badge.svg?branch=main)](https://github.com/lxzan/memorycache/actions?query=branch%3Amain)
+[![Build Status][1]][2] [![codecov][3]][4]
+
+[1]: https://github.com/lxzan/memorycache/workflows/Go%20Test/badge.svg?branch=main
+
+[2]: https://github.com/lxzan/memorycache/actions?query=branch%3Amain
+
+[3]: https://codecov.io/gh/lxzan/memorycache/graph/badge.svg?token=OHD6918OPT
+
+[4]: https://codecov.io/gh/lxzan/memorycache
 
 ### Usage
 ```go
@@ -14,25 +22,35 @@ import (
 
 func main() {
 	mc := memorycache.New(
-		memorycache.WithSegment(16),
-		memorycache.WithTTLCheckInterval(100*time.Millisecond),
+		memorycache.WithBucketNum(16),
+		memorycache.WithBucketSize(1000, 100000),
+		memorycache.WithInterval(100*time.Millisecond),
 	)
+
 	mc.Set("xxx", 1, 500*time.Millisecond)
-	time.Sleep(time.Second)
+
 	val, exist := mc.Get("xxx")
 	fmt.Printf("val=%v, exist=%v\n", val, exist)
+
+	time.Sleep(time.Second)
+
+	val, exist = mc.Get("xxx")
+	fmt.Printf("val=%v, exist=%v\n", val, exist)
 }
 ```
 
 ### Benchmark
-- 10,000 elements, 2 threads
+- 10,000 elements
+- 1,000,000 elements
 ```
+go test -benchmem -run=^$ -bench . github.com/lxzan/memorycache/benchmark
 goos: darwin
 goarch: arm64
 pkg: github.com/lxzan/memorycache/benchmark
-BenchmarkSet
-BenchmarkSet-8   	     727	   1589200 ns/op
-BenchmarkGet
-BenchmarkGet-8   	    2191	    530433 ns/op
+BenchmarkSet/10000-8            13830640                87.25 ns/op            0 B/op          0 allocs/op
+BenchmarkSet/1000000-8           3615801               326.6 ns/op            58 B/op          0 allocs/op
+BenchmarkGet/10000-8            14347058                82.28 ns/op            0 B/op          0 allocs/op
+BenchmarkGet/1000000-8           3899768               262.6 ns/op            54 B/op          0 allocs/op
 PASS
+ok      github.com/lxzan/memorycache/benchmark  13.037s
 ```

index.go

@@ -15,7 +15,7 @@ type MemoryCache struct {
 	storage []*bucket
 }
 
-// New 创建缓存数据库
+// New 创建缓存数据库实例
 func New(options ...Option) *MemoryCache {
 	var config = &types.Config{}
 	options = append(options, withInitialize())
@@ -50,7 +50,7 @@ func New(options ...Option) *MemoryCache {
 }
 
 func (c *MemoryCache) getBucket(key string) *bucket {
-	var idx = utils.NewFnv32(key) & (c.config.BucketNum - 1)
+	var idx = utils.Fnv32(key) & (c.config.BucketNum - 1)
 	return c.storage[idx]
 }
 
@@ -62,7 +62,7 @@ func (c *MemoryCache) getExp(d time.Duration) int64 {
 	return time.Now().Add(d).UnixMilli()
 }
 
-// 设置键值和过期时间. exp<=0表示永不过期.
+// Set 设置键值和过期时间. exp<=0表示永不过期.
 func (c *MemoryCache) Set(key string, value any, exp time.Duration) (replaced bool) {
 	var b = c.getBucket(key)
 	b.Lock()
@@ -116,7 +116,7 @@ func (c *MemoryCache) GetAndRefresh(key string, exp time.Duration) (any, bool) {
 	return v, true
 }
 
-// 删除一个键
+// Delete 删除一个键
 func (c *MemoryCache) Delete(key string) (deleted bool) {
 	var b = c.getBucket(key)
 	b.Lock()
@@ -132,7 +132,7 @@ func (c *MemoryCache) Delete(key string) (deleted bool) {
 	return true
 }
 
-// 获取前缀匹配的key
+// Keys 获取前缀匹配的key, 星号匹配所有
 func (c *MemoryCache) Keys(prefix string) []string {
 	var arr = make([]string, 0)
 	var now = time.Now().UnixMilli()
@@ -148,7 +148,7 @@ func (c *MemoryCache) Keys(prefix string) []string {
 	return arr
 }
 
-// 获取有效元素个数
+// Len 获取有效元素(未过期)数量
 func (c *MemoryCache) Len() int {
 	var num = 0
 	var now = time.Now().UnixMilli()
@@ -181,7 +181,7 @@ func (c *bucket) expireTimeCheck(maxNum int, maxCap int) {
 		delete(c.Map, c.Heap.Pop().Key)
 		num++
 	}
-	for c.Heap.Len() > maxNum && num < maxNum {
+	for c.Heap.Len() > maxCap && num < maxNum {
 		delete(c.Map, c.Heap.Pop().Key)
 		num++
 	}

index_test.go

@@ -152,3 +152,17 @@ func TestMemoryCache_Delete(t *testing.T) {
 	}
 	assert.Equal(t, mc.Len(), count-100)
 }
+
+func TestMaxCap(t *testing.T) {
+	var mc = New(
+		WithBucketNum(1),
+		WithBucketSize(10, 100),
+		WithInterval(100*time.Millisecond),
+	)
+	for i := 0; i < 1000; i++ {
+		key := string(utils.AlphabetNumeric.Generate(8))
+		mc.Set(key, 1, -1)
+	}
+	time.Sleep(200 * time.Millisecond)
+	assert.Equal(t, mc.Len(), 100)
+}

internal/utils/hash.go

@@ -5,9 +5,8 @@ const (
 	prime32  = 16777619
 )
 
-// NewFnv32 returns a new 32-bit FNV-1 hash.Hash.
-// Its Sum method will lay the value out in big-endian byte order.
-func NewFnv32(s string) uint32 {
+// Fnv32 returns a new 32-bit FNV-1 hash.Hash.
+func Fnv32(s string) uint32 {
 	var hash uint32 = offset32
 	for _, c := range s {
 		hash *= prime32

internal/utils/helper.go

@@ -1,28 +1,9 @@
 package utils
 
-import (
-	"sort"
-)
-
 type Integer interface {
 	int | int64 | int32 | uint | uint64 | uint32
 }
 
-func SameStrings(arr1, arr2 []string) bool {
-	sort.Strings(arr1)
-	sort.Strings(arr2)
-	var n = len(arr1)
-	if n != len(arr2) {
-		return false
-	}
-	for i := 0; i < n; i++ {
-		if arr1[i] != arr2[i] {
-			return false
-		}
-	}
-	return true
-}
-
 func ToBinaryNumber[T Integer](n T) T {
 	var x T = 1
 	for x < n {

internal/utils/helper_test.go

@@ -0,0 +1,34 @@
+package utils
+
+import (
+	"github.com/stretchr/testify/assert"
+	"hash/fnv"
+	"testing"
+)
+
+func TestNewFnv32(t *testing.T) {
+	for i := 0; i < 10; i++ {
+		key := AlphabetNumeric.Generate(16)
+		h := fnv.New32()
+		h.Write(key)
+		assert.Equal(t, h.Sum32(), Fnv32(string(key)))
+	}
+}
+
+func TestToBinaryNumber(t *testing.T) {
+	assert.Equal(t, 8, ToBinaryNumber(7))
+	assert.Equal(t, 1, ToBinaryNumber(0))
+	assert.Equal(t, 128, ToBinaryNumber(120))
+	assert.Equal(t, 1024, ToBinaryNumber(1024))
+}
+
+func TestUniq(t *testing.T) {
+	assert.ElementsMatch(t, Uniq([]int{1, 3, 5, 7, 7, 9}), []int{1, 3, 5, 7, 9})
+	assert.ElementsMatch(t, Uniq([]string{"ming", "ming", "shi"}), []string{"ming", "shi"})
+}
+
+func TestRandomString(t *testing.T) {
+	assert.Less(t, Numeric.Intn(10), 10)
+	Numeric.Uint32()
+	Numeric.Uint64()
+}

options.go

@@ -23,14 +23,14 @@ func WithBucketNum(num uint32) Option {
 	}
 }
 
-// WithMaxKeysDeleted 设置单个存储桶每次TTL检查最大删除key数量
+// WithMaxKeysDeleted (单个存储桶)设置每次TTL检查最大删除key数量
 func WithMaxKeysDeleted(num int) Option {
 	return func(c *types.Config) {
 		c.MaxKeysDeleted = num
 	}
 }
 
-// WithBucketSize 设置单个存储桶的初始化大小, 最大容量
+// WithBucketSize (单个存储桶)设置初始化大小, 最大容量. 超过最大容量会被定期清除.
 func WithBucketSize(size, cap int) Option {
 	return func(c *types.Config) {
 		c.InitialSize = size