searchkick 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92b9786d3ffe96d4accab83ae00accbaa5b2ffb3
-  data.tar.gz: 9b60f5ab8f709d9138cbe4823b14d29a06e4aa77
+  metadata.gz: 75ff5cc71f668744faa82225c281a7a636d2a774
+  data.tar.gz: 3acfb221ce185cd58e4e56907a4b175556c1da53
 SHA512:
-  metadata.gz: f8e3324376e90052bbf854fe3d04200857d06ac6cde06bea08ee2fe573462de243d558ed1d0592d92b7794d5c1fd761f396812c4ea09ff5fce1e30cdac2119a8
-  data.tar.gz: c5bc1d098f59c17945af081727ef92cd7d297cfebe3f0acd1c5401dd95bca71a208c10208b07f7d473e9e387fc37f4643c8dc9b373dec2006c4507f30c598808
+  metadata.gz: c329befd3fdad5beb444e0db1c6dabc138ace231cb66f6f8e6abe880bd06fb949aca2ab59fbd135e2516c052d753e743aadac8269a4904fcfc968d7bd6ce626c
+  data.tar.gz: 9943486403fc4a18e6fbf1a2ba3dcda15a85517afaacd8717ffa88dd2d47badb803c85eae9b0aac80b075e6afba2896404ffaeddb22d69c4546a0a8a1e579c4a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.3.1
+
+- Added support for `reindex(async: true)` for non-numeric primary keys
+- Added `conversions_term` option
+- Added support for passing fields to `suggest` option
+- Fixed `page_view_entries` for Kaminari
+
 ## 2.3.0
 
 - Fixed analyzer on dynamically mapped fields

data/Gemfile

@@ -10,3 +10,7 @@ gem "typhoeus"
 gem "activejob"
 gem "redis"
 gem "connection_pool"
+
+# kaminari
+gem "actionpack"
+gem "kaminari"

data/README.md

@@ -629,7 +629,7 @@ end
 Reindex and search with:
 
 ```ruby
-Movie.search "jurassic pa", match: :word_start
+Movie.search "jurassic pa", fields: [:title], match: :word_start
 ```
 
 Typically, you want to use a JavaScript library like [typeahead.js](http://twitter.github.io/typeahead.js/) or [jQuery UI](http://jqueryui.com/autocomplete/).
@@ -1177,14 +1177,16 @@ end
 
 ### Filterable Fields
 
-By default, all fields are filterable (can be used in `where` option). Speed up indexing and reduce index size by only making some fields filterable.
+By default, all string fields are filterable (can be used in `where` option). Speed up indexing and reduce index size by only making some fields filterable.
 
 ```ruby
 class Product < ActiveRecord::Base
-  searchkick filterable: [:store_id]
+  searchkick filterable: [:brand]
 end
 ```
 
+**Note:** Non-string fields will always be filterable and should not be passed to this option.
+
 ### Parallel Reindexing
 
 For large data sets, you can use background jobs to parallelize reindexing.
@@ -1563,6 +1565,12 @@ class Product < ActiveRecord::Base
 end
 ```
 
+Use a different term for boosting by conversions
+
+```ruby
+Product.search("banana", conversions_term: "organic banana")
+```
+
 Multiple conversion fields
 
 ```ruby

data/lib/searchkick/index.rb

@@ -420,14 +420,25 @@ module Searchkick
       if scope.respond_to?(:primary_key)
         # TODO expire Redis key
         primary_key = scope.primary_key
-        starting_id = scope.minimum(primary_key) || 0
-        max_id = scope.maximum(primary_key) || 0
-        batches_count = ((max_id - starting_id + 1) / batch_size.to_f).ceil
-
-        batches_count.times do |i|
-          batch_id = i + 1
-          min_id = starting_id + (i * batch_size)
-          bulk_reindex_job scope, batch_id, min_id: min_id, max_id: min_id + batch_size - 1
+
+        starting_id = scope.minimum(primary_key)
+        if starting_id.nil?
+          # no records, do nothing
+        elsif starting_id.is_a?(Numeric)
+          max_id = scope.maximum(primary_key)
+          batches_count = ((max_id - starting_id + 1) / batch_size.to_f).ceil
+
+          batches_count.times do |i|
+            batch_id = i + 1
+            min_id = starting_id + (i * batch_size)
+            bulk_reindex_job scope, batch_id, min_id: min_id, max_id: min_id + batch_size - 1
+          end
+        else
+          scope.find_in_batches(batch_size: batch_size).each_with_index do |batch, i|
+            batch_id = i + 1
+
+            bulk_reindex_job scope, batch_id, record_ids: batch.map { |record| record.id.to_s }
+          end
         end
       else
         batch_id = 1

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, :debug, :emoji, :exclude, :execute, :explain,
+        :boost_by, :boost_by_distance, :boost_where, :conversions, :conversions_term, :debug, :emoji, :exclude, :execute, :explain,
         :fields, :highlight, :includes, :index_name, :indices_boost, :limit, :load,
         :match, :misspellings, :offset, :operator, :order, :padding, :page, :per_page, :profile,
         :request_params, :routing, :select, :similar, :smart_aggs, :suggest, :track, :type, :where]
@@ -381,7 +381,7 @@ module Searchkick
                       boost_mode: "replace",
                       query: {
                         match: {
-                          "#{conversions_field}.query" => term
+                          "#{conversions_field}.query" => options[:conversions_term] || term
                         }
                       }
                     }.merge(script_score)
@@ -447,7 +447,7 @@ module Searchkick
         set_aggregations(payload) if options[:aggs]
 
         # suggestions
-        set_suggestions(payload) if options[:suggest]
+        set_suggestions(payload, options[:suggest]) if options[:suggest]
 
         # highlight
         set_highlights(payload, fields) if options[:highlight]
@@ -575,12 +575,18 @@ module Searchkick
       payload[:indices_boost] = indices_boost
     end
 
-    def set_suggestions(payload)
-      suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
+    def set_suggestions(payload, suggest)
+      suggest_fields = nil
 
-      # intersection
-      if options[:fields]
-        suggest_fields &= options[:fields].map { |v| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
+      if suggest.is_a?(Array)
+        suggest_fields = suggest
+      else
+        suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
+
+        # intersection
+        if options[:fields]
+          suggest_fields &= options[:fields].map { |v| (v.is_a?(Hash) ? v.keys.first : v).to_s.split("^", 2).first }
+        end
       end
 
       if suggest_fields.any?
@@ -592,6 +598,8 @@ module Searchkick
             }
           }
         end
+      else
+        raise ArgumentError, "Must pass fields to suggest option"
       end
     end
 

data/lib/searchkick/results.rb

@@ -127,8 +127,14 @@ module Searchkick
       klass.model_name
     end
 
-    def entry_name
-      model_name.human.downcase
+    def entry_name(options = {})
+      if options.empty?
+        # backward compatibility
+        model_name.human.downcase
+      else
+        default = options[:count] == 1 ? model_name.human : model_name.human.pluralize
+        model_name.human(options.reverse_merge(default: default))
+      end
     end
 
     def total_count

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/test/boost_test.rb

@@ -28,6 +28,18 @@ class BoostTest < Minitest::Test
     assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C"], {conversions: "conversions_b"}, Speaker
   end
 
+  def test_multiple_conversions_with_boost_term
+    store [
+      {name: "Speaker A", conversions_a: {"speaker" => 4, "speaker_1" => 1}},
+      {name: "Speaker B", conversions_a: {"speaker" => 3, "speaker_1" => 2}},
+      {name: "Speaker C", conversions_a: {"speaker" => 2, "speaker_1" => 3}},
+      {name: "Speaker D", conversions_a: {"speaker" => 1, "speaker_1" => 4}}
+    ], Speaker
+
+    assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C", "Speaker D"], {conversions: "conversions_a"}, Speaker
+    assert_order "speaker", ["Speaker D", "Speaker C", "Speaker B", "Speaker A"], {conversions: "conversions_a", conversions_term: "speaker_1"}, Speaker
+  end
+
   def test_conversions_stemmed
     store [
       {name: "Tomato A", conversions: {"tomato" => 1, "tomatos" => 1, "Tomatoes" => 1}},

data/test/gemfiles/mongoid6.gemfile

@@ -6,3 +6,7 @@ gemspec path: "../../"
 gem "mongoid", "~> 6.0.0"
 gem "activejob"
 gem "redis"
+
+# kaminari
+gem "actionpack"
+gem "kaminari"

data/test/index_test.rb

@@ -132,6 +132,11 @@ class IndexTest < Minitest::Test
     assert_search "*", [], where: {alt_description: "Hello"}
   end
 
+  def test_filterable_non_string
+    store [{name: "Product A", store_id: 1}]
+    assert_search "*", ["Product A"], where: {store_id: 1}
+  end
+
   def test_large_value
     skip if nobrainer?
     large_value = 1000.times.map { "hello" }.join(" ")

data/test/pagination_test.rb

@@ -50,4 +50,21 @@ class PaginationTest < Minitest::Test
     assert_equal 1, products.current_page
     assert products.first_page?
   end
+
+  def test_kaminari
+    skip unless defined?(Kaminari)
+
+    require "action_view"
+
+    I18n.load_path = Dir["test/support/kaminari.yml"]
+    I18n.backend.load_translations
+
+    view = ActionView::Base.new
+
+    store_names ["Product A"]
+    assert_equal "Displaying <b>1</b> product", view.page_entries_info(Product.search("product"))
+
+    store_names ["Product B"]
+    assert_equal "Displaying <b>all 2</b> products", view.page_entries_info(Product.search("product"))
+  end
 end

data/test/reindex_test.rb

@@ -39,6 +39,18 @@ class ReindexTest < Minitest::Test
     assert_search "product", ["Product A"]
   end
 
+  def test_async_non_integer_pk
+    skip if !defined?(ActiveJob)
+
+    Sku.create(id: SecureRandom.hex, name: "Test")
+    reindex = Sku.reindex(async: true)
+    assert_search "sku", [], conversions: false
+
+    index = Searchkick::Index.new(reindex[:index_name])
+    index.refresh
+    assert_equal 1, index.total_docs
+  end
+
   def test_refresh_interval
     reindex = Product.reindex(refresh_interval: "30s", async: true, import: false)
     index = Searchkick::Index.new(reindex[:index_name])

data/test/suggest_test.rb

@@ -67,6 +67,16 @@ class SuggestTest < Minitest::Test
     assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [{"name^2" => :word_start}]
   end
 
+  def test_multiple_models
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_equal "how big is a tiger shark", Searchkick.search("How Big is a Tigre Shar", suggest: [:name]).suggestions.first
+  end
+
+  def test_multiple_models_no_fields
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_raises(ArgumentError) { Searchkick.search("How Big is a Tigre Shar", suggest: true) }
+  end
+
   protected
 
   def assert_suggest(term, expected, options = {})

data/test/support/kaminari.yml

@@ -0,0 +1,21 @@
+en:
+  views:
+    pagination:
+      first: "« First"
+      last: "Last »"
+      previous: "‹ Prev"
+      next: "Next ›"
+      truncate: "…"
+  helpers:
+    page_entries_info:
+      entry:
+        zero: "entries"
+        one: "entry"
+        other: "entries"
+      one_page:
+        display_entries:
+          zero: "No %{entry_name} found"
+          one: "Displaying <b>1</b> %{entry_name}"
+          other: "Displaying <b>all %{count}</b> %{entry_name}"
+      more_pages:
+        display_entries: "Displaying %{entry_name} <b>%{first}&nbsp;-&nbsp;%{last}</b> of <b>%{total}</b> in total"

data/test/test_helper.rb

@@ -111,6 +111,12 @@ if defined?(Mongoid)
 
   class Cat < Animal
   end
+
+  class Sku
+    include Mongoid::Document
+
+    field :name
+  end
 elsif defined?(NoBrainer)
   NoBrainer.configure do |config|
     config.app_name = :searchkick
@@ -171,6 +177,13 @@ elsif defined?(NoBrainer)
 
   class Cat < Animal
   end
+
+  class Sku
+    include NoBrainer::Document
+
+    field :id,   type: String
+    field :name, type: String
+  end
 elsif defined?(Cequel)
   cequel =
     Cequel.connect(
@@ -252,6 +265,13 @@ elsif defined?(Cequel)
   class Cat < Animal
   end
 
+  class Sku
+    include Cequel::Record
+
+    key :id, :uuid
+    column :name, :text
+  end
+
   [Product, Store, Region, Speaker, Animal].each(&:synchronize_schema)
 else
   require "active_record"
@@ -339,6 +359,10 @@ else
     t.string :type
   end
 
+  ActiveRecord::Migration.create_table :skus, id: :uuid do |t|
+    t.string :name
+  end
+
   class Product < ActiveRecord::Base
     belongs_to :store
   end
@@ -361,6 +385,9 @@ else
 
   class Cat < Animal
   end
+
+  class Sku < ActiveRecord::Base
+  end
 end
 
 class Product
@@ -477,6 +504,10 @@ class Animal
     # wordnet: true
 end
 
+class Sku
+  searchkick callbacks: defined?(ActiveJob) ? :async : true
+end
+
 Product.searchkick_index.delete if Product.searchkick_index.exists?
 Product.reindex
 Product.reindex # run twice for both index paths
@@ -493,6 +524,7 @@ class Minitest::Test
     Store.destroy_all
     Animal.destroy_all
     Speaker.destroy_all
+    Sku.destroy_all
   end
 
   protected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -170,6 +170,7 @@ files:
 - test/similar_test.rb
 - test/sql_test.rb
 - test/suggest_test.rb
+- test/support/kaminari.yml
 - test/synonyms_test.rb
 - test/test_helper.rb
 - test/where_test.rb
@@ -245,6 +246,7 @@ test_files:
 - test/similar_test.rb
 - test/sql_test.rb
 - test/suggest_test.rb
+- test/support/kaminari.yml
 - test/synonyms_test.rb
 - test/test_helper.rb
 - test/where_test.rb