Module: Searchkick::Search

Defined in:
lib/searchkick/search.rb

Instance Method Summary collapse

Instance Method Details

#search(term, options = {}) ⇒ Object 



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/searchkick/search.rb', line 4

def search(term, options = {})
  term = term.to_s
  fields =
    if options[:fields]
      if options[:autocomplete]
        options[:fields].map{|f| "#{f}.autocomplete" }
      else
        options[:fields].map{|f| "#{f}.analyzed" }
      end
    else
      if options[:autocomplete]
        (@searchkick_options[:autocomplete] || []).map{|f| "#{f}.autocomplete" }
      else
        ["_all"]
      end
    end

  operator = options[:partial] ? "or" : "and"

  # model and eagar loading
  load = options[:load].nil? ? true : options[:load]
  load = (options[:include] ? {include: options[:include]} : true) if load

  # pagination
  page = options.has_key?(:page) ? [options[:page].to_i, 1].max : nil
  per_page = options[:limit] || options[:per_page] || 100000
  offset = options[:offset] || (page && (page - 1) * per_page)
  index_name = options[:index_name] || index.name

  conversions_field = @searchkick_options[:conversions]
  personalize_field = @searchkick_options[:personalize]

  # TODO lose Tire DSL for more flexibility
  s =
    Tire::Search::Search.new do
      query do
        custom_filters_score do
          query do
            boolean do
              must do
                if options[:autocomplete]
                  match fields, term, analyzer: "searchkick_autocomplete_search"
                else
                  dis_max do
                    query do
                      match fields, term, use_dis_max: false, boost: 10, operator: operator, analyzer: "searchkick_search"
                    end
                    query do
                      match fields, term, use_dis_max: false, boost: 10, operator: operator, analyzer: "searchkick_search2"
                    end
                    query do
                      match fields, term, use_dis_max: false, fuzziness: 1, max_expansions: 1, operator: operator, analyzer: "searchkick_search"
                    end
                    query do
                      match fields, term, use_dis_max: false, fuzziness: 1, max_expansions: 1, operator: operator, analyzer: "searchkick_search2"
                    end
                  end
                end
              end
              if conversions_field and options[:conversions] != false
                should do
                  nested path: conversions_field, score_mode: "total" do
                    query do
                      custom_score script: "doc['count'].value" do
                        match "query", term
                      end
                    end
                  end
                end
              end
            end
          end
          if options[:boost]
            filter do
              filter :exists, field: options[:boost]
              script "log(doc['#{options[:boost]}'].value + 2.718281828)"
            end
          end
          if options[:user_id] and personalize_field
            filter do
              filter :term, personalize_field => options[:user_id]
              boost 100
            end
          end
          score_mode "total"
        end
      end
      size per_page
      from offset if offset
      explain options[:explain] if options[:explain]

      # order
      if options[:order]
        order = options[:order].is_a?(Enumerable) ? options[:order] : {options[:order] => :asc}
        sort do
          order.each do |k, v|
            by k, v
          end
        end
      end

      # where
      # TODO expand or
      where_filters =
        proc do |where|
          filters = []
          (where || {}).each do |field, value|
            if field == :or
              value.each do |or_clause|
                filters << {or: or_clause.map{|or_statement| {term: or_statement} }}
              end
            else
              # expand ranges
              if value.is_a?(Range)
                value = {gte: value.first, (value.exclude_end? ? :lt : :lte) => value.last}
              end

              if value.is_a?(Array) # in query
                filters << {terms: {field => value}}
              elsif value.is_a?(Hash)
                value.each do |op, op_value|
                  if op == :not # not equal
                    if op_value.is_a?(Array)
                      filters << {not: {terms: {field => op_value}}}
                    else
                      filters << {not: {term: {field => op_value}}}
                    end
                  else
                    range_query =
                      case op
                      when :gt
                        {from: op_value, include_lower: false}
                      when :gte
                        {from: op_value, include_lower: true}
                      when :lt
                        {to: op_value, include_upper: false}
                      when :lte
                        {to: op_value, include_upper: true}
                      else
                        raise "Unknown where operator"
                      end
                    filters << {range: {field => range_query}}
                  end
                end
              else
                filters << {term: {field => value}}
              end
            end
          end
          filters
        end

      where_filters.call(options[:where]).each do |f|
        type, value = f.first
        filter type, value
      end

      # facets
      if options[:facets]
        facets = options[:facets] || {}
        if facets.is_a?(Array) # convert to more advanced syntax
          facets = Hash[ facets.map{|f| [f, {}] } ]
        end

        facets.each do |field, facet_options|
          facet_filters = where_filters.call(facet_options[:where])
          facet field do
            terms field
            if facet_filters.size == 1
              type, value = facet_filters.first.first
              facet_filter type, value
            elsif facet_filters.size > 1
              facet_filter :and, *facet_filters
            end
          end
        end
      end
    end

  payload = s.to_hash

  # An empty array will cause only the _id and _type for each hit to be returned
  # http://www.elasticsearch.org/guide/reference/api/search/fields/
  payload[:fields] = [] if load

  # suggestions
  if options[:suggest]
    suggest_fields = (@searchkick_options[:suggest] || []).map(&:to_s)
    # intersection
    suggest_fields = suggest_fields & options[:fields].map(&:to_s) if options[:fields]
    if suggest_fields.any?
      payload[:suggest] = {text: term}
      suggest_fields.each do |field|
        payload[:suggest][field] = {
          phrase: {
            field: "#{field}.suggest"
          }
        }
      end
    end
  end

  search = Tire::Search::Search.new(index_name, load: load, payload: payload)
  Searchkick::Results.new(search.json, search.options.merge(term: term))
end