Added support for passing fields to suggest option - fixes #932

Andrew Kane
1 parent 6f69dddc
Showing 3 changed files with 23 additions and 6 deletions Show diff stats
CHANGELOG.md
lib/searchkick/query.rb
test/suggest_test.rb
+## 2.3.1 [unreleased]
+
+- Added support for passing fields to `suggest` option
+
 ## 2.3.0
  
 - Fixed analyzer on dynamically mapped fields
@@ -447,7 +447,7 @@ module Searchkick
         set_aggregations(payload) if options[:aggs]
  
         # suggestions
-        set_suggestions(payload) if options[:suggest]
+        set_suggestions(payload, options[:suggest]) if options[:suggest]
  
         # highlight
         set_highlights(payload, fields) if options[:highlight]
@@ -575,12 +575,20 @@ module Searchkick
       payload[:indices_boost] = indices_boost
     end
  
-    def set_suggestions(payload)
-      suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
+    def set_suggestions(payload, suggest)
+      suggest_fields = nil
  
-      # intersection
-      if options[:fields]
-        suggest_fields &= options[:fields].map { |v| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
+      if suggest.is_a?(Array)
+        suggest_fields = suggest
+      elsif !klass
+        raise ArgumentError, "Must pass fields to suggest option"
+      else
+        suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
+
+        # intersection
+        if options[:fields]
+          suggest_fields &= options[:fields].map { |v| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
+        end
       end
  
       if suggest_fields.any?
@@ -67,6 +67,11 @@ class SuggestTest &lt; Minitest::Test
     assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [{"name^2" => :word_start}]
   end
  
+  def test_multiple_models
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_equal "how big is a tiger shark", Searchkick.search("How Big is a Tigre Shar", suggest: [:name]).suggestions.first
+  end
+
   protected
  
   def assert_suggest(term, expected, options = {})
	1	+## 2.3.1 [unreleased]
	2	+
	3	+- Added support for passing fields to `suggest` option
	4	+
1	5	## 2.3.0
2	6
3	7	- Fixed analyzer on dynamically mapped fields
...	...
...	...	@@ -447,7 +447,7 @@ module Searchkick
447	447	set_aggregations(payload) if options[:aggs]
448	448
449	449	# suggestions
450		- set_suggestions(payload) if options[:suggest]
	450	+ set_suggestions(payload, options[:suggest]) if options[:suggest]
451	451
452	452	# highlight
453	453	set_highlights(payload, fields) if options[:highlight]
...	...	@@ -575,12 +575,20 @@ module Searchkick
575	575	payload[:indices_boost] = indices_boost
576	576	end
577	577
578		- def set_suggestions(payload)
579		- suggest_fields = (searchkick_options[:suggest] \|\| []).map(&:to_s)
	578	+ def set_suggestions(payload, suggest)
	579	+ suggest_fields = nil
580	580
581		- # intersection
582		- if options[:fields]
583		- suggest_fields &= options[:fields].map { \|v\| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
	581	+ if suggest.is_a?(Array)
	582	+ suggest_fields = suggest
	583	+ elsif !klass
	584	+ raise ArgumentError, "Must pass fields to suggest option"
	585	+ else
	586	+ suggest_fields = (searchkick_options[:suggest] \|\| []).map(&:to_s)
	587	+
	588	+ # intersection
	589	+ if options[:fields]
	590	+ suggest_fields &= options[:fields].map { \|v\| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
	591	+ end
584	592	end
585	593
586	594	if suggest_fields.any?
...	...
...	...	@@ -67,6 +67,11 @@ class SuggestTest < Minitest::Test
67	67	assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [{"name^2" => :word_start}]
68	68	end
69	69
	70	+ def test_multiple_models
	71	+ store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
	72	+ assert_equal "how big is a tiger shark", Searchkick.search("How Big is a Tigre Shar", suggest: [:name]).suggestions.first
	73	+ end
	74	+
70	75	protected
71	76
72	77	def assert_suggest(term, expected, options = {})
...	...