Added ability to boost fields

Andrew Kane
1 parent efacf259
Showing 4 changed files with 39 additions and 4 deletions Show diff stats
CHANGELOG.md
README.md
lib/searchkick/query.rb
test/boost_test.rb
 ## 0.7.8 [unreleased]
 - Added `boost_by` and `boost_where` options
+- Added ability to boost fields - `name^10`
 - Added `select` option for `load: false`
 ## 0.7.7
@@ -118,6 +118,12 @@ limit: 20, offset: 40
 ### Boosting
+Boost important fields
+
+```ruby
+fields: ["title^10", "description"]
+```
+
 Boost by the value of a field
 ```ruby
@@ -192,6 +198,12 @@ Available options are:
 :text_end
 ```
+To boost fields, use:
+
+```ruby
+fields: [{"name^2" => :word_start}] # better interface on the way
+```
+
 ### Language
 Searchkick defaults to English for stemming.  To change this, use:
@@ -15,6 +15,7 @@ module Searchkick
       @term = term
       @options = options
+      boost_fields = {}
       fields =
         if options[:fields]
           if options[:autocomplete]
@@ -22,7 +23,10 @@ module Searchkick
           else
             options[:fields].map do |value|
               k, v = value.is_a?(Hash) ? value.to_a.first : [value, :word]
-              "#{k}.#{v == :word ? "analyzed" : v}"
+              k2, boost = k.split("^", 2)
+              field = "#{k2}.#{v == :word ? "analyzed" : v}"
+              boost_fields[field] = boost.to_i if boost
+              field
             end
           end
         else
@@ -74,17 +78,19 @@ module Searchkick
         else
           queries = []
           fields.each do |field|
+            factor = boost_fields[field] || 1
             shared_options = {
               fields: [field],
               query: term,
               use_dis_max: false,
-              operator: operator
+              operator: operator,
+              boost: factor
             }
             if field == "_all" or field.end_with?(".analyzed")
               shared_options[:cutoff_frequency] = 0.001 unless operator == "and"
               queries.concat [
-                {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search")},
-                {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search2")}
+                {multi_match: shared_options.merge(boost: 10 * factor, analyzer: "searchkick_search")},
+                {multi_match: shared_options.merge(boost: 10 * factor, analyzer: "searchkick_search2")}
               ]
               if options[:misspellings] != false
                 distance = (options[:misspellings].is_a?(Hash) && options[:misspellings][:distance]) || 1
@@ -67,6 +67,22 @@ class TestBoost &lt; Minitest::Unit::TestCase
     assert_first "tomato", "Tomato B", personalize: {user_ids: 2}
   end
+  def test_boost_fields
+    store [
+      {name: "Red", color: "White"},
+      {name: "White", color: "Red Red Red"}
+    ]
+    assert_order "red", ["Red", "White"], fields: ["name^10", "color"]
+  end
+
+  def test_boost_fields_word_start
+    store [
+      {name: "Red", color: "White"},
+      {name: "White", color: "Red Red Red"}
+    ]
+    assert_order "red", ["Red", "White"], fields: [{"name^10" => :word_start}, "color"]
+  end
+
   def test_boost_by
     store [
       {name: "Tomato A"},
1	## 0.7.8 [unreleased]	1	## 0.7.8 [unreleased]
2		2
3	- Added `boost_by` and `boost_where` options	3	- Added `boost_by` and `boost_where` options
		4	+- Added ability to boost fields - `name^10`
4	- Added `select` option for `load: false`	5	- Added `select` option for `load: false`
5		6
6	## 0.7.7	7	## 0.7.7
	@@ -118,6 +118,12 @@ limit: 20, offset: 40		@@ -118,6 +118,12 @@ limit: 20, offset: 40
118		118
119	### Boosting	119	### Boosting
120		120
		121	+Boost important fields
		122	+
		123	+```ruby
		124	+fields: ["title^10", "description"]
		125	+```
		126	+
121	Boost by the value of a field	127	Boost by the value of a field
122		128
123	```ruby	129	```ruby
	@@ -192,6 +198,12 @@ Available options are:		@@ -192,6 +198,12 @@ Available options are:
192	:text_end	198	:text_end
193	```	199	```
194		200
		201	+To boost fields, use:
		202	+
		203	+```ruby
		204	+fields: [{"name^2" => :word_start}] # better interface on the way
		205	+```
		206	+
195	### Language	207	### Language
196		208
197	Searchkick defaults to English for stemming. To change this, use:	209	Searchkick defaults to English for stemming. To change this, use:
	@@ -67,6 +67,22 @@ class TestBoost < Minitest::Unit::TestCase		@@ -67,6 +67,22 @@ class TestBoost < Minitest::Unit::TestCase
67	assert_first "tomato", "Tomato B", personalize: {user_ids: 2}	67	assert_first "tomato", "Tomato B", personalize: {user_ids: 2}
68	end	68	end
69		69
		70	+ def test_boost_fields
		71	+ store [
		72	+ {name: "Red", color: "White"},
		73	+ {name: "White", color: "Red Red Red"}
		74	+ ]
		75	+ assert_order "red", ["Red", "White"], fields: ["name^10", "color"]
		76	+ end
		77	+
		78	+ def test_boost_fields_word_start
		79	+ store [
		80	+ {name: "Red", color: "White"},
		81	+ {name: "White", color: "Red Red Red"}
		82	+ ]
		83	+ assert_order "red", ["Red", "White"], fields: [{"name^10" => :word_start}, "color"]
		84	+ end
		85	+
70	def test_boost_by	86	def test_boost_by
71	store [	87	store [
72	{name: "Tomato A"},	88	{name: "Tomato A"},