Class: Searchkick::Results

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Enumerable
Defined in:
lib/searchkick/results.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass, response, options = {}) ⇒ Results

Returns a new instance of Results.



12
13
14
15
16
 
# File 'lib/searchkick/results.rb', line 12

def initialize(klass, response, options = {})
  @klass = klass
  @response = response
  @options = options
end

Instance Attribute Details

#klass ⇒ Object (readonly)

Returns the value of attribute klass.



8
9
10
 
# File 'lib/searchkick/results.rb', line 8

def klass
  @klass
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



8
9
10
 
# File 'lib/searchkick/results.rb', line 8

def options
  @options
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



8
9
10
 
# File 'lib/searchkick/results.rb', line 8

def response
  @response
end

Instance Method Details

#aggregations ⇒ Object 



77
78
79
 
# File 'lib/searchkick/results.rb', line 77

def aggregations
  response["aggregations"]
end

#aggs ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/searchkick/results.rb', line 81

def aggs
  @aggs ||= begin
    if aggregations
      aggregations.dup.each do |field, filtered_agg|
        buckets = filtered_agg[field]
        # move the buckets one level above into the field hash
        if buckets
          filtered_agg.delete(field)
          filtered_agg.merge!(buckets)
        end
      end
    end
  end
end

#current_page ⇒ Object 



123
124
125
 
# File 'lib/searchkick/results.rb', line 123

def current_page
  options[:page]
end

#entry_name(options = {}) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/searchkick/results.rb', line 108

def entry_name(options = {})
  if options.empty?
    # backward compatibility
    model_name.human.downcase
  else
    default = options[:count] == 1 ? model_name.human : model_name.human.pluralize
    model_name.human(options.reverse_merge(default: default))
  end
end

#error ⇒ Object 



100
101
102
 
# File 'lib/searchkick/results.rb', line 100

def error
  response["error"]
end

#first_page? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/searchkick/results.rb', line 155

def first_page?
  previous_page.nil?
end

#highlights(multiple: false) ⇒ Object 



179
180
181
182
183
 
# File 'lib/searchkick/results.rb', line 179

def highlights(multiple: false)
  hits.map do |hit|
    Hash[hit["highlight"].map { |k, v| [(options[:json] ? k : k.sub(/\.#{@options[:match_suffix]}\z/, "")).to_sym, multiple ? v : v.first] }]
  end
end

#hits ⇒ Object 



167
168
169
170
171
172
173
 
# File 'lib/searchkick/results.rb', line 167

def hits
  if error
    raise Searchkick::Error, "Query error - use the error method to view it"
  else
    @response["hits"]["hits"]
  end
end

#last_page? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/searchkick/results.rb', line 159

def last_page?
  next_page.nil?
end

#misspellings? ⇒ Boolean

Returns:

  • (Boolean) 


189
190
191
 
# File 'lib/searchkick/results.rb', line 189

def misspellings?
  @options[:misspellings]
end

#model_name ⇒ Object 



104
105
106
 
# File 'lib/searchkick/results.rb', line 104

def model_name
  klass.model_name
end

#next_page ⇒ Object 



151
152
153
 
# File 'lib/searchkick/results.rb', line 151

def next_page
  current_page < total_pages ? (current_page + 1) : nil
end

#offset_value ⇒ Object Also known as: offset 



141
142
143
 
# File 'lib/searchkick/results.rb', line 141

def offset_value
  (current_page - 1) * per_page + padding
end

#out_of_range? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/searchkick/results.rb', line 163

def out_of_range?
  current_page > total_pages
end

#padding ⇒ Object 



132
133
134
 
# File 'lib/searchkick/results.rb', line 132

def padding
  options[:padding]
end

#per_page ⇒ Object Also known as: limit_value 



127
128
129
 
# File 'lib/searchkick/results.rb', line 127

def per_page
  options[:per_page]
end

#previous_page ⇒ Object Also known as: prev_page 



146
147
148
 
# File 'lib/searchkick/results.rb', line 146

def previous_page
  current_page > 1 ? (current_page - 1) : nil
end

#results ⇒ Object 



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
 
# File 'lib/searchkick/results.rb', line 18

def results
  @results ||= begin
    if options[:load]
      # results can have different types
      results = {}

      hits.group_by { |hit, _| hit["_type"] }.each do |type, grouped_hits|
        klass = (!options[:index_name] && @klass) || type.camelize.constantize
        results[type] = results_query(klass, grouped_hits).to_a.index_by { |r| r.id.to_s }
      end

      # sort
      hits.map do |hit|
        result = results[hit["_type"]][hit["_id"].to_s]
        if result && !(options[:load].is_a?(Hash) && options[:load][:dumpable])
          if hit["highlight"] && !result.respond_to?(:search_highlights)
            highlights = Hash[hit["highlight"].map { |k, v| [(options[:json] ? k : k.sub(/\.#{@options[:match_suffix]}\z/, "")).to_sym, v.first] }]
            result.define_singleton_method(:search_highlights) do
              highlights
            end
          end
        end
        result
      end.compact
    else
      hits.map do |hit|
        result =
          if hit["_source"]
            hit.except("_source").merge(hit["_source"])
          elsif hit["fields"]
            hit.except("fields").merge(hit["fields"])
          else
            hit
          end

        if hit["highlight"]
          highlight = Hash[hit["highlight"].map { |k, v| [base_field(k), v.first] }]
          options[:highlighted_fields].map { |k| base_field(k) }.each do |k|
            result["highlighted_#{k}"] ||= (highlight[k] || result[k])
          end
        end

        result["id"] ||= result["_id"] # needed for legacy reasons
        HashWrapper.new(result)
      end
    end
  end
end

#suggestions ⇒ Object 



67
68
69
70
71
72
73
74
75
 
# File 'lib/searchkick/results.rb', line 67

def suggestions
  if response["suggest"]
    response["suggest"].values.flat_map { |v| v.first["options"] }.sort_by { |o| -o["score"] }.map { |o| o["text"] }.uniq
  elsif options[:term] == "*"
    []
  else
    raise "Pass `suggest: true` to the search method for suggestions"
  end
end

#took ⇒ Object 



96
97
98
 
# File 'lib/searchkick/results.rb', line 96

def took
  response["took"]
end

#total_count ⇒ Object Also known as: total_entries 



118
119
120
 
# File 'lib/searchkick/results.rb', line 118

def total_count
  response["hits"]["total"]
end

#total_pages ⇒ Object Also known as: num_pages 



136
137
138
 
# File 'lib/searchkick/results.rb', line 136

def total_pages
  (total_count / per_page.to_f).ceil
end

#with_highlights(multiple: false) ⇒ Object 



185
186
187
 
# File 'lib/searchkick/results.rb', line 185

def with_highlights(multiple: false)
  results.zip(highlights(multiple: multiple))
end

#with_hit ⇒ Object 



175
176
177
 
# File 'lib/searchkick/results.rb', line 175

def with_hit
  results.zip(hits)
end