searchkick 4.2.1 → 4.4.2

data/lib/searchkick/model.rb

@@ -5,8 +5,8 @@ module Searchkick
 
       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, :settings, :similarity,
-        :special_characters, :stem, :stem_conversions, :suggest, :synonyms, :text_end,
+        :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?
 
@@ -41,6 +41,9 @@ module Searchkick
 
         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
@@ -54,10 +57,11 @@ module Searchkick
           alias_method :search_index, :searchkick_index unless method_defined?(:search_index)
 
           def searchkick_reindex(method_name = nil, **options)
-            scoped = (respond_to?(:current_scope) && respond_to?(:default_scoped) && current_scope && current_scope.to_sql != default_scoped.to_sql) ||
+            # 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: scoped, **options)
+            searchkick_index.reindex(searchkick_klass, method_name, scoped: relation, **options)
           end
           alias_method :reindex, :searchkick_reindex unless method_defined?(:reindex)
 

data/lib/searchkick/query.rb

@@ -574,7 +574,8 @@ module Searchkick
 
     def build_query(query, filters, should, must_not, custom_filters, multiply_filters)
       if filters.any? || must_not.any? || should.any?
-        bool = {must: query}
+        bool = {}
+        bool[:must] = query if query
         bool[:filter] = filters if filters.any?      # where
         bool[:must_not] = must_not if must_not.any?  # exclude
         bool[:should] = should if should.any?        # conversions
@@ -871,6 +872,11 @@ module Searchkick
     end
 
     def where_filters(where)
+      # if where.respond_to?(:permitted?) && !where.permitted?
+      #   # TODO check in more places
+      #   Searchkick.warn("Passing unpermitted parameters will raise an exception in Searchkick 5")
+      # end
+
       filters = []
       (where || {}).each do |field, value|
         field = :_id if field.to_s == "id"
@@ -953,10 +959,17 @@ module Searchkick
                 # % matches zero or more characters
                 # _ matches one character
                 # \ is escape character
-                regex = Regexp.escape(op_value).gsub(/(?<!\\)%/, ".*").gsub(/(?<!\\)_/, ".").gsub("\\%", "%").gsub("\\_", "_")
-                filters << {regexp: {field => {value: regex}}}
+                # escape Lucene reserved characters
+                # https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html#regexp-optional-operators
+                reserved = %w(. ? + * | { } [ ] ( ) " \\)
+                regex = op_value.dup
+                reserved.each do |v|
+                  regex.gsub!(v, "\\" + v)
+                end
+                regex = regex.gsub(/(?<!\\)%/, ".*").gsub(/(?<!\\)_/, ".").gsub("\\%", "%").gsub("\\_", "_")
+                filters << {regexp: {field => {value: regex, flags: "NONE"}}}
               when :prefix
-                filters << {prefix: {field => op_value}}
+                filters << {prefix: {field => {value: op_value}}}
               when :regexp # support for regexp queries without using a regexp ruby object
                 filters << {regexp: {field => {value: op_value}}}
               when :not, :_not # not equal
@@ -1036,7 +1049,16 @@ module Searchkick
 
         {regexp: {field => {value: source, flags: "NONE"}}}
       else
-        {term: {field => value}}
+        # TODO add this for other values
+        if value.as_json.is_a?(Enumerable)
+          # query will fail, but this is better
+          # same message as Active Record
+          # TODO make TypeError
+          # raise InvalidQueryError for backward compatibility
+          raise Searchkick::InvalidQueryError, "can't cast #{value.class.name}"
+        end
+
+        {term: {field => {value: value}}}
       end
     end
 

data/lib/searchkick/results.rb

@@ -19,78 +19,20 @@ module Searchkick
       @results ||= with_hit.map(&:first)
     end
 
+    # TODO return enumerator like with_score
     def with_hit
       @with_hit ||= begin
-        if options[:load]
-          # results can have different types
-          results = {}
-
-          hits.group_by { |hit, _| hit["_index"] }.each do |index, grouped_hits|
-            klasses =
-              if @klass
-                [@klass]
-              else
-                index_alias = index.split("_")[0..-2].join("_")
-                Array((options[:index_mapping] || {})[index_alias])
-              end
-            raise Searchkick::Error, "Unknown model for index: #{index}" unless klasses.any?
-
-            results[index] = {}
-            klasses.each do |klass|
-              results[index].merge!(results_query(klass, grouped_hits).to_a.index_by { |r| r.id.to_s })
-            end
-          end
-
-          missing_ids = []
-
-          # sort
-          results =
-            hits.map do |hit|
-              result = results[hit["_index"]][hit["_id"].to_s]
-              if result && !(options[:load].is_a?(Hash) && options[:load][:dumpable])
-                if (hit["highlight"] || options[:highlight]) && !result.respond_to?(:search_highlights)
-                  highlights = hit_highlights(hit)
-                  result.define_singleton_method(:search_highlights) do
-                    highlights
-                  end
-                end
-              end
-              [result, hit]
-            end.select do |result, hit|
-              missing_ids << hit["_id"] unless result
-              result
-            end
-
-          if missing_ids.any?
-            Searchkick.warn("Records in search index do not exist in database: #{missing_ids.join(", ")}")
-          end
-
-          results
-        else
-          hits.map do |hit|
-            result =
-              if hit["_source"]
-                hit.except("_source").merge(hit["_source"])
-              elsif hit["fields"]
-                hit.except("fields").merge(hit["fields"])
-              else
-                hit
-              end
-
-            if hit["highlight"] || options[:highlight]
-              highlight = Hash[hit["highlight"].to_a.map { |k, v| [base_field(k), v.first] }]
-              options[:highlighted_fields].map { |k| base_field(k) }.each do |k|
-                result["highlighted_#{k}"] ||= (highlight[k] || result[k])
-              end
-            end
-
-            result["id"] ||= result["_id"] # needed for legacy reasons
-            [HashWrapper.new(result), hit]
-          end
+        if missing_records.any?
+          Searchkick.warn("Records in search index do not exist in database: #{missing_records.map { |v| v[:id] }.join(", ")}")
         end
+        with_hit_and_missing_records[0]
       end
     end
 
+    def missing_records
+      @missing_records ||= with_hit_and_missing_records[1]
+    end
+
     def suggestions
       if response["suggest"]
         response["suggest"].values.flat_map { |v| v.first["options"] }.sort_by { |o| -o["score"] }.map { |o| o["text"] }.uniq
@@ -211,12 +153,21 @@ module Searchkick
       end
     end
 
+    # TODO return enumerator like with_score
     def with_highlights(multiple: false)
       with_hit.map do |result, hit|
         [result, hit_highlights(hit, multiple: multiple)]
       end
     end
 
+    def with_score
+      return enum_for(:with_score) unless block_given?
+
+      with_hit.each do |result, hit|
+        yield result, hit["_score"]
+      end
+    end
+
     def misspellings?
       @options[:misspellings]
     end
@@ -268,6 +219,90 @@ module Searchkick
 
     private
 
+    def with_hit_and_missing_records
+      @with_hit_and_missing_records ||= begin
+        missing_records = []
+
+        if options[:load]
+          grouped_hits = hits.group_by { |hit, _| hit["_index"] }
+
+          # determine models
+          index_models = {}
+          grouped_hits.each do |index, _|
+            models =
+              if @klass
+                [@klass]
+              else
+                index_alias = index.split("_")[0..-2].join("_")
+                Array((options[:index_mapping] || {})[index_alias])
+              end
+            raise Searchkick::Error, "Unknown model for index: #{index}" unless models.any?
+            index_models[index] = models
+          end
+
+          # fetch results
+          results = {}
+          grouped_hits.each do |index, index_hits|
+            results[index] = {}
+            index_models[index].each do |model|
+              results[index].merge!(results_query(model, index_hits).to_a.index_by { |r| r.id.to_s })
+            end
+          end
+
+          # sort
+          results =
+            hits.map do |hit|
+              result = results[hit["_index"]][hit["_id"].to_s]
+              if result && !(options[:load].is_a?(Hash) && options[:load][:dumpable])
+                if (hit["highlight"] || options[:highlight]) && !result.respond_to?(:search_highlights)
+                  highlights = hit_highlights(hit)
+                  result.define_singleton_method(:search_highlights) do
+                    highlights
+                  end
+                end
+              end
+              [result, hit]
+            end.select do |result, hit|
+              unless result
+                models = index_models[hit["_index"]]
+                missing_records << {
+                  id: hit["_id"],
+                  # may be multiple models for inheritance with child models
+                  # not ideal to return different types
+                  # but this situation shouldn't be common
+                  model: models.size == 1 ? models.first : models
+                }
+              end
+              result
+            end
+        else
+          results =
+            hits.map do |hit|
+              result =
+                if hit["_source"]
+                  hit.except("_source").merge(hit["_source"])
+                elsif hit["fields"]
+                  hit.except("fields").merge(hit["fields"])
+                else
+                  hit
+                end
+
+              if hit["highlight"] || options[:highlight]
+                highlight = Hash[hit["highlight"].to_a.map { |k, v| [base_field(k), v.first] }]
+                options[:highlighted_fields].map { |k| base_field(k) }.each do |k|
+                  result["highlighted_#{k}"] ||= (highlight[k] || result[k])
+                end
+              end
+
+              result["id"] ||= result["_id"] # needed for legacy reasons
+              [HashWrapper.new(result), hit]
+            end
+        end
+
+       [results, missing_records]
+      end
+    end
+
     def results_query(records, hits)
       ids = hits.map { |hit| hit["_id"] }
       if options[:includes] || options[:model_includes]

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "4.2.1"
+  VERSION = "4.4.2"
 end

data/lib/tasks/searchkick.rake

@@ -1,21 +1,22 @@
 namespace :searchkick do
-  desc "reindex model"
+  desc "reindex a model (specify CLASS)"
   task reindex: :environment do
-    if ENV["CLASS"]
-      klass = ENV["CLASS"].constantize rescue nil
-      if klass
-        klass.reindex
-      else
-        abort "Could not find class: #{ENV['CLASS']}"
-      end
-    else
-      abort "USAGE: rake searchkick:reindex CLASS=Product"
-    end
+    class_name = ENV["CLASS"]
+    abort "USAGE: rake searchkick:reindex CLASS=Product" unless class_name
+
+    model = class_name.safe_constantize
+    abort "Could not find class: #{class_name}" unless model
+    abort "#{class_name} is not a searchkick model" unless Searchkick.models.include?(model)
+
+    puts "Reindexing #{model.name}..."
+    model.reindex
+    puts "Reindex successful"
   end
 
   namespace :reindex do
     desc "reindex all models"
     task all: :environment do
+      # eager load models to populate Searchkick.models
       if Rails.respond_to?(:autoloaders) && Rails.autoloaders.zeitwerk_enabled?
         # fix for https://github.com/rails/rails/issues/37006
         Zeitwerk::Loader.eager_load_all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.4.2
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,56 +52,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - lib/searchkick.rb
@@ -130,7 +87,7 @@ homepage: https://github.com/ankane/searchkick
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch
 test_files: []

data/CONTRIBUTING.md

@@ -1,53 +0,0 @@
-# Contributing
-
-First, thanks for wanting to contribute. You’re awesome! :heart:
-
-## Help
-
-We’re not able to provide support through GitHub Issues. If you’re looking for help with your code, try posting on [Stack Overflow](https://stackoverflow.com/).
-
-All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist.
-
-## Bugs
-
-Think you’ve discovered a bug?
-
-1. Search existing issues to see if it’s been reported.
-2. Try the `master` branch to make sure it hasn’t been fixed.
-
-```rb
-gem "searchkick", github: "ankane/searchkick"
-```
-
-3. Try the `debug` option when searching. This can reveal useful info.
-
-```ruby
-Product.search("something", debug: true)
-```
-
-If the above steps don’t help, create an issue.
-
-- Recreate the problem by forking [this gist](https://gist.github.com/ankane/f80b0923d9ae2c077f41997f7b704e5c). Include a link to your gist and the output in the issue.
-- For exceptions, include the complete backtrace.
-
-## New Features
-
-If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`.
-
-## Pull Requests
-
-Fork the project and create a pull request. A few tips:
-
-- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
-- Follow the existing style. The code should read like it’s written by a single person.
-- Add one or more tests if possible. Make sure existing tests pass with:
-
-```sh
-bundle exec rake test
-```
-
-Feel free to open an issue to get feedback on your idea before spending too much time on it.
-
----
-
-This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.