searchkick 5.0.2 → 5.4.0

data/lib/searchkick/relation.rb

@@ -8,6 +8,9 @@ module Searchkick
     delegate :body, :params, to: :query
     delegate_missing_to :private_execute
 
+    attr_reader :model
+    alias_method :klass, :model
+
     def initialize(model, term = "*", **options)
       @model = model
       @term = term
@@ -26,20 +29,22 @@ module Searchkick
 
     def execute
       Searchkick.warn("The execute method is no longer needed")
-      private_execute
-      self
+      load
     end
 
+    # experimental
     def limit(value)
       clone.limit!(value)
     end
 
+    # experimental
     def limit!(value)
       check_loaded
       @options[:limit] = value
       self
     end
 
+    # experimental
     def offset(value = NO_DEFAULT_VALUE)
       # TODO remove in Searchkick 6
       if value == NO_DEFAULT_VALUE
@@ -49,22 +54,26 @@ module Searchkick
       end
     end
 
+    # experimental
     def offset!(value)
       check_loaded
       @options[:offset] = value
       self
     end
 
+    # experimental
     def page(value)
       clone.page!(value)
     end
 
+    # experimental
     def page!(value)
       check_loaded
       @options[:page] = value
       self
     end
 
+    # experimental
     def per_page(value = NO_DEFAULT_VALUE)
       # TODO remove in Searchkick 6
       if value == NO_DEFAULT_VALUE
@@ -74,24 +83,139 @@ module Searchkick
       end
     end
 
+    # experimental
     def per_page!(value)
       check_loaded
       @options[:per_page] = value
       self
     end
 
+    # experimental
+    def where(value = NO_DEFAULT_VALUE)
+      if value == NO_DEFAULT_VALUE
+        Where.new(self)
+      else
+        clone.where!(value)
+      end
+    end
+
+    # experimental
+    def where!(value)
+      check_loaded
+      if @options[:where]
+        @options[:where] = {_and: [@options[:where], ensure_permitted(value)]}
+      else
+        @options[:where] = ensure_permitted(value)
+      end
+      self
+    end
+
+    # experimental
+    def rewhere(value)
+      clone.rewhere!(value)
+    end
+
+    # experimental
+    def rewhere!(value)
+      check_loaded
+      @options[:where] = ensure_permitted(value)
+      self
+    end
+
+    # experimental
+    def order(*values)
+      clone.order!(*values)
+    end
+
+    # experimental
+    def order!(*values)
+      values = values.first if values.size == 1 && values.first.is_a?(Array)
+      check_loaded
+      (@options[:order] ||= []).concat(values)
+      self
+    end
+
+    # experimental
+    def reorder(*values)
+      clone.reorder!(*values)
+    end
+
+    # experimental
+    def reorder!(*values)
+      check_loaded
+      @options[:order] = values
+      self
+    end
+
+    # experimental
+    def select(*values, &block)
+      if block_given?
+        private_execute.select(*values, &block)
+      else
+        clone.select!(*values)
+      end
+    end
+
+    # experimental
+    def select!(*values)
+      check_loaded
+      (@options[:select] ||= []).concat(values)
+      self
+    end
+
+    # experimental
+    def reselect(*values)
+      clone.reselect!(*values)
+    end
+
+    # experimental
+    def reselect!(*values)
+      check_loaded
+      @options[:select] = values
+      self
+    end
+
+    # experimental
+    def includes(*values)
+      clone.includes!(*values)
+    end
+
+    # experimental
+    def includes!(*values)
+      check_loaded
+      (@options[:includes] ||= []).concat(values)
+      self
+    end
+
+    # experimental
     def only(*keys)
       Relation.new(@model, @term, **@options.slice(*keys))
     end
 
+    # experimental
     def except(*keys)
       Relation.new(@model, @term, **@options.except(*keys))
     end
 
+    # experimental
+    def load
+      private_execute
+      self
+    end
+
     def loaded?
       !@execute.nil?
     end
 
+    def respond_to_missing?(method_name, include_all)
+      Results.new(nil, nil, nil).respond_to?(method_name, include_all) || super
+    end
+
+    # TODO uncomment in 6.0
+    # def to_yaml
+    #   private_execute.to_a.to_yaml
+    # end
+
     private
 
     def private_execute
@@ -108,5 +232,16 @@ module Searchkick
       # reset query since options will change
       @query = nil
     end
+
+    # provides *very* basic protection from unfiltered parameters
+    # this is not meant to be comprehensive and may be expanded in the future
+    def ensure_permitted(obj)
+      obj.to_h
+    end
+
+    def initialize_copy(other)
+      super
+      @execute = nil
+    end
   end
 end

data/lib/searchkick/relation_indexer.rb

@@ -14,12 +14,17 @@ module Searchkick
         relation = relation.search_import
       end
 
-      # remove unneeded loading for async
-      if mode == :async
+      # remove unneeded loading for async and queue
+      if mode == :async || mode == :queue
         if relation.respond_to?(:primary_key)
-          relation = relation.select(relation.primary_key).except(:includes, :preload)
+          relation = relation.except(:includes, :preload)
+          unless mode == :queue && relation.klass.method_defined?(:search_routing)
+            relation = relation.except(:select).select(relation.primary_key)
+          end
         elsif relation.respond_to?(:only)
-          relation = relation.only(:_id)
+          unless mode == :queue && relation.klass.method_defined?(:search_routing)
+            relation = relation.only(:_id)
+          end
         end
       end
 
@@ -42,11 +47,11 @@ module Searchkick
     end
 
     def batches_left
-      Searchkick.with_redis { |r| r.scard(batches_key) }
+      Searchkick.with_redis { |r| r.call("SCARD", batches_key) }
     end
 
     def batch_completed(batch_id)
-      Searchkick.with_redis { |r| r.srem(batches_key, batch_id) }
+      Searchkick.with_redis { |r| r.call("SREM", batches_key, [batch_id]) }
     end
 
     private
@@ -134,7 +139,7 @@ module Searchkick
     end
 
     def batch_job(class_name, batch_id, record_ids)
-      Searchkick.with_redis { |r| r.sadd(batches_key, batch_id) }
+      Searchkick.with_redis { |r| r.call("SADD", batches_key, [batch_id]) }
       Searchkick::BulkReindexJob.perform_later(
         class_name: class_name,
         index_name: index.name,

data/lib/searchkick/reranking.rb

@@ -0,0 +1,28 @@
+module Searchkick
+  module Reranking
+    def self.rrf(first_ranking, *rankings, k: 60)
+      rankings.unshift(first_ranking)
+      rankings.map!(&:to_ary)
+
+      ranks = []
+      results = []
+      rankings.each do |ranking|
+        ranks << ranking.map.with_index.to_h { |v, i| [v, i + 1] }
+        results.concat(ranking)
+      end
+
+      results =
+        results.uniq.map do |result|
+          score =
+            ranks.sum do |rank|
+              r = rank[result]
+              r ? 1.0 / (k + r) : 0.0
+            end
+
+          {result: result, score: score}
+        end
+
+      results.sort_by { |v| -v[:score] }
+    end
+  end
+end

data/lib/searchkick/results.rb

@@ -3,6 +3,7 @@ module Searchkick
     include Enumerable
     extend Forwardable
 
+    # TODO remove klass and options in 6.0
     attr_reader :klass, :response, :options
 
     def_delegators :results, :each, :any?, :empty?, :size, :length, :slice, :[], :to_ary
@@ -13,6 +14,7 @@ module Searchkick
       @options = options
     end
 
+    # TODO make private in 6.0
     def results
       @results ||= with_hit.map(&:first)
     end
@@ -302,7 +304,7 @@ module Searchkick
     def build_hits
       @build_hits ||= begin
         if missing_records.any?
-          Searchkick.warn("Records in search index do not exist in database: #{missing_records.map { |v| v[:id] }.join(", ")}")
+          Searchkick.warn("Records in search index do not exist in database: #{missing_records.map { |v| "#{Array(v[:model]).map(&:model_name).sort.join("/")} #{v[:id]}" }.join(", ")}")
         end
         with_hit_and_missing_records[0]
       end

data/lib/searchkick/script.rb

@@ -0,0 +1,11 @@
+module Searchkick
+  class Script
+    attr_reader :source, :lang, :params
+
+    def initialize(source, lang: "painless", params: {})
+      @source = source
+      @lang = lang
+      @params = params
+    end
+  end
+end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "5.0.2"
+  VERSION = "5.4.0"
 end

data/lib/searchkick/where.rb

@@ -0,0 +1,11 @@
+module Searchkick
+  class Where
+    def initialize(relation)
+      @relation = relation
+    end
+
+    def not(value)
+      @relation.where(_not: value)
+    end
+  end
+end

data/lib/searchkick.rb

@@ -10,26 +10,29 @@ require "hashie"
 require "forwardable"
 
 # modules
-require "searchkick/controller_runtime"
-require "searchkick/index"
-require "searchkick/index_cache"
-require "searchkick/index_options"
-require "searchkick/indexer"
-require "searchkick/hash_wrapper"
-require "searchkick/log_subscriber"
-require "searchkick/model"
-require "searchkick/multi_search"
-require "searchkick/query"
-require "searchkick/reindex_queue"
-require "searchkick/record_data"
-require "searchkick/record_indexer"
-require "searchkick/relation"
-require "searchkick/relation_indexer"
-require "searchkick/results"
-require "searchkick/version"
+require_relative "searchkick/controller_runtime"
+require_relative "searchkick/index"
+require_relative "searchkick/index_cache"
+require_relative "searchkick/index_options"
+require_relative "searchkick/indexer"
+require_relative "searchkick/hash_wrapper"
+require_relative "searchkick/log_subscriber"
+require_relative "searchkick/model"
+require_relative "searchkick/multi_search"
+require_relative "searchkick/query"
+require_relative "searchkick/reindex_queue"
+require_relative "searchkick/record_data"
+require_relative "searchkick/record_indexer"
+require_relative "searchkick/relation"
+require_relative "searchkick/relation_indexer"
+require_relative "searchkick/reranking"
+require_relative "searchkick/results"
+require_relative "searchkick/script"
+require_relative "searchkick/version"
+require_relative "searchkick/where"
 
 # integrations
-require "searchkick/railtie" if defined?(Rails)
+require_relative "searchkick/railtie" if defined?(Rails)
 
 module Searchkick
   # requires faraday
@@ -134,11 +137,21 @@ module Searchkick
     @opensearch
   end
 
-  def self.server_below?(version)
-    server_version = opensearch? ? "7.10.2" : self.server_version
+  # TODO always check true version in Searchkick 6
+  def self.server_below?(version, true_version = false)
+    server_version = !true_version && opensearch? ? "7.10.2" : self.server_version
     Gem::Version.new(server_version.split("-")[0]) < Gem::Version.new(version.split("-")[0])
   end
 
+  # private
+  def self.knn_support?
+    if opensearch?
+      !server_below?("2.4.0", true)
+    else
+      !server_below?("8.6.0")
+    end
+  end
+
   def self.search(term = "*", model: nil, **options, &block)
     options = options.dup
     klass = model
@@ -180,13 +193,20 @@ module Searchkick
     queries = queries.map { |q| q.send(:query) }
     event = {
       name: "Multi Search",
-      body: queries.flat_map { |q| [q.params.except(:body).to_json, q.body.to_json] }.map { |v| "#{v}\n" }.join,
+      body: queries.flat_map { |q| [q.params.except(:body).to_json, q.body.to_json] }.map { |v| "#{v}\n" }.join
     }
     ActiveSupport::Notifications.instrument("multi_search.searchkick", event) do
       MultiSearch.new(queries).perform
     end
   end
 
+  # script
+
+  # experimental
+  def self.script(source, **options)
+    Script.new(source, **options)
+  end
+
   # callbacks
 
   def self.enable_callbacks
@@ -283,7 +303,7 @@ module Searchkick
     relation
   end
 
-  # private
+  # public (for reindexing conversions)
   def self.load_model(class_name, allow_child: false)
     model = class_name.safe_constantize
     raise Error, "Could not find class: #{class_name}" unless model

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -69,8 +69,11 @@ files:
 - lib/searchkick/reindex_v2_job.rb
 - lib/searchkick/relation.rb
 - lib/searchkick/relation_indexer.rb
+- lib/searchkick/reranking.rb
 - lib/searchkick/results.rb
+- lib/searchkick/script.rb
 - lib/searchkick/version.rb
+- lib/searchkick/where.rb
 - lib/tasks/searchkick.rake
 homepage: https://github.com/ankane/searchkick
 licenses:
@@ -84,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch or OpenSearch