searchkick 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 647df0215d082ec2eed37cabd3f1949aafc6c058
-  data.tar.gz: b3be78d876de64f7323fe31fbbe7829f7885ebc4
+  metadata.gz: 8b8b951d29bd106ae56b6ca7d2738574430f76ae
+  data.tar.gz: a56ba366f77bfb6f0378e8f5711704bec31ef2cf
 SHA512:
-  metadata.gz: 9326c663870b3dcf60384515ec29873a9b7c3ce6325922e3250ee0c7f75ebd933859d1a481275d035f2a8e00ac2b5c55ee0d342dfd55e698b575ca947f781f93
-  data.tar.gz: e6aaaa85a4ee9ccea8dba7bbd3077aef5164be1a5381ea60e1716881035050505575e1190494f9e53c1bef92b89852050b587a3fe3d84b4b35019eb9c8364ba8
+  metadata.gz: 7f532ecc2e7bb89ad4a705400c89151d7b5ab114efc7c8d4fa9771578de22a3e3ed5361863b6cea9cf56ea9ab6cf4b3379899168af619242844035197c1b294a
+  data.tar.gz: 37c8d654358714fc2a5389190940fdf5f9714b60ded559364ec28ea6a639ed69570f80495e004e2d17c3354e8aada69b7f5e9cf062176f595d4e626024921b1c

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.1
 services:
   - elasticsearch
   - mongodb
+before_install:
+  - wget https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.3.2.deb && sudo dpkg -i elasticsearch-1.3.2.deb && sudo service elasticsearch restart
 script: bundle exec rake test
 before_script:
   - psql -c 'create database searchkick_test;' -U postgres
@@ -14,6 +15,9 @@ notifications:
     on_failure: change
 gemfile:
   - Gemfile
+  - gemfiles/activerecord40.gemfile
+  - gemfiles/activerecord32.gemfile
+  - gemfiles/activerecord31.gemfile
   - gemfiles/mongoid2.gemfile
   - gemfiles/mongoid3.gemfile
   - gemfiles/mongoid4.gemfile

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.8.3
+
+- Added support for ActiveJob
+- Added `timeout` setting
+- Fixed import with no records
+
 ## 0.8.2
 
 - Added `async` to `callbacks` option

data/Gemfile

@@ -4,6 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem "sqlite3"
-gem "activerecord", ">= 3.1"
-# gem "activerecord", "~> 3.2.0"
-# gem "activerecord", "~> 3.1.0"
+gem "activerecord", "~> 4.1.0"
+gem "activejob_backport"

data/README.md

@@ -343,7 +343,7 @@ There are three strategies for keeping the index synced with your database.
   end
   ```
 
-  Supports [Delayed Job](https://github.com/collectiveidea/delayed_job) only at the moment
+  And [install Active Job](https://github.com/ankane/activejob_backport) for Rails 4.1 and below
 
 3. Manual
 
@@ -539,6 +539,14 @@ Product.search "*", facets: {store_id: {stats: true}}
 
 ### Highlight
 
+Specify which fields to index with highlighting.
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick highlight: [:name]
+end
+```
+
 Highlight the search query in the results.
 
 ```ruby
@@ -801,6 +809,12 @@ Product.enable_search_callbacks # or use Searchkick.enable_callbacks for all mod
 Product.reindex
 ```
 
+Change timeout
+
+```ruby
+Searchkick.timeout = 5 # defaults to 10
+```
+
 Change the search method name in `config/initializers/searchkick.rb`
 
 ```ruby

data/gemfiles/activerecord31.gemfile

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

data/gemfiles/activerecord32.gemfile

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

data/gemfiles/activerecord40.gemfile

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

data/gemfiles/mongoid4.gemfile

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

data/lib/searchkick.rb

@@ -12,6 +12,14 @@ require "searchkick/model"
 require "searchkick/tasks"
 require "searchkick/logging" if defined?(Rails)
 
+# background jobs
+begin
+  require "active_job"
+rescue LoadError
+  # do nothing
+end
+require "searchkick/reindex_v2_job" if defined?(ActiveJob)
+
 module Searchkick
   class MissingIndexError < StandardError; end
   class UnsupportedVersionError < StandardError; end
@@ -21,13 +29,19 @@ module Searchkick
     attr_accessor :callbacks
     attr_accessor :search_method_name
     attr_accessor :wordnet_path
+    attr_accessor :timeout
   end
   self.callbacks = true
   self.search_method_name = :search
   self.wordnet_path = "/var/lib/wn_s.pl"
+  self.timeout = 10
 
   def self.client
-    @client ||= Elasticsearch::Client.new(url: ENV["ELASTICSEARCH_URL"])
+    @client ||=
+      Elasticsearch::Client.new(
+        url: ENV["ELASTICSEARCH_URL"],
+        transport_options: {request: {timeout: timeout}}
+      )
   end
 
   def self.client=(client)

data/lib/searchkick/logging.rb

@@ -38,12 +38,14 @@ module Searchkick
     alias_method_chain :remove, :instrumentation
 
     def import_with_instrumentation(records)
-      event = {
-        name: "#{records.first.searchkick_klass.name} Import",
-        count: records.size
-      }
-      ActiveSupport::Notifications.instrument("request.searchkick", event) do
-        import_without_instrumentation(records)
+      if records.any?
+        event = {
+          name: "#{records.first.searchkick_klass.name} Import",
+          count: records.size
+        }
+        ActiveSupport::Notifications.instrument("request.searchkick", event) do
+          import_without_instrumentation(records)
+        end
       end
     end
     alias_method_chain :import, :instrumentation

data/lib/searchkick/model.rb

@@ -32,9 +32,11 @@ module Searchkick
         extend Searchkick::Reindex
         include Searchkick::Similar
 
-        if callbacks == :async
-          def reindex_async
-            Delayed::Job.enqueue Searchkick::ReindexJob.new(self.class.name, id)
+        def reindex_async
+          if defined?(Searchkick::ReindexV2Job)
+            Searchkick::ReindexV2Job.perform_later(self.class.name, id.to_s)
+          else
+            Delayed::Job.enqueue Searchkick::ReindexJob.new(self.class.name, id.to_s)
           end
         end
 

data/lib/searchkick/reindex.rb

@@ -17,7 +17,7 @@ module Searchkick
       # check if alias exists
       if Searchkick.client.indices.exists_alias(name: alias_name)
         # import before swap
-        searchkick_import(index) unless skip_import
+        searchkick_import(index: index) unless skip_import
 
         # get existing indices to remove
         old_indices = Searchkick.client.indices.get_alias(name: alias_name).keys
@@ -29,7 +29,7 @@ module Searchkick
         Searchkick.client.indices.update_aliases body: {actions: [{add: {index: new_name, alias: alias_name}}]}
 
         # import after swap
-        searchkick_import(index) unless skip_import
+        searchkick_import(index: index) unless skip_import
       end
 
       index.refresh
@@ -52,9 +52,8 @@ module Searchkick
       @descendents << klass unless @descendents.include?(klass)
     end
 
-    private
-
-    def searchkick_import(index)
+    def searchkick_import(options = {})
+      index = options[:index] || searchkick_index
       batch_size = searchkick_options[:batch_size] || 1000
 
       # use scope for import
@@ -261,7 +260,7 @@ module Searchkick
         end
 
         mapping_options = Hash[
-          [:autocomplete, :suggest, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end]
+          [:autocomplete, :suggest, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight]
             .map{|type| [type, (options[type] || []).map(&:to_s)] }
         ]
 
@@ -276,12 +275,16 @@ module Searchkick
             }
           }
 
-          mapping_options.each do |type, fields|
+          mapping_options.except(:highlight).each do |type, fields|
             if fields.include?(field)
               field_mapping[:fields][type] = {type: "string", index: "analyzed", analyzer: "searchkick_#{type}_index"}
             end
           end
 
+          if mapping_options[:highlight].include?(field)
+            field_mapping[:fields]["analyzed"][:term_vector] = "with_positions_offsets"
+          end
+
           mapping[field] = field_mapping
         end
 

data/lib/searchkick/reindex_v2_job.rb

@@ -0,0 +1,24 @@
+module Searchkick
+  class ReindexV2Job < ActiveJob::Base
+    queue_as :searchkick
+
+    def perform(klass, id)
+      model = klass.constantize
+      record = model.find(id) rescue nil # TODO fix lazy coding
+      index = model.searchkick_index
+      if !record or !record.should_index?
+        # hacky
+        record ||= model.new
+        record.id = id
+        begin
+          index.remove record
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          # do nothing
+        end
+      else
+        index.store record
+      end
+    end
+
+  end
+end

data/lib/searchkick/results.rb

@@ -88,6 +88,10 @@ module Searchkick
       klass.model_name
     end
 
+    def entry_name
+      model_name.human.downcase
+    end
+
     def total_count
       response["hits"]["total"]
     end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/test/highlight_test.rb

@@ -19,6 +19,11 @@ class TestHighlight < Minitest::Test
     assert_equal "<em>Cinema</em> Orange", highlight[:color]
   end
 
+  def test_multiple_words
+    store_names ["Hello World Hello"]
+    assert_equal "<em>Hello</em> World <em>Hello</em>", Product.search("hello", fields: [:name], highlight: true).with_details.first[1][:highlight][:name]
+  end
+
   def test_json
     store_names ["Two Door Cinema Club"]
     json = {

data/test/index_test.rb

@@ -53,6 +53,8 @@ class TestIndex < Minitest::Test
     store_names ["Product A", "Product B"]
     Product.where(name: "Product A").delete_all
     assert_search "product", ["Product B"]
+  ensure
+    Product.reindex
   end
 
   def test_bad_mapping

data/test/reindex_job_test.rb

@@ -15,7 +15,7 @@ class TestReindexJob < Minitest::Test
     product = Product.create!(name: "Boom")
     Product.searchkick_index.refresh
     assert_search "*", []
-    Searchkick::ReindexJob.new("Product", product.id).perform
+    Searchkick::ReindexJob.new("Product", product.id.to_s).perform
     Product.searchkick_index.refresh
     assert_search "*", ["Boom"]
   end
@@ -25,7 +25,7 @@ class TestReindexJob < Minitest::Test
     Product.reindex
     assert_search "*", ["Boom"]
     product.destroy
-    Searchkick::ReindexJob.new("Product", product.id).perform
+    Searchkick::ReindexJob.new("Product", product.id.to_s).perform
     Product.searchkick_index.refresh
     assert_search "*", []
   end

data/test/reindex_v2_job_test.rb

@@ -0,0 +1,34 @@
+require_relative "test_helper"
+
+class TestReindexV2Job < Minitest::Test
+
+  def setup
+    skip if !defined?(ActiveJob)
+    super
+    Searchkick.disable_callbacks
+  end
+
+  def teardown
+    Searchkick.enable_callbacks
+  end
+
+  def test_create
+    product = Product.create!(name: "Boom")
+    Product.searchkick_index.refresh
+    assert_search "*", []
+    Searchkick::ReindexV2Job.perform_later("Product", product.id.to_s)
+    Product.searchkick_index.refresh
+    assert_search "*", ["Boom"]
+  end
+
+  def test_destroy
+    product = Product.create!(name: "Boom")
+    Product.reindex
+    assert_search "*", ["Boom"]
+    product.destroy
+    Searchkick::ReindexV2Job.perform_later("Product", product.id.to_s)
+    Product.searchkick_index.refresh
+    assert_search "*", []
+  end
+
+end

data/test/sql_test.rb

@@ -22,6 +22,7 @@ class TestSql < Minitest::Test
     store_names ["Product A", "Product B", "Product C", "Product D", "Product E", "Product F"]
     products = Product.search("product", order: {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

data/test/suggest_test.rb

@@ -23,7 +23,8 @@ class TestSuggest < Minitest::Test
 
   def test_multiple_fields
     store [
-      {name: "Shark", color: "Sharp"}
+      {name: "Shark", color: "Sharp"},
+      {name: "Shark", color: "Sharp"},
     ]
     assert_suggest_all "shar", ["shark", "sharp"]
   end

data/test/test_helper.rb

@@ -11,6 +11,10 @@ Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
 File.delete("elasticsearch.log") if File.exists?("elasticsearch.log")
 Searchkick.client.transport.logger = Logger.new("elasticsearch.log")
 
+I18n.config.enforce_available_locales = true
+
+ActiveJob::Base.logger = nil if defined?(ActiveJob)
+
 if defined?(Mongoid)
 
   def mongoid2?
@@ -141,7 +145,8 @@ class Product
     text_end: [:name],
     word_start: [:name],
     word_middle: [:name],
-    word_end: [:name]
+    word_end: [:name],
+    highlight: [:name]
 
   attr_accessor :conversions, :user_ids, :aisle
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -108,6 +108,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/activerecord31.gemfile
+- gemfiles/activerecord32.gemfile
+- gemfiles/activerecord40.gemfile
 - gemfiles/mongoid2.gemfile
 - gemfiles/mongoid3.gemfile
 - gemfiles/mongoid4.gemfile
@@ -118,6 +121,7 @@ files:
 - lib/searchkick/query.rb
 - lib/searchkick/reindex.rb
 - lib/searchkick/reindex_job.rb
+- lib/searchkick/reindex_v2_job.rb
 - lib/searchkick/results.rb
 - lib/searchkick/similar.rb
 - lib/searchkick/tasks.rb
@@ -133,6 +137,7 @@ files:
 - test/model_test.rb
 - test/query_test.rb
 - test/reindex_job_test.rb
+- test/reindex_v2_job_test.rb
 - test/should_index_test.rb
 - test/similar_test.rb
 - test/sql_test.rb
@@ -176,6 +181,7 @@ test_files:
 - test/model_test.rb
 - test/query_test.rb
 - test/reindex_job_test.rb
+- test/reindex_v2_job_test.rb
 - test/should_index_test.rb
 - test/similar_test.rb
 - test/sql_test.rb