added HomeConfigDirProvider

Author: Oppodelldog

README.md

@@ -17,6 +17,7 @@
 		WorkingDirProvider(),
 		ExecutableDirProvider(),
 		EnvVarFilePathProvider(envVarName),
+		HomeConfigDirProvider(".config","myapp"),
 	}
 
 	discovery := filediscovery.New(fileLocationProviders)

providers.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"os/user"
 )
 
 var workingDirProviderFunc = os.Getwd
@@ -52,3 +53,24 @@ func EnvVarFilePathProvider(envVar string) FileLocationProvider {
 		return "", fmt.Errorf("env var '%s' not defined", envVar)
 	}
 }
+
+
+var homeFolderLookupFunc = user.Current
+
+// HomeConfigDirProvider provides the working directory as a possible file location
+func HomeConfigDirProvider(subFolders ...string) FileLocationProvider {
+
+	return func(fileName string) (string, error) {
+		usr, err := homeFolderLookupFunc()
+		if err != nil {
+			return "", err
+		}
+
+		subfoldersPath := ""
+		for _, subfolder := range subFolders {
+			subfoldersPath = path.Join(subfoldersPath, subfolder)
+		}
+
+		return path.Join(usr.HomeDir, subfoldersPath, fileName), nil
+	}
+}

providers_test.go

@@ -9,6 +9,7 @@ import (
 	"errors"
 
 	"github.com/stretchr/testify/assert"
+	"os/user"
 )
 
 func TestWorkingDirProvider(t *testing.T) {
@@ -102,3 +103,36 @@ func TestEnvVarFilePathProvider_error(t *testing.T) {
 	assert.Error(t, err)
 
 }
+
+func TestHomeConfigDirProvider(t *testing.T) {
+	testFileName := "testfile"
+
+	subfolder1 := ".config"
+	subfolder2 := "some-project"
+	provider := HomeConfigDirProvider(subfolder1, subfolder2)
+	result, err := provider(testFileName)
+	if err != nil {
+		t.Fatalf("Did not expect provider to return an error, but got: %v", err)
+	}
+
+	usr, err := user.Current()
+	if err != nil {
+		t.Fatalf("Did not expect user.Current to return an error, but got: %v", err)
+	}
+
+	expectedFilepath := path.Join(usr.HomeDir, subfolder1, subfolder2, testFileName)
+	assert.Equal(t, expectedFilepath, result)
+}
+
+func TestHomeConfigDirProvider_UserLookupReturnsError(t *testing.T) {
+
+	errorStub := errors.New("error-stub")
+	homeFolderLookupFunc = func() (*user.User, error) {
+		return nil, errorStub
+	}
+
+	provider := HomeConfigDirProvider()
+	_, err := provider(testFileName)
+
+	assert.Exactly(t, errorStub, err)
+}