searchkick 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9e19c9a72da12faf603c3fddbdd2fac429058a0774553c0afb874f0a1bc0de
-  data.tar.gz: a80890252fd573c07fa1f63b5cdbbaaec7dd1848ad0941e09160e973a0ad8ea2
+  metadata.gz: 2353bcf562a8f814430f473f0356e65cc8275c5bb21267fc46b96004c8edd27c
+  data.tar.gz: 5c570d53bc6d728a183de8ffb22056909ac748adebc6b436d2b8de785c3965fd
 SHA512:
-  metadata.gz: 1faf5e1622ec798d6ffca925d7831c55265973d8e58260a7dd8f98b249bd20cb9a3a903c9a12a870dfcd4eb723caf21459a259bd197e84d99771fed96a2d65ed
-  data.tar.gz: 796a19163cbc93d9fdbd235d29bbd86beedc3c583ea214c91406b6252f9d778d4f8ee710ae3ad1f1f85d91a7ab30571c3a01567ce8486a042d8e8d4ce3a63635
+  metadata.gz: c0aa2359ff46b280d0cc87fe57cf809760de414e3e40d7f5cb3c33cd43124ef3ad7aba824aa87f43390a188983ae2c1dfecba141ddaa19ab27a1cb50f6368447
+  data.tar.gz: bbf49af1a70667bdfa24ebee0227b0fa2b8d1738cfcbb860680d597a245d6860b1e5b56b978fc6b4aa9aa96e41bd20392e6e99116b7e69ff4a233a5480003709

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.1.0
+
+- Added `:inline` as alias for `true` for `callbacks` and `mode` options
+- Friendlier error message for bad mapping with partial matches
+- Warn when records in search index do not exist in database
+- Easier merging for `merge_mapping`
+- Fixed `with_hit` and `with_highlights` when records in search index do not exist in database
+- Fixed error with highlights and match all
+
 ## 3.0.3
 
 - Added support for pagination with `body` option

data/README.md

@@ -507,7 +507,7 @@ For large data sets, try [parallel reindexing](#parallel-reindexing).
 
 There are four strategies for keeping the index synced with your database.
 
-1. Immediate (default)
+1. Inline (default)
 
   Anytime a record is inserted, updated, or deleted
 
@@ -1790,12 +1790,12 @@ describe Product, search: true do
 end
 ```
 
-### Factory Girl
+### Factory Bot
 
 Use a trait and an after `create` hook for each indexed model:
 
 ```ruby
-FactoryGirl.define do
+FactoryBot.define do
   factory :product do
     # ...
 
@@ -1810,7 +1810,7 @@ FactoryGirl.define do
 end
 
 # use it
-FactoryGirl.create(:product, :some_trait, :reindex, some_attribute: "foo")
+FactoryBot.create(:product, :some_trait, :reindex, some_attribute: "foo")
 ```
 
 ### Parallel Tests

data/lib/searchkick.rb

@@ -26,13 +26,6 @@ rescue LoadError
 end
 require "searchkick/tasks" if defined?(Rake)
 
-begin
-  require "rake"
-rescue LoadError
-  # do nothing
-end
-require "searchkick/tasks" if defined?(Rake)
-
 # background jobs
 begin
   require "active_job"

data/lib/searchkick/index.rb

@@ -159,10 +159,9 @@ module Searchkick
         .keep_if { |k, _| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
         .values.compact.join(" ")
 
-      # TODO deep merge method
       options[:where] ||= {}
       options[:where][:_id] ||= {}
-      options[:where][:_id][:not] = record.id.to_s
+      options[:where][:_id][:not] = Array(options[:where][:_id][:not]) + [record.id.to_s]
       options[:per_page] ||= 10
       options[:similar] = true
 

data/lib/searchkick/index_options.rb

@@ -225,7 +225,7 @@ module Searchkick
           }
         end
 
-        settings.deep_merge!(options[:settings] || {})
+        settings = settings.symbolize_keys.deep_merge((options[:settings] || {}).symbolize_keys)
 
         # synonyms
         synonyms = options[:synonyms] || []
@@ -311,10 +311,10 @@ module Searchkick
 
           if !options[:searchable] || mapping_options[:searchable].include?(field)
             if word
-              fields["analyzed"] = analyzed_field_options
+              fields[:analyzed] = analyzed_field_options
 
               if mapping_options[:highlight].include?(field)
-                fields["analyzed"][:term_vector] = "with_positions_offsets"
+                fields[:analyzed][:term_vector] = "with_positions_offsets"
               end
             end
 
@@ -373,7 +373,7 @@ module Searchkick
           end
 
           if word
-            dynamic_fields["analyzed"] = analyzed_field_options
+            dynamic_fields[:analyzed] = analyzed_field_options
           end
         end
 
@@ -402,7 +402,7 @@ module Searchkick
           mappings[index_type][:_all] = all_enabled ? analyzed_field_options : {enabled: false}
         end
 
-        mappings = mappings.deep_merge(options[:mappings] || {})
+        mappings = mappings.symbolize_keys.deep_merge((options[:mappings] || {}).symbolize_keys)
       end
 
       {

data/lib/searchkick/model.rb

@@ -16,8 +16,8 @@ module Searchkick
 
       options[:_type] ||= -> { searchkick_index.klass_document_type(self, true) }
 
-      callbacks = options.key?(:callbacks) ? options[:callbacks] : true
-      unless [true, false, :async, :queue].include?(callbacks)
+      callbacks = options.key?(:callbacks) ? options[:callbacks] : :inline
+      unless [:inline, true, false, :async, :queue].include?(callbacks)
         raise ArgumentError, "Invalid value for callbacks"
       end
 

data/lib/searchkick/query.rb

@@ -111,6 +111,7 @@ module Searchkick
         model_includes: options[:model_includes],
         json: !@json.nil?,
         match_suffix: @match_suffix,
+        highlight: options[:highlight],
         highlighted_fields: @highlighted_fields || [],
         misspellings: @misspellings,
         term: term,
@@ -188,7 +189,7 @@ module Searchkick
         )
 
           raise UnsupportedVersionError, "This version of Searchkick requires Elasticsearch 5 or greater"
-        elsif e.message.include?("[multi_match] analyzer [searchkick_search] not found")
+        elsif e.message =~ /analyzer \[searchkick_.+\] not found/
           raise InvalidQueryError, "Bad mapping - run #{reindex_command}"
         else
           raise InvalidQueryError, e.message
@@ -583,7 +584,8 @@ module Searchkick
         unless attributes[:origin]
           raise ArgumentError, "boost_by_distance requires :origin"
         end
-        function_params = attributes.select { |k, _| [:origin, :scale, :offset, :decay].include?(k) }
+
+        function_params = attributes.except(:factor, :function)
         function_params[:origin] = location_value(function_params[:origin])
         custom_filters << {
           weight: attributes[:factor] || 1,

data/lib/searchkick/record_indexer.rb

@@ -8,7 +8,7 @@ module Searchkick
     end
 
     def reindex(method_name = nil, refresh: false, mode: nil)
-      unless [true, nil, :async, :queue].include?(mode)
+      unless [:inline, true, nil, :async, :queue].include?(mode)
         raise ArgumentError, "Invalid value for mode"
       end
 
@@ -31,7 +31,7 @@ module Searchkick
           record.id.to_s,
           method_name ? method_name.to_s : nil
         )
-      else # bulk, true
+      else # bulk, inline/true/nil
         reindex_record(method_name)
 
         index.refresh if refresh

data/lib/searchkick/reindex_v2_job.rb

@@ -30,7 +30,7 @@ module Searchkick
         record.id = id
       end
 
-      RecordIndexer.new(record).reindex(method_name, mode: true)
+      RecordIndexer.new(record).reindex(method_name, mode: :inline)
     end
   end
 end

data/lib/searchkick/results.rb

@@ -16,7 +16,11 @@ module Searchkick
     end
 
     def results
-      @results ||= begin
+      @results ||= with_hit.map(&:first)
+    end
+
+    def with_hit
+      @with_hit ||= begin
         if options[:load]
           # results can have different types
           results = {}
@@ -26,19 +30,31 @@ module Searchkick
             results[type] = results_query(klass, grouped_hits).to_a.index_by { |r| r.id.to_s }
           end
 
+          missing_ids = []
+
           # sort
-          hits.map do |hit|
-            result = results[hit["_type"]][hit["_id"].to_s]
-            if result && !(options[:load].is_a?(Hash) && options[:load][:dumpable])
-              if hit["highlight"] && !result.respond_to?(:search_highlights)
-                highlights = Hash[hit["highlight"].map { |k, v| [(options[:json] ? k : k.sub(/\.#{@options[:match_suffix]}\z/, "")).to_sym, v.first] }]
-                result.define_singleton_method(:search_highlights) do
-                  highlights
+          results =
+            hits.map do |hit|
+              result = results[hit["_type"]][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
-            result
-          end.compact
+
+          if missing_ids.any?
+            warn "[searchkick] WARNING: Records in search index do not exist in database: #{missing_ids.join(", ")}"
+          end
+
+          results
         else
           hits.map do |hit|
             result =
@@ -50,15 +66,15 @@ module Searchkick
                 hit
               end
 
-            if hit["highlight"]
-              highlight = Hash[hit["highlight"].map { |k, v| [base_field(k), v.first] }]
+            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)
+            [HashWrapper.new(result), hit]
           end
         end
       end
@@ -172,18 +188,16 @@ module Searchkick
       end
     end
 
-    def with_hit
-      results.zip(hits)
-    end
-
     def highlights(multiple: false)
       hits.map do |hit|
-        Hash[hit["highlight"].map { |k, v| [(options[:json] ? k : k.sub(/\.#{@options[:match_suffix]}\z/, "")).to_sym, multiple ? v : v.first] }]
+        hit_highlights(hit, multiple: multiple)
       end
     end
 
     def with_highlights(multiple: false)
-      results.zip(highlights(multiple: multiple))
+      with_hit do |result, hit|
+        [result, hit_highlights(hit, multiple: multiple)]
+      end
     end
 
     def misspellings?
@@ -231,5 +245,13 @@ module Searchkick
     def base_field(k)
       k.sub(/\.(analyzed|word_start|word_middle|word_end|text_start|text_middle|text_end|exact)\z/, "")
     end
+
+    def hit_highlights(hit, multiple: false)
+      if hit["highlight"]
+        Hash[hit["highlight"].map { |k, v| [(options[:json] ? k : k.sub(/\.#{@options[:match_suffix]}\z/, "")).to_sym, multiple ? v : v.first] }]
+      else
+        {}
+      end
+    end
   end
 end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "3.0.3"
+  VERSION = "3.1.0"
 end

data/test/highlight_test.rb

@@ -91,4 +91,19 @@ class HighlightTest < Minitest::Test
     store_names ["Two Door Cinema Club"]
     assert_equal "Two Door <em>Cinema</em> Club", Product.search("cinema", highlight: true).first.search_highlights[:name]
   end
+
+  def test_match_all
+    store_names ["Two Door Cinema Club"]
+    assert_nil Product.search("*", highlight: true).highlights.first[:name]
+  end
+
+  def test_match_all_load_false
+    store_names ["Two Door Cinema Club"]
+    assert_nil Product.search("*", highlight: true, load: false).highlights.first[:name]
+  end
+
+  def test_match_all_search_highlights
+    store_names ["Two Door Cinema Club"]
+    assert_nil Product.search("*", highlight: true).first.search_highlights[:name]
+  end
 end

data/test/index_test.rb

@@ -85,7 +85,9 @@ class IndexTest < Minitest::Test
   def test_record_not_found
     store_names ["Product A", "Product B"]
     Product.where(name: "Product A").delete_all
-    assert_search "product", ["Product B"]
+    assert_output nil, /\[searchkick\] WARNING: Records in search index do not exist in database/ do
+      assert_search "product", ["Product B"]
+    end
   ensure
     Product.reindex
   end
@@ -93,7 +95,8 @@ class IndexTest < Minitest::Test
   def test_bad_mapping
     Product.searchkick_index.delete
     store_names ["Product A"]
-    assert_raises(Searchkick::InvalidQueryError) { Product.search "test" }
+    error = assert_raises(Searchkick::InvalidQueryError) { Product.search "test" }
+    assert_equal "Bad mapping - run Product.reindex", error.message
   ensure
     Product.reindex
   end

data/test/routing_test.rb

@@ -8,7 +8,7 @@ class RoutingTest < Minitest::Test
 
   def test_routing_mappings
     index_options = Store.searchkick_index.index_options
-    assert_equal index_options[:mappings]["store"][:_routing], required: true
+    assert_equal index_options[:mappings][:store][:_routing], required: true
   end
 
   def test_routing_correct_node

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel