refactor: restructure project and decouple services via interfaces

Author: hurtki

services/StdInputService.go StdInputService.goservices/StdInputService.go renamed to StdInputService.go

@@ -8,11 +8,6 @@ import (
 	"strings"
 )
 
-type InputService interface {
-	AskUser(prompt string, options []string) (string, error)
-	GetPipedInput() (string, bool)
-}
-
 type StdInputService struct {
 	reader io.Reader
 }

cmd/add.go

@@ -5,16 +5,15 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/hurtki/configsManager/services"
 	"github.com/spf13/cobra"
 )
 
 type AddCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	InputService       services.InputService
-	ConfigsListService services.ConfigsListService
-	OsService          services.OsService
+	AppConfigService   AppConfigService
+	InputService       InputService
+	ConfigsListService ConfigsListService
+	OsService          OsService
 }
 
 func (c *AddCmd) run(cmd *cobra.Command, args []string) error {
@@ -125,10 +124,10 @@ func (c *AddCmd) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func NewAddCmd(AppConfigService services.AppConfigService,
-	InputService services.InputService,
-	ConfigsListService services.ConfigsListService,
-	OsService services.OsService,
+func NewAddCmd(AppConfigService AppConfigService,
+	InputService InputService,
+	ConfigsListService ConfigsListService,
+	OsService OsService,
 ) *AddCmd {
 	addCmd := AddCmd{
 		AppConfigService:   AppConfigService,

cmd/cat.go

@@ -2,15 +2,15 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/hurtki/configsManager/services"
+
 	"github.com/spf13/cobra"
 )
 
 type CatCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	ConfigsListService services.ConfigsListService
-	OsService          services.OsService
+	AppConfigService   AppConfigService
+	ConfigsListService ConfigsListService
+	OsService          OsService
 }
 
 // catCmd represents the cat command
@@ -38,9 +38,9 @@ func (c *CatCmd) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func NewCatCmd(AppConfig services.AppConfigService,
-	ConfigsListService services.ConfigsListService,
-	OsService services.OsService,
+func NewCatCmd(AppConfig AppConfigService,
+	ConfigsListService ConfigsListService,
+	OsService OsService,
 ) *CatCmd {
 	catCmd := CatCmd{
 		AppConfigService:   AppConfig,
@@ -51,13 +51,13 @@ func NewCatCmd(AppConfig services.AppConfigService,
 	cmd := &cobra.Command{
 		Use:   "cat [key]",
 		Short: "Print the content of the config file for a given key",
-		Long: `The 'cat' command fetches and displays the full content of the configuration file 
+		Long: `The 'cat' command fetches and displays the full content of the configuration file
 	associated with the specified key from the user's saved configs list.
 
 	Usage example:
 	cm cat myconfig
 
-	This command is useful when you want to quickly inspect the contents of a configuration 
+	This command is useful when you want to quickly inspect the contents of a configuration
 	file without opening it in an editor.`,
 		RunE: catCmd.run,
 	}

cmd/init.go

@@ -2,14 +2,15 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/hurtki/configsManager/services"
+
+	"github.com/hurtki/configsManager/internal/services"
 	"github.com/spf13/cobra"
 )
 
 type InitCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	ConfigsListService services.ConfigsListService
+	AppConfigService   AppConfigService
+	ConfigsListService ConfigsListService
 }
 
 func (c *InitCmd) run(cmd *cobra.Command, args []string) error {
@@ -37,8 +38,8 @@ func (c *InitCmd) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func NewInitCmd(AppConfig services.AppConfigService,
-	ConfigsListService services.ConfigsListService,
+func NewInitCmd(AppConfig AppConfigService,
+	ConfigsListService ConfigsListService,
 ) InitCmd {
 	InitCmd := InitCmd{
 		AppConfigService:   AppConfig,
@@ -48,10 +49,10 @@ func NewInitCmd(AppConfig services.AppConfigService,
 	cmd := &cobra.Command{
 		Use:   "init",
 		Short: "Initializes anapp folder",
-		Long: `The 'init' command initializes the configuration management folder structure 
+		Long: `The 'init' command initializes the configuration management folder structure
 and creates default configuration files if they do not exist.
 
-This is the first command that should be run before using other commands 
+This is the first command that should be run before using other commands
 like 'add', 'open', or 'edit', since it sets up the required files and directories.
 
 Usage example:

cmd/interfaces.go

@@ -0,0 +1,32 @@
+package cmd
+
+import (
+	"github.com/hurtki/configsManager/internal/config"
+	"github.com/hurtki/configsManager/internal/domain"
+)
+
+type AppConfigService interface {
+	Load() (*config.AppConfig, error)
+	Save(*config.AppConfig) error
+}
+
+type ConfigsListService interface {
+	Load() (*domain.ConfigsList, error)
+	Save(*domain.ConfigsList) error
+	GenerateUniqueKeyForPath(path string) (string, error)
+}
+
+type OsService interface {
+	GetFileData(path string) ([]byte, error)
+	OpenInEditor(editor, path string) error
+	FileExists(path string) (bool, error)
+	GetAbsolutePath(path string) (string, error)
+	MakePathAndFile(path string) error
+	WriteFile(path string, data []byte) error
+	GetHomeDir() (string, error)
+}
+
+type InputService interface {
+	AskUser(prompt string, options []string) (string, error)
+	GetPipedInput() (string, bool)
+}

cmd/keys.go

@@ -2,14 +2,14 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/hurtki/configsManager/services"
+
 	"github.com/spf13/cobra"
 )
 
 type KeysCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	ConfigsListService services.ConfigsListService
+	AppConfigService   AppConfigService
+	ConfigsListService ConfigsListService
 }
 
 func (c *KeysCmd) run(cmd *cobra.Command, args []string) error {
@@ -26,8 +26,8 @@ func (c *KeysCmd) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func NewKeysCmd(AppConfig services.AppConfigService,
-	ConfigsListService services.ConfigsListService,
+func NewKeysCmd(AppConfig AppConfigService,
+	ConfigsListService ConfigsListService,
 ) KeysCmd {
 	keysCmd := KeysCmd{
 		AppConfigService:   AppConfig,
@@ -37,13 +37,13 @@ func NewKeysCmd(AppConfig services.AppConfigService,
 	cmd := &cobra.Command{
 		Use:   "keys",
 		Short: "List all configuration keys",
-		Long: `The 'keys' command outputs all available configuration keys stored 
+		Long: `The 'keys' command outputs all available configuration keys stored
 		in the user's configuration list.
 
 		Usage example:
 		cm keys
 
-		This command is useful to quickly see what configuration entries exist 
+		This command is useful to quickly see what configuration entries exist
 		and can be accessed or managed with other commands.`,
 		RunE: keysCmd.run,
 	}

cmd/open.go

@@ -3,15 +3,14 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/hurtki/configsManager/services"
 	"github.com/spf13/cobra"
 )
 
 type OpenCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	OsService          services.OsService
-	ConfigsListService services.ConfigsListService
+	AppConfigService   AppConfigService
+	OsService          OsService
+	ConfigsListService ConfigsListService
 }
 
 func (c *OpenCmd) run(cmd *cobra.Command, args []string) error {
@@ -33,9 +32,9 @@ func (c *OpenCmd) run(cmd *cobra.Command, args []string) error {
 	return c.OsService.OpenInEditor(*editor, path)
 }
 
-func NewOpenCmd(AppConfig services.AppConfigService,
-	ConfigsListService services.ConfigsListService,
-	OsService services.OsService,
+func NewOpenCmd(AppConfig AppConfigService,
+	ConfigsListService ConfigsListService,
+	OsService OsService,
 ) OpenCmd {
 	openCmd := OpenCmd{
 		AppConfigService:   AppConfig,
@@ -46,15 +45,15 @@ func NewOpenCmd(AppConfig services.AppConfigService,
 	cmd := &cobra.Command{
 		Use:   "open [filename]",
 		Short: "Opens a config by name",
-		Long: `The 'open' command launches the default text editor specified in the application configuration 
+		Long: `The 'open' command launches the default text editor specified in the application configuration
 		to open the configuration file associated with the provided key.
 
 		This is useful for quickly editing or viewing the content of config files without manually locating them.
 
 		Usage example:
 		cm open myconfig
 
-		This command will open the file linked to 'myconfig' in the configured editor, 
+		This command will open the file linked to 'myconfig' in the configured editor,
 		you can configure it in app config by running 'cm open cm_config'`,
 		RunE: openCmd.run,
 	}

cmd/path.go

@@ -2,14 +2,13 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/hurtki/configsManager/services"
+
 	"github.com/spf13/cobra"
 )
 
 type PathCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	ConfigsListService services.ConfigsListService
+	ConfigsListService ConfigsListService
 }
 
 func (c *PathCmd) run(cmd *cobra.Command, args []string) error {
@@ -29,23 +28,22 @@ func (c *PathCmd) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func NewPathCmd(AppConfig services.AppConfigService, ConfigsListService services.ConfigsListService) PathCmd {
+func NewPathCmd(ConfigsListService ConfigsListService) PathCmd {
 	pathCmd := PathCmd{
-		AppConfigService:   AppConfig,
 		ConfigsListService: ConfigsListService,
 	}
 
 	cmd := &cobra.Command{
 		Use:   "path [key]",
 		Short: "Retrieve the file path associated with a configuration key",
-		Long: `The 'path' command fetches the absolute file path stored under the given configuration key 
+		Long: `The 'path' command fetches the absolute file path stored under the given configuration key
 from the user's saved configuration list.
 
 Usage examples:
   cm path myconfig      # Prints the file path associated with "myconfig"
   cm path cm_config     # Prints the default configManager config path
 
-This command helps you quickly locate configuration files by their keys, making management easier 
+This command helps you quickly locate configuration files by their keys, making management easier
 and more efficient.`,
 		RunE: pathCmd.run,
 	}

cmd/rm.go

@@ -2,14 +2,13 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/hurtki/configsManager/services"
 	"github.com/spf13/cobra"
 )
 
 type RmCmd struct {
 	Command            *cobra.Command
-	AppConfigService   services.AppConfigService
-	ConfigsListService services.ConfigsListService
+	AppConfigService   AppConfigService
+	ConfigsListService ConfigsListService
 }
 
 func (c *RmCmd) run(cmd *cobra.Command, args []string) error {
@@ -30,7 +29,7 @@ func (c *RmCmd) run(cmd *cobra.Command, args []string) error {
 
 }
 
-func NewRmCmd(AppConfig services.AppConfigService, ConfigsListService services.ConfigsListService) RmCmd {
+func NewRmCmd(AppConfig AppConfigService, ConfigsListService ConfigsListService) RmCmd {
 	rmCmd := RmCmd{
 		AppConfigService:   AppConfig,
 		ConfigsListService: ConfigsListService,

cmd/root.go

@@ -1,16 +1,15 @@
 package cmd
 
 import (
-	"github.com/hurtki/configsManager/services"
-	syncServices "github.com/hurtki/configsManager/services/sync"
+	sync_cmd "github.com/hurtki/configsManager/cmd/sync"
 	"github.com/spf13/cobra"
 )
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "cm",
 	Short: "A CLI tool to manage configuration file paths by keys",
-	Long: `ConfigManager is a simple and efficient CLI application that helps you 
+	Long: `ConfigManager is a simple and efficient CLI application that helps you
 manage your configuration files by associating keys with file paths.
 
 With configManager, you can:
@@ -43,18 +42,18 @@ func init() {
 	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }
 
-func NewRootCmd(AppConfigService services.AppConfigService,
-	InputService services.InputService,
-	ConfigsListService services.ConfigsListService,
-	OsService services.OsService,
-	SyncService syncServices.SyncService,
+func NewRootCmd(AppConfigService AppConfigService,
+	InputService InputService,
+	ConfigsListService ConfigsListService,
+	OsService OsService,
+	SyncService sync_cmd.SyncService,
 ) *cobra.Command {
 	// creating commands with dependencies
 	addCmd := NewAddCmd(AppConfigService, InputService, ConfigsListService, OsService)
 	catCmd := NewCatCmd(AppConfigService, ConfigsListService, OsService)
 	keysCmd := NewKeysCmd(AppConfigService, ConfigsListService)
 	openCmd := NewOpenCmd(AppConfigService, ConfigsListService, OsService)
-	pathCmd := NewPathCmd(AppConfigService, ConfigsListService)
+	pathCmd := NewPathCmd(ConfigsListService)
 	rmCmd := NewRmCmd(AppConfigService, ConfigsListService)
 	initCmd := NewInitCmd(AppConfigService, ConfigsListService)
 	syncCmd := NewSyncCmd(AppConfigService, ConfigsListService, OsService, SyncService)