searchkick 4.2.0 → 4.4.1

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,7 +41,10 @@ module Searchkick
 
         class << self
           def searchkick_search(term = "*", **options, &block)
-            Searchkick.search(term, {model: self}.merge(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)
 
@@ -79,8 +83,9 @@ module Searchkick
           RecordIndexer.new(self).reindex(method_name, **options)
         end unless method_defined?(:reindex)
 
+        # TODO switch to keyword arguments
         def similar(options = {})
-          self.class.searchkick_index.similar_record(self, options)
+          self.class.searchkick_index.similar_record(self, **options)
         end unless method_defined?(:similar)
 
         def search_data

data/lib/searchkick/query.rb

@@ -350,7 +350,7 @@ module Searchkick
             field_misspellings = misspellings && (!misspellings_fields || misspellings_fields.include?(base_field(field)))
 
             if field == "_all" || field.end_with?(".analyzed")
-              shared_options[:cutoff_frequency] = 0.001 unless operator.to_s == "and" || field_misspellings == false
+              shared_options[:cutoff_frequency] = 0.001 unless operator.to_s == "and" || field_misspellings == false || (!below73? && !track_total_hits?)
               qs << shared_options.merge(analyzer: "searchkick_search")
 
               # searchkick_search and searchkick_search2 are the same for ukrainian
@@ -522,7 +522,7 @@ module Searchkick
       # routing
       @routing = options[:routing] if options[:routing]
 
-      if searchkick_options[:deep_paging] && !below70?
+      if track_total_hits?
         payload[:track_total_hits] = true
       end
 
@@ -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("\\_", "_")
+                # 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}}}
               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
 
@@ -1100,6 +1122,14 @@ module Searchkick
       k.sub(/\.(analyzed|word_start|word_middle|word_end|text_start|text_middle|text_end|exact)\z/, "")
     end
 
+    def track_total_hits?
+      (searchkick_options[:deep_paging] && !below70?) || body_options[:track_total_hits]
+    end
+
+    def body_options
+      options[:body_options] || {}
+    end
+
     def below61?
       Searchkick.server_below?("6.1.0")
     end
@@ -1108,6 +1138,10 @@ module Searchkick
       Searchkick.server_below?("7.0.0")
     end
 
+    def below73?
+      Searchkick.server_below?("7.3.0")
+    end
+
     def below75?
       Searchkick.server_below?("7.5.0")
     end

data/lib/searchkick/results.rb

@@ -19,6 +19,7 @@ module Searchkick
       @results ||= with_hit.map(&:first)
     end
 
+    # TODO return enumerator like with_score
     def with_hit
       @with_hit ||= begin
         if options[:load]
@@ -211,12 +212,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

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "4.2.0"
+  VERSION = "4.4.1"
 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.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,48 +52,6 @@ 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: 
 email: andrew@chartkick.com
 executables: []
@@ -101,7 +59,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - lib/searchkick.rb
@@ -145,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch

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.