Module: Sunspot::Rails::Searchable::InstanceMethods

Defined in:
lib/sunspot/rails/searchable.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/sunspot/rails/searchable.rb', line 364

def self.included(base) #:nodoc:
  base.module_eval do
    alias_method :index, :solr_index unless method_defined? :index
    alias_method :index!, :solr_index! unless method_defined? :index!
    alias_method :remove_from_index, :solr_remove_from_index unless method_defined? :remove_from_index
    alias_method :remove_from_index!, :solr_remove_from_index! unless method_defined? :remove_from_index!
    alias_method :more_like_this, :solr_more_like_this unless method_defined? :more_like_this
    alias_method :more_like_this_ids, :solr_more_like_this_ids unless method_defined? :more_like_this_ids
  end
end

Instance Method Details

#indexable? ⇒ Boolean

Returns:

  • (Boolean) 


425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/sunspot/rails/searchable.rb', line 425

def indexable?
  # options[:if] is not specified or they successfully pass
  if_passes = self.class.sunspot_options[:if].nil? ||
              constraint_passes?(self.class.sunspot_options[:if])

  # options[:unless] is not specified or they successfully pass
  unless_passes = self.class.sunspot_options[:unless].nil? ||
                  !constraint_passes?(self.class.sunspot_options[:unless])

  if_passes and unless_passes
end

#solr_index ⇒ Object

Index the model in Solr. If the model is already indexed, it will be updated. Using the defaults, you will usually not need to call this method, as models are indexed automatically when they are created or updated. If you have disabled automatic indexing (see ClassMethods#searchable), this method allows you to manage indexing manually.



382
383
384
 
# File 'lib/sunspot/rails/searchable.rb', line 382

def solr_index
  Sunspot.index(self)
end

#solr_index! ⇒ Object

Index the model in Solr and immediately commit. See #index



389
390
391
 
# File 'lib/sunspot/rails/searchable.rb', line 389

def solr_index!
  Sunspot.index!(self)
end

#solr_more_like_this(*args, &block) ⇒ Object 



412
413
414
415
416
417
 
# File 'lib/sunspot/rails/searchable.rb', line 412

def solr_more_like_this(*args, &block)
  options = args.extract_options!
  self.class.solr_execute_search(options) do
    Sunspot.new_more_like_this(self, *args, &block)
  end
end

#solr_more_like_this_ids(&block) ⇒ Object 



419
420
421
422
423
 
# File 'lib/sunspot/rails/searchable.rb', line 419

def solr_more_like_this_ids(&block)
  self.class.solr_execute_search_ids do
    solr_more_like_this(&block)
  end
end

#solr_remove_from_index ⇒ Object

Remove the model from the Solr index. Using the defaults, this should not be necessary, as models will automatically be removed from the index when they are destroyed. If you disable automatic removal (which is not recommended!), you can use this method to manage removal manually.



400
401
402
 
# File 'lib/sunspot/rails/searchable.rb', line 400

def solr_remove_from_index
  Sunspot.remove(self)
end

#solr_remove_from_index! ⇒ Object

Remove the model from the Solr index and commit immediately. See #remove_from_index



408
409
410
 
# File 'lib/sunspot/rails/searchable.rb', line 408

def solr_remove_from_index!
  Sunspot.remove!(self)
end