Added with_details method

Andrew Kane
1 parent 7ec312d6
Showing 3 changed files with 18 additions and 10 deletions Show diff stats
README.md
lib/searchkick/results.rb
test/highlight_test.rb
@@ -348,7 +348,7 @@ Advanced
 Product.search "2% Milk", facets: {store_id: {where: {in_stock: true}, limit: 10}}
 ```
-### Highlight [master - subject to change]
+### Highlight [master]
 Highlight the search query in the results.
@@ -361,13 +361,11 @@ bands = Band.search &quot;cinema&quot;, fields: [:name], highlight: true
 View the highlighted fields with:
 ```ruby
-bands.each_with_hit do |band, hit|
-  puts hit["highlight"]["name.analyzed"].first # "Two Door <em>Cinema</em> Club"
+bands.with_details.each do |band, details|
+  puts details[:highlight][:name] # "Two Door <em>Cinema</em> Club"
 end
 ```
-**Note:** A simpler interface coming before the next release.
-
 To change the tag, use:
 ```ruby
@@ -9,6 +9,16 @@ module Searchkick
       end
     end
+    def with_details
+      each_with_hit.map do |model, hit|
+        details = {}
+        if hit["highlight"]
+          details[:highlight] = Hash[ hit["highlight"].map{|k, v| [k.sub(/\.analyzed\z/, "").to_sym, v.first] } ]
+        end
+        [model, details]
+      end
+    end
+
     # fixes deprecation warning
     def __find_records_by_ids(klass, ids)
       @options[:load] === true ? klass.find(ids) : klass.includes(@options[:load][:include]).find(ids)
@@ -4,19 +4,19 @@ class TestHighlight &lt; Minitest::Unit::TestCase
   def test_basic
     store_names ["Two Door Cinema Club"]
-    assert_equal "Two Door <em>Cinema</em> Club", Product.search("cinema", fields: [:name], highlight: true).each_with_hit.first[1]["highlight"]["name.analyzed"].first
+    assert_equal "Two Door <em>Cinema</em> Club", Product.search("cinema", fields: [:name], highlight: true).with_details.first[1][:highlight][:name]
   end
   def test_tag
     store_names ["Two Door Cinema Club"]
-    assert_equal "Two Door <strong>Cinema</strong> Club", Product.search("cinema", fields: [:name], highlight: {tag: "<strong>"}).each_with_hit.first[1]["highlight"]["name.analyzed"].first
+    assert_equal "Two Door <strong>Cinema</strong> Club", Product.search("cinema", fields: [:name], highlight: {tag: "<strong>"}).with_details.first[1][:highlight][:name]
   end
   def test_multiple_fields
     store [{name: "Two Door Cinema Club", color: "Cinema Orange"}]
-    highlight = Product.search("cinema", fields: [:name, :color], highlight: true).each_with_hit.first[1]["highlight"]
-    assert_equal "Two Door <em>Cinema</em> Club", highlight["name.analyzed"].first
-    assert_equal "<em>Cinema</em> Orange", highlight["color.analyzed"].first
+    highlight = Product.search("cinema", fields: [:name, :color], highlight: true).with_details.first[1][:highlight]
+    assert_equal "Two Door <em>Cinema</em> Club", highlight[:name]
+    assert_equal "<em>Cinema</em> Orange", highlight[:color]
   end
 end
	@@ -9,6 +9,16 @@ module Searchkick		@@ -9,6 +9,16 @@ module Searchkick
9	end	9	end
10	end	10	end
11		11
		12	+ def with_details
		13	+ each_with_hit.map do \|model, hit\|
		14	+ details = {}
		15	+ if hit["highlight"]
		16	+ details[:highlight] = Hash[ hit["highlight"].map{\|k, v\| [k.sub(/\.analyzed\z/, "").to_sym, v.first] } ]
		17	+ end
		18	+ [model, details]
		19	+ end
		20	+ end
		21	+
12	# fixes deprecation warning	22	# fixes deprecation warning
13	def __find_records_by_ids(klass, ids)	23	def __find_records_by_ids(klass, ids)
14	@options[:load] === true ? klass.find(ids) : klass.includes(@options[:load][:include]).find(ids)	24	@options[:load] === true ? klass.find(ids) : klass.includes(@options[:load][:include]).find(ids)