require "forwardable" module Searchkick class Results include Enumerable extend Forwardable attr_reader :klass, :response, :options def_delegators :results, :each, :any?, :empty?, :size, :length, :slice, :[], :to_ary def initialize(klass, response, options = {}) @klass = klass @response = response @options = options end # experimental: may not make next release def records @records ||= results_query(klass, hits) end def results @results ||= begin if options[:load] # results can have different types results = {} hits.group_by { |hit, _| hit["_type"] }.each do |type, grouped_hits| results[type] = results_query(type.camelize.constantize, 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 unless result.respond_to?(:search_hit) result.define_singleton_method(:search_hit) do hit end end 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 Hashie::Mash.new(result) end end end end 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 def each_with_hit(&block) results.zip(hits).each(&block) end 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(/\.#{@options[:match_suffix]}\z/, "")).to_sym, v.first] }] end [model, details] end end def aggregations response["aggregations"] end 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 def took response["took"] end def error response["error"] end def model_name klass.model_name end def entry_name model_name.human.downcase end def total_count response["hits"]["total"] end alias_method :total_entries, :total_count def current_page options[:page] end def per_page options[:per_page] end alias_method :limit_value, :per_page def padding options[:padding] end def total_pages (total_count / per_page.to_f).ceil end alias_method :num_pages, :total_pages def offset_value (current_page - 1) * per_page + padding end alias_method :offset, :offset_value def previous_page current_page > 1 ? (current_page - 1) : nil end alias_method :prev_page, :previous_page def next_page current_page < total_pages ? (current_page + 1) : nil end def first_page? previous_page.nil? end def last_page? next_page.nil? end def out_of_range? current_page > total_pages end def hits @response["hits"]["hits"] end def misspellings? @options[:misspellings] end private def results_query(records, hits) ids = hits.map { |hit| hit["_id"] } if options[:includes] records = if defined?(NoBrainer::Document) && records < NoBrainer::Document if Gem.loaded_specs["nobrainer"].version >= Gem::Version.new("0.21") records.eager_load(options[:includes]) else records.preload(options[:includes]) end else records.includes(options[:includes]) end end records = if records.respond_to?(:primary_key) # ActiveRecord records.where(records.primary_key => ids) if records.primary_key elsif records.respond_to?(:queryable) # Mongoid 3+ records.queryable.for_ids(ids) elsif records.respond_to?(:unscoped) && :id.respond_to?(:in) # Nobrainer records.unscoped.where(:id.in => ids) end raise Searchkick::Error, "Not sure how to load records" if !records records end def base_field(k) k.sub(/\.(analyzed|word_start|word_middle|word_end|text_start|text_middle|text_end|exact)\z/, "") end end end