Merge pull request #160 from eko/public-options

Make store options publicly available

store/bigcache.go

@@ -26,7 +26,7 @@ const (
 // BigcacheStore is a store for Bigcache
 type BigcacheStore struct {
 	client  BigcacheClientInterface
-	options *options
+	options *Options
 }
 
 // NewBigcache creates a new store to Bigcache instance(s)

store/bigcache_test.go

@@ -23,7 +23,7 @@ func TestNewBigcache(t *testing.T) {
 	// Then
 	assert.IsType(t, new(BigcacheStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, new(options), store.options)
+	assert.Equal(t, new(Options), store.options)
 }
 
 func TestBigcacheGet(t *testing.T) {

store/freecache.go

@@ -30,7 +30,7 @@ type FreecacheClientInterface interface {
 // FreecacheStore is a store for freecache
 type FreecacheStore struct {
 	client  FreecacheClientInterface
-	options *options
+	options *Options
 }
 
 // NewFreecache creates a new store to freecache instance(s)

store/freecache_test.go

@@ -24,7 +24,7 @@ func TestNewFreecache(t *testing.T) {
 	// Then
 	assert.IsType(t, new(FreecacheStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, &options{
+	assert.Equal(t, &Options{
 		expiration: 6 * time.Second,
 	}, store.options)
 }
@@ -41,7 +41,7 @@ func TestNewFreecacheDefaultOptions(t *testing.T) {
 	// Then
 	assert.IsType(t, new(FreecacheStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, new(options), store.options)
+	assert.Equal(t, new(Options), store.options)
 }
 
 func TestFreecacheGet(t *testing.T) {

store/go_cache.go

@@ -28,7 +28,7 @@ type GoCacheClientInterface interface {
 type GoCacheStore struct {
 	mu      sync.RWMutex
 	client  GoCacheClientInterface
-	options *options
+	options *Options
 }
 
 // NewGoCache creates a new store to GoCache (memory) library instance

store/go_cache_test.go

@@ -23,7 +23,7 @@ func TestNewGoCache(t *testing.T) {
 	// Then
 	assert.IsType(t, new(GoCacheStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, &options{cost: 8}, store.options)
+	assert.Equal(t, &Options{cost: 8}, store.options)
 }
 
 func TestGoCacheGet(t *testing.T) {

store/memcache.go

@@ -34,7 +34,7 @@ const (
 // MemcacheStore is a store for Memcache
 type MemcacheStore struct {
 	client  MemcacheClientInterface
-	options *options
+	options *Options
 }
 
 // NewMemcache creates a new store to Memcache instance(s)

store/memcache_test.go

@@ -24,7 +24,7 @@ func TestNewMemcache(t *testing.T) {
 	// Then
 	assert.IsType(t, new(MemcacheStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, &options{expiration: 3 * time.Second}, store.options)
+	assert.Equal(t, &Options{expiration: 3 * time.Second}, store.options)
 }
 
 func TestMemcacheGet(t *testing.T) {

store/options.go

@@ -5,19 +5,19 @@ import (
 )
 
 // Options represents a store option function.
-type Option func(o *options)
+type Option func(o *Options)
 
-type options struct {
+type Options struct {
 	cost       int64
 	expiration time.Duration
 	tags       []string
 }
 
-func (o *options) isEmpty() bool {
+func (o *Options) isEmpty() bool {
 	return o.cost == 0 && o.expiration == 0 && len(o.tags) == 0
 }
 
-func applyOptionsWithDefault(defaultOptions *options, opts ...Option) *options {
+func applyOptionsWithDefault(defaultOptions *Options, opts ...Option) *Options {
 	returnedOptions := applyOptions(opts...)
 
 	if returnedOptions.isEmpty() {
@@ -27,8 +27,8 @@ func applyOptionsWithDefault(defaultOptions *options, opts ...Option) *options {
 	return returnedOptions
 }
 
-func applyOptions(opts ...Option) *options {
-	o := &options{}
+func applyOptions(opts ...Option) *Options {
+	o := &Options{}
 
 	for _, opt := range opts {
 		opt(o)
@@ -40,21 +40,21 @@ func applyOptions(opts ...Option) *options {
 // WithCost allows setting the memory capacity used by the item when setting a value.
 // Actually it seems to be used by Ristretto library only.
 func WithCost(cost int64) Option {
-	return func(o *options) {
+	return func(o *Options) {
 		o.cost = cost
 	}
 }
 
 // WithExpiration allows to specify an expiration time when setting a value.
 func WithExpiration(expiration time.Duration) Option {
-	return func(o *options) {
+	return func(o *Options) {
 		o.expiration = expiration
 	}
 }
 
 // WithTags allows to specify associated tags to the current value.
 func WithTags(tags []string) Option {
-	return func(o *options) {
+	return func(o *Options) {
 		o.tags = tags
 	}
 }

store/options_test.go

@@ -9,7 +9,7 @@ import (
 
 func TestOptionsCostValue(t *testing.T) {
 	// Given
-	options := &options{
+	options := &Options{
 		cost: 7,
 	}
 
@@ -19,7 +19,7 @@ func TestOptionsCostValue(t *testing.T) {
 
 func TestOptionsExpirationValue(t *testing.T) {
 	// Given
-	options := &options{
+	options := &Options{
 		expiration: 25 * time.Second,
 	}
 
@@ -29,7 +29,7 @@ func TestOptionsExpirationValue(t *testing.T) {
 
 func TestOptionsTagsValue(t *testing.T) {
 	// Given
-	options := &options{
+	options := &Options{
 		tags: []string{"tag1", "tag2", "tag3"},
 	}
 

store/options_test_matchers.go

@@ -16,7 +16,7 @@ type OptionsMatcher struct {
 func (m OptionsMatcher) Matches(x interface{}) bool {
 	switch values := x.(type) {
 	case []Option:
-		opts := &options{}
+		opts := &Options{}
 		for _, value := range values {
 			value(opts)
 		}

store/pegasus.go

@@ -31,7 +31,7 @@ var empty = []byte("-")
 
 // OptionsPegasus is options of Pegasus
 type OptionsPegasus struct {
-	*options
+	*Options
 	MetaServers []string
 
 	TableName         string

store/redis.go

@@ -30,7 +30,7 @@ const (
 // RedisStore is a store for Redis
 type RedisStore struct {
 	client  RedisClientInterface
-	options *options
+	options *Options
 }
 
 // NewRedis creates a new store to Redis instance(s)

store/redis_test.go

@@ -23,7 +23,7 @@ func TestNewRedis(t *testing.T) {
 	// Then
 	assert.IsType(t, new(RedisStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, &options{expiration: 6 * time.Second}, store.options)
+	assert.Equal(t, &Options{expiration: 6 * time.Second}, store.options)
 }
 
 func TestRedisGet(t *testing.T) {

store/rediscluster.go

@@ -30,7 +30,7 @@ const (
 // RedisStore is a store for Redis
 type RedisClusterStore struct {
 	clusclient RedisClusterClientInterface
-	options    *options
+	options    *Options
 }
 
 // NewRedis creates a new store to Redis instance(s)

store/rediscluster_test.go

@@ -23,7 +23,7 @@ func TestNewRedisCluster(t *testing.T) {
 	// Then
 	assert.IsType(t, new(RedisClusterStore), store)
 	assert.Equal(t, client, store.clusclient)
-	assert.Equal(t, &options{expiration: 6 * time.Second}, store.options)
+	assert.Equal(t, &Options{expiration: 6 * time.Second}, store.options)
 }
 
 func TestRedisClusterGet(t *testing.T) {

store/ristretto.go

@@ -26,7 +26,7 @@ type RistrettoClientInterface interface {
 // RistrettoStore is a store for Ristretto (memory) library
 type RistrettoStore struct {
 	client  RistrettoClientInterface
-	options *options
+	options *Options
 }
 
 // NewRistretto creates a new store to Ristretto (memory) library instance

store/ristretto_test.go

@@ -23,7 +23,7 @@ func TestNewRistretto(t *testing.T) {
 	// Then
 	assert.IsType(t, new(RistrettoStore), store)
 	assert.Equal(t, client, store.client)
-	assert.Equal(t, &options{cost: 8}, store.options)
+	assert.Equal(t, &Options{cost: 8}, store.options)
 }
 
 func TestRistrettoGet(t *testing.T) {