Skip to content

Commit

Permalink
Add IntervalQueryRuleFuzzy
Browse files Browse the repository at this point in the history
This commit adds the missing `IntervalQueryRuleFuzzy`.

Close #1564
  • Loading branch information
olivere committed Jan 7, 2022
1 parent 15cfb75 commit c76a1be
Show file tree
Hide file tree
Showing 2 changed files with 191 additions and 0 deletions.
100 changes: 100 additions & 0 deletions search_queries_interval_integration_test.go
Expand Up @@ -20,6 +20,12 @@ func TestIntervalQuery_Integration(t *testing.T) {
t.Run("Prefix", func(t *testing.T) {
testIntervalQueryPrefix(client, t)
})
t.Run("Wildcard", func(t *testing.T) {
testIntervalQueryWildcard(client, t)
})
t.Run("Fuzzy", func(t *testing.T) {
testIntervalQueryFuzzy(client, t)
})
}

func testIntervalQueryMatch(client *Client, t *testing.T) {
Expand Down Expand Up @@ -115,3 +121,97 @@ func testIntervalQueryPrefix(client *Client, t *testing.T) {
}
}
}

func testIntervalQueryWildcard(client *Client, t *testing.T) {
q := NewIntervalQuery(
"message",
NewIntervalQueryRuleAllOf(
NewIntervalQueryRuleAnyOf(
NewIntervalQueryRuleMatch("Golang").Ordered(true),
NewIntervalQueryRuleMatch("Cycling").MaxGaps(0).Filter(
NewIntervalQueryFilter().NotContaining(
NewIntervalQueryRuleWildcard("Hockey*"),
),
),
),
).Ordered(true),
)

// Match all should return all documents
searchResult, err := client.Search().
Index(testIndexName).
Query(q).
Size(10).
Pretty(true).
Do(context.TODO())
if err != nil {
t.Fatal(err)
}
if searchResult.Hits == nil {
t.Errorf("expected SearchResult.Hits != nil; got nil")
}
if got, want := searchResult.TotalHits(), int64(2); got != want {
t.Errorf("expected SearchResult.TotalHits() = %d; got %d", want, got)
}
if got, want := len(searchResult.Hits.Hits), 2; got != want {
t.Errorf("expected len(SearchResult.Hits.Hits) = %d; got %d", want, got)
}

for _, hit := range searchResult.Hits.Hits {
if hit.Index != testIndexName {
t.Errorf("expected SearchResult.Hits.Hit.Index = %q; got %q", testIndexName, hit.Index)
}
item := make(map[string]interface{})
err := json.Unmarshal(hit.Source, &item)
if err != nil {
t.Fatal(err)
}
}
}

func testIntervalQueryFuzzy(client *Client, t *testing.T) {
q := NewIntervalQuery(
"message",
NewIntervalQueryRuleAllOf(
NewIntervalQueryRuleAnyOf(
NewIntervalQueryRuleMatch("Golang").Ordered(true),
NewIntervalQueryRuleMatch("Cycling").MaxGaps(0).Filter(
NewIntervalQueryFilter().NotContaining(
NewIntervalQueryRuleFuzzy("Hocky").Fuzziness("auto"),
),
),
),
).Ordered(true),
)

// Match all should return all documents
searchResult, err := client.Search().
Index(testIndexName).
Query(q).
Size(10).
Pretty(true).
Do(context.TODO())
if err != nil {
t.Fatal(err)
}
if searchResult.Hits == nil {
t.Errorf("expected SearchResult.Hits != nil; got nil")
}
if got, want := searchResult.TotalHits(), int64(2); got != want {
t.Errorf("expected SearchResult.TotalHits() = %d; got %d", want, got)
}
if got, want := len(searchResult.Hits.Hits), 2; got != want {
t.Errorf("expected len(SearchResult.Hits.Hits) = %d; got %d", want, got)
}

for _, hit := range searchResult.Hits.Hits {
if hit.Index != testIndexName {
t.Errorf("expected SearchResult.Hits.Hit.Index = %q; got %q", testIndexName, hit.Index)
}
item := make(map[string]interface{})
err := json.Unmarshal(hit.Source, &item)
if err != nil {
t.Fatal(err)
}
}
}
91 changes: 91 additions & 0 deletions search_queries_interval_rules_fuzzy.go
@@ -0,0 +1,91 @@
package elastic

var (
_ IntervalQueryRule = (*IntervalQueryRuleFuzzy)(nil)
)

// IntervalQueryRuleFuzzy is an implementation of IntervalQueryRule.
//
// See https://www.elastic.co/guide/en/elasticsearch/reference/7.16/query-dsl-intervals-query.html#intervals-fuzzy
// for details.
type IntervalQueryRuleFuzzy struct {
term string
prefixLength *int
transpositions *bool
fuzziness interface{}
analyzer string
useField string
}

// NewIntervalQueryRuleFuzzy initializes and returns a new instance
// of IntervalQueryRuleFuzzy.
func NewIntervalQueryRuleFuzzy(term string) *IntervalQueryRuleFuzzy {
return &IntervalQueryRuleFuzzy{term: term}
}

// PrefixLength is the number of beginning characters left unchanged when
// creating expansions. Defaults to 0.
func (q *IntervalQueryRuleFuzzy) PrefixLength(prefixLength int) *IntervalQueryRuleFuzzy {
q.prefixLength = &prefixLength
return q
}

// Fuzziness is the maximum edit distance allowed for matching.
// It can be integers like 0, 1 or 2 as well as strings
// like "auto", "0..1", "1..4" or "0.0..1.0". Defaults to "auto".
func (q *IntervalQueryRuleFuzzy) Fuzziness(fuzziness interface{}) *IntervalQueryRuleFuzzy {
q.fuzziness = fuzziness
return q
}

// Transpositions indicates whether edits include transpositions of two
// adjacent characters (ab -> ba). Defaults to true.
func (q *IntervalQueryRuleFuzzy) Transpositions(transpositions bool) *IntervalQueryRuleFuzzy {
q.transpositions = &transpositions
return q
}

// Analyzer specifies the analyzer used to analyze terms in the query.
func (r *IntervalQueryRuleFuzzy) Analyzer(analyzer string) *IntervalQueryRuleFuzzy {
r.analyzer = analyzer
return r
}

// UseField, if specified, matches the intervals from this field rather than
// the top-level field.
func (r *IntervalQueryRuleFuzzy) UseField(useField string) *IntervalQueryRuleFuzzy {
r.useField = useField
return r
}

// Source returns JSON for the function score query.
func (r *IntervalQueryRuleFuzzy) Source() (interface{}, error) {
source := make(map[string]interface{})

source["term"] = r.term

if r.prefixLength != nil {
source["prefix_length"] = *r.prefixLength
}
if r.transpositions != nil {
source["transpositions"] = *r.transpositions
}
if r.fuzziness != "" {
source["fuzziness"] = r.fuzziness
}
if r.analyzer != "" {
source["analyzer"] = r.analyzer
}
if r.useField != "" {
source["use_field"] = r.useField
}

return map[string]interface{}{
"fuzzy": source,
}, nil
}

// isIntervalQueryRule implements the marker interface.
func (r *IntervalQueryRuleFuzzy) isIntervalQueryRule() bool {
return true
}

0 comments on commit c76a1be

Please sign in to comment.