Added stem option

Andrew
1 parent 4bed5e3e
Showing 6 changed files with 45 additions and 16 deletions Show diff stats
CHANGELOG.md
README.md
lib/searchkick/index_options.rb
lib/searchkick/model.rb
test/case_sensitive_test.rb
test/index_options_test.rb
@@ -3,6 +3,7 @@
 - Added per-field misspellings
 - Made `exclude` option work with match all
 - Added `case_sensitive` option
+- Added `stem` option
  
 ## 3.1.0
  
@@ -1676,6 +1676,22 @@ class Product &lt; ApplicationRecord
 end
 ```
  
+Turn off stemming [master]
+
+```ruby
+class Product < ApplicationRecord
+  searchkick stem: false
+end
+```
+
+Turn on stemming for conversions
+
+```ruby
+class Product < ApplicationRecord
+  searchkick stem_conversions: true
+end
+```
+
 Use a different [similarity algorithm](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-similarity.html) for scoring
  
 ```ruby
@@ -226,12 +226,17 @@ module Searchkick
         end
  
         if options[:case_sensitive]
-          # delete lowercase analyzer from each
           settings[:analysis][:analyzer].each do |_, analyzer|
             analyzer[:filter].delete("lowercase")
           end
         end
  
+        if options[:stem] == false
+          settings[:analysis][:analyzer].each do |_, analyzer|
+            analyzer[:filter].delete("searchkick_stemmer")
+          end
+        end
+
         settings = settings.symbolize_keys.deep_merge((options[:settings] || {}).symbolize_keys)
  
         # synonyms
@@ -6,7 +6,7 @@ module Searchkick
       unknown_keywords = options.keys - [:_all, :_type, :batch_size, :callbacks, :case_sensitive, :conversions, :default_fields,
         :filterable, :geo_shape, :highlight, :ignore_above, :index_name, :index_prefix, :inheritance, :language,
         :locations, :mappings, :match, :merge_mappings, :routing, :searchable, :settings, :similarity,
-        :special_characters, :stem_conversions, :suggest, :synonyms, :text_end,
+        :special_characters, :stem, :stem_conversions, :suggest, :synonyms, :text_end,
         :text_middle, :text_start, :word, :wordnet, :word_end, :word_middle, :word_start]
       raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
  
@@ -1,14 +0,0 @@
-require_relative "test_helper"
-
-class CaseSensitiveTest < Minitest::Test
-  def setup
-    Song.destroy_all
-  end
-
-  def test_case_sensitive
-    with_options(Song, case_sensitive: true) do
-      store_names ["Test", "test"], Song
-      assert_search "test", ["test"], {misspellings: false}, Song
-    end
-  end
-end
@@ -0,0 +1,21 @@
+require_relative "test_helper"
+
+class IndexOptionsTest < Minitest::Test
+  def setup
+    Song.destroy_all
+  end
+
+  def test_case_sensitive
+    with_options(Song, case_sensitive: true) do
+      store_names ["Test", "test"], Song
+      assert_search "test", ["test"], {misspellings: false}, Song
+    end
+  end
+
+  def test_no_stemming
+    with_options(Song, stem: false) do
+      store_names ["milk", "milks"], Song
+      assert_search "milks", ["milks"], {misspellings: false}, Song
+    end
+  end
+end
...	...	@@ -3,6 +3,7 @@
3	3	- Added per-field misspellings
4	4	- Made `exclude` option work with match all
5	5	- Added `case_sensitive` option
	6	+- Added `stem` option
6	7
7	8	## 3.1.0
8	9
...	...
...	...	@@ -1676,6 +1676,22 @@ class Product < ApplicationRecord
1676	1676	end
1677	1677	```
1678	1678
	1679	+Turn off stemming [master]
	1680	+
	1681	+```ruby
	1682	+class Product < ApplicationRecord
	1683	+ searchkick stem: false
	1684	+end
	1685	+```
	1686	+
	1687	+Turn on stemming for conversions
	1688	+
	1689	+```ruby
	1690	+class Product < ApplicationRecord
	1691	+ searchkick stem_conversions: true
	1692	+end
	1693	+```
	1694	+
1679	1695	Use a different [similarity algorithm](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-similarity.html) for scoring
1680	1696
1681	1697	```ruby
...	...
...	...	@@ -226,12 +226,17 @@ module Searchkick
226	226	end
227	227
228	228	if options[:case_sensitive]
229		- # delete lowercase analyzer from each
230	229	settings[:analysis][:analyzer].each do \|_, analyzer\|
231	230	analyzer[:filter].delete("lowercase")
232	231	end
233	232	end
234	233
	234	+ if options[:stem] == false
	235	+ settings[:analysis][:analyzer].each do \|_, analyzer\|
	236	+ analyzer[:filter].delete("searchkick_stemmer")
	237	+ end
	238	+ end
	239	+
235	240	settings = settings.symbolize_keys.deep_merge((options[:settings] \|\| {}).symbolize_keys)
236	241
237	242	# synonyms
...	...
...	...	@@ -6,7 +6,7 @@ module Searchkick
6	6	unknown_keywords = options.keys - [:_all, :_type, :batch_size, :callbacks, :case_sensitive, :conversions, :default_fields,
7	7	:filterable, :geo_shape, :highlight, :ignore_above, :index_name, :index_prefix, :inheritance, :language,
8	8	:locations, :mappings, :match, :merge_mappings, :routing, :searchable, :settings, :similarity,
9		- :special_characters, :stem_conversions, :suggest, :synonyms, :text_end,
	9	+ :special_characters, :stem, :stem_conversions, :suggest, :synonyms, :text_end,
10	10	:text_middle, :text_start, :word, :wordnet, :word_end, :word_middle, :word_start]
11	11	raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
12	12
...	...
...	...	@@ -1,14 +0,0 @@
1		-require_relative "test_helper"
2		-
3		-class CaseSensitiveTest < Minitest::Test
4		- def setup
5		- Song.destroy_all
6		- end
7		-
8		- def test_case_sensitive
9		- with_options(Song, case_sensitive: true) do
10		- store_names ["Test", "test"], Song
11		- assert_search "test", ["test"], {misspellings: false}, Song
12		- end
13		- end
14		-end
...	...	@@ -0,0 +1,21 @@
	1	+require_relative "test_helper"
	2	+
	3	+class IndexOptionsTest < Minitest::Test
	4	+ def setup
	5	+ Song.destroy_all
	6	+ end
	7	+
	8	+ def test_case_sensitive
	9	+ with_options(Song, case_sensitive: true) do
	10	+ store_names ["Test", "test"], Song
	11	+ assert_search "test", ["test"], {misspellings: false}, Song
	12	+ end
	13	+ end
	14	+
	15	+ def test_no_stemming
	16	+ with_options(Song, stem: false) do
	17	+ store_names ["milk", "milks"], Song
	18	+ assert_search "milks", ["milks"], {misspellings: false}, Song
	19	+ end
	20	+ end
	21	+end
...	...