Merge branch 'master' into agg_docs

Andrew Kane
2 parents a39cc393 b5763d73
Showing 28 changed files with 47 additions and 109 deletions Show diff stats
lib/searchkick/index.rb
lib/searchkick/logging.rb
lib/searchkick/model.rb
lib/searchkick/query.rb
lib/searchkick/reindex_job.rb
lib/searchkick/reindex_v2_job.rb
lib/searchkick/results.rb
lib/searchkick/tasks.rb
test/aggs_test.rb
test/autocomplete_test.rb
test/boost_test.rb
test/facets_test.rb
test/highlight_test.rb
test/index_test.rb
test/inheritance_test.rb
test/match_test.rb
test/model_test.rb
test/query_test.rb
test/records_test.rb
test/reindex_job_test.rb
@@ -100,7 +100,7 @@ module Searchkick
     def similar_record(record, options = {})
       like_text = retrieve(record).to_hash
-        .keep_if { |k, v| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
+        .keep_if { |k, _| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
         .values.compact.join(" ")
       # TODO deep merge method
@@ -118,9 +118,7 @@ module Searchkick
     def search_model(searchkick_klass, term = nil, options = {}, &block)
       query = Searchkick::Query.new(searchkick_klass, term, options)
-      if block
-        block.call(query.body)
-      end
+      block.call(query.body) if block
       if options[:execute] == false
         query
       else
@@ -350,9 +348,7 @@ module Searchkick
         # synonyms
         synonyms = options[:synonyms] || []
-        if synonyms.respond_to?(:call)
-          synonyms = synonyms.call
-        end
+        synonyms = synonyms.call if synonyms.respond_to?(:call)
         if synonyms.any?
           settings[:analysis][:filter][:searchkick_synonym] = {
@@ -384,7 +380,7 @@ module Searchkick
         end
         if options[:special_characters] == false
-          settings[:analysis][:analyzer].each do |analyzer, analyzer_settings|
+          settings[:analysis][:analyzer].each do |_, analyzer_settings|
             analyzer_settings[:filter].reject! { |f| f == "asciifolding" }
           end
         end
@@ -566,6 +562,5 @@ module Searchkick
         obj
       end
     end
-
   end
 end
@@ -62,7 +62,8 @@ module Searchkick
     end
     def self.reset_runtime
-      rt, self.runtime = runtime, 0
+      rt = runtime
+      self.runtime = 0
       rt
     end
@@ -122,7 +123,8 @@ module Searchkick
     module ClassMethods
       def log_process_action(payload)
-        messages, runtime = super, payload[:searchkick_runtime]
+        messages = super
+        runtime = payload[:searchkick_runtime]
         messages << ("Searchkick: %.1fms" % runtime.to_f) if runtime.to_f > 0
         messages
       end
@@ -2,7 +2,6 @@ module Searchkick
   module Reindex; end # legacy for Searchjoy
   module Model
-
     def searchkick(options = {})
       raise "Only call searchkick once per model" if respond_to?(:searchkick_index)
@@ -94,9 +93,7 @@ module Searchkick
         def should_index?
           true
         end unless method_defined?(:should_index?)
-
       end
     end
-
   end
 end
@@ -190,11 +190,9 @@ module Searchkick
         if boost_by.is_a?(Array)
           boost_by = Hash[boost_by.map { |f| [f, {factor: 1}] }]
         elsif boost_by.is_a?(Hash)
-          multiply_by, boost_by = boost_by.partition { |k,v| v[:boost_mode] == "multiply" }.map{ |i| Hash[i] }
-        end
-        if options[:boost]
-          boost_by[options[:boost]] = {factor: 1}
+          multiply_by, boost_by = boost_by.partition { |_, v| v[:boost_mode] == "multiply" }.map { |i| Hash[i] }
         end
+        boost_by[options[:boost]] = {factor: 1} if options[:boost]
         custom_filters.concat boost_filters(boost_by, log: true)
         multiply_filters.concat boost_filters(multiply_by || {})
@@ -209,12 +207,10 @@ module Searchkick
         boost_where.each do |field, value|
           if value.is_a?(Array) && value.first.is_a?(Hash)
             value.each do |value_factor|
-              value, factor = value_factor[:value], value_factor[:factor]
-              custom_filters << custom_filter(field, value, factor)
+              custom_filters << custom_filter(field, value_factor[:value], value_factor[:factor])
             end
           elsif value.is_a?(Hash)
-            value, factor = value[:value], value[:factor]
-            custom_filters << custom_filter(field, value, factor)
+            custom_filters << custom_filter(field, value[:value], value[:factor])
           else
             factor = 1000
             custom_filters << custom_filter(field, value, factor)
@@ -227,7 +223,7 @@ module Searchkick
           if !boost_by_distance[:field] || !boost_by_distance[:origin]
             raise ArgumentError, "boost_by_distance requires :field and :origin"
           end
-          function_params = boost_by_distance.select { |k, v| [:origin, :scale, :offset, :decay].include?(k) }
+          function_params = boost_by_distance.select { |k, _| [:origin, :scale, :offset, :decay].include?(k) }
           function_params[:origin] = function_params[:origin].reverse
           custom_filters << {
             boost_by_distance[:function] => {
@@ -293,9 +289,7 @@ module Searchkick
         # facets
         if options[:facets]
           facets = options[:facets] || {}
-          if facets.is_a?(Array) # convert to more advanced syntax
-            facets = Hash[facets.map { |f| [f, {}] }]
-          end
+          facets = Hash[facets.map { |f| [f, {}] }] if facets.is_a?(Array) # convert to more advanced syntax
           payload[:facets] = {}
           facets.each do |field, facet_options|
@@ -331,7 +325,7 @@ module Searchkick
             # offset is not possible
             # http://elasticsearch-users.115913.n3.nabble.com/Is-pagination-possible-in-termsStatsFacet-td3422943.html
-            facet_options.deep_merge!(where: options.fetch(:where, {}).reject { |k| k == field } ) if options[:smart_facets] == true
+            facet_options.deep_merge!(where: options.fetch(:where, {}).reject { |k| k == field }) if options[:smart_facets] == true
             facet_filters = where_filters(facet_options[:where])
             if facet_filters.any?
               payload[:facets][field][:facet_filter] = {
@@ -348,9 +342,7 @@ module Searchkick
           aggs = options[:aggs]
           payload[:aggs] = {}
-          if aggs.is_a?(Array) # convert to more advanced syntax
-            aggs = aggs.map { |f| [f, {}] }.to_h
-          end
+          aggs = aggs.map { |f| [f, {}] }.to_h if aggs.is_a?(Array) # convert to more advanced syntax
           aggs.each do |field, agg_options|
             size = agg_options[:limit] ? agg_options[:limit] : 100_000
@@ -441,9 +433,7 @@ module Searchkick
         end
         # routing
-        if options[:routing]
-          @routing = options[:routing]
-        end
+        @routing = options[:routing] if options[:routing]
       end
       @body = payload
@@ -539,9 +529,7 @@ module Searchkick
             value = {gte: value.first, (value.exclude_end? ? :lt : :lte) => value.last}
           end
-          if value.is_a?(Array)
-            value = {in: value}
-          end
+          value = {in: value} if value.is_a?(Array)
           if value.is_a?(Hash)
             value.each do |op, op_value|
@@ -623,7 +611,7 @@ module Searchkick
     def custom_filter(field, value, factor)
       {
         filter: {
-          and: where_filters({field => value})
+          and: where_filters(field => value)
         },
         boost_factor: factor
       }
 module Searchkick
   class ReindexJob
-
     def initialize(klass, id)
       @klass = klass
       @id = id
@@ -23,6 +22,5 @@ module Searchkick
         index.store record
       end
     end
-
   end
 end
@@ -19,6 +19,5 @@ module Searchkick
         index.store record
       end
     end
-
   end
 end
@@ -26,7 +26,7 @@ module Searchkick
           # results can have different types
           results = {}
-          hits.group_by { |hit, i| hit["_type"] }.each do |type, grouped_hits|
+          hits.group_by { |hit, _| hit["_type"] }.each do |type, grouped_hits|
             results[type] = results_query(type.camelize.constantize, grouped_hits).to_a.index_by { |r| r.id.to_s }
           end
 require "rake"
 namespace :searchkick do
-
   desc "reindex model"
   task reindex: :environment do
     if ENV["CLASS"]
@@ -31,5 +30,4 @@ namespace :searchkick do
     end
   end
-
 end
 require_relative "test_helper"
-class TestAggs < Minitest::Test
-
+class AggsTest < Minitest::Test
   def setup
     super
     store [
@@ -79,5 +78,4 @@ class TestAggs &lt; Minitest::Test
       [field, buckets_as_hash(filtered_agg)]
     end.to_h
   end
-
 end
 require_relative "test_helper"
-class TestAutocomplete < Minitest::Test
-
+class AutocompleteTest < Minitest::Test
   def test_autocomplete
     store_names ["Hummus"]
     assert_search "hum", ["Hummus"], autocomplete: true
@@ -63,5 +62,4 @@ class TestAutocomplete &lt; Minitest::Test
     store_names ["hi@example.org"]
     assert_search "hi@example.org", ["hi@example.org"], fields: [{name: :exact}]
   end
-
 end
 require_relative "test_helper"
-class TestBoost < Minitest::Test
-
+class BoostTest < Minitest::Test
   # conversions
   def test_conversions
@@ -133,5 +132,4 @@ class TestBoost &lt; Minitest::Test
     ]
     assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: [37, -122], scale: "1000mi"}
   end
-
 end
 require_relative "test_helper"
-class TestFacets < Minitest::Test
-
+class FacetsTest < Minitest::Test
   def setup
     skip if elasticsearch2?
     super
@@ -79,14 +78,13 @@ class TestFacets &lt; Minitest::Test
     skip if Gem::Version.new(Searchkick.server_version) >= Gem::Version.new("1.4.0")
     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]
+    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, facet_key="store_id")
+  def store_facet(options, facet_key = "store_id")
     Hash[Product.search("Product", options).facets[facet_key]["terms"].map { |v| [v["term"], v["count"]] }]
   end
-
 end
 require_relative "test_helper"
-class TestHighlight < Minitest::Test
-
+class HighlightTest < Minitest::Test
   def test_basic
     store_names ["Two Door Cinema Club"]
     assert_equal "Two Door <em>Cinema</em> Club", Product.search("cinema", fields: [:name], highlight: true).with_details.first[1][:highlight][:name]
@@ -54,5 +53,4 @@ class TestHighlight &lt; Minitest::Test
     }
     assert_equal "Two Door <strong>Cinema</strong> Club", Product.search(json: json).with_details.first[1][:highlight][:"name.analyzed"]
   end
-
 end
 require_relative "test_helper"
-class TestIndex < Minitest::Test
-
+class IndexTest < Minitest::Test
   def test_clean_indices
     old_index = Searchkick::Index.new("products_test_20130801000000000")
     different_index = Searchkick::Index.new("items_test_20130801000000000")
@@ -93,7 +92,7 @@ class TestIndex &lt; Minitest::Test
   end
   def test_unsupported_version
-    raises_exception = ->(s) { raise Elasticsearch::Transport::Transport::Error.new("[500] No query registered for [multi_match]") }
+    raises_exception = ->(_) { raise Elasticsearch::Transport::Transport::Error.new("[500] No query registered for [multi_match]") }
     Searchkick.client.stub :search, raises_exception do
       assert_raises(Searchkick::UnsupportedVersionError) { Product.search("test") }
     end
@@ -115,5 +114,4 @@ class TestIndex &lt; Minitest::Test
     end
   end
-
 end
 require_relative "test_helper"
-class TestInheritance < Minitest::Test
-
+class InheritanceTest < Minitest::Test
   def test_child_reindex
     store_names ["Max"], Cat
     assert Dog.reindex
@@ -76,5 +75,4 @@ class TestInheritance &lt; Minitest::Test
     store_names ["Product B"], Animal
     assert_search "product", ["Product A", "Product B"], index_name: [Product.searchkick_index.name, Animal.searchkick_index.name], conversions: false
   end
-
 end
@@ -2,8 +2,7 @@
 require_relative "test_helper"
-class TestMatch < Minitest::Test
-
+class MatchTest < Minitest::Test
   # exact
   def test_match
@@ -195,5 +194,4 @@ class TestMatch &lt; Minitest::Test
     ]
     assert_search "almond", []
   end
-
 end
 require_relative "test_helper"
-class TestModel < Minitest::Test
-
+class ModelTest < Minitest::Test
   def test_disable_callbacks_model
     store_names ["product a"]
@@ -20,7 +19,7 @@ class TestModel &lt; Minitest::Test
   def test_disable_callbacks_global
     # make sure callbacks default to on
     assert Searchkick.callbacks?
-    
+
     store_names ["product a"]
     Searchkick.disable_callbacks
@@ -34,5 +33,4 @@ class TestModel &lt; Minitest::Test
     assert_search "product", ["product a", "product b"]
   end
-
 end
 require_relative "test_helper"
-class TestQuery < Minitest::Test
-
+class QueryTest < Minitest::Test
   def test_basic
     store_names ["Milk", "Apple"]
     query = Product.search("milk", execute: false)
@@ -10,5 +9,4 @@ class TestQuery &lt; Minitest::Test
     query.body[:query] = {match_all: {}}
     assert_equal ["Apple", "Milk"], query.execute.map(&:name).sort
   end
-
 end
 require_relative "test_helper"
 class RecordsTest < Minitest::Test
-
   def test_records
     store_names ["Milk", "Apple"]
     assert_equal Product.search("milk").records.where(name: "Milk").count, 1
   end
-
 end
 require_relative "test_helper"
-class TestReindexJob < Minitest::Test
-
+class ReindexJobTest < Minitest::Test
   def setup
     super
     Searchkick.disable_callbacks
@@ -29,5 +28,4 @@ class TestReindexJob &lt; Minitest::Test
     Product.searchkick_index.refresh
     assert_search "*", []
   end
-
 end
 require_relative "test_helper"
-class TestReindexV2Job < Minitest::Test
-
+class ReindexV2JobTest < Minitest::Test
   def setup
     skip unless defined?(ActiveJob)
     super
@@ -30,5 +29,4 @@ class TestReindexV2Job &lt; Minitest::Test
     Product.searchkick_index.refresh
     assert_search "*", []
   end
-
 end
 require_relative "test_helper"
-class TestRouting < Minitest::Test
-
+class RoutingTest < Minitest::Test
   def test_routing_query
     skip if elasticsearch2?
     query = Store.search("Dollar Tree", routing: "Dollar Tree", execute: false)
@@ -11,6 +10,6 @@ class TestRouting &lt; Minitest::Test
   def test_routing_mappings
     skip if elasticsearch2?
     index_options = Store.searchkick_index.index_options
-    assert_equal index_options[:mappings][:_default_][:_routing], {required: true, path: "name"}
+    assert_equal index_options[:mappings][:_default_][:_routing], required: true, path: "name"
   end
 end
 require_relative "test_helper"
-class TestShouldIndex < Minitest::Test
-
+class ShouldIndexTest < Minitest::Test
   def test_basic
     store_names ["INDEX", "DO NOT INDEX"]
     assert_search "index", ["INDEX"]
@@ -30,5 +29,4 @@ class TestShouldIndex &lt; Minitest::Test
     Product.searchkick_index.refresh
     assert_search "index", []
   end
-
 end
 require_relative "test_helper"
-class TestSimilar < Minitest::Test
-
+class SimilarTest < Minitest::Test
   def test_similar
     store_names ["Annie's Naturals Organic Shiitake & Sesame Dressing"]
     assert_search "Annie's Naturals Shiitake & Sesame Vinaigrette", ["Annie's Naturals Organic Shiitake & Sesame Dressing"], similar: true
@@ -16,5 +15,4 @@ class TestSimilar &lt; Minitest::Test
     store_names ["Lucerne Milk Chocolate Fat Free", "Clover Fat Free Milk"]
     assert_order "Lucerne Fat Free Chocolate Milk", ["Lucerne Milk Chocolate Fat Free", "Clover Fat Free Milk"], similar: true
   end
-
 end
 require_relative "test_helper"
-class TestSql < Minitest::Test
-
+class SqlTest < Minitest::Test
   def test_limit
     store_names ["Product A", "Product B", "Product C", "Product D"]
     assert_order "product", ["Product A", "Product B"], order: {name: :asc}, limit: 2
@@ -333,7 +332,7 @@ class TestSql &lt; Minitest::Test
   def test_select
     store [{name: "Product A", store_id: 1}]
     result = Product.search("product", load: false, select: [:name, :store_id]).first
-    assert_equal %w[id name store_id], result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal %w(id name store_id), result.keys.reject { |k| k.start_with?("_") }.sort
     assert_equal ["Product A"], result.name # this is not great
   end
@@ -363,5 +362,4 @@ class TestSql &lt; Minitest::Test
       assert Product.search("product", include: [:store]).first.association(:store).loaded?
     end
   end
-
 end
 require_relative "test_helper"
-class TestSuggest < Minitest::Test
-
+class SuggestTest < Minitest::Test
   def test_basic
     store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
     assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [:name]
@@ -78,5 +77,4 @@ class TestSuggest &lt; Minitest::Test
   def assert_suggest_all(term, expected, options = {})
     assert_equal expected.sort, Product.search(term, options.merge(suggest: true)).suggestions.sort
   end
-
 end
 require_relative "test_helper"
-class TestSynonyms < Minitest::Test
-
+class SynonymsTest < Minitest::Test
   def test_bleach
     store_names ["Clorox Bleach", "Kroger Bleach"]
     assert_search "clorox", ["Clorox Bleach", "Kroger Bleach"]
@@ -46,5 +45,4 @@ class TestSynonyms &lt; Minitest::Test
   #   store_names ["Creature", "Beast", "Dragon"], Animal
   #   assert_search "animal", ["Creature", "Beast"], {}, Animal
   # end
-
 end
@@ -101,7 +101,7 @@ elsif defined?(NoBrainer)
     field :color,        type: String
     field :latitude
     field :longitude
-    field :description,  type: String
+    field :description, type: String
     belongs_to :store, validates: false
   end
@@ -230,10 +230,10 @@ class Store
     mappings: {
       store: {
         properties: {
-          name: {type: "string", analyzer: "keyword"},
+          name: {type: "string", analyzer: "keyword"}
         }
       }
-  }
+    }
 end
 class Animal
@@ -252,7 +252,6 @@ Store.reindex
 Animal.reindex
 class Minitest::Test
-
   def setup
     Product.destroy_all
     Store.destroy_all
@@ -284,5 +283,4 @@ class Minitest::Test
   def assert_first(term, expected, options = {}, klass = Product)
     assert_equal expected, klass.search(term, options).map(&:name).first
   end
-
 end
	@@ -19,6 +19,5 @@ module Searchkick		@@ -19,6 +19,5 @@ module Searchkick
19	index.store record	19	index.store record
20	end	20	end
21	end	21	end
22	-
23	end	22	end
24	end	23	end
	@@ -26,7 +26,7 @@ module Searchkick		@@ -26,7 +26,7 @@ module Searchkick
26	# results can have different types	26	# results can have different types
27	results = {}	27	results = {}
28		28
29	- hits.group_by { \|hit, i\| hit["_type"] }.each do \|type, grouped_hits\|	29	+ hits.group_by { \|hit, _\| hit["_type"] }.each do \|type, grouped_hits\|
30	results[type] = results_query(type.camelize.constantize, grouped_hits).to_a.index_by { \|r\| r.id.to_s }	30	results[type] = results_query(type.camelize.constantize, grouped_hits).to_a.index_by { \|r\| r.id.to_s }
31	end	31	end
32		32