Added Cache interface, added docs.

Author: lpusok

oldcache/cache.go

@@ -3,41 +3,52 @@ package oldcache
 import (
 	"strings"
 
+	"github.com/bitrise-io/go-steputils/v2/stepenv"
 	"github.com/bitrise-io/go-utils/v2/env"
 )
 
-// CacheIncludePathsEnvKey ...
+// CacheIncludePathsEnvKey's value is a newline separated list of paths that should be included in the cache.
 const CacheIncludePathsEnvKey = "BITRISE_CACHE_INCLUDE_PATHS"
 
-// CacheExcludePathsEnvKey ...
+// CacheExcludePathsEnvKey's value is a newline separated list of paths that should be excluded from the cache.
 const CacheExcludePathsEnvKey = "BITRISE_CACHE_EXCLUDE_PATHS"
 
-// Cache ...
-type Cache struct {
+// Cache is an interface for managing cache paths.
+type Cache interface {
+	IncludePath(item ...string)
+	ExcludePath(item ...string)
+	Commit() error
+}
+
+type cache struct {
 	envRepository env.Repository
 
 	include []string
 	exclude []string
 }
 
-// New ...
+// NewDefault creates a new Cache instance that set envs using envman.
+func NewDefault() Cache {
+	return New(stepenv.NewRepository(env.NewRepository()))
+}
+
+// New creates a new Cache instance with a custom env.Repository.
 func New(envRepository env.Repository) Cache {
-	// defaultConfig := Config{NewOSVariableGetter(), []VariableSetter{NewOSVariableSetter(), NewEnvmanVariableSetter()}}
-	return Cache{envRepository: envRepository}
+	return &cache{envRepository: envRepository}
 }
 
-// IncludePath ...
-func (cache *Cache) IncludePath(item ...string) {
+// IncludePath appends paths to the cache include list.
+func (cache *cache) IncludePath(item ...string) {
 	cache.include = append(cache.include, item...)
 }
 
-// ExcludePath ...
-func (cache *Cache) ExcludePath(item ...string) {
+// ExcludePath appends paths to the cache exclude list.
+func (cache *cache) ExcludePath(item ...string) {
 	cache.exclude = append(cache.exclude, item...)
 }
 
-// Commit ...
-func (cache *Cache) Commit() error {
+// Commit writes paths to environment variables (also exported by envman when using stepenv.Repository).
+func (cache *cache) Commit() error {
 	commitCachePath := func(key string, values []string) error {
 		content := cache.envRepository.Get(key)
 		if content != "" {

oldcache/cache_test.go

@@ -7,7 +7,6 @@ import (
 	"testing"
 
 	cache "github.com/bitrise-io/go-steputils/v2/oldcache"
-	"github.com/bitrise-io/go-steputils/v2/stepenv"
 	"github.com/bitrise-io/go-utils/v2/command"
 	"github.com/bitrise-io/go-utils/v2/env"
 	"github.com/bitrise-io/go-utils/v2/fileutil"
@@ -75,7 +74,6 @@ const testThirdCommitIgnoreEnvVarContent = `/*.log
 func TestCacheFunctions(t *testing.T) {
 	filemanager := fileutil.NewFileManager()
 	pathmodifier := pathutil.NewPathModifier()
-	cacheEnvRepository := stepenv.NewRepository(env.NewRepository())
 
 	t.Log("Init envman")
 	{
@@ -102,7 +100,7 @@ func TestCacheFunctions(t *testing.T) {
 
 	t.Log("Test - cache")
 	{
-		c := cache.New(cacheEnvRepository)
+		c := cache.NewDefault()
 		c.IncludePath("/tmp/mypath -> /tmp/mypath/cachefile")
 		c.IncludePath("/tmp/otherpath")
 		c.IncludePath("/tmp/anotherpath")
@@ -122,12 +120,12 @@ func TestCacheFunctions(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, testIgnoreEnvVarContent, content)
 
-		c = cache.New(cacheEnvRepository)
+		c = cache.NewDefault()
 		c.ExcludePath("/*.lock")
 		err = c.Commit()
 		require.NoError(t, err)
 
-		c = cache.New(cacheEnvRepository)
+		c = cache.NewDefault()
 		c.ExcludePath("/*.lock")
 		err = c.Commit()
 		require.NoError(t, err)