fix(#117): support for XDG_CONFIG_HOME environment variable

Author: mk-5

.github/workflows/tests.yml

@@ -18,7 +18,8 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
       - uses: actions/checkout@v3
-      - run: | 
+      - run: |
+          export XDG_CONFIG_HOME=""
           go test  -coverprofile=coverage.out -coverpkg=./... -covermode=count ./internal/... 
           COVERAGE=$(go tool cover -func=coverage.out | grep total | awk '{print substr($3, 1, length($3)-1)}')
           echo "Total coverage: $COVERAGE"

internal/app/colors.go

@@ -24,8 +24,8 @@ func Color(c string) tcell.Color {
 }
 
 func MustLoadColorScheme() map[string]interface{} {
-	d := os2.MustGetUserHomeDir()
-	p := fmt.Sprintf("%s/.fjira/colors.yml", d)
+	d := os2.MustGetFjiraHomeDir()
+	p := fmt.Sprintf("%s/colors.yml", d)
 	b, err := os.ReadFile(p)
 	if err != nil {
 		schemeMap = parseYMLStr(defaultColorsYML())

internal/fjira/install.go

@@ -29,10 +29,6 @@ var (
 )
 
 func Install(workspace string) (*workspaces.WorkspaceSettings, error) {
-	// it will be removed after a few version
-	u := workspaces.NewDeprecatedUserHomeWorkspaces()
-	_ = u.MigrateFromGlobWorkspacesToYaml()
-
 	err := validateWorkspaceName(workspace)
 	if err != nil {
 		return nil, err

internal/os/user_home_dir.go

@@ -1,6 +1,7 @@
 package os
 
 import (
+	"fmt"
 	"os"
 	"runtime"
 )
@@ -18,13 +19,30 @@ func SetUserHomeDir(dir string) error {
 }
 
 func MustGetUserHomeDir() string {
-	xdx := os.Getenv("XDX_CONFIG_HOME")
-	if xdx != "" {
-		return xdx
-	}
 	dir, err := os.UserHomeDir()
 	if err != nil {
 		panic(err)
 	}
 	return dir
 }
+
+func MustGetFjiraHomeDir() string {
+	dir := MustGetUserHomeDir()
+	userHomeDir := fmt.Sprintf("%s/.fjira", dir)
+	xdg := os.Getenv("XDG_CONFIG_HOME")
+	xdgDir := fmt.Sprintf("%s/fjira", xdg)
+	if xdg != "" && dirExist(xdgDir) {
+		return xdgDir
+	}
+	if xdg != "" && !dirExist(userHomeDir) {
+		return xdgDir
+	}
+	return userHomeDir
+}
+
+func dirExist(path string) bool {
+	if stat, err := os.Stat(path); err == nil && stat.IsDir() {
+		return true
+	}
+	return false
+}

internal/os/user_home_dir_test.go

@@ -9,15 +9,53 @@ func TestMustGetUserHomeDir_xdxPath(t *testing.T) {
 	tests := []struct {
 		name string
 	}{
-		{"should return XDX path if available"},
+		{"should return XDG path if available"},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			_ = os.Setenv("XDX_CONFIG_HOME", "abc")
-			if got := MustGetUserHomeDir(); got != "abc" {
+			_ = os.Setenv("XDG_CONFIG_HOME", "abc")
+			_ = SetUserHomeDir("something_for_just_for_test")
+			if got := MustGetFjiraHomeDir(); got != "abc/fjira" {
 				t.Errorf("MustGetUserHomeDir() = %v, want %v", got, "abc")
 			}
-			_ = os.Setenv("XDX_CONFIG_HOME", "")
+			_ = os.Setenv("XDG_CONFIG_HOME", "")
+		})
+	}
+}
+
+func TestMustGetUserHomeDir_userHomeWhenExist(t *testing.T) {
+	tests := []struct {
+		name string
+	}{
+		{"should return userHome when exist, and XDG doesn't"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_ = os.Setenv("XDG_CONFIG_HOME", "abc")
+			_ = SetUserHomeDir("./something_for_just_for_test")
+			_ = os.MkdirAll("./something_for_just_for_test/.fjira", 0750)
+			if got := MustGetFjiraHomeDir(); got != "./something_for_just_for_test/.fjira" {
+				t.Errorf("MustGetUserHomeDir() = %v, want %v", got, "abc")
+			}
+			_ = os.Setenv("XDG_CONFIG_HOME", "")
+			_ = os.RemoveAll("./something_for_just_for_test")
+		})
+	}
+}
+
+func TestMustGetUserHomeDir_homePath(t *testing.T) {
+	tests := []struct {
+		name string
+	}{
+		{"should return HOME path if available"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_ = SetUserHomeDir("user_home")
+			if got := MustGetFjiraHomeDir(); got != "user_home/.fjira" {
+				t.Errorf("MustGetUserHomeDir() = %v, want %v", got, "abc")
+			}
+			_ = os.Setenv("HOME", "")
 		})
 	}
 }

internal/workspaces/settings.go

@@ -149,8 +149,7 @@ func (s *userHomeSettingsStorage) ReadAllWorkspaces() ([]string, error) {
 }
 
 func (s *userHomeSettingsStorage) ConfigDir() (string, error) {
-	userHomeDir := os2.MustGetUserHomeDir()
-	configDir := fmt.Sprintf("%s/.fjira", userHomeDir)
+	configDir := os2.MustGetFjiraHomeDir()
 	if _, err := os.Stat(configDir); errors.Is(err, os.ErrNotExist) {
 		err := os.Mkdir(configDir, os.ModePerm)
 		if err != nil {