feat: search-project-with-client config

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
+}
+
+// IsSearchProjectWithClientName 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/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/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
 				}
 			}

pkg/cmd/task/list/list_test.go

@@ -63,6 +63,7 @@ func TestCmdList(t *testing.T) {
 				f.On("Config").Return(cf)
 
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(false)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -111,6 +112,7 @@ func TestCmdList(t *testing.T) {
 				f.On("Config").Return(cf)
 
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(false)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)

pkg/cmd/task/quick-add/quick-add.go

@@ -61,7 +61,8 @@ func NewCmdQuickAdd(
 
 			p, _ := cmd.Flags().GetString("project")
 			if f.Config().IsAllowNameForID() {
-				if p, err = search.GetProjectByName(c, w, p, ""); err != nil {
+				if p, err = search.GetProjectByName(
+					c, f.Config(), w, p, ""); err != nil {
 					return err
 				}
 			}

pkg/cmd/task/util/read-flags.go

@@ -79,7 +79,7 @@ func TaskReadFlags(cmd *cobra.Command, f cmdutil.Factory) (p FlagsDTO, err error
 		}
 
 		if p.ProjectID, err = search.GetProjectByName(
-			c, p.Workspace, p.ProjectID, ""); err != nil {
+			c, f.Config(), p.Workspace, p.ProjectID, ""); err != nil {
 			return p, err
 		}
 

pkg/cmd/time-entry/in/in_test.go

@@ -223,6 +223,31 @@ func TestNewCmdIn_ShouldLookupProject_WithAndWithoutClient(t *testing.T) {
 				"No project with id or name containing 'notonclient' " +
 					"was found for client 'me'"),
 		},
+		{
+			name: "project with client name does not exist",
+			args: []string{"-s=08:00", "-p", "notonclient me"},
+			err: errors.New(
+				"No project with id or name containing 'notonclient me' " +
+					"was found"),
+		},
+		{
+			name: "project and client's name",
+			args: []string{"-s=08:00", "-p", "second me"},
+			param: api.CreateTimeEntryParam{
+				Workspace: w.ID,
+				Start:     defaultStart,
+				ProjectID: projects[1].ID,
+			},
+		},
+		{
+			name: "project and client's name (other)",
+			args: []string{"-s=08:00", "-p=second clockify"},
+			param: api.CreateTimeEntryParam{
+				Workspace: w.ID,
+				Start:     defaultStart,
+				ProjectID: projects[2].ID,
+			},
+		},
 	}
 
 	for i := range tts {
@@ -235,7 +260,8 @@ func TestNewCmdIn_ShouldLookupProject_WithAndWithoutClient(t *testing.T) {
 			f.EXPECT().GetWorkspaceID().Return(w.ID, nil)
 
 			f.EXPECT().Config().Return(&mocks.SimpleConfig{
-				AllowNameForID: true,
+				AllowNameForID:               true,
+				SearchProjectWithClientsName: true,
 			})
 
 			c := mocks.NewMockClient(t)

pkg/cmd/time-entry/report/util/report.go

@@ -112,9 +112,10 @@ func ReportWithRange(
 		return err
 	}
 
+	cnf := f.Config()
 	if rf.Project != "" && f.Config().IsAllowNameForID() {
 		if rf.Project, err = search.GetProjectByName(
-			c, workspace, rf.Project, rf.Client); err != nil {
+			c, cnf, workspace, rf.Project, rf.Client); err != nil {
 			return err
 		}
 	}
@@ -171,7 +172,7 @@ func ReportWithRange(
 	}
 
 	return util.PrintTimeEntries(
-		log, out, f.Config(), rf.OutputFlags)
+		log, out, cnf, rf.OutputFlags)
 }
 
 func filterBilling(l []dto.TimeEntry, billable bool) []dto.TimeEntry {

pkg/cmd/time-entry/report/util/reportwithrange_test.go

@@ -117,6 +117,7 @@ func TestReportWithRange(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(false)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -174,6 +175,7 @@ func TestReportWithRange(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(false)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)
@@ -210,6 +212,7 @@ func TestReportWithRange(t *testing.T) {
 				cf := mocks.NewMockConfig(t)
 				f.On("Config").Return(cf)
 				cf.On("IsAllowNameForID").Return(true)
+				cf.On("IsSearchProjectWithClientsName").Return(false)
 
 				c := mocks.NewMockClient(t)
 				f.On("Client").Return(c, nil)