searchkick 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17c7f39c1470d38bc637340ae0031997a0b0134c
-  data.tar.gz: 0167c2d1448536bf5b2b48120f56e992c22aed8e
+  metadata.gz: 01c193778cc86142dca494a2aa0b0ac8c6474d0b
+  data.tar.gz: 7ff77b2f385a8004acaf1dabb4935f90d61c26f8
 SHA512:
-  metadata.gz: a6bf61245813c31fc922a29c5aa4998df13c9c1f51eba6c248ea1bfbba435f048de37a069d23cad6fc041618a235974895cb7466c08ee24cb14eb39296fc908d
-  data.tar.gz: b50909d603658acd1c9562470c2fd1de404cffd2f93a22c1ca926003afaaabcf33ea70a14ba69d96e3b94b50af241b91cbd267492c079416e2b9ae500c6cf32e
+  metadata.gz: cbeefdbb0c40dfb0c32789e7468d3b570c7014fe9b27a202fca7b310820fd3c223264e360456ea68ca5bb13378e3770f448b3237abb9f61385f22d72942b09b0
+  data.tar.gz: 199fb639bcc0d883e87848009e35d2ed0e62e491c5ada17d0eeab3844539513f27c09af46ebb17051f402973dabed86e46e8d6bd08e18b9b3dc43ce3ac2d74e0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.2
+
+- Added `retain` option to `reindex`
+- Added support for attributes in highlight tags
+- Fixed potentially silent errors in reindex job
+- Improved syntax for `boost_by_distance`
+
 ## 2.0.1
 
 - Added `search_hit` and `search_highlights` methods to models

data/Gemfile

@@ -7,3 +7,4 @@ gem "sqlite3"
 gem "activerecord", "~> 5.0.0"
 gem "gemoji-parser"
 gem "typhoeus"
+gem "activejob"

data/README.md

@@ -119,7 +119,7 @@ limit: 20, offset: 40
 Select
 
 ```ruby
-select: ["name"]
+select: [:name]
 ```
 
 ### Results
@@ -497,7 +497,7 @@ end
 
 ### Analytics
 
-We highly recommend tracking searches and conversions.
+The best starting point to improve your search **by far** is to track searches and conversions.
 
 [Searchjoy](https://github.com/ankane/searchjoy) makes it easy.
 
@@ -815,14 +815,14 @@ Find similar items.
 
 ```ruby
 product = Product.first
-product.similar(fields: ["name"], where: {size: "12 oz"})
+product.similar(fields: [:name], where: {size: "12 oz"})
 ```
 
 ### Geospatial Searches
 
 ```ruby
 class City < ActiveRecord::Base
-  searchkick locations: ["location"]
+  searchkick locations: [:location]
 
   def search_data
     attributes.merge location: {lat: latitude, lon: longitude}
@@ -853,13 +853,13 @@ City.search "san", where: {location: {geo_polygon: {points: [{lat: 38, lon: -123
 Boost results by distance - closer results are boosted more
 
 ```ruby
-City.search "san", boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}}
+City.search "san", boost_by_distance: {location: {origin: {lat: 37, lon: -122}}}
 ```
 
 Also supports [additional options](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions)
 
 ```ruby
-City.search "san", boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}, function: :linear, scale: "30mi", decay: 0.5}
+City.search "san", boost_by_distance: {location: {origin: {lat: 37, lon: -122}, function: "linear", scale: "30mi", decay: 0.5}}
 ```
 
 ### Geo Shapes

data/Rakefile

@@ -5,6 +5,7 @@ task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
+  t.warning = false
 end
 
 task :benchmark do

data/lib/searchkick/index.rb

@@ -38,7 +38,7 @@ module Searchkick
       client.indices.get_settings index: name
     end
 
-    def swap(new_name)
+    def promote(new_name)
       old_indices =
         begin
           client.indices.get_alias(name: name).keys
@@ -48,6 +48,7 @@ module Searchkick
       actions = old_indices.map { |old_name| {remove: {index: old_name, alias: name}} } + [{add: {index: new_name, alias: name}}]
       client.indices.update_aliases body: {actions: actions}
     end
+    alias_method :swap, :promote
 
     # record based
 
@@ -186,30 +187,30 @@ module Searchkick
 
     # https://gist.github.com/jarosan/3124884
     # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-    def reindex_scope(scope, import: true, resume: false)
+    def reindex_scope(scope, import: true, resume: false, retain: false)
       if resume
         index_name = all_indices.sort.last
         raise Searchkick::Error, "No index to resume" unless index_name
         index = Searchkick::Index.new(index_name)
       else
-        clean_indices
+        clean_indices unless retain
 
         index = create_index(index_options: scope.searchkick_index_options)
       end
 
       # check if alias exists
       if alias_exists?
-        # import before swap
+        # import before promotion
         index.import_scope(scope, resume: resume) if import
 
         # get existing indices to remove
-        swap(index.name)
-        clean_indices
+        promote(index.name)
+        clean_indices unless retain
       else
         delete if exists?
-        swap(index.name)
+        promote(index.name)
 
-        # import after swap
+        # import after promotion
         index.import_scope(scope, resume: resume) if import
       end
 

data/lib/searchkick/query.rb

@@ -459,17 +459,25 @@ module Searchkick
 
     def set_boost_by_distance(custom_filters)
       boost_by_distance = options[:boost_by_distance] || {}
-      boost_by_distance = {function: :gauss, scale: "5mi"}.merge(boost_by_distance)
-      if !boost_by_distance[:field] || !boost_by_distance[:origin]
-        raise ArgumentError, "boost_by_distance requires :field and :origin"
+
+      # legacy format
+      if boost_by_distance[:field]
+        boost_by_distance = {boost_by_distance[:field] => boost_by_distance.except(:field)}
       end
-      function_params = boost_by_distance.select { |k, _| [:origin, :scale, :offset, :decay].include?(k) }
-      function_params[:origin] = location_value(function_params[:origin])
-      custom_filters << {
-        boost_by_distance[:function] => {
-          boost_by_distance[:field] => function_params
+
+      boost_by_distance.each do |field, attributes|
+        attributes = {function: :gauss, scale: "5mi"}.merge(attributes)
+        unless attributes[:origin]
+          raise ArgumentError, "boost_by_distance requires :origin"
+        end
+        function_params = attributes.select { |k, _| [:origin, :scale, :offset, :decay].include?(k) }
+        function_params[:origin] = location_value(function_params[:origin])
+        custom_filters << {
+          attributes[:function] => {
+            field => function_params
+          }
         }
-      }
+      end
     end
 
     def set_boost_by(multiply_filters, custom_filters)
@@ -542,7 +550,7 @@ module Searchkick
       if options[:highlight].is_a?(Hash)
         if (tag = options[:highlight][:tag])
           payload[:highlight][:pre_tags] = [tag]
-          payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A</, "</")]
+          payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A<(\w+).+/, "</\\1>")]
         end
 
         if (fragment_size = options[:highlight][:fragment_size])
@@ -770,7 +778,9 @@ module Searchkick
       if below50?
         {
           filter: {
-            and: where_filters(field => value)
+            bool: {
+              must: where_filters(field => value)
+            }
           },
           boost_factor: factor
         }

data/lib/searchkick/reindex_v2_job.rb

@@ -1,10 +1,25 @@
 module Searchkick
   class ReindexV2Job < ActiveJob::Base
+    RECORD_NOT_FOUND_CLASSES = [
+      "ActiveRecord::RecordNotFound",
+      "Mongoid::Errors::DocumentNotFound",
+      "NoBrainer::Error::DocumentNotFound"
+    ]
+
     queue_as :searchkick
 
     def perform(klass, id)
       model = klass.constantize
-      record = model.find(id) rescue nil # TODO fix lazy coding
+      record =
+        begin
+          model.find(id)
+        rescue => e
+          # check by name rather than rescue directly so we don't need
+          # to determine which classes are defined
+          raise e unless RECORD_NOT_FOUND_CLASSES.include?(e.class.name)
+          nil
+        end
+
       index = model.searchkick_index
       if !record || !record.should_index?
         # hacky

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/test/boost_test.rb

@@ -138,6 +138,24 @@ class BoostTest < Minitest::Test
     assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}, scale: "1000mi"}
   end
 
+  def test_boost_by_distance_v2
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {location: {origin: [37, -122], scale: "1000mi"}}
+  end
+
+  def test_boost_by_distance_v2_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {location: {origin: {lat: 37, lon: -122}, scale: "1000mi"}}
+  end
+
   def test_boost_by_indices
     store_names ["Rex"], Animal
     store_names ["Rexx"], Product

data/test/gemfiles/mongoid6.gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec path: "../../"
 
 gem "mongoid", "~> 6.0.0"
+gem "activejob"

data/test/gemfiles/nobrainer.gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec path: "../../"
 
 gem "nobrainer", ">= 0.21.0"
+gem "activejob"

data/test/highlight_test.rb

@@ -11,6 +11,11 @@ class HighlightTest < Minitest::Test
     assert_equal "Two Door <strong>Cinema</strong> Club", Product.search("cinema", fields: [:name], highlight: {tag: "<strong>"}).first.search_highlights[:name]
   end
 
+  def test_tag_class
+    store_names ["Two Door Cinema Club"]
+    assert_equal "Two Door <strong class='classy'>Cinema</strong> Club", Product.search("cinema", fields: [:name], highlight: {tag: "<strong class='classy'>"}).first.search_highlights[:name]
+  end
+
   def test_multiple_fields
     store [{name: "Two Door Cinema Club", color: "Cinema Orange"}]
     highlights = Product.search("cinema", fields: [:name, :color], highlight: true).first.search_highlights

data/test/index_test.rb

@@ -28,6 +28,13 @@ class IndexTest < Minitest::Test
     assert !old_index.exists?
   end
 
+  def test_retain
+    Product.reindex
+    assert_equal 1, Product.searchkick_index.all_indices.size
+    Product.reindex(retain: true)
+    assert_equal 2, Product.searchkick_index.all_indices.size
+  end
+
   def test_total_docs
     store_names ["Product A"]
     assert_equal 1, Product.searchkick_index.total_docs
@@ -107,10 +114,10 @@ class IndexTest < Minitest::Test
       store_names ["Product A"]
       raise ActiveRecord::Rollback
     end
-    assert_search "product", []
+    assert_search "*", []
   end
 
-  def test_analyzed_only
+  def test_filterable
     # skip for 5.0 since it throws
     # Cannot search on field [alt_description] since it is not indexed.
     skip unless elasticsearch_below50?
@@ -118,7 +125,7 @@ class IndexTest < Minitest::Test
     assert_search "*", [], where: {alt_description: "Hello"}
   end
 
-  def test_analyzed_only_large_value
+  def test_large_value
     skip if nobrainer?
     large_value = 10000.times.map { "hello" }.join(" ")
     store [{name: "Product A", alt_description: large_value}]

data/test/test_helper.rb

@@ -18,7 +18,11 @@ puts "Running against Elasticsearch #{Searchkick.server_version}"
 
 I18n.config.enforce_available_locales = true
 
-ActiveJob::Base.logger = nil if defined?(ActiveJob)
+if defined?(ActiveJob)
+  ActiveJob::Base.logger = nil
+  ActiveJob::Base.queue_adapter = :inline
+end
+
 ActiveSupport::LogSubscriber.logger = Logger.new(STDOUT) if ENV["NOTIFICATIONS"]
 
 def elasticsearch_below50?

data/test/where_test.rb

@@ -184,6 +184,15 @@ class WhereTest < Minitest::Test
     assert_search "san", ["San Francisco"], where: {multiple_locations: {near: [37.5, -122.5]}}
   end
 
+  def test_multiple_locations_with_term_filter
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000}
+    ]
+    assert_search "san", [], where: {multiple_locations: {near: [37.5, -122.5]}, name: "San Antonio"}
+    assert_search "san", ["San Francisco"], where: {multiple_locations: {near: [37.5, -122.5]}, name: "San Francisco"}
+  end
+
   def test_multiple_locations_hash
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Searchkick learns what your users are looking for. As more people search,