feat: search-project-with-client config (#256)

* feat: search-project-with-client config

* fix: tests

* fix: doc block

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- new config `search-project-with-client` to set whether or not the cli should lookup projects using the
+  client's name too
+
 ## [v0.47.0] - 2024-02-09
 
 ### Added

internal/mocks/simple_config.go

@@ -5,20 +5,27 @@ import "github.com/lucassabreu/clockify-cli/pkg/cmdutil"
 // SimpleConfig is used to set configs for tests were changing the config or
 // accessing them with Get and All is not important
 type SimpleConfig struct {
-	WorkweekDays                []string
-	Interactive                 bool
-	InteractivePageSizeNumber   int
-	AllowNameForID              bool
-	UserID                      string
-	Workspace                   string
-	Token                       string
-	AllowIncomplete             bool
-	ShowTask                    bool
-	DescriptionAutocomplete     bool
-	DescriptionAutocompleteDays int
-	ShowTotalDuration           bool
-	LogLevelValue               string
-	AllowArchivedTags           bool
+	WorkweekDays                 []string
+	Interactive                  bool
+	InteractivePageSizeNumber    int
+	AllowNameForID               bool
+	UserID                       string
+	Workspace                    string
+	Token                        string
+	AllowIncomplete              bool
+	ShowTask                     bool
+	DescriptionAutocomplete      bool
+	DescriptionAutocompleteDays  int
+	ShowTotalDuration            bool
+	LogLevelValue                string
+	AllowArchivedTags            bool
+	SearchProjectWithClientsName bool
+}
+
+// IsSearchProjectWithClientsName defines if the project name for ID should
+// include the client's name
+func (s *SimpleConfig) IsSearchProjectWithClientsName() bool {
+	return s.SearchProjectWithClientsName
 }
 
 // InteractivePageSize sets how many items are shown when prompting

pkg/cmd/config/init/init.go

@@ -95,6 +95,16 @@ func NewCmdInit(f cmdutil.Factory) *cobra.Command {
 				return err
 			}
 
+			if config.IsAllowNameForID() {
+				if err := updateFlag(i, config,
+					cmdutil.CONF_SEARCH_PROJECTS_WITH_CLIENT_NAME,
+					`Should search projects looking into their `+
+						`client's name too?`,
+				); err != nil {
+					return err
+				}
+			}
+
 			if err := updateFlag(i, config, cmdutil.CONF_INTERACTIVE,
 				`Should use "Interactive Mode" by default?`,
 			); err != nil {

pkg/cmd/config/init/init_test.go

@@ -73,7 +73,12 @@ func TestInitCmd(t *testing.T) {
 
 			setStringFn(config, cmdutil.CONF_USER_ID, "user-1")
 
-			setBoolFn(config, cmdutil.CONF_ALLOW_NAME_FOR_ID, false, true)
+			setBoolFn(config, cmdutil.CONF_ALLOW_NAME_FOR_ID, false, true).
+				Run(func(args mock.Arguments) {
+					config.EXPECT().IsAllowNameForID().Return(true)
+				})
+			setBoolFn(config, cmdutil.CONF_SEARCH_PROJECTS_WITH_CLIENT_NAME,
+				false, true)
 			setBoolFn(config, cmdutil.CONF_INTERACTIVE, false, false)
 
 			config.EXPECT().GetInt(cmdutil.CONF_INTERACTIVE_PAGE_SIZE).
@@ -130,6 +135,10 @@ func TestInitCmd(t *testing.T) {
 			c.SendLine("y")
 			c.ExpectString("Yes")
 
+			c.ExpectString("search projects looking into their client's name")
+			c.SendLine("y")
+			c.ExpectString("Yes")
+
 			c.ExpectString("Interactive Mode\" by default?")
 			c.SendLine("n")
 			c.ExpectString("No")

pkg/cmd/project/get/get.go

@@ -63,7 +63,7 @@ func NewCmdGet(
 
 			if f.Config().IsAllowNameForID() {
 				if p.ProjectID, err = search.GetProjectByName(
-					c, p.Workspace, p.ProjectID, ""); err != nil {
+					c, f.Config(), p.Workspace, p.ProjectID, ""); err != nil {
 					return err
 				}
 			}

pkg/cmd/project/get/get_test.go

@@ -124,6 +124,7 @@ func TestCmdGet(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.EXPECT().Config().Return(cf)
 				cf.EXPECT().IsAllowNameForID().Return(true)
+				cf.EXPECT().IsSearchProjectWithClientsName().Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.EXPECT().Client().Return(c, nil)
@@ -155,6 +156,7 @@ func TestCmdGet(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.EXPECT().Config().Return(cf)
 				cf.EXPECT().IsAllowNameForID().Return(true)
+				cf.EXPECT().IsSearchProjectWithClientsName().Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.EXPECT().Client().Return(c, nil)

pkg/cmd/task/add/add_test.go

@@ -85,9 +85,7 @@ func TestCmdAdd(t *testing.T) {
 				f.On("GetWorkspaceID").
 					Return("w", nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(false)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 
 				f.On("Client").Return(nil, errors.New("client error"))
 				return f
@@ -115,9 +113,9 @@ func TestCmdAdd(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -138,9 +136,9 @@ func TestCmdAdd(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -168,9 +166,7 @@ func TestCmdAdd(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(false)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 
 				c.On("AddTask", api.AddTaskParam{
 					Workspace: "w",
@@ -196,9 +192,9 @@ func TestCmdAdd(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -237,9 +233,9 @@ func TestCmdAdd(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",

pkg/cmd/task/delete/delete.go

@@ -70,7 +70,7 @@ func NewCmdDelete(
 
 			if f.Config().IsAllowNameForID() {
 				if project, err = search.GetProjectByName(
-					c, w, project, ""); err != nil {
+					c, f.Config(), w, project, ""); err != nil {
 					return err
 				}
 

pkg/cmd/task/delete/delete_test.go

@@ -74,6 +74,7 @@ func TestCmdDelete(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -96,6 +97,7 @@ func TestCmdDelete(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -124,6 +126,7 @@ func TestCmdDelete(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -162,6 +165,7 @@ func TestCmdDelete(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)

pkg/cmd/task/done/done.go

@@ -88,7 +88,7 @@ func NewCmdDone(
 
 			if f.Config().IsAllowNameForID() {
 				if project, err = search.GetProjectByName(
-					c, workspace, project, ""); err != nil {
+					c, f.Config(), workspace, project, ""); err != nil {
 					return err
 				}
 

pkg/cmd/task/done/done_test.go

@@ -146,6 +146,7 @@ func TestCmdDone(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -178,6 +179,7 @@ func TestCmdDone(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -237,6 +239,7 @@ func TestCmdDone(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(true)
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",

pkg/cmd/task/edit/edit_test.go

@@ -94,9 +94,7 @@ func TestCmdEdit(t *testing.T) {
 				f.On("GetWorkspaceID").
 					Return("w", nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(false)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{})
 
 				f.On("Client").Return(nil, errors.New("client error"))
 				return f
@@ -147,9 +145,9 @@ func TestCmdEdit(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -177,9 +175,9 @@ func TestCmdEdit(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -239,9 +237,9 @@ func TestCmdEdit(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",
@@ -290,9 +288,9 @@ func TestCmdEdit(t *testing.T) {
 					Return("w", nil)
 				f.On("Client").Return(c, nil)
 
-				cf := mocks.NewMockConfig(t)
-				f.On("Config").Return(cf)
-				cf.On("IsAllowNameForID").Return(true)
+				f.EXPECT().Config().Return(&mocks.SimpleConfig{
+					AllowNameForID: true,
+				})
 
 				c.On("GetProjects", api.GetProjectsParam{
 					Workspace:       "w",

pkg/cmd/task/list/list.go

@@ -63,7 +63,7 @@ func NewCmdList(
 			if f.Config().IsAllowNameForID() &&
 				p.ProjectID != "" {
 				if p.ProjectID, err = search.GetProjectByName(
-					c, workspace, p.ProjectID, ""); err != nil {
+					c, f.Config(), workspace, p.ProjectID, ""); err != nil {
 					return err
 				}
 			}