searchkick 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85108ff6dc90bd7075f66c5627fc06eba581657f
-  data.tar.gz: 062420bd6cd4c9601026425d40923cc82e649364
+  metadata.gz: e592f63efa26867238f106cdede925736897c39e
+  data.tar.gz: b873c66a18f69cffcd9227fe92a1cf314e602090
 SHA512:
-  metadata.gz: 680ef536ba5e15456b0df70412eec5e47d13f43424c02e7d039921abf3c83b06fbaefa95d824fa2ae0efeecde8c6488ad56b4aabed442eb6c191a309f2204c6c
-  data.tar.gz: d118d331ffd37c1fbec228bba2cc043f03730510a0ca45d7bd9afe9c04aa31a8ebeeaba82b57113c070fd7af3b1c8c347f0b22bd8cff43565f9246ed408a0c77
+  metadata.gz: 74566048b5471575f1c7f2e269a6fa23fa62dbbd717696a077a26875f43883be128cbbb731578634ec948c51a5e9d336ed3595ea631717ac3056f784c813f19c
+  data.tar.gz: 5c1a40b9633f70201a13e003a1852d5a3cfcf0d16d23024cea19ddce523b2f32e5675119e5899b1b4c3e7f057466cd09a80a788a655933923a78172b5b95ebb0

data/.travis.yml

@@ -19,7 +19,7 @@ gemfile:
   - test/gemfiles/mongoid5.gemfile
   - test/gemfiles/mongoid6.gemfile
 env:
-  - ELASTICSEARCH_VERSION=5.2.0
+  - ELASTICSEARCH_VERSION=5.3.0
 jdk: oraclejdk8
 matrix:
   include:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.2.1
+
+- Added `avg`, `cardinality`, `max`, `min`, and `sum` aggregations
+- Added `load: {dumpable: true}` option
+- Added `index_suffix` option
+- Accept string for `exclude` option
+
 ## 2.2.0
 
 - Fixed bug with text values longer than 256 characters and `_all` field - see [#850](https://github.com/ankane/searchkick/issues/850)

data/README.md

@@ -294,13 +294,17 @@ end
 ```ruby
 class Product < ActiveRecord::Base
   searchkick synonyms: [["scallion", "green onion"], ["qtip", "cotton swab"]]
-  # or
-  # searchkick synonyms: -> { CSV.read("/some/path/synonyms.csv") }
 end
 ```
 
 Call `Product.reindex` after changing synonyms.
 
+To read synonyms from a file, use:
+
+```ruby
+synonyms: -> { CSV.read("/some/path/synonyms.csv") }
+```
+
 For directional synonyms, use:
 
 ```ruby
@@ -388,7 +392,7 @@ You can map queries and terms to exclude with:
 ```ruby
 exclude_queries = {
   "butter" => ["peanut butter"],
-  "cream" => ["ice cream"]
+  "cream" => ["ice cream", "whipped cream"]
 }
 
 Product.search query, exclude: exclude_queries[query]
@@ -1766,6 +1770,14 @@ product = FactoryGirl.create(:product)
 product.reindex(refresh: true)
 ```
 
+### Parallel Tests
+
+Set:
+
+```ruby
+Searchkick.index_suffix = ENV["TEST_ENV_NUMBER"]
+```
+
 ## Multi-Tenancy
 
 Check out [this great post](https://www.tiagoamaro.com.br/2014/12/11/multi-tenancy-with-searchkick/) on the [Apartment](https://github.com/influitive/apartment) gem. Follow a similar pattern if you use another gem.

data/Rakefile

@@ -1,6 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+begin
+  require "parallel_tests/tasks"
+  require "shellwords"
+rescue LoadError
+  # do nothing
+end
+
 task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"

data/lib/searchkick.rb

@@ -36,7 +36,7 @@ module Searchkick
   class ImportError < Error; end
 
   class << self
-    attr_accessor :search_method_name, :wordnet_path, :timeout, :models, :client_options, :redis
+    attr_accessor :search_method_name, :wordnet_path, :timeout, :models, :client_options, :redis, :index_suffix
     attr_writer :client, :env, :search_timeout
     attr_reader :aws_credentials
   end

data/lib/searchkick/model.rb

@@ -21,8 +21,8 @@ module Searchkick
         class_variable_set :@@searchkick_klass, self
         class_variable_set :@@searchkick_callbacks, callbacks
         class_variable_set :@@searchkick_index, options[:index_name] ||
-          (options[:index_prefix].respond_to?(:call) && proc { [options[:index_prefix].call, model_name.plural, Searchkick.env].compact.join("_") }) ||
-          [options[:index_prefix], model_name.plural, Searchkick.env].compact.join("_")
+          (options[:index_prefix].respond_to?(:call) && proc { [options[:index_prefix].call, model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_") }) ||
+          [options[:index_prefix], model_name.plural, Searchkick.env, Searchkick.index_suffix].compact.join("_")
 
         class << self
           def searchkick_search(term = "*", **options, &block)

data/lib/searchkick/query.rb

@@ -2,6 +2,8 @@ module Searchkick
   class Query
     extend Forwardable
 
+    @@metric_aggs = [:avg, :cardinality, :max, :min, :sum]
+
     attr_reader :klass, :term, :options
     attr_accessor :body
 
@@ -328,7 +330,7 @@ module Searchkick
 
             if options[:exclude]
               must_not =
-                options[:exclude].map do |phrase|
+                Array(options[:exclude]).map do |phrase|
                   {
                     match_phrase: {
                       exclude_field => {
@@ -643,6 +645,12 @@ module Searchkick
               interval: interval
             }
           }
+        elsif metric = @@metric_aggs.find { |k| agg_options.has_key?(k) }
+          payload[:aggs][field] = {
+            metric => {
+              field: agg_options[metric][:field] || field
+            }
+          }
         else
           payload[:aggs][field] = {
             terms: {

data/lib/searchkick/results.rb

@@ -33,7 +33,7 @@ module Searchkick
           # sort
           hits.map do |hit|
             result = results[hit["_type"]][hit["_id"].to_s]
-            if result
+            if result && !(options[:load].is_a?(Hash) && options[:load][:dumpable])
               unless result.respond_to?(:search_hit)
                 result.define_singleton_method(:search_hit) do
                   hit

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/test/aggs_test.rb

@@ -116,6 +116,68 @@ class AggsTest < Minitest::Test
     assert_equal 4, products.aggs["products_per_year"]["buckets"].size
   end
 
+  def test_aggs_avg
+    products =
+      Product.search("*", {
+        aggs: {
+          avg_price: {
+            avg: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 16.5, products.aggs["avg_price"]["value"]
+  end
+
+  def test_aggs_cardinality
+    products =
+      Product.search("*", {
+        aggs: {
+          total_stores: {
+            cardinality: {
+              field: :store_id
+            }
+          }
+        }
+      })
+    assert_equal 3, products.aggs["total_stores"]["value"]
+  end
+
+  def test_aggs_min_max
+    products =
+      Product.search("*", {
+        aggs: {
+          min_price: {
+            min: {
+              field: :price
+            }
+          },
+          max_price: {
+            max: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 5, products.aggs["min_price"]["value"]
+    assert_equal 25, products.aggs["max_price"]["value"]
+  end
+
+  def test_aggs_sum
+    products =
+      Product.search("*", {
+        aggs: {
+          sum_price: {
+            sum: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 66, products.aggs["sum_price"]["value"]
+  end
+
   protected
 
   def buckets_as_hash(agg)

data/test/gemfiles/parallel_tests.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../../"
+
+gem "sqlite3"
+gem "activerecord", "~> 5.0.0"
+gem "parallel_tests"

data/test/index_test.rb

@@ -7,8 +7,9 @@ class IndexTest < Minitest::Test
   end
 
   def test_clean_indices
-    old_index = Searchkick::Index.new("products_test_20130801000000000")
-    different_index = Searchkick::Index.new("items_test_20130801000000000")
+    suffix = Searchkick.index_suffix ? "_#{Searchkick.index_suffix}" : ""
+    old_index = Searchkick::Index.new("products_test#{suffix}_20130801000000000")
+    different_index = Searchkick::Index.new("items_test#{suffix}_20130801000000000")
 
     old_index.delete if old_index.exists?
     different_index.delete if different_index.exists?
@@ -25,7 +26,8 @@ class IndexTest < Minitest::Test
   end
 
   def test_clean_indices_old_format
-    old_index = Searchkick::Index.new("products_test_20130801000000")
+    suffix = Searchkick.index_suffix ? "_#{Searchkick.index_suffix}" : ""
+    old_index = Searchkick::Index.new("products_test#{suffix}_20130801000000")
     old_index.create
 
     Product.searchkick_index.clean_indices

data/test/marshal_test.rb

@@ -0,0 +1,8 @@
+require_relative "test_helper"
+
+class MarshalTest < Minitest::Test
+  def test_marshal
+    store_names ["Product A"]
+    assert Marshal.dump(Product.search("*", load: {dumpable: true}).results)
+  end
+end

data/test/match_test.rb

@@ -186,6 +186,11 @@ class MatchTest < Minitest::Test
     assert_search "egg", ["eggs"], exclude: ["eggplant"], match: :word_start
   end
 
+  def test_exclude_string
+    store_names ["Butter Tub", "Peanut Butter Tub"]
+    assert_search "butter", ["Butter Tub"], exclude: "peanut butter"
+  end
+
   # other
 
   def test_all

data/test/sql_test.rb

@@ -7,6 +7,11 @@ class SqlTest < Minitest::Test
     assert_search "fresh honey", ["Honey"], operator: "or"
   end
 
+  def test_operator_scoring
+    store_names ["Big Red Circle", "Big Green Circle", "Small Orange Circle"]
+    assert_order "big red circle", ["Big Red Circle", "Big Green Circle", "Small Orange Circle"], operator: "or"
+  end
+
   def test_fields_operator
     store [
       {name: "red", color: "red"},

data/test/test_helper.rb

@@ -6,11 +6,16 @@ require "logger"
 require "active_support/core_ext" if defined?(NoBrainer)
 require "active_support/notifications"
 
+Searchkick.index_suffix = ENV["TEST_ENV_NUMBER"]
+
 ENV["RACK_ENV"] = "test"
 
 Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
 
-File.delete("elasticsearch.log") if File.exist?("elasticsearch.log")
+if !defined?(ParallelTests) || ParallelTests.first_process?
+  File.delete("elasticsearch.log") if File.exist?("elasticsearch.log")
+end
+
 Searchkick.client.transport.logger = Logger.new("elasticsearch.log")
 Searchkick.search_timeout = 5
 
@@ -466,7 +471,7 @@ class Animal
   searchkick \
     text_start: [:name],
     suggest: [:name],
-    index_name: -> { "#{name.tableize}-#{Date.today.year}" },
+    index_name: -> { "#{name.tableize}-#{Date.today.year}#{Searchkick.index_suffix}" },
     callbacks: defined?(ActiveJob) ? :async : true
     # wordnet: true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -147,10 +147,12 @@ files:
 - test/gemfiles/mongoid5.gemfile
 - test/gemfiles/mongoid6.gemfile
 - test/gemfiles/nobrainer.gemfile
+- test/gemfiles/parallel_tests.gemfile
 - test/geo_shape_test.rb
 - test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb
+- test/marshal_test.rb
 - test/match_test.rb
 - test/misspellings_test.rb
 - test/model_test.rb
@@ -220,10 +222,12 @@ test_files:
 - test/gemfiles/mongoid5.gemfile
 - test/gemfiles/mongoid6.gemfile
 - test/gemfiles/nobrainer.gemfile
+- test/gemfiles/parallel_tests.gemfile
 - test/geo_shape_test.rb
 - test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb
+- test/marshal_test.rb
 - test/match_test.rb
 - test/misspellings_test.rb
 - test/model_test.rb