Added per-field misspellings

Co-authored-by: David Sweetman <david@davidsweetman.com>

Added per-field misspellings
Co-authored-by: David Sweetman <david@davidsweetman.com>
Andrew
1 parent 2cf9d0fa
Showing 5 changed files with 74 additions and 2 deletions Show diff stats
CHANGELOG.md
README.md
lib/searchkick/query.rb
test/misspellings_test.rb
test/test_helper.rb
 ## 3.1.1 [unreleased]
+- Added per-field misspellings
 - Made `exclude` option work with match all
 ## 3.1.0
@@ -410,6 +410,14 @@ Turn off misspellings with:
 Product.search "zuchini", misspellings: false # no zucchini
 ```
+Specify which fields can include misspellings with: [master]
+
+```ruby
+Product.search "zucini", fields: [:name, :color], misspellings: {fields: [:name]}
+```
+
+> When doing this, you must also specify fields to search
+
 ### Bad Matches
 If a user searches `butter`, they may also get results for `peanut butter`. To prevent this, use:
@@ -280,6 +280,15 @@ module Searchkick
             prefix_length = (misspellings.is_a?(Hash) && misspellings[:prefix_length]) || 0
             default_max_expansions = @misspellings_below ? 20 : 3
             max_expansions = (misspellings.is_a?(Hash) && misspellings[:max_expansions]) || default_max_expansions
+            misspellings_fields = misspellings.is_a?(Hash) && misspellings.key?(:fields) && misspellings[:fields].map { |f| "#{f}.#{@match_suffix}" }
+
+            if misspellings_fields
+              missing_fields = misspellings_fields - fields
+              if missing_fields.any?
+                raise ArgumentError, "All fields in per-field misspellings must also be specified in fields option"
+              end
+            end
+
             @misspellings = true
           else
             @misspellings = false
@@ -314,8 +323,10 @@ module Searchkick
             exclude_analyzer = nil
             exclude_field = field
+            field_misspellings = misspellings && (!misspellings_fields || misspellings_fields.include?(field))
+
             if field == "_all" || field.end_with?(".analyzed")
-              shared_options[:cutoff_frequency] = 0.001 unless operator.to_s == "and" || misspellings == false
+              shared_options[:cutoff_frequency] = 0.001 unless operator.to_s == "and" || field_misspellings == false
               qs << shared_options.merge(analyzer: "searchkick_search")
               # searchkick_search and searchkick_search2 are the same for ukrainian
@@ -334,7 +345,7 @@ module Searchkick
               exclude_analyzer = analyzer
             end
-            if misspellings != false && match_type == :match
+            if field_misspellings != false && match_type == :match
               qs.concat(qs.map { |q| q.except(:cutoff_frequency).merge(fuzziness: edit_distance, prefix_length: prefix_length, max_expansions: max_expansions, boost: factor).merge(transpositions) })
             end
@@ -53,4 +53,48 @@ class MisspellingsTest &lt; Minitest::Test
     store_names ["abc", "abd", "aee"]
     assert !Product.search("abc", misspellings: {below: 1}).misspellings?
   end
+
+  def test_misspellings_field_correct_spelling_still_works
+    store [{name: "Sriracha", color: "blue"}]
+    assert_misspellings "Sriracha", ["Sriracha"], {fields: [:name, :color]}
+    assert_misspellings "blue", ["Sriracha"], {fields: [:name, :color]}
+  end
+
+  def test_misspellings_field_enabled
+    store [{name: "Sriracha", color: "blue"}]
+    assert_misspellings "siracha", ["Sriracha"], {fields: [:name]}
+    assert_misspellings "clue", ["Sriracha"], {fields: [:color]}
+  end
+
+  def test_misspellings_field_disabled
+    store [{name: "Sriracha", color: "blue"}]
+    assert_misspellings "siracha", [], {fields: [:color]}
+    assert_misspellings "clue", [], {fields: [:name]}
+  end
+
+  def test_misspellings_field_with_transpositions
+    store [{name: "Sriracha", color: "blue"}]
+    assert_misspellings "lbue", [], {transpositions: false, fields: [:color]}
+  end
+
+  def test_misspellings_field_with_edit_distance
+    store [{name: "Sriracha", color: "blue"}]
+    assert_misspellings "crue", ["Sriracha"], {edit_distance: 2, fields: [:color]}
+  end
+
+  def test_misspellings_field_multiple
+    store [
+      {name: "Greek Yogurt", color: "white"},
+      {name: "Green Onions", color: "yellow"}
+    ]
+    assert_misspellings "greed", ["Greek Yogurt", "Green Onions"], {fields: [:name, :color]}
+    assert_misspellings "mellow", ["Green Onions"], {fields: [:name, :color]}
+  end
+
+  def test_misspellings_field_requires_explicit_search_fields
+    store_names ["Sriracha"]
+    assert_raises(ArgumentError) do
+      assert_search "siracha", ["Sriracha"], {misspellings: {fields: [:name]}}
+    end
+  end
 end
@@ -579,6 +579,14 @@ class Minitest::Test
     assert_equal expected, klass.search(term, options).map(&:name).first
   end
+  def assert_misspellings(term, expected, misspellings = {}, klass = Product)
+    options = {
+      fields: [:name, :color],
+      misspellings: misspellings
+    }
+    assert_search(term, expected, options, klass)
+  end
+
   def with_options(klass, options)
     previous_options = klass.searchkick_options.dup
     begin
1	## 3.1.1 [unreleased]	1	## 3.1.1 [unreleased]
2		2
		3	+- Added per-field misspellings
3	- Made `exclude` option work with match all	4	- Made `exclude` option work with match all
4		5
5	## 3.1.0	6	## 3.1.0
	@@ -410,6 +410,14 @@ Turn off misspellings with:		@@ -410,6 +410,14 @@ Turn off misspellings with:
410	Product.search "zuchini", misspellings: false # no zucchini	410	Product.search "zuchini", misspellings: false # no zucchini
411	```	411	```
412		412
		413	+Specify which fields can include misspellings with: [master]
		414	+
		415	+```ruby
		416	+Product.search "zucini", fields: [:name, :color], misspellings: {fields: [:name]}
		417	+```
		418	+
		419	+> When doing this, you must also specify fields to search
		420	+
413	### Bad Matches	421	### Bad Matches
414		422
415	If a user searches `butter`, they may also get results for `peanut butter`. To prevent this, use:	423	If a user searches `butter`, they may also get results for `peanut butter`. To prevent this, use:
	@@ -53,4 +53,48 @@ class MisspellingsTest < Minitest::Test		@@ -53,4 +53,48 @@ class MisspellingsTest < Minitest::Test
53	store_names ["abc", "abd", "aee"]	53	store_names ["abc", "abd", "aee"]
54	assert !Product.search("abc", misspellings: {below: 1}).misspellings?	54	assert !Product.search("abc", misspellings: {below: 1}).misspellings?
55	end	55	end
		56	+
		57	+ def test_misspellings_field_correct_spelling_still_works
		58	+ store [{name: "Sriracha", color: "blue"}]
		59	+ assert_misspellings "Sriracha", ["Sriracha"], {fields: [:name, :color]}
		60	+ assert_misspellings "blue", ["Sriracha"], {fields: [:name, :color]}
		61	+ end
		62	+
		63	+ def test_misspellings_field_enabled
		64	+ store [{name: "Sriracha", color: "blue"}]
		65	+ assert_misspellings "siracha", ["Sriracha"], {fields: [:name]}
		66	+ assert_misspellings "clue", ["Sriracha"], {fields: [:color]}
		67	+ end
		68	+
		69	+ def test_misspellings_field_disabled
		70	+ store [{name: "Sriracha", color: "blue"}]
		71	+ assert_misspellings "siracha", [], {fields: [:color]}
		72	+ assert_misspellings "clue", [], {fields: [:name]}
		73	+ end
		74	+
		75	+ def test_misspellings_field_with_transpositions
		76	+ store [{name: "Sriracha", color: "blue"}]
		77	+ assert_misspellings "lbue", [], {transpositions: false, fields: [:color]}
		78	+ end
		79	+
		80	+ def test_misspellings_field_with_edit_distance
		81	+ store [{name: "Sriracha", color: "blue"}]
		82	+ assert_misspellings "crue", ["Sriracha"], {edit_distance: 2, fields: [:color]}
		83	+ end
		84	+
		85	+ def test_misspellings_field_multiple
		86	+ store [
		87	+ {name: "Greek Yogurt", color: "white"},
		88	+ {name: "Green Onions", color: "yellow"}
		89	+ ]
		90	+ assert_misspellings "greed", ["Greek Yogurt", "Green Onions"], {fields: [:name, :color]}
		91	+ assert_misspellings "mellow", ["Green Onions"], {fields: [:name, :color]}
		92	+ end
		93	+
		94	+ def test_misspellings_field_requires_explicit_search_fields
		95	+ store_names ["Sriracha"]
		96	+ assert_raises(ArgumentError) do
		97	+ assert_search "siracha", ["Sriracha"], {misspellings: {fields: [:name]}}
		98	+ end
		99	+ end
56	end	100	end
	@@ -579,6 +579,14 @@ class Minitest::Test		@@ -579,6 +579,14 @@ class Minitest::Test
579	assert_equal expected, klass.search(term, options).map(&:name).first	579	assert_equal expected, klass.search(term, options).map(&:name).first
580	end	580	end
581		581
		582	+ def assert_misspellings(term, expected, misspellings = {}, klass = Product)
		583	+ options = {
		584	+ fields: [:name, :color],
		585	+ misspellings: misspellings
		586	+ }
		587	+ assert_search(term, expected, options, klass)
		588	+ end
		589	+
582	def with_options(klass, options)	590	def with_options(klass, options)
583	previous_options = klass.searchkick_options.dup	591	previous_options = klass.searchkick_options.dup
584	begin	592	begin