Module: Searchkick::Model

Defined in:
lib/searchkick/model.rb

Instance Method Summary collapse

Instance Method Details

#searchkick(**options) ⇒ Object

Raises:

  • (ArgumentError)

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/searchkick/model.rb', line 3

def searchkick(**options)
  options = Searchkick.model_options.merge(options)

  unknown_keywords = options.keys - [:_all, :_type, :batch_size, :callbacks, :case_sensitive, :conversions, :deep_paging, :default_fields,
    :filterable, :geo_shape, :highlight, :ignore_above, :index_name, :index_prefix, :inheritance, :language,
    :locations, :mappings, :match, :merge_mappings, :routing, :searchable, :search_synonyms, :settings, :similarity,
    :special_characters, :stem, :stem_conversions, :stem_exclusion, :stemmer_override, :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

  options[:_type] ||= -> { searchkick_index.klass_document_type(self, true) }
  options[:class_name] = model_name.name

  callbacks = options.key?(:callbacks) ? options[:callbacks] : :inline
  unless [:inline, true, false, :async, :queue].include?(callbacks)
    raise ArgumentError, "Invalid value for callbacks"
  end

  index_name =
    if options[:index_name]
      options[:index_name]
    elsif options[:index_prefix].respond_to?(:call)
      -> { [options[:index_prefix].call, model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_") }
    else
      [options.key?(:index_prefix) ? options[:index_prefix] : Searchkick.index_prefix, model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_")
    end

  class_eval do
    cattr_reader :searchkick_options, :searchkick_klass

    class_variable_set :@@searchkick_options, options.dup
    class_variable_set :@@searchkick_klass, self
    class_variable_set :@@searchkick_index, index_name
    class_variable_set :@@searchkick_index_cache, {}

    class << self
      def searchkick_search(term = "*", **options, &block)
        # TODO throw error in next major version
        Searchkick.warn("calling search on a relation is deprecated") if Searchkick.relation?(self)

        Searchkick.search(term, model: self, **options, &block)
      end
      alias_method Searchkick.search_method_name, :searchkick_search if Searchkick.search_method_name

      def searchkick_index(name: nil)
        index = name || class_variable_get(:@@searchkick_index)
        index = index.call if index.respond_to?(:call)
        index_cache = class_variable_get(:@@searchkick_index_cache)
        index_cache[index] ||= Searchkick::Index.new(index, searchkick_options)
      end
      alias_method :search_index, :searchkick_index unless method_defined?(:search_index)

      def searchkick_reindex(method_name = nil, **options)
        # TODO relation = Searchkick.relation?(self)
        relation = (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)

        searchkick_index.reindex(searchkick_klass, method_name, scoped: relation, **options)
      end
      alias_method :reindex, :searchkick_reindex unless method_defined?(:reindex)

      def searchkick_index_options
        searchkick_index.index_options
      end
    end

    # always add callbacks, even when callbacks is false
    # so Model.callbacks block can be used
    if respond_to?(:after_commit)
      after_commit :reindex, if: -> { Searchkick.callbacks?(default: callbacks) }
    elsif respond_to?(:after_save)
      after_save :reindex, if: -> { Searchkick.callbacks?(default: callbacks) }
      after_destroy :reindex, if: -> { Searchkick.callbacks?(default: callbacks) }
    end

    def reindex(method_name = nil, **options)
      RecordIndexer.new(self).reindex(method_name, **options)
    end unless method_defined?(:reindex)

    # TODO switch to keyword arguments
    def similar(options = {})
      self.class.searchkick_index.similar_record(self, **options)
    end unless method_defined?(:similar)

    def search_data
      data = respond_to?(:to_hash) ? to_hash : serializable_hash
      data.delete("id")
      data.delete("_id")
      data.delete("_type")
      data
    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