extend cache (#10)

Author: markus621

cache/cache.go

@@ -6,7 +6,10 @@
 package cache
 
 import (
+	"iter"
 	"sync"
+
+	"go.osspkg.com/random"
 )
 
 type (
@@ -57,6 +60,20 @@ func (v *_cache[K, V]) Get(key K) (V, bool) {
 	return item, true
 }
 
+func (v *_cache[K, V]) One() (key K, val V, ok bool) {
+	keys := v._keys(30)
+	if len(keys) == 0 {
+		return
+	}
+
+	random.Shuffle(keys)
+
+	key = keys[0]
+	val, ok = v.Get(key)
+
+	return
+}
+
 func (v *_cache[K, V]) Extract(key K) (V, bool) {
 	v.mux.Lock()
 	defer v.mux.Unlock()
@@ -94,12 +111,21 @@ func (v *_cache[K, V]) Del(key K) {
 }
 
 func (v *_cache[K, V]) Keys() []K {
+	return v._keys(v.Size())
+}
+
+func (v *_cache[K, V]) _keys(limit int) []K {
 	v.mux.RLock()
 	defer v.mux.RUnlock()
 
-	result := make([]K, 0, len(v.list))
+	i := 0
+	result := make([]K, 0, limit)
 	for k := range v.list {
 		result = append(result, k)
+		i++
+		if i >= limit {
+			break
+		}
 	}
 
 	return result
@@ -113,3 +139,21 @@ func (v *_cache[K, V]) Flush() {
 		delete(v.list, k)
 	}
 }
+
+func (v *_cache[K, V]) Yield(limit int) iter.Seq2[K, V] {
+	if limit < 1 {
+		limit = v.Size()
+	}
+
+	keys := v._keys(limit)
+
+	return func(yield func(K, V) bool) {
+		for _, key := range keys {
+			if val, ok := v.Get(key); ok {
+				if !yield(key, val) {
+					return
+				}
+			}
+		}
+	}
+}

cache/cache_test.go

@@ -7,6 +7,7 @@ package cache_test
 
 import (
 	"context"
+	"fmt"
 	"testing"
 	"time"
 
@@ -78,6 +79,31 @@ func TestUnit_OptTimeClean(t *testing.T) {
 	casecheck.False(t, c.Has("foo"))
 }
 
+func TestUnit_Yield(t *testing.T) {
+	c := cache.New[string, int64]()
+
+	c.Set("foo1", 1)
+	c.Set("foo2", 2)
+	casecheck.True(t, c.Has("foo1"))
+	casecheck.True(t, c.Has("foo2"))
+
+	for k, v := range c.Yield(0) {
+		fmt.Println(k, v)
+	}
+
+	list := map[string]int{}
+	for i := 0; i < 10; i++ {
+		k, _, ok := c.One()
+		casecheck.True(t, ok)
+		list[k] += 1
+	}
+	casecheck.Equal(t, 2, len(list))
+
+	for k, v := range list {
+		fmt.Println(k, v)
+	}
+}
+
 func TestUnit_OptCountRandomClean(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
@@ -122,3 +148,20 @@ func Benchmark_New(b *testing.B) {
 		}
 	})
 }
+
+func Benchmark_One(b *testing.B) {
+	c := cache.New[int, int]()
+
+	for i := 0; i < 200; i++ {
+		c.Set(i, i)
+	}
+
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	b.RunParallel(func(pb *testing.PB) {
+		for pb.Next() {
+			c.One()
+		}
+	})
+}

cache/options.go

@@ -21,25 +21,14 @@ func OptTimeClean[K comparable, V Timestamp](ctx context.Context, interval time.
 			Calls: []routine.TickFunc{
 				func(ctx context.Context, t time.Time) {
 					curr := t.Unix()
-					keys := make([]K, 0, 10)
-
-					v.mux.RLock()
-					for key, value := range v.list {
-						if value.Timestamp() < curr {
-							keys = append(keys, key)
-						}
-					}
-					v.mux.RUnlock()
-
-					if len(keys) == 0 {
-						return
-					}
 
 					v.mux.Lock()
 					defer v.mux.Unlock()
 
-					for _, key := range keys {
-						delete(v.list, key)
+					for key, value := range v.list {
+						if value.Timestamp() < curr {
+							delete(v.list, key)
+						}
 					}
 				},
 			},
@@ -62,24 +51,13 @@ func OptCountRandomClean[K comparable, V any](ctx context.Context, maxCount int,
 			Calls: []routine.TickFunc{
 				func(ctx context.Context, _ time.Time) {
 
-					v.mux.RLock()
-					removeCount := len(v.list) - maxCount
-					v.mux.RUnlock()
-
+					removeCount := v.Size() - maxCount
 					if removeCount <= 0 {
 						return
 					}
 
-					v.mux.Lock()
-					defer v.mux.Unlock()
-
-					for key := range v.list {
-						if removeCount <= 0 {
-							return
-						}
-
-						delete(v.list, key)
-						removeCount--
+					for key := range v.Yield(removeCount) {
+						v.Del(key)
 					}
 				},
 			},

cache/types.go

@@ -5,13 +5,21 @@
 
 package cache
 
+import "iter"
+
 type Cache[K comparable, V any] interface {
-	Has(key K) bool
-	Get(key K) (V, bool)
-	Extract(key K) (V, bool)
-	Set(key K, value V)
-	Replace(data map[K]V)
-	Del(key K)
+	Has(K) bool
+	Get(K) (V, bool)
+	//Yield if limit <=0 then got all elements for range
+	Yield(limit int) iter.Seq2[K, V]
+	//Extract getting element and delete form cache
+	Extract(K) (V, bool)
+	//One getting one random key-value element
+	One() (K, V, bool)
+	Set(K, V)
+	//Replace replace all elements
+	Replace(map[K]V)
+	Del(K)
 	Keys() []K
 	Size() int
 	Flush()

go.mod

@@ -1,11 +1,12 @@
 module go.osspkg.com/ioutils
 
-go 1.24.0
+go 1.24.6
 
 require (
 	github.com/BurntSushi/toml v1.5.0
 	go.osspkg.com/casecheck v0.3.0
 	go.osspkg.com/errors v0.3.1
+	go.osspkg.com/random v0.5.0
 	go.osspkg.com/routine v0.4.0
 	go.osspkg.com/syncing v0.4.0
 	gopkg.in/yaml.v3 v3.0.1

go.sum

@@ -4,6 +4,8 @@ go.osspkg.com/casecheck v0.3.0 h1:x15blEszElbrHrEH5H02JIIhGIg/lGZzIt1kQlD3pwM=
 go.osspkg.com/casecheck v0.3.0/go.mod h1:TRFXDMFJEOtnlp3ET2Hix3osbxwPWhvaiT/HfD3+gBA=
 go.osspkg.com/errors v0.3.1 h1:F9m/EEd/Ot2jba/TV7tvVRIpWXzIpNLc7vRJKcBD86A=
 go.osspkg.com/errors v0.3.1/go.mod h1:dKXe6Rt07nzY7OyKQNZ8HGBicZ2uQ5TKEoVFnVFOK44=
+go.osspkg.com/random v0.5.0 h1:6x2CQ5Vb6PVyuGi6Ao3K6Pr2fzVviBPCEEJC5HQNSmg=
+go.osspkg.com/random v0.5.0/go.mod h1:lsg3FI87PQdjhVWIVo2GXyPBclipljUxjMlWqRl2cck=
 go.osspkg.com/routine v0.4.0 h1:fEDOI3BTaM/rt5pYT+qPq4gFxvw8WJVY2jMeczB7F9A=
 go.osspkg.com/routine v0.4.0/go.mod h1:HUVnPHLFzNCYEGOqUiQWL+av73aFJ6H57XutFxhA+eU=
 go.osspkg.com/syncing v0.4.0 h1:9ytMfGHd6Ew69D2n/1syj0FTujNfb1KBiUSZ+KsMTqk=