Added support for scripting to where option - closes #1600 and closes #…

…1660

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 5.4.0 (unreleased)
 
+- Added support for scripting to `where` option
 - Added warning for full reindex and `:queue` mode
 - Dropped support for Ruby < 3.1
 

README.md

@@ -122,7 +122,8 @@ where: {
   store_id: {exists: true},      # exists
   _not: {store_id: 1},           # negate a condition
   _or: [{in_stock: true}, {backordered: true}],
-  _and: [{in_stock: true}, {backordered: true}]
+  _and: [{in_stock: true}, {backordered: true}],
+  _script: Searchkick.script("doc['a'].value > doc['b'].value") # [unreleased]
 }
 ```
 

lib/searchkick.rb

@@ -26,6 +26,7 @@
 require_relative "searchkick/relation"
 require_relative "searchkick/relation_indexer"
 require_relative "searchkick/results"
+require_relative "searchkick/script"
 require_relative "searchkick/version"
 require_relative "searchkick/where"
 
@@ -189,6 +190,12 @@ def self.multi_search(queries)
     end
   end
 
+  # script
+
+  def self.script(source, **options)
+    Script.new(source, **options)
+  end
+
   # callbacks
 
   def self.enable_callbacks

lib/searchkick/query.rb

@@ -909,8 +909,12 @@ def where_filters(where)
           filters << {bool: {must_not: where_filters(value)}}
         elsif field == :_and
           filters << {bool: {must: value.map { |or_statement| {bool: {filter: where_filters(or_statement)}} }}}
-        # elsif field == :_script
-        #   filters << {script: {script: {source: value, lang: "painless"}}}
+        elsif field == :_script
+          unless value.is_a?(Script)
+            raise TypeError, "expected Searchkick::Script"
+          end
+
+          filters << {script: {script: {source: value.source, lang: value.lang, params: value.params}}}
         else
           # expand ranges
           if value.is_a?(Range)

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

test/where_test.rb

@@ -254,13 +254,22 @@ def test_ilike_optional_operators
     assert_search "product", ["Product @Home"], where: {name: {ilike: "%@home%"}}
   end
 
-  # def test_script
-  #   store [
-  #     {name: "Product A", store_id: 1},
-  #     {name: "Product B", store_id: 10}
-  #   ]
-  #   assert_search "product", ["Product A"], where: {_script: "doc['store_id'].value < 10"}
-  # end
+  def test_script
+    store [
+      {name: "Product A", store_id: 1},
+      {name: "Product B", store_id: 10}
+    ]
+    assert_search "product", ["Product A"], where: {_script: Searchkick.script("doc['store_id'].value < 10")}
+    assert_search "product", ["Product A"], where: {_script: Searchkick.script("doc['store_id'].value < 10", lang: "expression")}
+    assert_search "product", ["Product A"], where: {_script: Searchkick.script("doc['store_id'].value < params['value']", params: {value: 10})}
+  end
+
+  def test_script_string
+    error = assert_raises(TypeError) do
+      assert_search "product", ["Product A"], where: {_script: "doc['store_id'].value < 10"}
+    end
+    assert_equal "expected Searchkick::Script", error.message
+  end
 
   def test_where_string
     store [