1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Elasticsearch
module DSL
module Search
# Wraps the `highlight` part of a search definition
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html
#
class Highlight
include BaseComponent
def initialize(*args, &block)
@value = args.pop || {}
super
end
# Specify the fields to highlight
#
# @example
#
# search do
# highlight do
# fields [:title, :body]
# field :comments.body if options[:comments]
# end
# end
#
def fields(value_or_name)
value = case value_or_name
when Hash
value_or_name
when Array
value_or_name.reduce({}) { |sum, item| sum.update item.to_sym => {}; sum }
else
end
(@value[:fields] ||= {}).update value
self
end
# Specify a single field to highlight
#
# @example
#
# search do
# highlight do
# field :title, fragment_size: 0
# field :body if options[:comments]
# end
# end
#
def field(name, options={})
(@value[:fields] ||= {}).update name.to_sym => options
end
# Specify the opening tags for the highlighted snippets
#
def pre_tags(*value)
@value[:pre_tags] = value.flatten
end; alias_method :pre_tags=, :pre_tags
# Specify the closing tags for the highlighted snippets
#
def post_tags(*value)
@value[:post_tags] = value.flatten
end; alias_method :post_tags=, :post_tags
# Specify the `encoder` option for highlighting
#
def encoder(value)
@value[:encoder] = value
end; alias_method :encoder=, :encoder
# Specify the `tags_schema` option for highlighting
#
def tags_schema(value)
@value[:tags_schema] = value
end; alias_method :tags_schema=, :tags_schema
# Convert the definition to a Hash
#
# @return [Hash]
#
def to_hash
call
@hash = @value
@hash
end
end
end
end
end
|
