Added highlighted method [skip ci]

Andrew
1 parent 7e14e594
Showing 3 changed files with 52 additions and 0 deletions Show diff stats
README.md
lib/searchkick/results.rb
test/highlight_test.rb
@@ -803,6 +803,14 @@ bands.with_highlights.each do |band, highlights|
 end
 ```
  
+Or
+
+```ruby
+bands.highlighted.each do |band|
+  band.name
+end
+```
+
 To change the tag, use:
  
 ```ruby
@@ -189,6 +189,26 @@ module Searchkick
       @options[:misspellings]
     end
  
+    def highlighted(multiple: false)
+      with_highlights(multiple: multiple).map do |result, highlights|
+        if result.is_a?(HashWrapper)
+          result = result.dup
+          highlights.each do |k, v|
+            result.send("#{k}=", v)
+          end
+        else
+          result = result.clone
+          result.readonly! if result.respond_to?(:readonly!)
+          highlights.each do |k, v|
+            result.define_singleton_method(k) do
+              v
+            end
+          end
+        end
+        result
+      end
+    end
+
     private
  
     def results_query(records, hits)
@@ -86,4 +86,28 @@ class HighlightTest &lt; Minitest::Test
       assert highlight.include?("<em>Cinema</em>")
     end
   end
+
+  def test_highlighted
+    store_names ["Two Door Cinema Club"]
+    result = Product.search("cinema", highlight: true)
+
+    product = result.highlighted.first
+    assert_equal "Two Door <em>Cinema</em> Club", product.name
+    assert product.readonly?
+
+    # make sure it doesn't modify original
+    assert_equal "Two Door Cinema Club", result.first.name
+    assert !result.first.readonly?
+  end
+
+  def test_highlighted_load_false
+    store_names ["Two Door Cinema Club"]
+    result = Product.search("cinema", highlight: true, load: false)
+    product = result.highlighted.first
+    assert_equal "Two Door <em>Cinema</em> Club", product.name
+    assert_equal "Two Door <em>Cinema</em> Club", product[:name]
+
+    # make sure it doesn't modify original
+    assert_equal "Two Door Cinema Club", result.first.name
+  end
 end
...	...	@@ -803,6 +803,14 @@ bands.with_highlights.each do \|band, highlights\|
803	803	end
804	804	```
805	805
	806	+Or
	807	+
	808	+```ruby
	809	+bands.highlighted.each do \|band\|
	810	+ band.name
	811	+end
	812	+```
	813	+
806	814	To change the tag, use:
807	815
808	816	```ruby
...	...
...	...	@@ -189,6 +189,26 @@ module Searchkick
189	189	@options[:misspellings]
190	190	end
191	191
	192	+ def highlighted(multiple: false)
	193	+ with_highlights(multiple: multiple).map do \|result, highlights\|
	194	+ if result.is_a?(HashWrapper)
	195	+ result = result.dup
	196	+ highlights.each do \|k, v\|
	197	+ result.send("#{k}=", v)
	198	+ end
	199	+ else
	200	+ result = result.clone
	201	+ result.readonly! if result.respond_to?(:readonly!)
	202	+ highlights.each do \|k, v\|
	203	+ result.define_singleton_method(k) do
	204	+ v
	205	+ end
	206	+ end
	207	+ end
	208	+ result
	209	+ end
	210	+ end
	211	+
192	212	private
193	213
194	214	def results_query(records, hits)
...	...
...	...	@@ -86,4 +86,28 @@ class HighlightTest < Minitest::Test
86	86	assert highlight.include?("<em>Cinema</em>")
87	87	end
88	88	end
	89	+
	90	+ def test_highlighted
	91	+ store_names ["Two Door Cinema Club"]
	92	+ result = Product.search("cinema", highlight: true)
	93	+
	94	+ product = result.highlighted.first
	95	+ assert_equal "Two Door <em>Cinema</em> Club", product.name
	96	+ assert product.readonly?
	97	+
	98	+ # make sure it doesn't modify original
	99	+ assert_equal "Two Door Cinema Club", result.first.name
	100	+ assert !result.first.readonly?
	101	+ end
	102	+
	103	+ def test_highlighted_load_false
	104	+ store_names ["Two Door Cinema Club"]
	105	+ result = Product.search("cinema", highlight: true, load: false)
	106	+ product = result.highlighted.first
	107	+ assert_equal "Two Door <em>Cinema</em> Club", product.name
	108	+ assert_equal "Two Door <em>Cinema</em> Club", product[:name]
	109	+
	110	+ # make sure it doesn't modify original
	111	+ assert_equal "Two Door Cinema Club", result.first.name
	112	+ end
89	113	end
...	...