searchkick 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c68977ac74916a49b5e7dd8c22cb18dd5793dc
-  data.tar.gz: 3a03323a99f0ee6b726796aad8b2242a9606dfe0
+  metadata.gz: c50ef339d04f201523ff1f41aad11277d7168dab
+  data.tar.gz: d7f79bf282327a781e23475f64b7530dfac6beab
 SHA512:
-  metadata.gz: 4618c81555aa422098d15533378efbc13cfb5070685649a8d3410e65a63628eaed3f0f60783b8cbe2972e3c98d6604c1fefc3cf6c6dba663fada4f7e8a215499
-  data.tar.gz: 789ff34e062fa62c06f7fa6b1fed9c9f95ba64c99d35ceb58553d473bfc9a16b29f0b3f8ff56688822be9cf90a862d9b0d9633c3a1ef7f657186829693a4c84b
+  metadata.gz: 61072c05e3aa82903b699e2062dc0a2944f7fcec20545709d2b83f1f0a760778adffbc7cf7002815c56c2ba6f9484de13f35134c484842ebbf56785d549a6883
+  data.tar.gz: 5c95dd8df5ead5050d2b24175e01b6ad197d7f430f92554f2330cb3b0976360ab4182d956e62ae734ce38b77985eb84f6c0e7e95a0d147d18f061e0964ee61e6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.8.5
+
+- Added support for Elasticsearch 1.4
+- Added `unsearchable` option
+- Added `select: true` option
+- Added `body` option
+
 ## 0.8.4
 
 - Added `boost_by_distance`

data/README.md

@@ -774,6 +774,8 @@ See [Production Rails](https://github.com/ankane/production_rails) for other goo
 
 Prefer to use the [Elasticsearch DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) but still want awesome features like zero-downtime reindexing?
 
+### Advanced Mapping
+
 Create a custom mapping:
 
 ```ruby
@@ -788,32 +790,35 @@ class Product < ActiveRecord::Base
 end
 ```
 
-And use the `query` option to search:
+To keep the mappings and settings generated by Searchkick, use:
 
 ```ruby
-products = Product.search query: {match: {name: "milk"}}
+class Product < ActiveRecord::Base
+  searchkick merge_mappings: true, mappings: {...}
+end
 ```
 
-View the response with:
+### Advanced Search
+
+And use the `body` option to search:
 
 ```ruby
-products.response
+products = Product.search body: {match: {name: "milk"}}
 ```
 
-To keep the mappings and settings generated by Searchkick, use:
+View the response with:
 
 ```ruby
-class Product < ActiveRecord::Base
-  searchkick merge_mappings: true, mappings: {...}
-end
+products.response
 ```
 
 To modify the query generated by Searchkick, use:
 
 ```ruby
-query = Product.search "2% Milk", execute: false
-query.body[:query] = {match_all: {}}
-products = query.execute
+products =
+  Product.search "2% Milk" do |body|
+    body[:query] = {match_all: {}}
+  end
 ```
 
 ## Reference
@@ -897,6 +902,14 @@ class Product < ActiveRecord::Base
 end
 ```
 
+Make fields unsearchable but include in the source
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick unsearchable: [:color]
+end
+```
+
 Reindex asynchronously
 
 ```ruby

data/lib/searchkick/model.rb

@@ -20,8 +20,11 @@ module Searchkick
           Searchkick::Index.new(index)
         end
 
-        define_singleton_method(Searchkick.search_method_name) do |term = nil, options={}|
+        define_singleton_method(Searchkick.search_method_name) do |term = nil, options={}, &block|
           query = Searchkick::Query.new(self, term, options)
+          if block
+            block.call(query.body)
+          end
           if options[:execute] == false
             query
           else

data/lib/searchkick/query.rb

@@ -16,6 +16,7 @@ module Searchkick
       @options = options
 
       below12 = Gem::Version.new(Searchkick.server_version) < Gem::Version.new("1.2")
+      below14 = Gem::Version.new(Searchkick.server_version) < Gem::Version.new("1.4")
 
       boost_fields = {}
       fields =
@@ -56,6 +57,7 @@ module Searchkick
       all = term == "*"
       facet_limits = {}
 
+      options[:json] ||= options[:body]
       if options[:json]
         payload = options[:json]
       else
@@ -279,7 +281,7 @@ module Searchkick
               payload[:facets][field] = {
                 terms_stats: {
                   key_field: field,
-                  value_script: "doc.score",
+                  value_script: below14 ? "doc.score" : "_score",
                   size: size
                 }
               }
@@ -355,10 +357,10 @@ 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/
-        if load
+        if options[:select]
+          payload[:fields] = options[:select] if options[:select] != true
+        elsif load
           payload[:fields] = []
-        elsif options[:select]
-          payload[:fields] = options[:select]
         end
 
         if options[:type] or klass != searchkick_klass

data/lib/searchkick/reindex.rb

@@ -40,7 +40,7 @@ module Searchkick
     # remove old indices that start w/ index_name
     def clean_indices
       all_indices = Searchkick.client.indices.get_aliases
-      indices = all_indices.select{|k, v| v["aliases"].empty? && k =~ /\A#{Regexp.escape(searchkick_index.name)}_\d{14,17}\z/ }.keys
+      indices = all_indices.select{|k, v| (v.empty? || v["aliases"].empty?) && k =~ /\A#{Regexp.escape(searchkick_index.name)}_\d{14,17}\z/ }.keys
       indices.each do |index|
         Searchkick::Index.new(index).delete
       end
@@ -288,12 +288,19 @@ module Searchkick
           mapping[field] = field_mapping
         end
 
-        (options[:locations] || []).each do |field|
+        (options[:locations] || []).map(&:to_s).each do |field|
           mapping[field] = {
             type: "geo_point"
           }
         end
 
+        (options[:unsearchable] || []).map(&:to_s).each do |field|
+          mapping[field] = {
+            type: "string",
+            index: "no"
+          }
+        end
+
         mappings = {
           _default_: {
             properties: mapping,

data/lib/searchkick/results.rb

@@ -127,8 +127,6 @@ module Searchkick
       next_page.nil?
     end
 
-    protected
-
     def hits
       @response["hits"]["hits"]
     end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.8.4"
+  VERSION = "0.8.5"
 end

data/test/index_test.rb

@@ -41,6 +41,21 @@ class TestIndex < Minitest::Test
     assert_equal ["Dollar Tree"], Store.search(json: {query: {match: {name: "Dollar Tree"}}}, load: false).map(&:name)
   end
 
+  def test_body
+    store_names ["Dollar Tree"], Store
+    assert_equal [], Store.search(query: {match: {name: "dollar"}}).map(&:name)
+    assert_equal ["Dollar Tree"], Store.search(body: {query: {match: {name: "Dollar Tree"}}}, load: false).map(&:name)
+  end
+
+  def test_block
+    store_names ["Dollar Tree"]
+    products =
+      Product.search "boom" do |body|
+        body[:query] = {match_all: {}}
+      end
+    assert_equal ["Dollar Tree"], products.map(&:name)
+  end
+
   def test_tokens
     assert_equal ["dollar", "dollartre", "tree"], Product.searchkick_index.tokens("Dollar Tree")
   end

data/test/match_test.rb

@@ -153,4 +153,11 @@ class TestMatch < Minitest::Test
     assert_search "to be", ["to be or not to be"]
   end
 
+  def test_unsearchable
+    store [
+      {name: "Unsearchable", description: "Almond"}
+    ]
+    assert_search "almond", []
+  end
+
 end

data/test/sql_test.rb

@@ -298,6 +298,13 @@ class TestSql < Minitest::Test
     assert_equal [1, 2], result.user_ids
   end
 
+  def test_select_all
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select: true).hits.first
+    assert_equal hit["_source"]["name"], "Product A"
+    assert_equal hit["_source"]["user_ids"], [1, 2]
+  end
+
   def test_nested_object
     aisle = {"id" => 1, "name" => "Frozen"}
     store [{name: "Product A", aisle: aisle}]

data/test/test_helper.rb

@@ -53,6 +53,7 @@ if defined?(Mongoid)
     field :color
     field :latitude, type: BigDecimal
     field :longitude, type: BigDecimal
+    field :description
   end
 
   class Store
@@ -95,6 +96,7 @@ else
     t.string :color
     t.decimal :latitude, precision: 10, scale: 7
     t.decimal :longitude, precision: 10, scale: 7
+    t.text :description
     t.timestamps
   end
 
@@ -146,7 +148,8 @@ class Product
     word_start: [:name],
     word_middle: [:name],
     word_end: [:name],
-    highlight: [:name]
+    highlight: [:name],
+    unsearchable: [:description]
 
   attr_accessor :conversions, :user_ids, :aisle
 

metadata

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