Merge pull request #15 from Code-Hex/add/policy

added policy directory

Author: Code-Hex

README.md

@@ -8,25 +8,25 @@ go-generics-cache is an in-memory key:value store/cache that is suitable for app
 - implemented with [Go Generics](https://go.dev/blog/generics-proposal)
 - TTL supported (with expiration times)
 - Simple cache is like `map[string]interface{}`
-  - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/simple/example_test.go)
+  - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/simple/example_test.go)
 - Cache replacement policies
   - **Least recently used (LRU)**
     - Discards the least recently used items first.
-    - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/lru/example_test.go)
+    - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/lru/example_test.go)
   - **Least-frequently used (LFU)**
     - Counts how often an item is needed. Those that are used least often are discarded first.
     - [An O(1) algorithm for implementing the LFU cache eviction scheme](http://dhruvbird.com/lfu.pdf)
-    - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/lfu/example_test.go)
+    - See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/lfu/example_test.go)
   - **First in first out (FIFO)**
     - Using this algorithm the cache behaves in the same way as a [FIFO queue](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)).
     - The cache evicts the blocks in the order they were added, without any regard to how often or how many times they were accessed before.
-	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/fifo/example_test.go)
+	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/fifo/example_test.go)
   - **Most recently used (MRU)**
     - In contrast to Least Recently Used (LRU), MRU discards the most recently used items first.
-	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/mru/example_test.go)
+	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/mru/example_test.go)
   - **Clock**
     - Clock is a more efficient version of FIFO than Second-chance cache algorithm.
-	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/clock/example_test.go)
+	- See [examples](https://github.com/Code-Hex/go-generics-cache/blob/main/policy/clock/example_test.go)
 
 ## Requirements
 

cache.go

@@ -4,12 +4,12 @@ import (
 	"sync"
 	"time"
 
-	"github.com/Code-Hex/go-generics-cache/clock"
-	"github.com/Code-Hex/go-generics-cache/fifo"
-	"github.com/Code-Hex/go-generics-cache/lfu"
-	"github.com/Code-Hex/go-generics-cache/lru"
-	"github.com/Code-Hex/go-generics-cache/mru"
-	"github.com/Code-Hex/go-generics-cache/simple"
+	"github.com/Code-Hex/go-generics-cache/policy/clock"
+	"github.com/Code-Hex/go-generics-cache/policy/fifo"
+	"github.com/Code-Hex/go-generics-cache/policy/lfu"
+	"github.com/Code-Hex/go-generics-cache/policy/lru"
+	"github.com/Code-Hex/go-generics-cache/policy/mru"
+	"github.com/Code-Hex/go-generics-cache/policy/simple"
 )
 
 // Interface is a common-cache interface.

example_test.go

@@ -20,7 +20,7 @@ func ExampleCache() {
 	// 0 false
 }
 
-func ExampleCacheAsClock() {
+func ExampleAsClock() {
 	// use clock cache algorithm.
 	c := cache.New(cache.AsClock[string, int]())
 	c.Set("a", 1)
@@ -33,7 +33,7 @@ func ExampleCacheAsClock() {
 	// 0 false
 }
 
-func ExampleCacheWithExpiration() {
+func ExampleWithExpiration() {
 	c := cache.New(cache.AsFIFO[string, int]())
 	exp := 250 * time.Millisecond
 	c.Set("a", 1, cache.WithExpiration(exp))
@@ -58,7 +58,7 @@ func ExampleCacheWithExpiration() {
 	// 0 false
 }
 
-func ExampleDelete() {
+func ExampleCache_Delete() {
 	c := cache.New(cache.AsMRU[string, int]())
 	c.Set("a", 1)
 	c.Delete("a")
@@ -68,7 +68,7 @@ func ExampleDelete() {
 	// 0 false
 }
 
-func ExampleKeys() {
+func ExampleCache_Keys() {
 	c := cache.New(cache.AsLFU[string, int]())
 	c.Set("a", 1)
 	c.Set("b", 1)
@@ -78,7 +78,7 @@ func ExampleKeys() {
 	// [a b c]
 }
 
-func ExampleContains() {
+func ExampleCache_Contains() {
 	c := cache.New(cache.AsLRU[string, int]())
 	c.Set("a", 1)
 	fmt.Println(c.Contains("a"))
@@ -88,7 +88,7 @@ func ExampleContains() {
 	// false
 }
 
-func ExampleNumberCache() {
+func ExampleNewNumber() {
 	nc := cache.NewNumber[string, int]()
 	nc.Set("a", 1)
 	nc.Set("b", 2, cache.WithExpiration(time.Minute))

clock/clock.go renamed to policy/clock/clock.go

@@ -4,7 +4,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/Code-Hex/go-generics-cache/clock"
+	"github.com/Code-Hex/go-generics-cache/policy/clock"
 )
 
 func TestSet(t *testing.T) {

clock/clock_test.go renamed to policy/clock/clock_test.go

@@ -3,10 +3,10 @@ package clock_test
 import (
 	"fmt"
 
-	"github.com/Code-Hex/go-generics-cache/clock"
+	"github.com/Code-Hex/go-generics-cache/policy/clock"
 )
 
-func ExampleCache() {
+func ExampleNewCache() {
 	c := clock.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
@@ -33,7 +33,7 @@ func ExampleCache() {
 	// 3
 }
 
-func ExampleCacheKeys() {
+func ExampleCache_Keys() {
 	c := clock.NewCache[string, int]()
 	c.Set("foo", 1)
 	c.Set("bar", 2)

clock/example_test.go renamed to policy/clock/example_test.go

@@ -3,10 +3,10 @@ package fifo_test
 import (
 	"fmt"
 
-	"github.com/Code-Hex/go-generics-cache/fifo"
+	"github.com/Code-Hex/go-generics-cache/policy/fifo"
 )
 
-func ExampleCache() {
+func ExampleNewCache() {
 	c := fifo.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
@@ -33,7 +33,7 @@ func ExampleCache() {
 	// 3
 }
 
-func ExampleCacheKeys() {
+func ExampleCache_Keys() {
 	c := fifo.NewCache[string, int]()
 	c.Set("foo", 1)
 	c.Set("bar", 2)

fifo/example_test.go renamed to policy/fifo/example_test.go

@@ -4,7 +4,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/Code-Hex/go-generics-cache/fifo"
+	"github.com/Code-Hex/go-generics-cache/policy/fifo"
 )
 
 func TestSet(t *testing.T) {

fifo/fifo.go renamed to policy/fifo/fifo.go

@@ -3,10 +3,10 @@ package lfu_test
 import (
 	"fmt"
 
-	"github.com/Code-Hex/go-generics-cache/lfu"
+	"github.com/Code-Hex/go-generics-cache/policy/lfu"
 )
 
-func ExampleLFUCache() {
+func ExampleNewCache() {
 	c := lfu.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)
@@ -22,7 +22,7 @@ func ExampleLFUCache() {
 	// 0 false
 }
 
-func ExampleCacheKeys() {
+func ExampleCache_Keys() {
 	c := lfu.NewCache[string, int]()
 	c.Set("a", 1)
 	c.Set("b", 2)