searchkick 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdf75cc3dce90b3109799a5ee97e30c319d450ac
-  data.tar.gz: 646d884beeb278d6a056f662d9a9df6de2e0b6a4
+  metadata.gz: c2afa6ea99c2995b003f51cbe409392097fdfa8e
+  data.tar.gz: dc2e4add51195454636f94db1ae6417c2a8933bb
 SHA512:
-  metadata.gz: 3f97d141a413008ecb2ce03db8c29bd09aa0127af473f40428d0c21b350e4a0266931e347164f978c695a25ebd4c26b57cfd921ce39768355821387ffccad52e
-  data.tar.gz: 91b030868ca63ad185a67b91062d682a414d942f1e17b6af3aa1ff5dd6392831c240507cf0eb18bf025f4dc3522a40b042d411420608df85a2de6227a4be5378
+  metadata.gz: 1895d905c2b916de3e5e5fb5640d8132318f0dccffa553cfd6770d1c38d84bcd5dc9c92d1749711fa16f0bfdf677962318a5ec50e366f91e0dd1324121bf169f
+  data.tar.gz: 8c9bc21cf09a320ee676d2307f7ebbdbf1cc2f2dce37633e799f6282ee2f3f1d8e5ba0af1696c23c2271f401ca1173b4803779f6f50f43cd8674db15c7483620

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.5.1
+
+- Replaced stop words with common terms query
+- Added language option
+- Fixed bug with empty array in where clause
+- Fixed bug with MongoDB integer _id
+- Fixed reindex bug when callbacks disabled
+
 ## 0.5.0
 
 - Better control over partial matches

data/README.md

@@ -21,12 +21,14 @@ Plus:
 - “Did you mean” suggestions
 - works with ActiveRecord and Mongoid
 
-:zap: Even better with [Searchjoy](http://ankane.github.io/searchjoy/)
-
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com)
 
 [![Build Status](https://travis-ci.org/ankane/searchkick.png?branch=master)](https://travis-ci.org/ankane/searchkick)
 
+We highly recommend tracking queries and conversions
+
+:zap: [Searchjoy](http://ankane.github.io/searchjoy/) makes it easy
+
 ## Get Started
 
 [Install Elasticsearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
@@ -174,6 +176,18 @@ Available options are:
 :text_end
 ```
 
+### Language
+
+Searchkick defaults to English for stemming.  To change this, use:
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick language: "German"
+end
+```
+
+[See the list of languages](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/analysis-snowball-tokenfilter.html)
+
 ### Synonyms
 
 ```ruby
@@ -219,7 +233,7 @@ Searchkick uses `find_in_batches` to import documents.  To eager load associatio
 
 ```ruby
 class Product < ActiveRecord::Base
-  scope :search_import, includes(:searches)
+  scope :search_import, -> { includes(:searches) }
 end
 ```
 
@@ -556,7 +570,7 @@ And use the `query` option to search:
 Product.search query: {match: {name: "milk"}}
 ```
 
-[master] To keep the mappings and settings generated by Searchkick, use:
+To keep the mappings and settings generated by Searchkick, use:
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -608,9 +622,9 @@ end
 or temporarily
 
 ```ruby
-Product.disable_search_callbacks # use Searchkick.disable_callbacks for all models
+Product.disable_search_callbacks # or use Searchkick.disable_callbacks for all models
 ExpensiveProductsTask.execute
-Product.enable_search_callbacks
+Product.enable_search_callbacks # or use Searchkick.enable_callbacks for all models
 Product.reindex
 ```
 
@@ -635,7 +649,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-Change import batch size [master]
+Change import batch size
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -643,6 +657,35 @@ class Product < ActiveRecord::Base
 end
 ```
 
+Reindex conditionally
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick callbacks: false
+
+  # add the callbacks manually
+  after_save :reindex, if: proc{|model| model.name_changed? } # use your own condition
+  after_destroy :reindex
+end
+```
+
+Asynchronous reindexing
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick callbacks: false
+
+  # add the callbacks manually
+  after_save :reindex_async
+  after_destroy :reindex_async
+
+  def reindex_async
+    # delayed job
+    delay.reindex
+  end
+end
+```
+
 Reindex all models (Rails only)
 
 ```sh

data/lib/searchkick/model.rb

@@ -19,8 +19,8 @@ module Searchkick
         extend Searchkick::Reindex
         include Searchkick::Similar
 
-        after_save :reindex
-        after_destroy :reindex
+        after_save :reindex, if: proc { self.class.search_callbacks? }
+        after_destroy :reindex, if: proc { self.class.search_callbacks? }
 
         def self.enable_search_callbacks
           class_variable_set :@@searchkick_callbacks, true
@@ -39,13 +39,11 @@ module Searchkick
         end
 
         def reindex
-          if self.class.search_callbacks?
-            index = self.class.searchkick_index
-            if destroyed? or !should_index?
-              index.remove self
-            else
-              index.store self
-            end
+          index = self.class.searchkick_index
+          if destroyed? or !should_index?
+            index.remove self
+          else
+            index.store self
           end
         end
 
@@ -60,7 +58,9 @@ module Searchkick
           source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
 
           # Mongoid 4 hack
-          source["_id"] = source["_id"].to_s if source["_id"]
+          if defined?(BSON::ObjectId) and source["_id"].is_a?(BSON::ObjectId)
+            source["_id"] = source["_id"].to_s
+          end
 
           options = self.class.searchkick_options
 

data/lib/searchkick/reindex.rb

@@ -94,24 +94,24 @@ module Searchkick
               searchkick_keyword: {
                 type: "custom",
                 tokenizer: "keyword",
-                filter: ["lowercase", "snowball"]
+                filter: ["lowercase", "searchkick_stemmer"]
               },
               default_index: {
                 type: "custom",
                 tokenizer: "standard",
                 # synonym should come last, after stemming and shingle
-                # shingle must come before snowball
-                filter: ["standard", "lowercase", "asciifolding", "stop", "searchkick_index_shingle", "snowball"]
+                # shingle must come before searchkick_stemmer
+                filter: ["standard", "lowercase", "asciifolding", "searchkick_index_shingle", "searchkick_stemmer"]
               },
               searchkick_search: {
                 type: "custom",
                 tokenizer: "standard",
-                filter: ["standard", "lowercase", "asciifolding", "stop", "searchkick_search_shingle", "snowball"]
+                filter: ["standard", "lowercase", "asciifolding", "searchkick_search_shingle", "searchkick_stemmer"]
               },
               searchkick_search2: {
                 type: "custom",
                 tokenizer: "standard",
-                filter: ["standard", "lowercase", "asciifolding", "stop", "snowball"]
+                filter: ["standard", "lowercase", "asciifolding", "searchkick_stemmer"]
               },
               # https://github.com/leschenko/elasticsearch_autocomplete/blob/master/lib/elasticsearch_autocomplete/analyzers.rb
               searchkick_autocomplete_index: {
@@ -190,6 +190,10 @@ module Searchkick
                 type: "nGram",
                 min_gram: 1,
                 max_gram: 50
+              },
+              searchkick_stemmer: {
+                type: "snowball",
+                language: options[:language] || "English"
               }
             },
             tokenizer: {

data/lib/searchkick/search.rb

@@ -77,7 +77,8 @@ module Searchkick
                 fields: [field],
                 query: term,
                 use_dis_max: false,
-                operator: operator
+                operator: operator,
+                cutoff_frequency: 0.001
               }
               queries.concat [
                 {multi_match: shared_options.merge(boost: 10, analyzer: "searchkick_search")},
@@ -178,13 +179,17 @@ module Searchkick
       # order
       if options[:order]
         order = options[:order].is_a?(Enumerable) ? options[:order] : {options[:order] => :asc}
-        payload[:sort] = order
+        payload[:sort] = Hash[ order.map{|k, v| [k.to_s == "id" ? :_id : k, v] } ]
       end
 
       term_filters =
         proc do |field, value|
           if value.is_a?(Array) # in query
-            {or: value.map{|v| term_filters.call(field, v) }}
+            if value.any?
+              {or: value.map{|v| term_filters.call(field, v) }}
+            else
+              {terms: {field => value}} # match nothing
+            end
           elsif value.nil?
             {missing: {"field" => field, existence: true, null_value: true}}
           else

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/test/match_test.rb

@@ -139,4 +139,9 @@ class TestMatch < Minitest::Unit::TestCase
     assert_search "*", ["Product A", "Product B"]
   end
 
+  def test_to_be_or_not_to_be
+    store_names ["to be or not to be"]
+    assert_search "to be", ["to be or not to be"]
+  end
+
 end

data/test/sql_test.rb

@@ -95,6 +95,16 @@ class TestSql < Minitest::Unit::TestCase
     assert_search "product", ["Product A"], where: {id: product.id.to_s}
   end
 
+  def test_where_empty
+    store_names ["Product A"]
+    assert_search "product", ["Product A"], where: {}
+  end
+
+  def test_where_empty_array
+    store_names ["Product A"]
+    assert_search "product", [], where: {store_id: []}
+  end
+
   def test_near
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
@@ -138,6 +148,22 @@ class TestSql < Minitest::Unit::TestCase
     assert_order "product", ["Product A", "Product B", "Product C", "Product D"], order: "name"
   end
 
+  def test_order_id
+    store_names ["Product A", "Product B"]
+    product_a = Product.where(name: "Product A").first
+    product_b = Product.where(name: "Product B").first
+    assert_order "product", [product_a, product_b].sort_by(&:id).map(&:name), order: {id: :asc}
+  end
+
+  def test_order_multiple
+    store [
+      {name: "Product A", color: "blue", store_id: 1},
+      {name: "Product B", color: "red", store_id: 3},
+      {name: "Product C", color: "red", store_id: 2}
+    ]
+    assert_order "product", ["Product A", "Product B", "Product C"], order: {color: :asc, store_id: :desc}
+  end
+
   def test_partial
     store_names ["Honey"]
     assert_search "fresh honey", []

data/test/test_helper.rb

@@ -126,7 +126,7 @@ class Product
   attr_accessor :conversions, :user_ids
 
   def search_data
-    serializable_hash.merge conversions: conversions, user_ids: user_ids, location: [latitude, longitude], multiple_locations: [[latitude, longitude], [0, 0]]
+    serializable_hash.except("id").merge conversions: conversions, user_ids: user_ids, location: [latitude, longitude], multiple_locations: [[latitude, longitude], [0, 0]]
   end
 
   def should_index?
@@ -159,6 +159,7 @@ class Minitest::Unit::TestCase
 
   def setup
     Product.destroy_all
+    Store.destroy_all
     Animal.destroy_all
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire