searchkick 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 755a0e68ea42b18bb5d3ab111bec8d7f95a0bce2
-  data.tar.gz: 5ed049addff00159cfe9a4c7db03ea81cb9383ca
+SHA256:
+  metadata.gz: eb9e19c9a72da12faf603c3fddbdd2fac429058a0774553c0afb874f0a1bc0de
+  data.tar.gz: a80890252fd573c07fa1f63b5cdbbaaec7dd1848ad0941e09160e973a0ad8ea2
 SHA512:
-  metadata.gz: cab627210801732d119796bce578d42289d808199a1f3a3510343ded21c4513ecad2f2e7259a435fc4c31db13e89995bf659195fa783c5d5747c0c0e554ee76f
-  data.tar.gz: 4b06af47509a66eafc9f8bc6080e28a72fbd03998c4b7307b4e26cb950a5d52417ace6261a9b974dcf809fb535af75c5789a2e1ae96c45c66dd630dd9e0b76fc
+  metadata.gz: 1faf5e1622ec798d6ffca925d7831c55265973d8e58260a7dd8f98b249bd20cb9a3a903c9a12a870dfcd4eb723caf21459a259bd197e84d99771fed96a2d65ed
+  data.tar.gz: 796a19163cbc93d9fdbd235d29bbd86beedc3c583ea214c91406b6252f9d778d4f8ee710ae3ad1f1f85d91a7ab30571c3a01567ce8486a042d8e8d4ce3a63635

data/.travis.yml

@@ -15,12 +15,13 @@ notifications:
     on_failure: change
 gemfile:
   - Gemfile
+  - test/gemfiles/activerecord51.gemfile
   - test/gemfiles/activerecord50.gemfile
   - test/gemfiles/activerecord42.gemfile
   - test/gemfiles/mongoid5.gemfile
   - test/gemfiles/mongoid6.gemfile
 env:
-  - ELASTICSEARCH_VERSION=6.2.2
+  - ELASTICSEARCH_VERSION=6.2.3
 jdk: oraclejdk8
 matrix:
   include:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.0.3
+
+- Added support for pagination with `body` option
+- Added `boost_by_recency` option
+- Fixed "Model Search Data" output for `debug` option
+- Fixed `reindex_status` error
+- Fixed error with optional operators in Ruby regexp
+- Fixed deprecation warnings for Elasticsearch 6.2+
+
 ## 3.0.2
 
 - Added support for Korean and Vietnamese

data/README.md

@@ -201,7 +201,16 @@ boost_where: {user_id: {value: 1, factor: 100}} # default factor is 1000
 boost_where: {user_id: [{value: 1, factor: 100}, {value: 2, factor: 200}]}
 ```
 
-[Conversions](#keep-getting-better) are also a great way to boost.
+Boost by recency
+
+```ruby
+boost_by_recency: {created_at: {scale: "7d", decay: 0.5}}
+```
+
+You can also boost by:
+
+- [Conversions](#keep-getting-better)
+- [Distance](#boost-by-distance)
 
 ### Get Everything
 

data/lib/searchkick.rb

@@ -95,10 +95,11 @@ module Searchkick
   end
 
   def self.server_below?(version)
-    Gem::Version.new(server_version.sub("-", ".")) < Gem::Version.new(version.sub("-", "."))
+    Gem::Version.new(server_version.split("-")[0]) < Gem::Version.new(version.split("-")[0])
   end
 
   def self.search(term = "*", model: nil, **options, &block)
+    options = options.dup
     klass = model
 
     # make Searchkick.search(index_name: [Product]) and Product.search equivalent
@@ -106,6 +107,7 @@ module Searchkick
       index_name = Array(options[:index_name])
       if index_name.size == 1 && index_name.first.respond_to?(:searchkick_index)
         klass = index_name.first
+        options.delete(:index_name)
       end
     end
 

data/lib/searchkick/bulk_indexer.rb

@@ -51,6 +51,10 @@ module Searchkick
       Searchkick.indexer.queue(records.map { |r| RecordData.new(index, r).update_data(method_name) })
     end
 
+    def batches_left
+      Searchkick.with_redis { |r| r.scard(batches_key) }
+    end
+
     private
 
     def import_or_update(records, method_name, async)
@@ -134,12 +138,12 @@ module Searchkick
     end
 
     def bulk_reindex_job(scope, batch_id, options)
+      Searchkick.with_redis { |r| r.sadd(batches_key, batch_id) }
       Searchkick::BulkReindexJob.perform_later({
         class_name: scope.model_name.name,
         index_name: index.name,
         batch_id: batch_id
       }.merge(options))
-      Searchkick.with_redis { |r| r.sadd(batches_key, batch_id) }
     end
 
     def with_retries
@@ -156,10 +160,6 @@ module Searchkick
       end
     end
 
-    def batches_left
-      Searchkick.with_redis { |r| r.scard(batches_key) }
-    end
-
     def batches_key
       "searchkick:reindex:#{index.name}:batches"
     end

data/lib/searchkick/index.rb

@@ -17,7 +17,7 @@ module Searchkick
     end
 
     def delete
-      if !Searchkick.server_below?("6.0.0-alpha1") && alias_exists?
+      if !Searchkick.server_below?("6.0.0") && alias_exists?
         # can't call delete directly on aliases in ES 6
         indices = client.indices.get_alias(name: name).keys
         client.indices.delete index: indices

data/lib/searchkick/index_options.rb

@@ -11,7 +11,9 @@ module Searchkick
         settings = options[:settings] || {}
         mappings = options[:mappings]
       else
-        below60 = Searchkick.server_below?("6.0.0-alpha1")
+        below60 = Searchkick.server_below?("6.0.0")
+        below62 = Searchkick.server_below?("6.2.0")
+
         default_type = "text"
         default_analyzer = :searchkick_index
         keyword_mapping = {type: "keyword"}
@@ -216,6 +218,13 @@ module Searchkick
           settings[:similarity] = {default: {type: options[:similarity]}}
         end
 
+        unless below62
+          settings[:index] = {
+            max_ngram_diff: 49,
+            max_shingle_diff: 4
+          }
+        end
+
         settings.deep_merge!(options[:settings] || {})
 
         # synonyms

data/lib/searchkick/query.rb

@@ -16,7 +16,7 @@ module Searchkick
 
     def initialize(klass, term = "*", **options)
       unknown_keywords = options.keys - [:aggs, :body, :body_options, :boost,
-        :boost_by, :boost_by_distance, :boost_where, :conversions, :conversions_term, :debug, :emoji, :exclude, :execute, :explain,
+        :boost_by, :boost_by_distance, :boost_by_recency, :boost_where, :conversions, :conversions_term, :debug, :emoji, :exclude, :execute, :explain,
         :fields, :highlight, :includes, :index_name, :indices_boost, :limit, :load,
         :match, :misspellings, :model_includes, :offset, :operator, :order, :padding, :page, :per_page, :profile,
         :request_params, :routing, :scope_results, :select, :similar, :smart_aggs, :suggest, :track, :type, :where]
@@ -114,7 +114,8 @@ module Searchkick
         highlighted_fields: @highlighted_fields || [],
         misspellings: @misspellings,
         term: term,
-        scope_results: options[:scope_results]
+        scope_results: options[:scope_results],
+        index_name: options[:index_name]
       }
 
       if options[:debug]
@@ -135,7 +136,7 @@ module Searchkick
         if searchkick_index
           puts "Model Search Data"
           begin
-            pp(klass.first(3).map { |r| {index: searchkick_index.record_data(r).merge(data: searchkick_index.send(:search_data, r))}})
+            pp klass.limit(3).map { |r| RecordData.new(searchkick_index, r).index_data }
           rescue => e
             puts "#{e.class.name}: #{e.message}"
           end
@@ -224,9 +225,9 @@ module Searchkick
       @json = options[:body]
       if @json
         ignored_options = options.keys & [:aggs, :boost,
-          :boost_by, :boost_by_distance, :boost_where, :conversions, :conversions_term, :exclude, :explain,
-          :fields, :highlight, :indices_boost, :limit, :match, :misspellings, :offset, :operator, :order,
-          :padding, :page, :per_page, :profile, :select, :smart_aggs, :suggest, :where]
+          :boost_by, :boost_by_distance, :boost_by_recency, :boost_where, :conversions, :conversions_term, :exclude, :explain,
+          :fields, :highlight, :indices_boost, :match, :misspellings, :operator, :order,
+          :profile, :select, :smart_aggs, :suggest, :where]
         raise ArgumentError, "Options incompatible with body option: #{ignored_options.join(", ")}" if ignored_options.any?
         payload = @json
       else
@@ -381,10 +382,7 @@ module Searchkick
           query = payload
         end
 
-        payload = {
-          size: per_page,
-          from: offset
-        }
+        payload = {}
 
         # type when inheritance
         where = (options[:where] || {}).dup
@@ -409,6 +407,7 @@ module Searchkick
         set_boost_by(multiply_filters, custom_filters)
         set_boost_where(custom_filters)
         set_boost_by_distance(custom_filters) if options[:boost_by_distance]
+        set_boost_by_recency(custom_filters) if options[:boost_by_recency]
 
         payload[:query] = build_query(query, filters, should, must_not, custom_filters, multiply_filters)
 
@@ -444,6 +443,13 @@ module Searchkick
         end
       end
 
+      # pagination
+      pagination_options = options[:page] || options[:limit] || options[:per_page] || options[:offset] || options[:padding]
+      if !options[:body] || pagination_options
+        payload[:size] = per_page
+        payload[:from] = offset
+      end
+
       # type
       if !searchkick_options[:inheritance] && (options[:type] || (klass != searchkick_klass && searchkick_index))
         @type = [options[:type] || klass].flatten.map { |v| searchkick_index.klass_document_type(v) }
@@ -588,6 +594,19 @@ module Searchkick
       end
     end
 
+    def set_boost_by_recency(custom_filters)
+      options[:boost_by_recency].each do |field, attributes|
+        attributes = {function: :gauss, origin: Time.now}.merge(attributes)
+
+        custom_filters << {
+          weight: attributes[:factor] || 1,
+          attributes[:function] => {
+            field => attributes.except(:factor, :function)
+          }
+        }
+      end
+    end
+
     def set_boost_by(multiply_filters, custom_filters)
       boost_by = options[:boost_by] || {}
       if boost_by.is_a?(Array)
@@ -900,7 +919,7 @@ module Searchkick
       elsif value.nil?
         {bool: {must_not: {exists: {field: field}}}}
       elsif value.is_a?(Regexp)
-        {regexp: {field => {value: value.source}}}
+        {regexp: {field => {value: value.source, flags: "NONE"}}}
       else
         {term: {field => value}}
       end
@@ -963,11 +982,11 @@ module Searchkick
     end
 
     def below60?
-      Searchkick.server_below?("6.0.0-alpha1")
+      Searchkick.server_below?("6.0.0")
     end
 
     def below61?
-      Searchkick.server_below?("6.1.0-alpha1")
+      Searchkick.server_below?("6.1.0")
     end
   end
 end

data/lib/searchkick/results.rb

@@ -22,7 +22,8 @@ module Searchkick
           results = {}
 
           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 }
+            klass = (!options[:index_name] && @klass) || type.camelize.constantize
+            results[type] = results_query(klass, grouped_hits).to_a.index_by { |r| r.id.to_s }
           end
 
           # sort

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

data/searchkick.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features|benchmark)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.2.0"
+
   spec.add_dependency "activemodel", ">= 4.2"
   spec.add_dependency "elasticsearch", ">= 5"
   spec.add_dependency "hashie"

data/test/boost_test.rb

@@ -149,6 +149,24 @@ class BoostTest < Minitest::Test
     assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"], boost_where: {user_ids: [{value: 1, factor: 10}, {value: 3, factor: 20}]}
   end
 
+  def test_boost_by_recency
+    store [
+      {name: "Article 1", created_at: 2.days.ago},
+      {name: "Article 2", created_at: 1.day.ago},
+      {name: "Article 3", created_at: Time.now}
+    ]
+    assert_order "article", ["Article 3", "Article 2", "Article 1"], boost_by_recency: {created_at: {scale: "7d", decay: 0.5}}
+  end
+
+  def test_boost_by_recency_origin
+    store [
+      {name: "Article 1", created_at: 2.days.ago},
+      {name: "Article 2", created_at: 1.day.ago},
+      {name: "Article 3", created_at: Time.now}
+    ]
+    assert_order "article", ["Article 1", "Article 2", "Article 3"], boost_by_recency: {created_at: {origin: 2.days.ago, scale: "7d", decay: 0.5}}
+  end
+
   def test_boost_by_distance
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},

data/test/gemfiles/activerecord51.gemfile

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

data/test/pagination_test.rb

@@ -43,6 +43,32 @@ class PaginationTest < Minitest::Test
     assert products.any?
   end
 
+  def test_pagination_body
+    store_names ["Product A", "Product B", "Product C", "Product D", "Product E", "Product F"]
+    products = Product.search("product", body: {query: {match_all: {}}, sort: [{name: "asc"}]}, page: 2, per_page: 2, padding: 1)
+    assert_equal ["Product D", "Product E"], products.map(&:name)
+    assert_equal "product", products.entry_name
+    assert_equal 2, products.current_page
+    assert_equal 1, products.padding
+    assert_equal 2, products.per_page
+    assert_equal 2, products.size
+    assert_equal 2, products.length
+    assert_equal 3, products.total_pages
+    assert_equal 6, products.total_count
+    assert_equal 6, products.total_entries
+    assert_equal 2, products.limit_value
+    assert_equal 3, products.offset_value
+    assert_equal 3, products.offset
+    assert_equal 3, products.next_page
+    assert_equal 1, products.previous_page
+    assert_equal 1, products.prev_page
+    assert !products.first_page?
+    assert !products.last_page?
+    assert !products.empty?
+    assert !products.out_of_range?
+    assert products.any?
+  end
+
   def test_pagination_nil_page
     store_names ["Product A", "Product B", "Product C", "Product D", "Product E"]
     products = Product.search("product", order: {name: :asc}, page: nil, per_page: 2)

data/test/query_test.rb

@@ -32,4 +32,12 @@ class QueryTest < Minitest::Test
   def test_request_params
     assert_equal "dfs_query_then_fetch", Product.search("*", request_params: {search_type: "dfs_query_then_fetch"}, execute: false).params[:search_type]
   end
+
+  def test_debug
+    store_names ["Milk"]
+    out, _ = capture_io do
+      assert_search "milk", ["Milk"], debug: true
+    end
+    refute_includes out, "Error"
+  end
 end

data/test/reindex_test.rb

@@ -28,7 +28,7 @@ class ReindexTest < Minitest::Test
   end
 
   def test_async
-    skip if !defined?(ActiveJob)
+    skip unless defined?(ActiveJob)
 
     Searchkick.callbacks(false) do
       store_names ["Product A"]
@@ -40,12 +40,30 @@ class ReindexTest < Minitest::Test
     index.refresh
     assert_equal 1, index.total_docs
 
+    if defined?(Redis)
+      assert Searchkick.reindex_status(reindex[:name])
+    end
+
     Product.searchkick_index.promote(reindex[:index_name])
     assert_search "product", ["Product A"]
   end
 
+  def test_async_wait
+    skip unless defined?(ActiveJob) && defined?(Redis)
+
+    Searchkick.callbacks(false) do
+      store_names ["Product A"]
+    end
+
+    capture_io do
+      Product.reindex(async: {wait: true})
+    end
+
+    assert_search "product", ["Product A"]
+  end
+
   def test_async_non_integer_pk
-    skip if !defined?(ActiveJob)
+    skip unless defined?(ActiveJob)
 
     Sku.create(id: SecureRandom.hex, name: "Test")
     reindex = Sku.reindex(async: true)

data/test/where_test.rb

@@ -79,6 +79,11 @@ class WhereTest < Minitest::Test
     assert_search "*", ["Product A"], where: {name: {regexp: "Pro.+"}}
   end
 
+  def test_special_regexp
+    store_names ["Product <A>", "Item <B>"]
+    assert_search "*", ["Product <A>"], where: {name: /Pro.+<.+/}
+  end
+
   def test_where_string
     store [
       {name: "Product A", color: "RED"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -144,6 +144,7 @@ files:
 - test/errors_test.rb
 - test/gemfiles/activerecord42.gemfile
 - test/gemfiles/activerecord50.gemfile
+- test/gemfiles/activerecord51.gemfile
 - test/gemfiles/apartment.gemfile
 - test/gemfiles/cequel.gemfile
 - test/gemfiles/mongoid5.gemfile
@@ -188,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Searchkick learns what your users are looking for. As more people search,
@@ -214,6 +215,7 @@ test_files:
 - test/errors_test.rb
 - test/gemfiles/activerecord42.gemfile
 - test/gemfiles/activerecord50.gemfile
+- test/gemfiles/activerecord51.gemfile
 - test/gemfiles/apartment.gemfile
 - test/gemfiles/cequel.gemfile
 - test/gemfiles/mongoid5.gemfile