Class: ThinkingSphinx::Search

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

Overview

Once you’ve got those indexes in and built, this is the stuff that matters - how to search! This class provides a generic search interface - which you can use to search all your indexed models at once. Most times, you will just want a specific model’s results - to search and search_for_ids methods will do the job in exactly the same manner when called from a model.

Constant Summary collapse

CoreMethods = 
%w( == class class_eval extend frozen? id instance_eval
instance_of? instance_values instance_variable_defined?
instance_variable_get instance_variable_set instance_variables is_a?
kind_of? member? method methods nil? object_id respond_to? send should
type )
SafeMethods = 
%w( partition private_methods protected_methods
public_methods send class )
HashOptions = 
[:conditions, :with, :without, :with_all]
ArrayOptions = 
[:classes, :without_ids]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Search

Returns a new instance of Search.



60
61
62
63
64
65
66
 
# File 'lib/thinking_sphinx/search.rb', line 60

def initialize(*args)
  ThinkingSphinx.context.define_indexes
  
  @array    = []
  @options  = args.extract_options!
  @args     = args
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/thinking_sphinx/search.rb', line 91

def method_missing(method, *args, &block)
  if is_scope?(method)
    add_scope(method, *args, &block)
    return self
  elsif method == :search_count
    return scoped_count
  elsif method.to_s[/^each_with_.*/].nil? && !@array.respond_to?(method)
    super
  elsif !SafeMethods.include?(method.to_s)
    populate
  end
  
  if method.to_s[/^each_with_.*/] && !@array.respond_to?(method)
    each_with_attribute method.to_s.gsub(/^each_with_/, ''), &block
  else
    @array.send(method, *args, &block)
  end
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



28
29
30
 
# File 'lib/thinking_sphinx/search.rb', line 28

def args
  @args
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



28
29
30
 
# File 'lib/thinking_sphinx/search.rb', line 28

def options
  @options
end

Class Method Details

.count(*args) ⇒ Object

Deprecated. Use ThinkingSphinx.count



49
50
51
52
 
# File 'lib/thinking_sphinx/search.rb', line 49

def self.count(*args)
  log 'ThinkingSphinx::Search.count is deprecated. Please use ThinkingSphinx.count instead.'
  ThinkingSphinx.count *args
end

.facets(*args) ⇒ Object

Deprecated. Use ThinkingSphinx.facets



55
56
57
58
 
# File 'lib/thinking_sphinx/search.rb', line 55

def self.facets(*args)
  log 'ThinkingSphinx::Search.facets is deprecated. Please use ThinkingSphinx.facets instead.'
  ThinkingSphinx.facets *args
end

.search(*args) ⇒ Object

Deprecated. Use ThinkingSphinx.search



31
32
33
34
 
# File 'lib/thinking_sphinx/search.rb', line 31

def self.search(*args)
  log 'ThinkingSphinx::Search.search is deprecated. Please use ThinkingSphinx.search instead.'
  ThinkingSphinx.search *args
end

.search_for_id(*args) ⇒ Object

Deprecated. Use ThinkingSphinx.search_for_ids



43
44
45
46
 
# File 'lib/thinking_sphinx/search.rb', line 43

def self.search_for_id(*args)
  log 'ThinkingSphinx::Search.search_for_id is deprecated. Please use ThinkingSphinx.search_for_id instead.'
  ThinkingSphinx.search_for_id *args
end

.search_for_ids(*args) ⇒ Object

Deprecated. Use ThinkingSphinx.search_for_ids



37
38
39
40
 
# File 'lib/thinking_sphinx/search.rb', line 37

def self.search_for_ids(*args)
  log 'ThinkingSphinx::Search.search_for_ids is deprecated. Please use ThinkingSphinx.search_for_ids instead.'
  ThinkingSphinx.search_for_ids *args
end

Instance Method Details

#current_page ⇒ Integer

The current page number of the result set. Defaults to 1 if no page was explicitly requested.

Returns:

  • (Integer) 


125
126
127
 
# File 'lib/thinking_sphinx/search.rb', line 125

def current_page
  @options[:page].blank? ? 1 : @options[:page].to_i
end

#each_with_groupby_and_count(&block) ⇒ Object Also known as: each_with_group_and_count 



198
199
200
201
202
203
204
205
 
# File 'lib/thinking_sphinx/search.rb', line 198

def each_with_groupby_and_count(&block)
  populate
  results[:matches].each_with_index do |match, index|
    yield self[index],
      match[:attributes]["@groupby"],
      match[:attributes]["@count"]
  end
end

#each_with_weighting(&block) ⇒ Object 



208
209
210
211
212
213
 
# File 'lib/thinking_sphinx/search.rb', line 208

def each_with_weighting(&block)
  populate
  results[:matches].each_with_index do |match, index|
    yield self[index], match[:weight]
  end
end

#excerpt_for(string, model = nil) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/thinking_sphinx/search.rb', line 215

def excerpt_for(string, model = nil)
  if model.nil? && one_class
    model ||= one_class
  end
  
  populate
  client.excerpts(
    :docs   => [string],
    :words  => results[:words].keys.join(' '),
    :index  => "#{model.source_of_sphinx_index.sphinx_name}_core"
  ).first
end

#indexes ⇒ Object 



191
192
193
194
195
196
 
# File 'lib/thinking_sphinx/search.rb', line 191

def indexes
  return options[:index] if options[:index]
  return '*' if classes.empty?
  
  classes.collect { |klass| klass.sphinx_index_names }.flatten.join(',')
end

#next_page ⇒ Integer?

The next page number of the result set. If there are no more pages available, nil is returned.

Returns:

  • (Integer, nil) 


134
135
136
 
# File 'lib/thinking_sphinx/search.rb', line 134

def next_page
  current_page >= total_pages ? nil : current_page + 1
end

#offset ⇒ Integer

The current page’s offset, based on the number of records per page. Or explicit :offset if given.

Returns:

  • (Integer) 


187
188
189
 
# File 'lib/thinking_sphinx/search.rb', line 187

def offset
  @options[:offset] || ((current_page - 1) * per_page)
end

#per_page ⇒ Integer

The amount of records per set of paged results. Defaults to 20 unless a specific page size is requested.

Returns:

  • (Integer) 


152
153
154
155
156
 
# File 'lib/thinking_sphinx/search.rb', line 152

def per_page
  @options[:limit] ||= @options[:per_page]
  @options[:limit] ||= 20
  @options[:limit].to_i
end

#populated? ⇒ Boolean

Indication of whether the request has been made to Sphinx for the search query.

Returns:

  • (Boolean) —

    true if the results have been requested.



78
79
80
 
# File 'lib/thinking_sphinx/search.rb', line 78

def populated?
  !!@populated
end

#previous_page ⇒ Integer?

The previous page number of the result set. If this is the first page, then nil is returned.

Returns:

  • (Integer, nil) 


143
144
145
 
# File 'lib/thinking_sphinx/search.rb', line 143

def previous_page
  current_page == 1 ? nil : current_page - 1
end

#respond_to?(method) ⇒ Boolean

Returns true if the Search object or the underlying Array object respond to the requested method.

Parameters:

  • method (Symbol) —

    The method name

Returns:

  • (Boolean) —

    true if either Search or Array responds to the method.



116
117
118
 
# File 'lib/thinking_sphinx/search.rb', line 116

def respond_to?(method)
  super || @array.respond_to?(method)
end

#results ⇒ Hash

The query result hash from Riddle.

Returns:

  • (Hash) —

    Raw Sphinx results



86
87
88
89
 
# File 'lib/thinking_sphinx/search.rb', line 86

def results
  populate
  @results
end

#search(*args) ⇒ Object 



228
229
230
231
232
 
# File 'lib/thinking_sphinx/search.rb', line 228

def search(*args)
  add_default_scope
  merge_search ThinkingSphinx::Search.new(*args)
  self
end

#to_a ⇒ Object 



68
69
70
71
 
# File 'lib/thinking_sphinx/search.rb', line 68

def to_a
  populate
  @array
end

#total_entries ⇒ Integer

The total number of search results available.

Returns:

  • (Integer) 


175
176
177
178
179
180
 
# File 'lib/thinking_sphinx/search.rb', line 175

def total_entries
  populate
  return 0 if @results[:total_found].nil?
  
  @total_entries ||= @results[:total_found]
end

#total_pages ⇒ Integer Also known as: page_count

The total number of pages available if the results are paginated.

Returns:

  • (Integer) 


162
163
164
165
166
167
 
# File 'lib/thinking_sphinx/search.rb', line 162

def total_pages
  populate
  return 0 if @results[:total].nil?
  
  @total_pages ||= (@results[:total] / per_page.to_f).ceil
end