searchkick 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32cdf7dc806463087e8de7a1178b759b18621a3e
-  data.tar.gz: 354388509186cbd11616c958832182a892aacff9
+  metadata.gz: d67265d1ad299d9e79b7f1020197f3b12f551535
+  data.tar.gz: b72d9fb064fad2f904db6d2cf69e9be96fb8c44e
 SHA512:
-  metadata.gz: 0154a4d77e5c9308a26c8524db04dbbe75b471ab5875835cb1d0c0594e0543e1e7bd9bb8f31384eb166bb513af6faede705d11964942674ec9452df7b113aac3
-  data.tar.gz: f5477b6069d310f813a2e0f84a6452920583458ba4ded63cc973976181dcf033271d90e3d30e5d7c1edbc3288bc4516adcbaee29dcbb12c96ebb7639e9c263c5
+  metadata.gz: 7ec7b5537539de163009b0857bd84a78829a0520b55b1f77544d0a65dee789dfce467b7afc63aa4aa54327d87be1dc3954178d3d209a35bb92e47c5179ad53a3
+  data.tar.gz: c9710769dd1045f5e8cfb1cd4cc86242df365289d28409bf8c47fe19e3b829b6d5b7ab6bed8ba890e56189ececacad520280c0940651bb2d8cdb2a0f78ac1356

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.4
+
+- Added highlighting
+- Added :distance option to misspellings
+- Fixed issue w/ BigDecimal serialization
+
 ## 0.3.3
 
 - Better error messages

data/README.md

@@ -29,7 +29,7 @@ Plus:
 
 ## Get Started
 
-[Install Elasticsearch](http://www.elasticsearch.org/guide/reference/setup/installation/). For Homebrew, use:
+[Install Elasticsearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
 
 ```sh
 brew install elasticsearch
@@ -152,7 +152,13 @@ Call `Product.reindex` after changing synonyms.
 By default, Searchkick handles misspelled queries by returning results with an [edit distance](http://en.wikipedia.org/wiki/Levenshtein_distance) of one. To turn off this feature, use:
 
 ```ruby
-Product.search "zuchini", misspellings: false
+Product.search "zuchini", misspellings: false # no zucchini
+```
+
+You can also change the edit distance with:
+
+```ruby
+Product.search "zucini", misspellings: {distance: 2} # zucchini
 ```
 
 ### Indexing
@@ -342,6 +348,30 @@ Advanced
 Product.search "2% Milk", facets: {store_id: {where: {in_stock: true}, limit: 10}}
 ```
 
+### Highlight
+
+Highlight the search query in the results.
+
+```ruby
+bands = Band.search "cinema", fields: [:name], highlight: true
+```
+
+**Note:** The `fields` option is required.
+
+View the highlighted fields with:
+
+```ruby
+bands.with_details.each do |band, details|
+  puts details[:highlight][:name] # "Two Door <em>Cinema</em> Club"
+end
+```
+
+To change the tag, use:
+
+```ruby
+Band.search "cinema", fields: [:name], highlight: {tag: "<strong>"}
+```
+
 ### Similar Items
 
 Find similar items.
@@ -528,7 +558,7 @@ rake searchkick:reindex:all
 
   ```ruby
   class Product < ActiveRecord::Base
-      searchkick
+    searchkick
   end
   ```
 
@@ -560,7 +590,6 @@ Thanks to Karel Minarik for [Tire](https://github.com/karmi/tire), Jaroslav Kali
 
 ## TODO
 
-- Analytics for searches and conversions
 - Generate autocomplete predictions from past search queries
 - Automatic failover
 - Make Searchkick work with any language

data/lib/searchkick/model.rb

@@ -61,6 +61,29 @@ module Searchkick
             source[field] = source[field].map(&:to_f).reverse if source[field]
           end
 
+          # change all BigDecimal values to floats due to
+          # https://github.com/rails/rails/issues/6033
+          # possible loss of precision :/
+          cast_big_decimal =
+            proc do |obj|
+              case obj
+              when BigDecimal
+                obj.to_f
+              when Hash
+                obj.each do |k, v|
+                  obj[k] = cast_big_decimal.call(v)
+                end
+              when Enumerable
+                obj.map! do |v|
+                  cast_big_decimal.call(v)
+                end
+              else
+                obj
+              end
+            end
+
+          cast_big_decimal.call(source)
+
           source.to_json
         end
 

data/lib/searchkick/reindex.rb

@@ -203,6 +203,8 @@ module Searchkick
           fields: {
             field => {type: "string", index: "not_analyzed"},
             "analyzed" => {type: "string", index: "analyzed"}
+            # term_vector: "with_positions_offsets" for fast / correct highlighting
+            # http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html#_fast_vector_highlighter
           }
         }
         if autocomplete.include?(field)

data/lib/searchkick/results.rb

@@ -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)

data/lib/searchkick/search.rb

@@ -70,9 +70,10 @@ module Searchkick
             {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search2")}
           ]
           if options[:misspellings] != false
+            distance = (options[:misspellings].is_a?(Hash) && options[:misspellings][:distance]) || 1
             queries.concat [
-              {multi_match: shared_options.merge(fuzziness: 1, max_expansions: 3, analyzer: "searchkick_search")},
-              {multi_match: shared_options.merge(fuzziness: 1, max_expansions: 3, analyzer: "searchkick_search2")}
+              {multi_match: shared_options.merge(fuzziness: distance, max_expansions: 3, analyzer: "searchkick_search")},
+              {multi_match: shared_options.merge(fuzziness: distance, max_expansions: 3, analyzer: "searchkick_search2")}
             ]
           end
           payload = {
@@ -288,6 +289,17 @@ module Searchkick
         end
       end
 
+      # highlight
+      if options[:highlight]
+        payload[:highlight] = {
+          fields: Hash[ fields.map{|f| [f, {}] } ]
+        }
+        if options[:highlight].is_a?(Hash) and tag = options[:highlight][:tag]
+          payload[:highlight][:pre_tags] = [tag]
+          payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A</, "</")]
+        end
+      end
+
       # An empty array will cause only the _id and _type for each hit to be returned
       # http://www.elasticsearch.org/guide/reference/api/search/fields/
       payload[:fields] = [] if load

data/lib/searchkick/tasks.rb

@@ -23,8 +23,10 @@ namespace :searchkick do
       task :all => :environment do
         Rails.application.eager_load!
         (Searchkick::Reindex.instance_variable_get(:@descendents) || []).each do |model|
+          puts "Reindexing #{model.name}..."
           model.reindex
         end
+        puts "Reindex complete"
       end
     end
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/test/highlight_test.rb

@@ -0,0 +1,22 @@
+require_relative "test_helper"
+
+class TestHighlight < 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).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>"}).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).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

data/test/sql_test.rb

@@ -129,6 +129,11 @@ class TestSql < Minitest::Unit::TestCase
     assert_search "abc", ["abc"], misspellings: false
   end
 
+  def test_misspellings_distance
+    store_names ["abbb", "aabb"]
+    assert_search "aaaa", ["aabb"], misspellings: {distance: 2}
+  end
+
   def test_fields
     store [
       {name: "red", color: "light blue"},
@@ -150,6 +155,13 @@ class TestSql < Minitest::Unit::TestCase
     assert_first "blue", "Blue B", fields: [:name, :color]
   end
 
+  def test_big_decimal
+    store [
+      {name: "Product", latitude: 100.0}
+    ]
+    assert_search "product", ["Product"], where: {latitude: {gt: 99}}
+  end
+
   # load
 
   def test_load_default

data/test/suggest_test.rb

@@ -4,17 +4,17 @@ class TestSuggest < Minitest::Unit::TestCase
 
   def test_basic
     store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
-    assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark"
+    assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [:name]
   end
 
   def test_perfect
     store_names ["Tiger Shark", "Great White Shark"]
-    assert_suggest "Tiger Shark", nil # no correction
+    assert_suggest "Tiger Shark", nil, fields: [:name] # no correction
   end
 
   def test_phrase
     store_names ["Big Tiger Shark", "Tiger Sharp Teeth", "Tiger Sharp Mind"]
-    assert_suggest "How to catch a big tiger shar", "how to catch a big tiger shark"
+    assert_suggest "How to catch a big tiger shar", "how to catch a big tiger shark", fields: [:name]
   end
 
   def test_without_option

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-04 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
@@ -135,6 +135,7 @@ files:
 - test/autocomplete_test.rb
 - test/boost_test.rb
 - test/facets_test.rb
+- test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb
 - test/match_test.rb
@@ -171,6 +172,7 @@ test_files:
 - test/autocomplete_test.rb
 - test/boost_test.rb
 - test/facets_test.rb
+- test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb
 - test/match_test.rb