Added not-sub-project filter

- redesigned sub-project filter

Author: Kharonus

cmd/list/work_packages.go

@@ -2,17 +2,17 @@ package list
 
 import (
 	"fmt"
-	"github.com/opf/openproject-cli/components/requests"
-	"github.com/opf/openproject-cli/components/resources"
-	"github.com/opf/openproject-cli/components/resources/work_packages/filters"
 	"os"
 	"regexp"
 	"strconv"
 
 	"github.com/opf/openproject-cli/components/common"
 	"github.com/opf/openproject-cli/components/printer"
+	"github.com/opf/openproject-cli/components/requests"
+	"github.com/opf/openproject-cli/components/resources"
 	"github.com/opf/openproject-cli/components/resources/projects"
 	"github.com/opf/openproject-cli/components/resources/work_packages"
+	"github.com/opf/openproject-cli/components/resources/work_packages/filters"
 	"github.com/opf/openproject-cli/models"
 	"github.com/spf13/cobra"
 )
@@ -24,10 +24,11 @@ var showTotal bool
 var statusFilter string
 var typeFilter string
 var includeSubProjects bool
-var subProject string
 
-var activeFilters = []resources.Filter{
-	filters.NewTimestampFilter(),
+var activeFilters = map[string]resources.Filter{
+	"timestamp":     filters.NewTimestampFilter(),
+	"subProject":    filters.NewSubProjectFilter(),
+	"notSubProject": filters.NewNotSubProjectFilter(),
 }
 
 var workPackagesCmd = &cobra.Command{
@@ -40,7 +41,7 @@ var workPackagesCmd = &cobra.Command{
 
 func listWorkPackages(_ *cobra.Command, _ []string) {
 	// This needs to be removed, once all filters are built the "new" way
-	if errorText := validateCommandFlags(); len(errorText) > 0 {
+	if errorText := validateCommandFlagComposition(); len(errorText) > 0 {
 		printer.ErrorText(errorText)
 		return
 	}
@@ -62,21 +63,29 @@ func listWorkPackages(_ *cobra.Command, _ []string) {
 	}
 }
 
-func validateCommandFlags() (errorText string) {
+func validateCommandFlagComposition() (errorText string) {
 	switch {
 	case len(version) != 0 && projectId == 0:
 		return "Version flag (--version) can only be used in conjunction with projectId flag (-p or --project-id)."
-	case len(subProject) > 0 && (!includeSubProjects || projectId == 0):
-		return "Sub project filter flag (--sub-project) can only be used in conjunction with setting the flag--include-sub-projects and setting a project with the projectId flag (-p or --project-id)."
-	default:
-		return ""
+	case len(activeFilters["subProject"].Value()) > 0 || len(activeFilters["notSubProject"].Value()) > 0:
+		if !includeSubProjects || projectId == 0 {
+			return `Sub project filter flags (--sub-project or --not-sub-project) can only be used
+in conjunction with setting the flag --include-sub-projects and setting a
+project with the projectId flag (-p or --project-id).`
+		}
 	}
+
+	return ""
 }
 
 func buildQuery() (requests.Query, error) {
 	var q requests.Query
 
 	for _, filter := range activeFilters {
+		if filter.Value() == filter.DefaultValue() {
+			continue
+		}
+
 		err := filter.ValidateInput()
 		if err != nil {
 			return requests.NewEmptyQuery(), err
@@ -109,10 +118,6 @@ func filterOptions() *map[work_packages.FilterOption]string {
 		options[work_packages.Type] = validateFilterValue(work_packages.Type, typeFilter)
 	}
 
-	if len(subProject) > 0 {
-		options[work_packages.SubProject] = validateFilterValue(work_packages.SubProject, subProject)
-	}
-
 	if len(version) > 0 {
 		options[work_packages.Version] = validatedVersionId(version)
 	}

cmd/list/work_packages_flags.go

@@ -1,9 +1,5 @@
 package list
 
-import (
-	"github.com/opf/openproject-cli/components/resources"
-)
-
 func initWorkPackagesFlags() {
 	workPackagesCmd.Flags().StringVarP(
 		&assignee,
@@ -48,18 +44,6 @@ ID or a comma separated array of IDs, i.e. '7,13'. Multiple values are
 concatenated with a logical 'OR'. If the IDs are prefixed with an '!' the list
 is instead filtered to not have the specified status.`)
 
-	workPackagesCmd.Flags().StringVarP(
-		&subProject,
-		"sub-project",
-		"",
-		"",
-		`Show only work packages of the specified subprojects. This filter only applies,
-if the flag '--include-sub-projects' is set. It then includes only the sub
-projects matching the filter. The value can be a single ID or a comma separated
-array of IDs, i.e. '7,13'. Multiple values are concatenated with a logical
-'OR'. If the IDs are prefixed with an '!' instead the specified sub projects
-are excluded.`)
-
 	workPackagesCmd.Flags().BoolVarP(
 		&includeSubProjects,
 		"include-sub-projects",
@@ -77,15 +61,12 @@ the default is false.`)
 		"Show only the total number of work packages matching the filter options.")
 
 	for _, filter := range activeFilters {
-		switch filter.(type) {
-		case resources.StringValueFilter:
-			workPackagesCmd.Flags().StringVarP(
-				filter.Value(),
-				filter.Name(),
-				filter.ShortHand(),
-				filter.(resources.StringValueFilter).DefaultValue(),
-				filter.Usage(),
-			)
-		}
+		workPackagesCmd.Flags().StringVarP(
+			filter.ValuePointer(),
+			filter.Name(),
+			filter.ShortHand(),
+			filter.DefaultValue(),
+			filter.Usage(),
+		)
 	}
 }

components/resources/filters.go

@@ -11,14 +11,12 @@ func TypeAheadFilter(input string) requests.Filter {
 }
 
 type Filter interface {
-	Value() *string
+	Value() string
+	ValuePointer() *string
 	Name() string
 	ShortHand() string
 	Usage() string
 	ValidateInput() error
 	Query() requests.Query
-}
-
-type StringValueFilter interface {
 	DefaultValue() string
 }

components/resources/work_packages/filters.go

@@ -14,14 +14,12 @@ const (
 	Project
 	Status
 	Type
-	SubProject
 	IncludeSubProjects
 )
 
 var InputValidationExpression = map[FilterOption]string{
-	Status:     "^(open)$|^(closed)$|^(!?[0-9,]+)$",
-	Type:       "^(!?[0-9,]+)$",
-	SubProject: "^(!?[0-9,]+)$",
+	Status: "^(open)$|^(closed)$|^(!?[0-9,]+)$",
+	Type:   "^(!?[0-9,]+)$",
 }
 
 func (f FilterOption) String() string {
@@ -36,8 +34,6 @@ func (f FilterOption) String() string {
 		return "status"
 	case Type:
 		return "type"
-	case SubProject:
-		return "sub-project"
 	case IncludeSubProjects:
 		return "include-sub-projects"
 	default:
@@ -81,26 +77,6 @@ func TypeFilter(workPackageType string) requests.Filter {
 	}
 }
 
-func SubProjectFilter(filterValue string) requests.Filter {
-	var operator string
-	var values []string
-
-	switch {
-	case strings.Index(filterValue, "!") == 0:
-		operator = "!"
-		values = strings.Split(filterValue[1:], ",")
-	default:
-		operator = "="
-		values = strings.Split(filterValue, ",")
-	}
-
-	return requests.Filter{
-		Operator: operator,
-		Name:     "subprojectId",
-		Values:   values,
-	}
-}
-
 func StatusFilter(status string) requests.Filter {
 	var operator string
 	var values []string

components/resources/work_packages/filters/not_sub_project.go

@@ -0,0 +1,65 @@
+package filters
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/opf/openproject-cli/components/errors"
+	"github.com/opf/openproject-cli/components/printer"
+	"github.com/opf/openproject-cli/components/requests"
+)
+
+type NotSubProjectFilter struct {
+	value string
+}
+
+func (f *NotSubProjectFilter) ValuePointer() *string {
+	return &f.value
+}
+
+func (f *NotSubProjectFilter) Value() string {
+	return f.value
+}
+
+func (f *NotSubProjectFilter) Name() string {
+	return "not-sub-project"
+}
+
+func (f *NotSubProjectFilter) ShortHand() string {
+	return ""
+}
+
+func (f *NotSubProjectFilter) Usage() string {
+	return `Show only work packages that are not inside the specified subprojects. This
+filter only applies, if the flag '--include-sub-projects' is set. It then
+excludes all sub projects matching the filter. The value can be a single ID or
+a comma separated array of IDs, i.e. '7,13'.`
+}
+
+func (f *NotSubProjectFilter) ValidateInput() error {
+	matched, _ := regexp.Match("^([0-9,]+)$", []byte(f.value))
+	if !matched {
+		return errors.Custom(fmt.Sprintf("Invalid not-sub-project value %s.", printer.Yellow(f.value)))
+	}
+
+	return nil
+}
+
+func (f *NotSubProjectFilter) DefaultValue() string {
+	return ""
+}
+
+func (f *NotSubProjectFilter) Query() requests.Query {
+	return requests.NewQuery(nil, []requests.Filter{
+		{
+			Operator: "!",
+			Name:     "subprojectId",
+			Values:   strings.Split(f.value, ","),
+		},
+	})
+}
+
+func NewNotSubProjectFilter() *NotSubProjectFilter {
+	return &NotSubProjectFilter{}
+}

components/resources/work_packages/filters/sub_project.go

@@ -0,0 +1,65 @@
+package filters
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/opf/openproject-cli/components/errors"
+	"github.com/opf/openproject-cli/components/printer"
+	"github.com/opf/openproject-cli/components/requests"
+)
+
+type SubProjectFilter struct {
+	value string
+}
+
+func (f *SubProjectFilter) ValuePointer() *string {
+	return &f.value
+}
+
+func (f *SubProjectFilter) Value() string {
+	return f.value
+}
+
+func (f *SubProjectFilter) Name() string {
+	return "sub-project"
+}
+
+func (f *SubProjectFilter) ShortHand() string {
+	return ""
+}
+
+func (f *SubProjectFilter) Usage() string {
+	return `Show only work packages of the specified subprojects. This filter only applies,
+if the flag '--include-sub-projects' is set. It then includes only the sub
+projects matching the filter. The value can be a single ID or a comma separated
+array of IDs, i.e. '7,13'. Multiple values are concatenated with a logical 'OR'.`
+}
+
+func (f *SubProjectFilter) ValidateInput() error {
+	matched, _ := regexp.Match("^([0-9,]+)$", []byte(f.value))
+	if !matched {
+		return errors.Custom(fmt.Sprintf("Invalid sub-project value %s.", printer.Yellow(f.value)))
+	}
+
+	return nil
+}
+
+func (f *SubProjectFilter) DefaultValue() string {
+	return ""
+}
+
+func (f *SubProjectFilter) Query() requests.Query {
+	return requests.NewQuery(nil, []requests.Filter{
+		{
+			Operator: "=",
+			Name:     "subprojectId",
+			Values:   strings.Split(f.value, ","),
+		},
+	})
+}
+
+func NewSubProjectFilter() *SubProjectFilter {
+	return &SubProjectFilter{}
+}

components/resources/work_packages/filters/timestamp.go

@@ -10,10 +10,14 @@ type TimestampFilter struct {
 	value string
 }
 
-func (f *TimestampFilter) Value() *string {
+func (f *TimestampFilter) ValuePointer() *string {
 	return &f.value
 }
 
+func (f *TimestampFilter) Value() string {
+	return f.value
+}
+
 func (f *TimestampFilter) Name() string {
 	return "timestamp"
 }

components/resources/work_packages/read.go

@@ -36,8 +36,6 @@ func All(filterOptions *map[FilterOption]string, query requests.Query, showOnlyT
 			filters = append(filters, StatusFilter(value))
 		case Type:
 			filters = append(filters, TypeFilter(value))
-		case SubProject:
-			filters = append(filters, SubProjectFilter(value))
 		case Project:
 			n, _ := strconv.ParseUint(value, 10, 64)
 			projectId = &n