path: root/query/parser.go

package query

import (
	"fmt"

	"github.com/git-bug/git-bug/entities/common"
)

// Parse parse a query DSL
//
// Ex: "status:open author:descartes sort:edit-asc"
//
// Supported filter qualifiers and syntax are described in docs/queries.md
func Parse(query string) (*Query, error) {
	tokens, err := tokenize(query)
	if err != nil {
		return nil, err
	}

	q := &Query{
		OrderBy:        OrderByCreation,
		OrderDirection: OrderDescending,
	}
	sortingDone := false

	for _, t := range tokens {
		switch t.kind {
		case tokenKindSearch:
			q.Search = append(q.Search, t.term)
			break

		case tokenKindKV:
			switch t.qualifier {
			case "status", "state":
				status, err := common.StatusFromString(t.value)
				if err != nil {
					return nil, err
				}
				q.Status = append(q.Status, status)
			case "author":
				q.Author = append(q.Author, t.value)
			case "actor":
				q.Actor = append(q.Actor, t.value)
			case "participant":
				q.Participant = append(q.Participant, t.value)
			case "label":
				q.Label = append(q.Label, t.value)
			case "title":
				q.Title = append(q.Title, t.value)
			case "no":
				switch t.value {
				case "label":
					q.NoLabel = true
				default:
					return nil, fmt.Errorf("unknown \"no\" filter \"%s\"", t.value)
				}
			case "sort":
				if sortingDone {
					return nil, fmt.Errorf("multiple sorting")
				}
				err = parseSorting(q, t.value)
				if err != nil {
					return nil, err
				}
				sortingDone = true

			default:
				return nil, fmt.Errorf("unknown qualifier \"%s\"", t.qualifier)
			}

		case tokenKindKVV:
			switch t.qualifier {
			case "metadata":
				q.Metadata = append(q.Metadata, StringPair{Key: t.subQualifier, Value: t.value})

			default:
				return nil, fmt.Errorf("unknown qualifier \"%s:%s\"", t.qualifier, t.subQualifier)
			}
		}
	}
	return q, nil
}

func parseSorting(q *Query, value string) error {
	switch value {
	// default ASC
	case "id-desc":
		q.OrderBy = OrderById
		q.OrderDirection = OrderDescending
	case "id", "id-asc":
		q.OrderBy = OrderById
		q.OrderDirection = OrderAscending

	// default DESC
	case "creation", "creation-desc":
		q.OrderBy = OrderByCreation
		q.OrderDirection = OrderDescending
	case "creation-asc":
		q.OrderBy = OrderByCreation
		q.OrderDirection = OrderAscending

	// default DESC
	case "edit", "edit-desc":
		q.OrderBy = OrderByEdit
		q.OrderDirection = OrderDescending
	case "edit-asc":
		q.OrderBy = OrderByEdit
		q.OrderDirection = OrderAscending

	default:
		return fmt.Errorf("unknown sorting %s", value)
	}

	return nil
}