Class: Sunspot::Search::AbstractSearch

Inherits:
Object
  • Object
show all
Defined in:
lib/sunspot/search/abstract_search.rb

Overview

This class encapsulates the results of a Solr search. It provides access to search results, total result count, facets, and pagination information. Instances of Search are returned by the Sunspot.search and Sunspot.new_search methods.

Direct Known Subclasses

MoreLikeThisSearch, StandardSearch

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, setup, query, configuration) ⇒ AbstractSearch

:nodoc:



18
19
20
21
22
23
 
# File 'lib/sunspot/search/abstract_search.rb', line 18

def initialize(connection, setup, query, configuration) #:nodoc:
  @connection, @setup, @query = connection, setup, query
  @query.paginate(1, configuration.pagination.default_per_page)
  @facets = []
  @facets_by_name = {}
end

Instance Attribute Details

#facets ⇒ Object (readonly)

Retrieve all facet objects defined for this search, in order they were defined. To retrieve an individual facet by name, use #facet()



14
15
16
 
# File 'lib/sunspot/search/abstract_search.rb', line 14

def facets
  @facets
end

#query ⇒ Object (readonly)

:nodoc:



15
16
17
 
# File 'lib/sunspot/search/abstract_search.rb', line 15

def query
  @query
end

#request_handler ⇒ Object

Returns the value of attribute request_handler.



16
17
18
 
# File 'lib/sunspot/search/abstract_search.rb', line 16

def request_handler
  @request_handler
end

Instance Method Details

#add_date_facet(field, options) ⇒ Object

:nodoc:



246
247
248
249
 
# File 'lib/sunspot/search/abstract_search.rb', line 246

def add_date_facet(field, options) #:nodoc:
  name = (options[:name] || field.name)
  add_facet(name, DateFacet.new(field, self, options))
end

#add_field_facet(field, options = {}) ⇒ Object

:nodoc:



237
238
239
240
 
# File 'lib/sunspot/search/abstract_search.rb', line 237

def add_field_facet(field, options = {}) #:nodoc:
  name = (options[:name] || field.name)
  add_facet(name, FieldFacet.new(field, self, options))
end

#add_query_facet(name, options) ⇒ Object

:nodoc:



242
243
244
 
# File 'lib/sunspot/search/abstract_search.rb', line 242

def add_query_facet(name, options) #:nodoc:
  add_facet(name, QueryFacet.new(name, self, options))
end

#build(&block) ⇒ Object

Build this search using a DSL block. This method can be called more than once on an unexecuted search (e.g., Sunspot.new_search) in order to build a search incrementally.

Example

search = Sunspot.new_search(Post)
search.build do
  with(:published_at).less_than Time.now
end
search.execute



206
207
208
209
 
# File 'lib/sunspot/search/abstract_search.rb', line 206

def build(&block)
  Util.instance_eval_or_call(dsl, &block)
  self
end

#data_accessor_for(clazz) ⇒ Object

Get the data accessor that will be used to load a particular class out of persistent storage. Data accessors can implement any methods that may be useful for refining how data is loaded out of storage. When building a search manually (e.g., using the Sunspot#new_search method), this should be used before calling #execute(). Use the Sunspot::DSL::Search#data_accessor_for method when building searches using the block DSL.



188
189
190
191
 
# File 'lib/sunspot/search/abstract_search.rb', line 188

def data_accessor_for(clazz) #:nodoc:
  (@data_accessors ||= {})[clazz.name.to_sym] ||=
    Adapters::DataAccessor.create(clazz)
end

#dynamic_facet(base_name, dynamic_name) ⇒ Object

Deprecated in favor of optional second argument to #facet



171
172
173
 
# File 'lib/sunspot/search/abstract_search.rb', line 171

def dynamic_facet(base_name, dynamic_name) #:nodoc:
  facet(base_name, dynamic_name)
end

#each_hit_with_result ⇒ Object

Convenience method to iterate over hit and result objects. Block is yielded a Sunspot::Server::Hit instance and a Sunspot::Server::Result instance.

Note that this method iterates over verified hits (see #hits method for more information).



101
102
103
104
105
 
# File 'lib/sunspot/search/abstract_search.rb', line 101

def each_hit_with_result
  verified_hits.each do |hit|
    yield(hit, hit.result)
  end
end

#execute ⇒ Object

Execute the search on the Solr instance and store the results. If you use Sunspot#search() to construct your searches, there is no need to call this method as it has already been called. If you use Sunspot#new_search(), you will need to call this method after building the query.



32
33
34
35
36
37
 
# File 'lib/sunspot/search/abstract_search.rb', line 32

def execute
  reset
  params = @query.to_params
  @solr_result = @connection.request("/#{request_handler}", params)
  self
end

#execute! ⇒ Object

:nodoc: deprecated



39
40
41
 
# File 'lib/sunspot/search/abstract_search.rb', line 39

def execute! #:nodoc: deprecated
  execute
end

#facet(name, dynamic_name = nil) ⇒ Object

Get the facet object for the given name. ‘name` can either be the name given to a query facet, or the field name of a field facet. Returns a Sunspot::Facet object.

Parameters

name<Symbol>

Name of the field to return the facet for, or the name given to the query facet when the search was constructed.

dynamic_name<Symbol>

If faceting on a dynamic field, this is the dynamic portion of the field name.

Example:

search = Sunspot.search(Post) do
  facet :category_ids
  dynamic :custom do
    facet :cuisine
  end
  facet :age do
    row 'Less than a month' do
      with(:published_at).greater_than(1.month.ago)
    end
    row 'Less than a year' do
      with(:published_at, 1.year.ago..1.month.ago)
    end
    row 'More than a year' do
      with(:published_at).less_than(1.year.ago)
    end
  end
end
search.facet(:category_ids)
  #=> Facet for :category_ids field
search.facet(:custom, :cuisine)
  #=> Facet for the dynamic field :cuisine in the :custom field definition
search.facet(:age)
  #=> Facet for the query facet named :age



158
159
160
161
162
163
164
165
166
 
# File 'lib/sunspot/search/abstract_search.rb', line 158

def facet(name, dynamic_name = nil)
  if name
    if dynamic_name
      @facets_by_name[:"#{name}:#{dynamic_name}"]
    else
      @facets_by_name[name.to_sym]
    end
  end
end

#facet_response ⇒ Object

:nodoc:



175
176
177
 
# File 'lib/sunspot/search/abstract_search.rb', line 175

def facet_response #:nodoc:
  @solr_result['facet_counts']
end

#hits(options = {}) ⇒ Object Also known as: raw_results

Access raw Solr result information. Returns a collection of Hit objects that contain the class name, primary key, keyword relevance score (if applicable), and any stored fields.

Options (options)

:verify

Only return hits that reference objects that actually exist in the data store. This causes results to be eager-loaded from the data store, unlike the normal behavior of this method, which only loads the referenced results when Hit#result is first called.

Returns

Array

Ordered collection of Hit objects



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/sunspot/search/abstract_search.rb', line 76

def hits(options = {})
  if options[:verify]
    verified_hits
  else
    @hits ||=
      begin
        hits = if solr_response && solr_response['docs']
          solr_response['docs'].map do |doc|
            Hit.new(doc, highlights_for(doc), distance_for(doc), self)
          end
        end
        maybe_will_paginate(hits || [])
      end
  end
end

#inspect ⇒ Object

:nodoc:



233
234
235
 
# File 'lib/sunspot/search/abstract_search.rb', line 233

def inspect #:nodoc:
  "<Sunspot::Search:#{query.to_params.inspect}>"
end

#populate_hits ⇒ Object

Populate the Hit objects with their instances. This is invoked the first time any hit has its instance requested, and all hits are loaded as a batch.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sunspot/search/abstract_search.rb', line 216

def populate_hits #:nodoc:
  id_hit_hash = Hash.new { |h, k| h[k] = {} }
  hits.each do |hit|
    id_hit_hash[hit.class_name][hit.primary_key] = hit
  end
  id_hit_hash.each_pair do |class_name, hits|
    ids = hits.map { |id, hit| hit.primary_key }
    data_accessor = data_accessor_for(Util.full_const_get(class_name))
    hits_for_class = id_hit_hash[class_name]
    data_accessor.load_all(ids).each do |result|
      hit = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
      hit.result = result
    end
    hits_for_class.values.each { |hit| hit.result = nil }
  end
end

#results ⇒ Object

Get the collection of results as instantiated objects. If WillPaginate is available, the results will be a WillPaginate::Collection instance; if not, it will be a vanilla Array.

If not all of the results referenced by the Solr hits actually exist in the data store, Sunspot will only return the results that do exist.

Returns

WillPaginate::Collection or Array

Instantiated result objects



55
56
57
 
# File 'lib/sunspot/search/abstract_search.rb', line 55

def results
  @results ||= maybe_will_paginate(verified_hits.map { |hit| hit.instance })
end

#total ⇒ Object

The total number of documents matching the query parameters

Returns

Integer

Total matching documents



114
115
116
 
# File 'lib/sunspot/search/abstract_search.rb', line 114

def total
  @total ||= solr_response['numFound'] || 0
end