searchkick 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a044b56c37732d857fe1dfa7109dc1b87259f15
-  data.tar.gz: 6fa27e15c4317b20e87f81c22e0ca0f3e69d68cc
+  metadata.gz: bb8ada9111159102b2327b5344afe0876aac137d
+  data.tar.gz: 3e3e655a723d06f6b741b0938d3fde6d02d5c7ab
 SHA512:
-  metadata.gz: 6669b630d244570056a3c2373dda6d99c0c59e25af9c4a716401b9b3178b8867d572a7b553156d69e0b7728fa2ba24e256d347ef39597033d845b9d15e05e7d6
-  data.tar.gz: b351f5f4d832e80dd9e16acbbebbeb2db89a9ac0ea470394391f033ab66da728e811ee9b25f99de6bb0a65c6bedf5d2e572b10eef879d4f225d488f2cf2b3453
+  metadata.gz: fdb99efc9149d644dd126456c9ab2e753a6f67a77feb90e07ad20dcbea75dd7152705136a2e30cfd0fd9e1a38a0ba35b1f05d0b8dd6c986ba248aa90a82126b2
+  data.tar.gz: 04a2c3229e5f40a866fa8cc2aed8832d361d680ef9a88fe75d1e3b8dc72875524961056f2f00bf2edd7bcd07989864118367547006198588b5f3af3e0e81ee96

data/CHANGELOG.md

@@ -1,7 +1,13 @@
+## 0.7.8
+
+- Added `boost_by` and `boost_where` options
+- Added ability to boost fields - `name^10`
+- Added `select` option for `load: false`
+
 ## 0.7.7
 
 - Added support for automatic failover
-- Fixed default operator for partial queries
+- Fixed `operator` option (and default) for partial matches
 
 ## 0.7.6
 

data/README.md

@@ -116,10 +116,26 @@ Limit / offset
 limit: 20, offset: 40
 ```
 
-Boost by a field
+### Boosting
+
+Boost important fields
+
+```ruby
+fields: ["title^10", "description"]
+```
+
+Boost by the value of a field
 
 ```ruby
-boost: "orders_count" # give popular documents a little boost
+boost_by: [:orders_count] # give popular documents a little boost
+boost_by: {orders_count: {factor: 10}}
+```
+
+Boost matching documents
+
+```ruby
+boost_where: {user_id: 1}
+boost_where: {user_id: {value: 1, factor: 100}}
 ```
 
 ### Get Everything
@@ -164,7 +180,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-And to search:
+And to search (after you reindex):
 
 ```ruby
 Product.search "back", fields: [{name: :word_start}]
@@ -182,6 +198,12 @@ Available options are:
 :text_end
 ```
 
+To boost fields, use:
+
+```ruby
+fields: [{"name^2" => :word_start}] # better interface on the way
+```
+
 ### Language
 
 Searchkick defaults to English for stemming.  To change this, use:
@@ -281,7 +303,7 @@ end
 
 You do **not** need to clean up the search queries.  Searchkick automatically treats `apple` and `APPLES` the same.
 
-Next, add conversions to the index.  You must specify the conversions field as of version `0.2.0`.
+Next, add conversions to the index.
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -311,22 +333,21 @@ Order results differently for each user.  For example, show a user’s previousl
 
 ```ruby
 class Product < ActiveRecord::Base
-  searchkick personalize: "user_ids"
 
   def search_data
     {
       name: name,
       user_ids: orders.pluck(:user_id) # boost this product for these users
-      # [4, 8, 15, 16, 23, 42]
     }
   end
+
 end
 ```
 
 Reindex and search with:
 
 ```ruby
-Product.search "milk", user_id: 8
+Product.search "milk", boost_where: {user_id: 8}
 ```
 
 ### Autocomplete
@@ -484,8 +505,6 @@ product.similar(fields: ["name"])
 
 ### Geospatial Searches
 
-**Note:** Before `0.3.0`, locations were indexed incorrectly. When upgrading, be sure to reindex immediately.
-
 ```ruby
 class City < ActiveRecord::Base
   searchkick locations: ["location"]
@@ -785,10 +804,20 @@ rake searchkick:reindex:all
 
 4. Once it finishes, replace search calls w/ searchkick calls
 
-## Note about 0.6.0 and 0.7.0
+## Upgrading
+
+View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md).
+
+Important notes are listed below.
+
+### 0.6.0 and 0.7.0
 
 If running Searchkick `0.6.0` or `0.7.0` and Elasticsearch `0.90`, we recommend upgrading to Searchkick `0.6.1` or `0.7.1` to fix an issue that causes downtime when reindexing.
 
+### 0.3.0
+
+Before `0.3.0`, locations were indexed incorrectly. When upgrading, be sure to reindex immediately.
+
 ## Elasticsearch Gotchas
 
 ### Inconsistent Scores
@@ -816,10 +845,6 @@ Thanks to Karel Minarik for [Elasticsearch Ruby](https://github.com/elasticsearc
 - Much finer customization
 - More transparency into generated queries (for advanced use)
 
-## History
-
-View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md)
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/searchkick/query.rb

@@ -15,6 +15,7 @@ module Searchkick
       @term = term
       @options = options
 
+      boost_fields = {}
       fields =
         if options[:fields]
           if options[:autocomplete]
@@ -22,7 +23,10 @@ module Searchkick
           else
             options[:fields].map do |value|
               k, v = value.is_a?(Hash) ? value.to_a.first : [value, :word]
-              "#{k}.#{v == :word ? "analyzed" : v}"
+              k2, boost = k.to_s.split("^", 2)
+              field = "#{k2}.#{v == :word ? "analyzed" : v}"
+              boost_fields[field] = boost.to_i if boost
+              field
             end
           end
         else
@@ -74,17 +78,19 @@ module Searchkick
         else
           queries = []
           fields.each do |field|
+            factor = boost_fields[field] || 1
             shared_options = {
               fields: [field],
               query: term,
               use_dis_max: false,
-              operator: operator
+              operator: operator,
+              boost: factor
             }
             if field == "_all" or field.end_with?(".analyzed")
               shared_options[:cutoff_frequency] = 0.001 unless operator == "and"
               queries.concat [
-                {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search")},
-                {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search2")}
+                {multi_match: shared_options.merge(boost: 10 * factor, analyzer: "searchkick_search")},
+                {multi_match: shared_options.merge(boost: 10 * factor, analyzer: "searchkick_search2")}
               ]
               if options[:misspellings] != false
                 distance = (options[:misspellings].is_a?(Hash) && options[:misspellings][:distance]) || 1
@@ -137,36 +143,45 @@ module Searchkick
 
       custom_filters = []
 
+      boost_by = options[:boost_by] || {}
+      if boost_by.is_a?(Array)
+        boost_by = Hash[ boost_by.map{|f| [f, {factor: 1}] } ]
+      end
       if options[:boost]
+        boost_by[options[:boost]] = {factor: 1}
+      end
+
+      boost_by.each do |field, value|
         custom_filters << {
           filter: {
             exists: {
-              field: options[:boost]
+              field: field
             }
           },
           script_score: {
-            script: "log(doc['#{options[:boost]}'].value + 2.718281828)"
+            script: "#{value[:factor].to_f} * log(doc['#{field}'].value + 2.718281828)"
           }
         }
       end
 
+      boost_where = options[:boost_where] || {}
       if options[:user_id] and personalize_field
-        custom_filters << {
-          filter: {
-            term: {
-              personalize_field => options[:user_id]
-            }
-          },
-          boost_factor: 100
-        }
+        boost_where[personalize_field] = options[:user_id]
       end
-
       if options[:personalize]
+        boost_where.merge!(options[:personalize])
+      end
+      boost_where.each do |field, value|
+        if value.is_a?(Hash)
+          value, factor = value[:value], value[:factor]
+        else
+          factor = 1000
+        end
         custom_filters << {
           filter: {
-            term: options[:personalize]
+            term: {field => value}
           },
-          boost_factor: 100
+          boost_factor: factor
         }
       end
 
@@ -292,7 +307,11 @@ module Searchkick
 
       # 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
+      if load
+        payload[:fields] = []
+      elsif options[:select]
+        payload[:fields] = options[:select]
+      end
 
       if options[:type] or klass != searchkick_klass
         @type = [options[:type] || klass].flatten.map{|v| searchkick_index.klass_document_type(v) }

data/lib/searchkick/results.rb

@@ -38,7 +38,12 @@ module Searchkick
           end.compact
         else
           hits.map do |hit|
-            result = hit.except("_source").merge(hit["_source"])
+            result =
+              if hit["_source"]
+                hit.except("_source").merge(hit["_source"])
+              else
+                hit.except("fields").merge(hit["fields"])
+              end
             result["id"] ||= result["_id"] # needed for legacy reasons
             Hashie::Mash.new(result)
           end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.7.7"
+  VERSION = "0.7.8"
 end

data/test/boost_test.rb

@@ -67,4 +67,41 @@ class TestBoost < Minitest::Unit::TestCase
     assert_first "tomato", "Tomato B", personalize: {user_ids: 2}
   end
 
+  def test_boost_fields
+    store [
+      {name: "Red", color: "White"},
+      {name: "White", color: "Red Red Red"}
+    ]
+    assert_order "red", ["Red", "White"], fields: ["name^10", "color"]
+  end
+
+  def test_boost_fields_word_start
+    store [
+      {name: "Red", color: "White"},
+      {name: "White", color: "Red Red Red"}
+    ]
+    assert_order "red", ["Red", "White"], fields: [{"name^10" => :word_start}, "color"]
+  end
+
+  def test_boost_by
+    store [
+      {name: "Tomato A"},
+      {name: "Tomato B", orders_count: 10},
+      {name: "Tomato C", orders_count: 100}
+    ]
+    assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"], boost_by: [:orders_count]
+    assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"], boost_by: {orders_count: {factor: 10}}
+  end
+
+  def test_boost_where
+    store [
+      {name: "Tomato A"},
+      {name: "Tomato B", user_ids: [1, 2, 3]},
+      {name: "Tomato C"},
+      {name: "Tomato D"}
+    ]
+    assert_first "tomato", "Tomato B", boost_where: {user_ids: 2}
+    assert_first "tomato", "Tomato B", boost_where: {user_ids: {value: 2, factor: 10}}
+  end
+
 end

data/test/sql_test.rb

@@ -274,6 +274,13 @@ class TestSql < Minitest::Unit::TestCase
     assert_kind_of Hash, Product.search("product", load: false, include: [:store]).first
   end
 
+  # select
+
+  def test_select
+    store [{name: "Product A", store_id: 1}]
+    assert_equal %w[id name store_id], Product.search("product", load: false, select: [:name, :store_id]).first.keys.reject{|k| k.start_with?("_") }.sort
+  end
+
   # TODO see if Mongoid is loaded
   if !defined?(Mongoid)
     def test_include

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel