combine interface and common tests, add comments

README.md

@@ -18,6 +18,7 @@ Main features:
 - Limit maximum size of a value 
 - Limit number of keys
 - TTL support (`ExpirableCache` only)
+- Callback on eviction event
 - Functional style invalidation
 - Functional options
 - Sane defaults

interface.go → cache.go

@@ -1,3 +1,9 @@
+// Package lcw adds a thin layer on top of lru cache and go-cache providing more limits and common interface.
+// The primary method to get (and set) data to/from the cache is LoadingCache.Get retruning stored data for a given key or
+// call provided func to retrive and store, similar to Guava loading cache.
+// Limits allow max values for key size, number of keys, value size and total size of values in the cache.
+// CacheStat gives general stats on cache performance.
+// 3 flavours of cache provided - NoP (do-nothing cache), ExpirableCache (TTL based), and LruCache
 package lcw
 
 import "fmt"

cache_test.go

@@ -14,6 +14,48 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+func TestNop_Get(t *testing.T) {
+	var coldCalls int32
+	var c LoadingCache = NewNopCache()
+	res, err := c.Get("key1", func() (Value, error) {
+		atomic.AddInt32(&coldCalls, 1)
+		return "result", nil
+	})
+	assert.Nil(t, err)
+	assert.Equal(t, "result", res.(string))
+	assert.Equal(t, int32(1), atomic.LoadInt32(&coldCalls))
+
+	res, err = c.Get("key1", func() (Value, error) {
+		atomic.AddInt32(&coldCalls, 1)
+		return "result2", nil
+	})
+	assert.Nil(t, err)
+	assert.Equal(t, "result2", res.(string))
+	assert.Equal(t, int32(2), atomic.LoadInt32(&coldCalls))
+
+	assert.Equal(t, CacheStat{}, c.Stat())
+}
+
+func TestNop_Peek(t *testing.T) {
+	var coldCalls int32
+	c := NewNopCache()
+	res, err := c.Get("key1", func() (Value, error) {
+		atomic.AddInt32(&coldCalls, 1)
+		return "result", nil
+	})
+	assert.Nil(t, err)
+	assert.Equal(t, "result", res.(string))
+	assert.Equal(t, int32(1), atomic.LoadInt32(&coldCalls))
+
+	_, ok := c.Peek("key1")
+	assert.False(t, ok)
+}
+
+func TestStat_String(t *testing.T) {
+	s := CacheStat{Keys: 100, Hits: 60, Misses: 10, Size: 12345, Errors: 5}
+	assert.Equal(t, "{hits:60, misses:10, ratio:85.7%, keys:100, size:12345, errors:5}", s.String())
+}
+
 func TestCache_Get(t *testing.T) {
 
 	caches := cachesTestList(t)