searchkick 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b3dc0e591516c6ddd76101c1053211ae7f9fe9
-  data.tar.gz: f56695cbbfcc4e92b6d751add7c00ec6bbdb82ed
+  metadata.gz: 2d9d6517d9d49a09f8827ea95a866e4a162fa7f3
+  data.tar.gz: cb53edf08c5f05e95e6bb11aa2e00f010f6e2043
 SHA512:
-  metadata.gz: 1a4ca76c448e90b4d838aa1e0076b01355866b837a046618222aaa7e65b9142b3370c8f93fc622be57e248a5ed8fd4941155fa915dda118c1781893266c832c6
-  data.tar.gz: 2d7f62a4329cf8005f57ae60968f3e2aea626cff87e5073a8fa141250ec135424ba8bb2ccff46ddf8033bdf07d05ecad3dec59fceeb5d67d044911e7ffa9f561
+  metadata.gz: 3a9fb661de8eaa36d5f1c979ee1bb0a3779716b4983e17d94de72883fd1a549c874cbd2a41f8498b7f4110e5d62ed7511f3d873df9a42d51aa590cf55156d72f
+  data.tar.gz: 000f1e7fb07a5d00659f21a8116e8fd57dcaf6b41adcc261d7687e6cccccd2edb811738c7e3552f0ac1c594dffd818ae4966cdda36ed8fe334843df1350e4137

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.7.6
+
+- Added `stats` option to facets
+- Added `padding` option
+
 ## 0.7.5
 
 - Do not throw errors when index becomes out of sync with database

data/README.md

@@ -108,6 +108,8 @@ Order
 order: {_score: :desc} # most relevant first - default
 ```
 
+[All of these sort options are supported](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html)
+
 Limit / offset
 
 ```ruby
@@ -441,6 +443,12 @@ price_ranges = [{to: 20}, {from: 20, to: 50}, {from: 50}]
 Product.search "*", facets: {price: {ranges: price_ranges}}
 ```
 
+Use the `stats` option to get to max, min, mean, and total scores for each facet [master]
+
+```ruby
+Product.search "*", facets: {store_id: {stats: true}}
+```
+
 ### Highlight
 
 Highlight the search query in the results.

data/lib/searchkick/index.rb

@@ -44,7 +44,7 @@ module Searchkick
         client.bulk(
           index: name,
           type: type,
-          body: batch.map{|r| data = search_data(r); {index: {_id: search_id(r), data: data}} }
+          body: batch.map{|r| {index: {_id: search_id(r), data: search_data(r)}} }
         )
       end
     end
@@ -58,7 +58,11 @@ module Searchkick
     end
 
     def klass_document_type(klass)
-      klass.model_name.to_s.underscore
+      if klass.respond_to?(:document_type)
+        klass.document_type
+      else
+        klass.model_name.to_s.underscore
+      end
     end
 
     protected
@@ -77,11 +81,11 @@ module Searchkick
 
     def search_data(record)
       source = record.search_data
+      options = record.class.searchkick_options
 
       # stringify fields
-      source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}.except("id", "_id")
-
-      options = record.class.searchkick_options
+      # remove _id since search_id is used instead
+      source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}.except("_id")
 
       # conversions
       conversions_field = options[:conversions]
@@ -107,8 +111,6 @@ module Searchkick
 
       cast_big_decimal(source)
 
-      # p search_data
-
       source.as_json
     end
 

data/lib/searchkick/query.rb

@@ -38,7 +38,8 @@ module Searchkick
       # pagination
       page = [options[:page].to_i, 1].max
       per_page = (options[:limit] || options[:per_page] || 100000).to_i
-      offset = options[:offset] || (page - 1) * per_page
+      padding = [options[:padding].to_i, 0].max
+      offset = options[:offset] || (page - 1) * per_page + padding
 
       conversions_field = searchkick_options[:conversions]
       personalize_field = searchkick_options[:personalize]
@@ -218,6 +219,7 @@ module Searchkick
         facets.each do |field, facet_options|
           # ask for extra facets due to
           # https://github.com/elasticsearch/elasticsearch/issues/1305
+          size = facet_options[:limit] ? facet_options[:limit] + 150 : 100000
 
           if facet_options[:ranges]
             payload[:facets][field] = {
@@ -225,11 +227,19 @@ module Searchkick
                 field.to_sym => facet_options[:ranges]
               }
             }
+          elsif facet_options[:stats]
+            payload[:facets][field] = {
+              terms_stats: {
+                key_field: field,
+                value_script: "doc.score",
+                size: size
+              }
+            }
           else
             payload[:facets][field] = {
               terms: {
                 field: field,
-                size: facet_options[:limit] ? facet_options[:limit] + 150 : 100000
+                size: size
               }
             }
           end
@@ -298,6 +308,7 @@ module Searchkick
       @facet_limits = facet_limits
       @page = page
       @per_page = per_page
+      @padding = padding
       @load = load
     end
 
@@ -360,6 +371,7 @@ module Searchkick
       opts = {
         page: @page,
         per_page: @per_page,
+        padding: @padding,
         load: @load,
         includes: options[:include] || options[:includes]
       }

data/lib/searchkick/results.rb

@@ -39,7 +39,7 @@ module Searchkick
         else
           hits.map do |hit|
             result = hit.except("_source").merge(hit["_source"])
-            result["id"] = result["_id"]
+            result["id"] ||= result["_id"] # needed for legacy reasons
             Hashie::Mash.new(result)
           end
         end
@@ -90,13 +90,17 @@ module Searchkick
     end
     alias_method :limit_value, :per_page
 
+    def padding
+      options[:padding]
+    end
+
     def total_pages
       (total_count / per_page.to_f).ceil
     end
     alias_method :num_pages, :total_pages
 
     def offset_value
-      (current_page - 1) * per_page
+      (current_page - 1) * per_page + padding
     end
     alias_method :offset, :offset_value
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.7.5"
+  VERSION = "0.7.6"
 end

data/test/facets_test.rb

@@ -59,6 +59,13 @@ class TestFacets < Minitest::Unit::TestCase
     assert_equal ({1 => 1, 2 => 1}), store_facet(where: {store_id: 2, price: {gt: 5}}, facets: [:store_id], smart_facets: true)
   end
 
+  def test_stats_facets
+    options = {where: {store_id: 2}, facets: {store_id: {stats: true}}}
+    facets = Product.search("Product", options).facets["store_id"]["terms"]
+    expected_facets_keys = %w[term count total_count min max total mean]
+    assert_equal expected_facets_keys, facets.first.keys
+  end
+
   protected
 
   def store_facet(options)

data/test/sql_test.rb

@@ -19,19 +19,20 @@ class TestSql < Minitest::Unit::TestCase
   end
 
   def test_pagination
-    store_names ["Product A", "Product B", "Product C", "Product D", "Product E"]
-    products = Product.search("product", order: {name: :asc}, page: 2, per_page: 2)
-    assert_equal ["Product C", "Product D"], products.map(&:name)
+    store_names ["Product A", "Product B", "Product C", "Product D", "Product E", "Product F"]
+    products = Product.search("product", order: {name: :asc}, page: 2, per_page: 2, padding: 1)
+    assert_equal ["Product D", "Product E"], products.map(&:name)
     assert_equal 2, products.current_page
+    assert_equal 1, products.padding
     assert_equal 2, products.per_page
     assert_equal 2, products.size
     assert_equal 2, products.length
     assert_equal 3, products.total_pages
-    assert_equal 5, products.total_count
-    assert_equal 5, products.total_entries
+    assert_equal 6, products.total_count
+    assert_equal 6, products.total_entries
     assert_equal 2, products.limit_value
-    assert_equal 2, products.offset_value
-    assert_equal 2, products.offset
+    assert_equal 3, products.offset_value
+    assert_equal 3, products.offset
     assert !products.first_page?
     assert !products.last_page?
     assert !products.empty?
@@ -197,6 +198,10 @@ class TestSql < Minitest::Unit::TestCase
     assert_order "product", ["Product A", "Product B", "Product C"], order: {color: :asc, store_id: :desc}
   end
 
+  def test_order_ignore_unmapped
+    assert_order "product", [], order: {not_mapped: {ignore_unmapped: true}}, conversions: false
+  end
+
   def test_partial
     store_names ["Honey"]
     assert_search "fresh honey", []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel