Merge pull request #5 from Code-Hex/fix/signature-new

fixed signature New -> NewCache

Author: Code-Hex

README.md

@@ -45,7 +45,7 @@ import (
 
 func main() {
 	// Create a simple cache. key as string, value as int.
-	simpleCache := simple.New[string, int](simple.WithExpiration(time.Hour))
+	simpleCache := simple.NewCache[string, int](simple.WithExpiration(time.Hour))
 
 	// Create a cache for Number constraint. key as string, value as int.
 	nc := cache.NewNumber[string, int](simpleCache)

cache_test.go

@@ -9,7 +9,7 @@ import (
 )
 
 func TestMultiThreadIncr(t *testing.T) {
-	nc := cache.NewNumber[string, int](simple.New[string, int]())
+	nc := cache.NewNumber[string, int](simple.NewCache[string, int]())
 	nc.Set("counter", 0)
 
 	var wg sync.WaitGroup
@@ -30,7 +30,7 @@ func TestMultiThreadIncr(t *testing.T) {
 }
 
 func TestMultiThreadDecr(t *testing.T) {
-	nc := cache.NewNumber[string, int](simple.New[string, int]())
+	nc := cache.NewNumber[string, int](simple.NewCache[string, int]())
 	nc.Set("counter", 100)
 
 	var wg sync.WaitGroup

example_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func ExampleNumberCache() {
-	c := cache.NewNumber[string, int](simple.New[string, int]())
+	c := cache.NewNumber[string, int](simple.NewCache[string, int]())
 	c.Set("a", 1)
 	c.Set("b", 2)
 	av := c.Increment("a", 1)

lru/example_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func ExampleLRUCache() {
-	c := lru.New[string, int]()
+	c := lru.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
 	av, aok := c.Get("a")
@@ -23,7 +23,7 @@ func ExampleLRUCache() {
 }
 
 func ExampleCacheKeys() {
-	c := lru.New[string, int]()
+	c := lru.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
 	c.Set("c", 3)

lru/lru.go

@@ -22,13 +22,13 @@ type item[K comparable, V any] struct {
 	Value V
 }
 
-// New creates a new LRU cache whose capacity is the default size (128).
-func New[K comparable, V any]() *Cache[K, V] {
-	return NewCap[K, V](128)
+// NewCache creates a new LRU cache whose capacity is the default size (128).
+func NewCache[K comparable, V any]() *Cache[K, V] {
+	return NewCacheWithCap[K, V](128)
 }
 
-// NewCap creates a new LRU cache whose capacity is the specified size.
-func NewCap[K comparable, V any](cap int) *Cache[K, V] {
+// NewCacheWithCap creates a new LRU cache whose capacity is the specified size.
+func NewCacheWithCap[K comparable, V any](cap int) *Cache[K, V] {
 	return &Cache[K, V]{
 		cap:   cap,
 		list:  list.New(),

lru/lru_test.go

@@ -8,7 +8,7 @@ import (
 
 func TestSet(t *testing.T) {
 	// set capacity is 1
-	cache := lru.NewCap[string, int](1)
+	cache := lru.NewCacheWithCap[string, int](1)
 	cache.Set("foo", 1)
 	if got := cache.Len(); got != 1 {
 		t.Fatalf("invalid length: %d", got)
@@ -44,7 +44,7 @@ func TestSet(t *testing.T) {
 }
 
 func TestContains(t *testing.T) {
-	cache := lru.New[string, int]()
+	cache := lru.NewCache[string, int]()
 	cache.Set("foo", 1)
 	cache.Set("bar", 2)
 	cache.Set("baz", 3)
@@ -60,7 +60,7 @@ func TestContains(t *testing.T) {
 }
 
 func TestDelete(t *testing.T) {
-	cache := lru.NewCap[string, int](1)
+	cache := lru.NewCacheWithCap[string, int](1)
 	cache.Set("foo", 1)
 	if got := cache.Len(); got != 1 {
 		t.Fatalf("invalid length: %d", got)

simple/example_test.go

@@ -9,7 +9,7 @@ import (
 )
 
 func ExampleCache() {
-	c := simple.New[string, int](simple.WithExpiration(time.Hour))
+	c := simple.NewCache[string, int](simple.WithExpiration(time.Hour))
 	c.Set("a", 1)
 	c.Set("b", 2)
 	av, aok := c.Get("a")
@@ -25,7 +25,7 @@ func ExampleCache() {
 }
 
 func ExampleCacheKeys() {
-	c := simple.New[string, int]()
+	c := simple.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
 	c.Set("c", 3)

simple/simple.go

@@ -44,8 +44,8 @@ type Cache[K comparable, V any] struct {
 
 var _ cache.Cache[interface{}, any] = (*Cache[interface{}, any])(nil)
 
-// New creates a new cache.
-func New[K comparable, V any](opts ...Option) *Cache[K, V] {
+// NewCache creates a new cache.
+func NewCache[K comparable, V any](opts ...Option) *Cache[K, V] {
 	o := new(options)
 	for _, optFunc := range opts {
 		optFunc(o)

simple/simple_test.go

@@ -59,7 +59,7 @@ func TestHasExpired(t *testing.T) {
 }
 
 func TestGetItemExpired(t *testing.T) {
-	c := New[struct{}, int]()
+	c := NewCache[struct{}, int]()
 	c.SetItem(struct{}{}, &Item[int]{
 		Value:      1,
 		Expiration: time.Hour * 24,