searchkick 6.0.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91941f04c724b051532a882173be99f4cd53a51ba1dac8b5b68807d2aee3d002
-  data.tar.gz: 1c5ed483a01e65ec2cb56dcc2f377cedaba1887b40f82ba40cb90bdb90055a21
+  metadata.gz: 33be926c61ab632ecf611bce7ceecc0f23cec9eedde74758b66c297936e48293
+  data.tar.gz: c9dd60ae1fe20336066554d08c042a2fde153d7d1bb2e49bacc32219a3943915
 SHA512:
-  metadata.gz: 438bad554db6815bfe582054d62933885c13d3b1ad28b7feea7c70709159eb7d168087aac9317658a86a274833c0832851497f205adf49e6f52aa97ff328291e
-  data.tar.gz: fd3481046430357d460a70e35dff63da66207138e21effbbe1793d5318ff8badb2168de4e7dc258ae49f2aa2a28b4c15df4c7046de3ef8cf14f1f601eae8d7cb
+  metadata.gz: 95ebb7c3cc4d511a7f75a1cef3f73f64e1bbf8242c18091cbacfe71bcd244840538c11f2c83db0a676f90c442668f4a1cb1c320d6e970a23bec00ee7ccec2935
+  data.tar.gz: eb7638d2cda8512314894dbcd205ccff57293b332f3e52e3fdbd4a8bb6359ea8cb309b2bd53b3b7c67515538e07422e16eca919092757106307abd22781df603

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 6.1.0 (2026-02-18)
+
+- Added `per` method
+- Fixed error with `aggs` method and non-hash arguments
+- Fixed smart aggs behavior when multiple `where` calls
+
+## 6.0.3 (2026-01-06)
+
+- Fixed `inspect` method for `Relation`
+
 ## 6.0.2 (2025-10-24)
 
 - Fixed `as_json` method for `HashWrapper`
@@ -22,6 +32,7 @@
 - Removed default quantization for `knn` option for Elasticsearch 8.14+
 - Removed `results` method (use `to_a` instead)
 - Removed `execute` option and method (no longer needed)
+- Removed `options` method (use individual methods instead)
 - Removed dependency on Hashie
 - Deprecated `conversions` option in favor of `conversions_v2`
 - Dropped support for Elasticsearch 7 and OpenSearch 1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2025 Andrew Kane
+Copyright (c) 2013-2026 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1182,7 +1182,7 @@ And to search, use:
 ```ruby
 Animal.search("*")                # all animals
 Dog.search("*")                   # just dogs
-Animal.search("*").type(Dog, Cat) # just cats and dogs
+Animal.search("*").type(Cat, Dog) # just cats and dogs
 ```
 
 **Notes:**
@@ -1547,30 +1547,6 @@ See [Production Rails](https://github.com/ankane/production_rails) for other goo
 
 ## Performance
 
-### JSON Generation
-
-Increase performance with faster JSON generation. Add to your Gemfile:
-
-```ruby
-gem "json", ">= 2.10.2"
-```
-
-And create an initializer with:
-
-```ruby
-class SearchSerializer
-  CODER = JSON::Coder.new { |v, _| v.is_a?(Time) ? v.as_json : v }
-
-  def dump(object)
-    CODER.generate(object)
-  end
-end
-
-Elasticsearch::API.settings[:serializer] = SearchSerializer.new
-# or
-OpenSearch::API.settings[:serializer] = SearchSerializer.new
-```
-
 ### Persistent HTTP Connections
 
 Significantly increase performance with persistent HTTP connections. Add [Typhoeus](https://github.com/typhoeus/typhoeus) to your Gemfile and it’ll automatically be used.
@@ -2311,7 +2287,7 @@ Product.search("apples").where(in_stock: true).limit(10).offset(50)
 
 All existing options can be used as methods, or you can continue to use the existing API.
 
-This release also significantly improves the performance of searches when using conversions. To upgrade without downtime, add `conversions_v2` to your model and an additional field to `search_data`:
+This release also significantly improves the performance of searches when using conversions. To upgrade conversions without downtime, add `conversions_v2` to your model and an additional field to `search_data`:
 
 ```ruby
 class Product < ApplicationRecord

data/lib/searchkick/index.rb

@@ -359,7 +359,7 @@ module Searchkick
     end
 
     # https://gist.github.com/jarosan/3124884
-    # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
+    # https://www.elastic.co/blog/changing-mapping-with-zero-downtime/
     def full_reindex(relation, import: true, resume: false, retain: false, mode: nil, refresh_interval: nil, scope: nil, wait: nil, job_options: nil)
       raise ArgumentError, "wait only available in :async mode" if !wait.nil? && mode != :async
       raise ArgumentError, "Full reindex does not support :queue mode - use :async mode instead" if mode == :queue

data/lib/searchkick/index_options.rb

@@ -524,7 +524,7 @@ module Searchkick
 
       dynamic_fields = {
         # analyzed field must be the default field for include_in_all
-        # http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
+        # https://www.elastic.co/guide/reference/mapping/multi-field-type/
         # however, we can include the not_analyzed field in _all
         # and the _all index analyzer will take care of it
         "{name}" => keyword_mapping
@@ -544,7 +544,7 @@ module Searchkick
         end
       end
 
-      # http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
+      # https://www.elastic.co/guide/reference/mapping/multi-field-type/
       multi_field = dynamic_fields["{name}"].merge(fields: dynamic_fields.except("{name}"))
 
       mappings = {
@@ -578,7 +578,7 @@ module Searchkick
         # https://groups.google.com/forum/#!topic/elasticsearch/p7qcQlgHdB8
         # TODO use a snowball stemmer on synonyms when creating the token filter
 
-        # http://elasticsearch-users.115913.n3.nabble.com/synonym-multi-words-search-td4030811.html
+        # https://discuss.elastic.co/t/synonym-multi-words-search/10964
         # I find the following approach effective if you are doing multi-word synonyms (synonym phrases):
         # - Only apply the synonym expansion at index time
         # - Don't have the synonym filter applied search

data/lib/searchkick/query.rb

@@ -872,10 +872,21 @@ module Searchkick
           }
         end
 
-        where = {}
-        where = ensure_permitted(options[:where] || {}).reject { |k| k == field } unless options[:smart_aggs] == false
         agg_where = ensure_permitted(agg_options[:where] || {})
-        agg_filters = where_filters(where.merge(agg_where))
+        if options[:smart_aggs] != false && options[:where]
+          where = ensure_permitted(options[:where])
+          where_without_field = where.reject { |k| k == field }
+          # where_without_field = where_without_field(where, field.to_s)
+          if where_without_field.any?
+            if agg_where.any?
+              agg_where = where.merge(agg_where)
+              # agg_where = combine_agg_where(agg_where, where_without_field)
+            else
+              agg_where = where_without_field
+            end
+          end
+        end
+        agg_filters = where_filters(agg_where)
 
         # only do one level comparison for simplicity
         filters.select! do |filter|
@@ -902,6 +913,53 @@ module Searchkick
       end
     end
 
+    def where_without_field(where, field)
+      result = {}
+      where.each do |f, v|
+        case f
+        when :_and
+          r = v.map { |v2| where_without_field(v2, field) }.reject(&:empty?)
+          result[f] = r unless r.empty?
+        when :_or
+          r = v.map { |v2| where_without_field(v2, field) }
+          result[f] = r unless r.any?(&:empty?)
+        when :or
+          r = v.map { |v2| v2.map { |v3| where_without_field(v3, field) }.reject { |v2| v2.any?(&:empty?) } }
+          result[f] = r unless r.empty?
+        when :_not
+          r = where_without_field(v, field)
+          result[f] = r unless r.empty?
+        when :_script
+          result[f] = v
+        else
+          if f.to_s != field
+            result[f] = v
+          end
+        end
+      end
+      result
+    end
+
+    def combine_agg_where(agg_where, where)
+      result = agg_where.dup
+      field_keys = result.except(:_and, :_or, :or, :_not, :_script).transform_keys(&:to_s)
+      where.each do |f, v|
+        case f
+        when :_and, :_or, :or, :_not, :_script
+          if result.key?(f)
+            # combine with _and if needed
+            result[:_and] ||= []
+            result[:_and] += [{f => v}]
+          else
+            result[f] = v
+          end
+        else
+          result[f] = v unless field_keys.include?(f.to_s)
+        end
+      end
+      result
+    end
+
     def set_knn(payload, knn, per_page, offset)
       if term != "*"
         raise ArgumentError, "Use Searchkick.multi_search for hybrid search"
@@ -1049,6 +1107,7 @@ module Searchkick
       (where || {}).each do |field, value|
         field = :_id if field.to_s == "id"
 
+        # update smart aggs when adding new symbol
         if field == :or
           value.each do |or_clause|
             filters << {bool: {should: or_clause.map { |or_statement| {bool: {filter: where_filters(or_statement)}} }}}

data/lib/searchkick/relation.rb

@@ -17,27 +17,36 @@ module Searchkick
       @options = options
 
       # generate query to validate options
-      query
+      query if options.any?
     end
 
     # same as Active Record
     def inspect
-      entries = results.first(11).map!(&:inspect)
+      entries = private_execute.first(11).map!(&:inspect)
       entries[10] = "..." if entries.size == 11
       "#<#{self.class.name} [#{entries.join(', ')}]>"
     end
 
-    def aggs(value = NO_DEFAULT_VALUE)
-      if value == NO_DEFAULT_VALUE
+    def aggs(*args, **kwargs)
+      if args.empty? && kwargs.empty?
         private_execute.aggs
       else
-        clone.aggs!(value)
+        clone.aggs!(*args, **kwargs)
       end
     end
 
-    def aggs!(value)
+    def aggs!(*args, **kwargs)
       check_loaded
-      (@options[:aggs] ||= {}).merge!(value)
+      aggs = {}
+      args.flatten.each do |arg|
+        if arg.is_a?(Hash)
+          aggs.merge!(arg)
+        else
+          aggs[arg] = {}
+        end
+      end
+      aggs.merge!(kwargs)
+      merge_option(:aggs, aggs)
       self
     end
 
@@ -61,7 +70,7 @@ module Searchkick
 
     def body_options!(value)
       check_loaded
-      (@options[:body_options] ||= {}).merge!(value)
+      merge_option(:body_options, value)
       self
     end
 
@@ -86,7 +95,7 @@ module Searchkick
       elsif !value.is_a?(Hash)
         value = {value => {factor: 1}}
       end
-      (@options[:boost_by] ||= {}).merge!(value)
+      merge_option(:boost_by, value)
       self
     end
 
@@ -98,7 +107,7 @@ module Searchkick
       check_loaded
       # legacy format
       value = {value[:field] => value.except(:field)} if value[:field]
-      (@options[:boost_by_distance] ||= {}).merge!(value)
+      merge_option(:boost_by_distance, value)
       self
     end
 
@@ -108,7 +117,7 @@ module Searchkick
 
     def boost_by_recency!(value)
       check_loaded
-      (@options[:boost_by_recency] ||= {}).merge!(value)
+      merge_option(:boost_by_recency, value)
       self
     end
 
@@ -119,7 +128,7 @@ module Searchkick
     def boost_where!(value)
       check_loaded
       # TODO merge duplicate fields
-      (@options[:boost_where] ||= {}).merge!(value)
+      merge_option(:boost_where, value)
       self
     end
 
@@ -189,7 +198,7 @@ module Searchkick
 
     def exclude!(*values)
       check_loaded
-      (@options[:exclude] ||= []).concat(values.flatten)
+      concat_option(:exclude, values.flatten)
       self
     end
 
@@ -209,7 +218,7 @@ module Searchkick
 
     def fields!(*values)
       check_loaded
-      (@options[:fields] ||= []).concat(values.flatten)
+      concat_option(:fields, values.flatten)
       self
     end
 
@@ -229,7 +238,7 @@ module Searchkick
 
     def includes!(*values)
       check_loaded
-      (@options[:includes] ||= []).concat(values.flatten)
+      concat_option(:includes, values.flatten)
       self
     end
 
@@ -243,7 +252,7 @@ module Searchkick
       if values.all? { |v| v.respond_to?(:searchkick_index) }
         models!(*values)
       else
-        (@options[:index_name] ||= []).concat(values)
+        concat_option(:index_name, values)
         self
       end
     end
@@ -254,7 +263,7 @@ module Searchkick
 
     def indices_boost!(value)
       check_loaded
-      (@options[:indices_boost] ||= {}).merge!(value)
+      merge_option(:indices_boost, value)
       self
     end
 
@@ -319,7 +328,7 @@ module Searchkick
 
     def models!(*values)
       check_loaded
-      (@options[:models] ||= []).concat(values.flatten)
+      concat_option(:models, values.flatten)
       self
     end
 
@@ -329,7 +338,7 @@ module Searchkick
 
     def model_includes!(*values)
       check_loaded
-      (@options[:model_includes] ||= []).concat(values.flatten)
+      concat_option(:model_includes, values.flatten)
       self
     end
 
@@ -373,7 +382,7 @@ module Searchkick
 
     def order!(*values)
       check_loaded
-      (@options[:order] ||= []).concat(values.flatten)
+      concat_option(:order, values.flatten)
       self
     end
 
@@ -409,6 +418,10 @@ module Searchkick
       end
     end
 
+    def per(value)
+      per_page(value)
+    end
+
     def per_page!(value)
       check_loaded
       # TODO set limit?
@@ -432,7 +445,7 @@ module Searchkick
 
     def request_params!(value)
       check_loaded
-      (@options[:request_params] ||= {}).merge!(value)
+      merge_option(:request_params, value)
       self
     end
 
@@ -482,7 +495,7 @@ module Searchkick
 
     def select!(*values)
       check_loaded
-      (@options[:select] ||= []).concat(values.flatten)
+      concat_option(:select, values.flatten)
       self
     end
 
@@ -546,7 +559,7 @@ module Searchkick
 
     def type!(*values)
       check_loaded
-      (@options[:type] ||= []).concat(values.flatten)
+      concat_option(:type, values.flatten)
       self
     end
 
@@ -560,10 +573,18 @@ module Searchkick
 
     def where!(value)
       check_loaded
+      value = ensure_permitted(value)
       if @options[:where]
-        @options[:where] = {_and: [@options[:where], ensure_permitted(value)]}
+        if @options[:where][:_and].is_a?(Array)
+          merge_option(:where, {_and: @options[:where][:_and] + [value]})
+        # keep simple when possible for smart aggs
+        elsif !@options[:where].keys.intersect?(value.keys)
+          merge_option(:where, value)
+        else
+          @options[:where] = {_and: [@options[:where], value]}
+        end
       else
-        @options[:where] = ensure_permitted(value)
+        @options[:where] = value
       end
       self
     end
@@ -644,6 +665,16 @@ module Searchkick
       Results.new(nil, nil, nil).respond_to?(...) || super
     end
 
+    # TODO uncomment in 7.0
+    # def to_json(...)
+    #   private_execute.to_a.to_json(...)
+    # end
+
+    # TODO uncomment in 7.0
+    # def as_json(...)
+    #   private_execute.to_a.as_json(...)
+    # end
+
     def to_yaml
       private_execute.to_a.to_yaml
     end
@@ -673,7 +704,25 @@ module Searchkick
 
     def initialize_copy(other)
       super
+      # shallow dup and avoid updating values in-place
+      @options = @options.dup
       @execute = nil
     end
+
+    def concat_option(key, value)
+      if @options[key]
+        @options[key] += value
+      else
+        @options[key] = value.to_ary
+      end
+    end
+
+    def merge_option(key, value)
+      if @options[key]
+        @options[key] = @options[key].merge(value)
+      else
+        @options[key] = value.to_hash
+      end
+    end
   end
 end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "6.0.2"
+  VERSION = "6.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch or OpenSearch
 test_files: []