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

#current_page ⇒ Object 



94
95
96
 
# File 'lib/searchkick/results.rb', line 94

def current_page
  options[:page]
end

#each_with_hit(&block) ⇒ Object 



63
64
65
 
# File 'lib/searchkick/results.rb', line 63

def each_with_hit(&block)
  results.zip(hits).each(&block)
end

#entry_name ⇒ Object 



85
86
87
 
# File 'lib/searchkick/results.rb', line 85

def entry_name
  model_name.human.downcase
end

#facets ⇒ Object 



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

def facets
  response["facets"]
end

#first_page? ⇒ Boolean

Returns:

  • (Boolean) 


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

def first_page?
  previous_page.nil?
end

#hits ⇒ Object 



134
135
136
 
# File 'lib/searchkick/results.rb', line 134

def hits
  @response["hits"]["hits"]
end

#last_page? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/searchkick/results.rb', line 130

def last_page?
  next_page.nil?
end

#model_name ⇒ Object 



81
82
83
 
# File 'lib/searchkick/results.rb', line 81

def model_name
  klass.model_name
end

#next_page ⇒ Object 



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

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

#offset_value ⇒ Object Also known as: offset 



112
113
114
 
# File 'lib/searchkick/results.rb', line 112

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

#padding ⇒ Object 



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

def padding
  options[:padding]
end

#per_page ⇒ Object Also known as: limit_value 



98
99
100
 
# File 'lib/searchkick/results.rb', line 98

def per_page
  options[:per_page]
end

#previous_page ⇒ Object Also known as: prev_page 



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

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

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

      hits.group_by{|hit, i| hit["_type"] }.each do |type, grouped_hits|
        records = type.camelize.constantize
        if options[:includes]
          if defined?(NoBrainer::Document) and records < NoBrainer::Document
            records = records.preload(options[:includes])
          else
            records = records.includes(options[:includes])
          end
        end
        results[type] = results_query(records, grouped_hits)
      end

      # sort
      hits.map do |hit|
        results[hit["_type"]].find{|r| r.id.to_s == hit["_id"].to_s }
      end.compact
    else
      hits.map do |hit|
        result =
          if hit["_source"]
            hit.except("_source").merge(hit["_source"])
          else
            hit.except("fields").merge(hit["fields"])
          end
        result["id"] ||= result["_id"] # needed for legacy reasons
        Hashie::Mash.new(result)
      end
    end
  end
end

#suggestions ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/searchkick/results.rb', line 55

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

#total_count ⇒ Object Also known as: total_entries 



89
90
91
 
# File 'lib/searchkick/results.rb', line 89

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

#total_pages ⇒ Object Also known as: num_pages 



107
108
109
 
# File 'lib/searchkick/results.rb', line 107

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

#with_details ⇒ Object 



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

def with_details
  each_with_hit.map do |model, hit|
    details = {}
    if hit["highlight"]
      details[:highlight] = Hash[ hit["highlight"].map{|k, v| [(options[:json] ? k : k.sub(/\.analyzed\z/, "")).to_sym, v.first] } ]
    end
    [model, details]
  end
end