Changed to boost_by_distance

Andrew Kane
1 parent 5a19d5ad
Showing 5 changed files with 32 additions and 40 deletions Show diff stats
CHANGELOG.md
README.md
lib/searchkick/query.rb
test/boost_test.rb
test/sql_test.rb
 ## 0.8.4 [unreleased]
+- Added `boost_by_distance`
 - More flexible highlight options
 ## 0.8.3
@@ -616,16 +616,19 @@ Bounded by a box
 City.search "san", where: {location: {top_left: [38, -123], bottom_right: [37, -122]}}
 ```
-Modify search score by proximity to a point:
+### Boost By Distance [master]
+
+Boost results by distance - closer results are boosted more
 ```ruby
-City.search "san", proximity_factor: { field: :location, origin: [37, -122] } # field and origin mandatory
-City.search "san", proximity_factor: { field: :location, origin: [37, -122], function: :linear, scale: "30mi", decay: 0.5 } # at 30mi, decrease score by 50%
+City.search "san", boost_by_distance: {field: :location, origin: [37, -122]}
 ```
-The difference between where with a geo_point and proximity_factor is that the former is a hard cutoff that simply includes or excludes results but has no impact on the order of results, whereas the latter smoothly modifies the search score so that the results with the best match for the query text and the distance are returned.
+Also supports [additional options](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions)
-See [more details on modifying the score by proximity](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions).
+```ruby
+City.search "san", boost_by_distance: {field: :location, origin: [37, -122], function: :linear, scale: "30mi", decay: 0.5}
+```
 ## Inheritance
@@ -209,39 +209,27 @@ module Searchkick
           }
         end
-        if custom_filters.any?
-          payload = {
-            function_score: {
-              functions: custom_filters,
-              query: payload,
-              score_mode: "sum"
+        boost_by_distance = options[:boost_by_distance]
+        if boost_by_distance
+          boost_by_distance = {function: :gauss, scale: "5mi"}.merge(boost_by_distance)
+          if !boost_by_distance[:field] or !boost_by_distance[:origin]
+            raise ArgumentError, "boost_by_distance requires :field and :origin"
+          end
+          function_params = boost_by_distance.select{|k,v| [:origin, :scale, :offset, :decay].include?(k) }
+          function_params[:origin] = function_params[:origin].reverse
+          custom_filters << {
+            boost_by_distance[:function] => {
+              boost_by_distance[:field] => function_params
             }
           }
         end
-        # Modify the query scoring by proximity to a geo point
-        if options[:proximity_factor]
-          proximity_factor = { function: :gauss, score_mode: :multiply, scale: "5mi" }.merge(options[:proximity_factor])
-          (proximity_factor[:field] and proximity_factor[:origin]) or raise ArgumentError, "query() option :proximity_factor must contain at least :field and :origin"
-
-          field = proximity_factor[:field]
-          function = proximity_factor[:function]
-          function_params = proximity_factor.select { |k,v| [:origin, :scale, :offset, :decay].include? k }
-          # Conform to GeoJSON convention of [longitude, latitude]
-          function_params[:origin] = function_params[:origin].reverse
-          score_mode = proximity_factor[:score_mode]
-
+        if custom_filters.any?
           payload = {
             function_score: {
-              functions: [
-                {
-                  function => {
-                    field => function_params
-                  }
-                }
-              ],
+              functions: custom_filters,
               query: payload,
-              score_mode: score_mode
+              score_mode: "sum"
             }
           }
         end
@@ -104,4 +104,13 @@ class TestBoost &lt; Minitest::Test
     assert_first "tomato", "Tomato B", boost_where: {user_ids: {value: 2, factor: 10}}
   end
+  def test_boost_by_distance
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: [37, -122], scale: "1000mi"}
+  end
+
 end
@@ -261,15 +261,6 @@ class TestSql &lt; Minitest::Test
     assert_search "product", ["Product"], where: {latitude: {gt: 99}}
   end
-  def test_proximity
-    store [
-      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
-      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
-      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
-    ]
-    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], proximity_factor: {field: :location, origin: [37, -122]}
-  end
-
   # load
   def test_load_default
1	## 0.8.4 [unreleased]	1	## 0.8.4 [unreleased]
2		2
		3	+- Added `boost_by_distance`
3	- More flexible highlight options	4	- More flexible highlight options
4		5
5	## 0.8.3	6	## 0.8.3
	@@ -104,4 +104,13 @@ class TestBoost < Minitest::Test		@@ -104,4 +104,13 @@ class TestBoost < Minitest::Test
104	assert_first "tomato", "Tomato B", boost_where: {user_ids: {value: 2, factor: 10}}	104	assert_first "tomato", "Tomato B", boost_where: {user_ids: {value: 2, factor: 10}}
105	end	105	end
106		106
		107	+ def test_boost_by_distance
		108	+ store [
		109	+ {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
		110	+ {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
		111	+ {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
		112	+ ]
		113	+ assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: [37, -122], scale: "1000mi"}
		114	+ end
		115	+
107	end	116	end
	@@ -261,15 +261,6 @@ class TestSql < Minitest::Test		@@ -261,15 +261,6 @@ class TestSql < Minitest::Test
261	assert_search "product", ["Product"], where: {latitude: {gt: 99}}	261	assert_search "product", ["Product"], where: {latitude: {gt: 99}}
262	end	262	end
263		263
264	- def test_proximity
265	- store [
266	- {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
267	- {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
268	- {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
269	- ]
270	- assert_order "san", ["San Francisco", "San Antonio", "San Marino"], proximity_factor: {field: :location, origin: [37, -122]}
271	- end
272	-
273	# load	264	# load
274		265
275	def test_load_default	266	def test_load_default