chewy 7.3.5 → 7.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb16d3ca40da336d2445b114cff68c634f6091c66352f459bafbce6794aa864
-  data.tar.gz: bedb5bcc0520a6e6b26c9605cd2574a102469d6043f9ce39c55aeae61d1fa30b
+  metadata.gz: e5405b97585dccb630ef95340245a390ff7ffe19a1a27e57a35b4f4d6844e2e0
+  data.tar.gz: 91570a2fd199d511bf40caf473d8000504cae38a4bb4b68c6f767913033f7234
 SHA512:
-  metadata.gz: 46eef11ff1d3acf7d3717fa5975071f06ae0fa03f638c82be7f5e687efababf39c67d1cfd7d376854c556ea0227876743b5e7e0ac845df1f72f1ea8bab510d70
-  data.tar.gz: '0889aee5bc0d928dbff9b1894064c5fe3f8a572b7f3e434034b8fe32a7bcece1d48a86673cad80fcc40b2a6a41342f7195905d90d87e7f6a85d9bb5e1b8ab4a2'
+  metadata.gz: 8441a05d5a3c55834f7380a1e10b3acb4f01f17b6cafc45e3ccead13f0d7c2a6485447c2bc8461ae5c91b37b36c4d57f140f76cb993ca63777195d64237d8432
+  data.tar.gz: 3571db3d5fa632d6ee9c10105578ca8f805090e375372f1ad98a192dca440536f27559be2439d7e75c8ab833f596fc61758d464696ec4ee47942ff29fbffa6d5

data/CHANGELOG.md

@@ -8,6 +8,16 @@
 
 ### Bugs Fixed
 
+## 7.3.5 (2023-12-13)
+
+### New Features
+
+* [#890](https://github.com/toptal/chewy/pull/890): Add the [`knn`](https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html) option to the request. ([@jkostolansky][])
+
+### Changes
+
+### Bugs Fixed
+
 ## 7.3.5 (2023-12-06)
 
 ### New Features

data/lib/chewy/search/parameters/knn.rb

@@ -0,0 +1,16 @@
+require 'chewy/search/parameters/storage'
+
+module Chewy
+  module Search
+    class Parameters
+      # Just a standard hash storage. Nothing to see here.
+      #
+      # @see Chewy::Search::Parameters::HashStorage
+      # @see Chewy::Search::Request#knn
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html
+      class Knn < Storage
+        include HashStorage
+      end
+    end
+  end
+end

data/lib/chewy/search/request.rb

@@ -20,7 +20,7 @@ module Chewy
       UNDEFINED = Class.new.freeze
       EVERFIELDS = %w[_index _type _id _parent _routing].freeze
       DELEGATED_METHODS = %i[
-        query filter post_filter order reorder docvalue_fields
+        query filter post_filter knn order reorder docvalue_fields
         track_scores track_total_hits request_cache explain version profile
         search_type preference limit offset terminate_after
         timeout min_score source stored_fields search_after
@@ -41,7 +41,7 @@ module Chewy
       EXTRA_STORAGES = %i[aggs suggest].freeze
       # An array of storage names that are changing the returned hist collection in any way.
       WHERE_STORAGES = %i[
-        query filter post_filter none min_score rescore indices_boost collapse
+        query filter post_filter knn none min_score rescore indices_boost collapse
       ].freeze
 
       delegate :hits, :wrappers, :objects, :records, :documents,
@@ -520,7 +520,18 @@ module Chewy
       #   @see https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html
       #   @param value [Hash]
       #   @return [Chewy::Search::Request]
-      %i[request_cache search_type preference timeout limit offset terminate_after min_score ignore_unavailable collapse].each do |name|
+      #
+      # @!method knn(value)
+      #   Replaces the value of the `knn` request part.
+      #
+      #   @example
+      #     PlacesIndex.knn(field: :vector, query_vector: [4, 2], k: 5, num_candidates: 50)
+      #     # => <PlacesIndex::Query {..., :body=>{:knn=>{"field"=>:vector, "query_vector"=>[4, 2], "k"=>5, "num_candidates"=>50}}}>
+      #   @see Chewy::Search::Parameters::Knn
+      #   @see https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html
+      #   @param value [Hash]
+      #   @return [Chewy::Search::Request]
+      %i[request_cache search_type preference timeout limit offset terminate_after min_score ignore_unavailable collapse knn].each do |name|
         define_method name do |value|
           modify(name) { replace!(value) }
         end

data/lib/chewy/version.rb

@@ -1,3 +1,3 @@
 module Chewy
-  VERSION = '7.3.5'.freeze
+  VERSION = '7.3.6'.freeze
 end

data/spec/chewy/search/parameters/knn_spec.rb

@@ -0,0 +1,5 @@
+require 'chewy/search/parameters/hash_storage_examples'
+
+describe Chewy::Search::Parameters::Knn do
+  it_behaves_like :hash_storage, :knn
+end

data/spec/chewy/search/request_spec.rb

@@ -314,14 +314,16 @@ describe Chewy::Search::Request do
     end
   end
 
-  describe '#collapse' do
-    specify { expect(subject.collapse(foo: {bar: 42}).render[:body]).to include(collapse: {'foo' => {bar: 42}}) }
-    specify do
-      expect(subject.collapse(foo: {bar: 42}).collapse(moo: {baz: 43}).render[:body])
-        .to include(collapse: {'moo' => {baz: 43}})
+  %i[collapse knn].each do |name|
+    describe "##{name}" do
+      specify { expect(subject.send(name, foo: {bar: 42}).render[:body]).to include(name => {'foo' => {bar: 42}}) }
+      specify do
+        expect(subject.send(name, foo: {bar: 42}).send(name, moo: {baz: 43}).render[:body])
+          .to include(name => {'moo' => {baz: 43}})
+      end
+      specify { expect(subject.send(name, foo: {bar: 42}).send(name, nil).render[:body]).to be_blank }
+      specify { expect { subject.send(name, foo: {bar: 42}) }.not_to change { subject.render } }
     end
-    specify { expect(subject.collapse(foo: {bar: 42}).collapse(nil).render[:body]).to be_blank }
-    specify { expect { subject.collapse(foo: {bar: 42}) }.not_to change { subject.render } }
   end
 
   describe '#docvalue_fields' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chewy
 version: !ruby/object:Gem::Version
-  version: 7.3.5
+  version: 7.3.6
 platform: ruby
 authors:
 - Toptal, LLC
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -324,6 +324,7 @@ files:
 - lib/chewy/search/parameters/ignore_unavailable.rb
 - lib/chewy/search/parameters/indices.rb
 - lib/chewy/search/parameters/indices_boost.rb
+- lib/chewy/search/parameters/knn.rb
 - lib/chewy/search/parameters/limit.rb
 - lib/chewy/search/parameters/load.rb
 - lib/chewy/search/parameters/min_score.rb
@@ -419,6 +420,7 @@ files:
 - spec/chewy/search/parameters/ignore_unavailable_spec.rb
 - spec/chewy/search/parameters/indices_spec.rb
 - spec/chewy/search/parameters/integer_storage_examples.rb
+- spec/chewy/search/parameters/knn_spec.rb
 - spec/chewy/search/parameters/limit_spec.rb
 - spec/chewy/search/parameters/load_spec.rb
 - spec/chewy/search/parameters/min_score_spec.rb
@@ -537,6 +539,7 @@ test_files:
 - spec/chewy/search/parameters/ignore_unavailable_spec.rb
 - spec/chewy/search/parameters/indices_spec.rb
 - spec/chewy/search/parameters/integer_storage_examples.rb
+- spec/chewy/search/parameters/knn_spec.rb
 - spec/chewy/search/parameters/limit_spec.rb
 - spec/chewy/search/parameters/load_spec.rb
 - spec/chewy/search/parameters/min_score_spec.rb