module Searchkick::Model

Public Class Methods

disable_search_callbacks() click to toggle source
# File lib/searchkick/model.rb, line 44
def disable_search_callbacks
  class_variable_set :@@searchkick_callbacks, false
end
enable_search_callbacks() click to toggle source
# File lib/searchkick/model.rb, line 40
def enable_search_callbacks
  class_variable_set :@@searchkick_callbacks, true
end
reindex(method_name = nil, full: false, **options)
Alias for: searchkick_reindex
search_callbacks?() click to toggle source
# File lib/searchkick/model.rb, line 48
def search_callbacks?
  class_variable_get(:@@searchkick_callbacks) && Searchkick.callbacks?
end
search_index()
Alias for: searchkick_index
searchkick_index() click to toggle source
# File lib/searchkick/model.rb, line 33
def searchkick_index
  index = class_variable_get :@@searchkick_index
  index = index.call if index.respond_to? :call
  Searchkick::Index.new(index, searchkick_options)
end
Also aliased as: search_index
searchkick_index_options() click to toggle source
# File lib/searchkick/model.rb, line 75
def searchkick_index_options
  searchkick_index.index_options
end
searchkick_reindex(method_name = nil, full: false, **options) click to toggle source
# File lib/searchkick/model.rb, line 52
def searchkick_reindex(method_name = nil, full: false, **options)
  scoped = (respond_to?(:current_scope) && respond_to?(:default_scoped) && current_scope && current_scope.to_sql != default_scoped.to_sql) ||
    (respond_to?(:queryable) && queryable != unscoped.with_default_scope)

  refresh = options.fetch(:refresh, !scoped)

  if method_name
    # update
    searchkick_index.import_scope(searchkick_klass, method_name: method_name)
    searchkick_index.refresh if refresh
    true
  elsif scoped && !full
    # reindex association
    searchkick_index.import_scope(searchkick_klass)
    searchkick_index.refresh if refresh
    true
  else
    # full reindex
    searchkick_index.reindex_scope(searchkick_klass, options)
  end
end
Also aliased as: reindex

Public Instance Methods

destroyed?() click to toggle source
# File lib/searchkick/model.rb, line 156
def destroyed?
  transient?
end
reindex(method_name = nil, refresh: false, async: false, mode: nil) click to toggle source
# File lib/searchkick/model.rb, line 88
def reindex(method_name = nil, refresh: false, async: false, mode: nil)
  klass_options = self.class.searchkick_index.options

  if mode.nil?
    mode =
      if async
        :async
      elsif Searchkick.callbacks_value
        Searchkick.callbacks_value
      elsif klass_options.key?(:callbacks) && klass_options[:callbacks] != :async
        # TODO remove 2nd condition in next major version
        klass_options[:callbacks]
      end
  end

  case mode
  when :queue
    if method_name
      raise Searchkick::Error, "Partial reindex not supported with queue option"
    else
      self.class.searchkick_index.reindex_queue.push(id.to_s)
    end
  when :async
    if method_name
      # TODO support Mongoid and NoBrainer and non-id primary keys
      Searchkick::BulkReindexJob.perform_later(
        class_name: self.class.name,
        record_ids: [id.to_s],
        method_name: method_name ? method_name.to_s : nil
      )
    else
      self.class.searchkick_index.reindex_record_async(self)
    end
  else
    if method_name
      self.class.searchkick_index.update_record(self, method_name)
    else
      self.class.searchkick_index.reindex_record(self)
    end
    self.class.searchkick_index.refresh if refresh
  end
end
reindex_async() click to toggle source

TODO remove this method in next major version

# File lib/searchkick/model.rb, line 139
def reindex_async
  reindex(async: true)
end
search_data() click to toggle source
# File lib/searchkick/model.rb, line 147
def search_data
  respond_to?(:to_hash) ? to_hash : serializable_hash
end
searchkick(**options) click to toggle source
# File lib/searchkick/model.rb, line 3
def searchkick(**options)
  unknown_keywords = options.keys - [:_all, :batch_size, :callbacks, :conversions, :default_fields,
    :filterable, :geo_shape, :highlight, :ignore_above, :index_name, :index_prefix, :language,
    :locations, :mappings, :match, :merge_mappings, :routing, :searchable, :settings, :similarity,
    :special_characters, :stem_conversions, :suggest, :synonyms, :text_end,
    :text_middle, :text_start, :word, :wordnet, :word_end, :word_middle, :word_start]
  raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?

  raise "Only call searchkick once per model" if respond_to?(:searchkick_index)

  Searchkick.models << self

  class_eval do
    cattr_reader :searchkick_options, :searchkick_klass

    callbacks = options.key?(:callbacks) ? options[:callbacks] : true

    class_variable_set :@@searchkick_options, options.dup
    class_variable_set :@@searchkick_klass, self
    class_variable_set :@@searchkick_callbacks, callbacks
    class_variable_set :@@searchkick_index, options[:index_name] ||
      (options[:index_prefix].respond_to?(:call) && proc { [options[:index_prefix].call, model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_") }) ||
      [options.key?(:index_prefix) ? options[:index_prefix] : Searchkick.index_prefix, model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_")

    class << self
      def searchkick_search(term = "*", **options, &block)
        Searchkick.search(term, {model: self}.merge(options), &block)
      end
      alias_method Searchkick.search_method_name, :searchkick_search if Searchkick.search_method_name

      def searchkick_index
        index = class_variable_get :@@searchkick_index
        index = index.call if index.respond_to? :call
        Searchkick::Index.new(index, searchkick_options)
      end
      alias_method :search_index, :searchkick_index unless method_defined?(:search_index)

      def enable_search_callbacks
        class_variable_set :@@searchkick_callbacks, true
      end

      def disable_search_callbacks
        class_variable_set :@@searchkick_callbacks, false
      end

      def search_callbacks?
        class_variable_get(:@@searchkick_callbacks) && Searchkick.callbacks?
      end

      def searchkick_reindex(method_name = nil, full: false, **options)
        scoped = (respond_to?(:current_scope) && respond_to?(:default_scoped) && current_scope && current_scope.to_sql != default_scoped.to_sql) ||
          (respond_to?(:queryable) && queryable != unscoped.with_default_scope)

        refresh = options.fetch(:refresh, !scoped)

        if method_name
          # update
          searchkick_index.import_scope(searchkick_klass, method_name: method_name)
          searchkick_index.refresh if refresh
          true
        elsif scoped && !full
          # reindex association
          searchkick_index.import_scope(searchkick_klass)
          searchkick_index.refresh if refresh
          true
        else
          # full reindex
          searchkick_index.reindex_scope(searchkick_klass, options)
        end
      end
      alias_method :reindex, :searchkick_reindex unless method_defined?(:reindex)

      def searchkick_index_options
        searchkick_index.index_options
      end
    end

    callback_name = callbacks == :async ? :reindex_async : :reindex
    if respond_to?(:after_commit)
      after_commit callback_name, if: proc { self.class.search_callbacks? }
    elsif respond_to?(:after_save)
      after_save callback_name, if: proc { self.class.search_callbacks? }
      after_destroy callback_name, if: proc { self.class.search_callbacks? }
    end

    def reindex(method_name = nil, refresh: false, async: false, mode: nil)
      klass_options = self.class.searchkick_index.options

      if mode.nil?
        mode =
          if async
            :async
          elsif Searchkick.callbacks_value
            Searchkick.callbacks_value
          elsif klass_options.key?(:callbacks) && klass_options[:callbacks] != :async
            # TODO remove 2nd condition in next major version
            klass_options[:callbacks]
          end
      end

      case mode
      when :queue
        if method_name
          raise Searchkick::Error, "Partial reindex not supported with queue option"
        else
          self.class.searchkick_index.reindex_queue.push(id.to_s)
        end
      when :async
        if method_name
          # TODO support Mongoid and NoBrainer and non-id primary keys
          Searchkick::BulkReindexJob.perform_later(
            class_name: self.class.name,
            record_ids: [id.to_s],
            method_name: method_name ? method_name.to_s : nil
          )
        else
          self.class.searchkick_index.reindex_record_async(self)
        end
      else
        if method_name
          self.class.searchkick_index.update_record(self, method_name)
        else
          self.class.searchkick_index.reindex_record(self)
        end
        self.class.searchkick_index.refresh if refresh
      end
    end unless method_defined?(:reindex)

    def termvectors(arguments = {})
      index = self.class.searchkick_index
      index_name = index.name
      index_type = index.send :document_type, self
      Searchkick.client.termvectors(:id => self.id, :index => index_name, :type => index_type)
    end

    # TODO remove this method in next major version
    def reindex_async
      reindex(async: true)
    end unless method_defined?(:reindex_async)

    def similar(options = {})
      self.class.searchkick_index.similar_record(self, options)
    end unless method_defined?(:similar)

    def search_data
      respond_to?(:to_hash) ? to_hash : serializable_hash
    end unless method_defined?(:search_data)

    def should_index?
      true
    end unless method_defined?(:should_index?)

    if defined?(Cequel) && self < Cequel::Record && !method_defined?(:destroyed?)
      def destroyed?
        transient?
      end
    end
  end
end
should_index?() click to toggle source
# File lib/searchkick/model.rb, line 151
def should_index?
  true
end
similar(options = {}) click to toggle source
# File lib/searchkick/model.rb, line 143
def similar(options = {})
  self.class.searchkick_index.similar_record(self, options)
end
termvectors(arguments = {}) click to toggle source
# File lib/searchkick/model.rb, line 131
def termvectors(arguments = {})
  index = self.class.searchkick_index
  index_name = index.name
  index_type = index.send :document_type, self
  Searchkick.client.termvectors(:id => self.id, :index => index_name, :type => index_type)
end