Added more details in types.go...

Author: jnbdz

location/README.md

@@ -0,0 +1,3 @@
+# Location 📍
+Is a service to get all the absolute path of system directory paths and application paths.
+

location/location.go

@@ -14,7 +14,9 @@ type ILocation interface {
 	TmpMain() (string, error)
 	MakePaths(paths AbsPaths) error*/
 }
-type SLocation struct{}
+type SLocation struct {
+	paths *Paths
+}
 
 //const perm os.FileMode = os.ModePerm
 

location/service.go

@@ -1,7 +1,75 @@
 package location
 
+import (
+	"path/filepath"
+
+	"github.com/adrg/xdg"
+)
+
 // NewLocationService to set up the location service
-func NewLocationService() ILocation {
+//
+// Params:
+// - 📇 appName - Is the of the application (normally all lowercase)
+// - ♻️ version - The version of the application
+func NewLocationService(appName, version string) ILocation {
+	sysPaths := &System{
+		Home:            xdg.Home,
+		DataHome:        xdg.DataHome,
+		DataDirs:        xdg.DataDirs,
+		ConfigHome:      xdg.ConfigHome,
+		ConfigDirs:      xdg.ConfigDirs,
+		StateHome:       xdg.StateHome,
+		CacheHome:       xdg.CacheHome,
+		RuntimeDir:      xdg.RuntimeDir,
+		BinHome:         xdg.BinHome,
+		UserDirs:        xdg.UserDirs,
+		FontDirs:        xdg.FontDirs,
+		ApplicationDirs: xdg.ApplicationDirs,
+	}
+
+	// TODO: What happens when there is no path set
+	// TODO: There needs to be a check for each of these paths... Maybe use `mkdir -p`
+	if sysPaths.DataHome == "" {
+	}
+
+	if sysPaths.ConfigHome == "" {
+	}
+
+	if sysPaths.StateHome == "" {
+	}
+
+	if sysPaths.CacheHome == "" {
+	}
+
+	if sysPaths.RuntimeDir == "" {
+	}
+
+	if sysPaths.BinHome == "" {
+	}
+
+	appDataHome := filepath.Join(sysPaths.DataHome, appName)
+	appConfigHome := filepath.Join(sysPaths.ConfigHome, appName)
+	appStateHome := filepath.Join(sysPaths.StateHome, appName)
+	appCacheHome := filepath.Join(sysPaths.CacheHome, appName)
+	appRuntimeDir := filepath.Join(sysPaths.RuntimeDir, appName)
+	appBinHome := filepath.Join(sysPaths.BinHome, appName)
+
+	// TODO: Validate them
 
-	return &SLocation{}
+	return &SLocation{
+		paths: &Paths{
+			SystemPaths: sysPaths,
+			ThisApplicationPaths: &Application{
+				Name: appName,
+				Paths: &ApplicationPaths{
+					DataHome:   appDataHome,
+					ConfigHome: appConfigHome,
+					StateHome:  appStateHome,
+					CacheHome:  appCacheHome,
+					RuntimeDir: appRuntimeDir,
+					BinHome:    appBinHome,
+				},
+			},
+		},
+	}
 }

location/service_test.go

@@ -1 +1,14 @@
 package location
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestNewLocationService(t *testing.T) {
+	t.Run("should return a new instance of Location", func(t *testing.T) {
+		service := NewLocationService()
+		assert.NotNil(t, service)
+		assert.IsType(t, &SLocation{}, service)
+	})
+}

location/types.go

@@ -1,14 +1,17 @@
 package location
 
 import (
-	"github.com/AmadlaOrg/LibraryUtils/env"
 	"github.com/adrg/xdg"
 )
 
-const (
-	HeryStoragePath = env.HeryStoragePath
-)
+// Paths contains all the paths
+type Paths struct {
+	SystemPaths          *System
+	ThisApplicationPaths *Application
+	Applications         *[]Application
+}
 
+// System contains the system directories paths
 type System struct {
 	// Home contains the path of the user's home directory.
 	Home string
@@ -84,13 +87,40 @@ type System struct {
 	ApplicationDirs []string
 }
 
-type Amadla struct {
-	Storage    string // e.g.: /home/user/.hery/
+// AmadlaPaths contains all the amadla root paths since all the amadla
+// TODO: Might remove
+type AmadlaPaths struct {
+	/*Storage    string // e.g.: /home/user/.hery/
 	Catalog    string // e.g.: /home/user/.hery/collection/
 	Collection string // e.g.: /home/user/.hery/collection/amadla/
 	Entities   string // e.g.: /home/user/.hery/collection/amadla/entity/
 	Cache      string // e.g.: /home/user/.hery/collection/amadla/amadla.cache
+	*/
 }
 
+// Application contains the specific paths and name/title of an application
 type Application struct {
+	Name  string
+	Paths *ApplicationPaths
+}
+
+// ApplicationPaths contains all the path
+type ApplicationPaths struct {
+	// E.g.: /home/jn/.local/share
+	DataHome string
+
+	// E.g.: /home/jn/.config
+	ConfigHome string
+
+	// E.g.: /home/jn/.local/state
+	StateHome string
+
+	// E.g.: /home/jn/.cache
+	CacheHome string
+
+	// E.g.: /run/user/1000
+	RuntimeDir string
+
+	// E.g.: /home/jn/.local/bin
+	BinHome string
 }