filters_base.go

package scopes

// Filter is implemented by all scope filter types.
type Filter interface {
	serializeFilter() map[string]interface{}
}

type FilterDisplayHints int

const (
	FilterDisplayDefault FilterDisplayHints = 0
	FilterDisplayPrimary FilterDisplayHints = 1 << iota
)

// FilterState represents the current state of a set of filters.
type FilterState map[string]interface{}

type filterBase struct {
	Id           string
	DisplayHints FilterDisplayHints
	FilterType   string
	Title        string
}

func (f *filterBase) serializeFilter() map[string]interface{} {
	v := map[string]interface{}{
		"filter_type":   f.FilterType,
		"id":            f.Id,
		"display_hints": f.DisplayHints,
	}
	if f.Title != "" {
		v["title"] = f.Title
	}
	return v
}

type filterWithOptions struct {
	filterBase
	Options []FilterOption
}

// AddOption adds a new option to the filter.
func (f *filterWithOptions) AddOption(id, label string, defaultValue bool) {
	f.Options = append(f.Options, FilterOption{
		Id:      id,
		Label:   label,
		Default: defaultValue,
	})
}

func (f *filterWithOptions) isValidOption(optionId interface{}) bool {
	for _, o := range f.Options {
		if o.Id == optionId {
			return true
		}
	}
	return false
}

// HasActiveOption returns true if any of the filters options are active.
func (f *filterWithOptions) HasActiveOption(state FilterState) bool {
	for _, optionId := range f.ActiveOptions(state) {
		if f.isValidOption(optionId) {
			return true
		}
	}
	return false
}

// ActiveOptions returns the filter's active options from the filter state.
func (f *filterWithOptions) ActiveOptions(state FilterState) []string {
	var ret []string
	if state[f.Id] != nil {
		options := state[f.Id].([]interface{})
		ret = make([]string, len(options))
		for i, opt := range options {
			ret[i] = opt.(string)
		}
	} else {
		// We don't have this filter in the state object, so
		// give defaults back.
		for _, o := range f.Options {
			if o.Default {
				ret = append(ret, o.Id)
			}
		}
	}
	return ret
}

type FilterOption struct {
	Id      string `json:"id"`
	Label   string `json:"label"`
	Default bool   `json:"default"`
}