searchkick 2.3.2 → 4.4.1

data/lib/searchkick.rb

@@ -1,34 +1,36 @@
-require "active_model"
+# dependencies
+require "active_support"
+require "active_support/core_ext/hash/deep_merge"
 require "elasticsearch"
 require "hashie"
-require "searchkick/version"
-require "searchkick/index_options"
+
+# modules
+require "searchkick/bulk_indexer"
 require "searchkick/index"
 require "searchkick/indexer"
+require "searchkick/hash_wrapper"
+require "searchkick/middleware"
+require "searchkick/model"
+require "searchkick/multi_search"
+require "searchkick/query"
 require "searchkick/reindex_queue"
+require "searchkick/record_data"
+require "searchkick/record_indexer"
 require "searchkick/results"
-require "searchkick/query"
-require "searchkick/multi_search"
-require "searchkick/model"
-require "searchkick/tasks"
-require "searchkick/middleware"
-require "searchkick/logging" if defined?(ActiveSupport::Notifications)
-require "active_support/core_ext/hash/deep_merge"
+require "searchkick/version"
 
-# background jobs
-begin
-  require "active_job"
-rescue LoadError
-  # do nothing
-end
-if defined?(ActiveJob)
-  require "searchkick/bulk_reindex_job"
-  require "searchkick/process_queue_job"
-  require "searchkick/process_batch_job"
-  require "searchkick/reindex_v2_job"
-end
+# integrations
+require "searchkick/railtie" if defined?(Rails)
+require "searchkick/logging" if defined?(ActiveSupport::Notifications)
 
 module Searchkick
+  # background jobs
+  autoload :BulkReindexJob,  "searchkick/bulk_reindex_job"
+  autoload :ProcessBatchJob, "searchkick/process_batch_job"
+  autoload :ProcessQueueJob, "searchkick/process_queue_job"
+  autoload :ReindexV2Job,    "searchkick/reindex_v2_job"
+
+  # errors
   class Error < StandardError; end
   class MissingIndexError < Error; end
   class UnsupportedVersionError < Error; end
@@ -37,7 +39,7 @@ module Searchkick
   class ImportError < Error; end
 
   class << self
-    attr_accessor :search_method_name, :wordnet_path, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name
+    attr_accessor :search_method_name, :wordnet_path, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options
     attr_writer :client, :env, :search_timeout
     attr_reader :aws_credentials
   end
@@ -47,21 +49,19 @@ module Searchkick
   self.models = []
   self.client_options = {}
   self.queue_name = :searchkick
+  self.model_options = {}
 
   def self.client
     @client ||= begin
-      require "typhoeus/adapters/faraday" if defined?(Typhoeus)
+      require "typhoeus/adapters/faraday" if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
 
       Elasticsearch::Client.new({
         url: ENV["ELASTICSEARCH_URL"],
-        transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}}
+        transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
+        retry_on_failure: 2
       }.deep_merge(client_options)) do |f|
         f.use Searchkick::Middleware
-        f.request :aws_signers_v4, {
-          credentials: Aws::Credentials.new(aws_credentials[:access_key_id], aws_credentials[:secret_access_key]),
-          service_name: "es",
-          region: aws_credentials[:region] || "us-east-1"
-        } if aws_credentials
+        f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
       end
     end
   end
@@ -71,7 +71,7 @@ module Searchkick
   end
 
   def self.search_timeout
-    @search_timeout || timeout
+    (defined?(@search_timeout) && @search_timeout) || timeout
   end
 
   def self.server_version
@@ -79,22 +79,44 @@ 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 = "*", **options, &block)
-    klass = options[:model]
+  # memoize for performance
+  def self.server_below7?
+    unless defined?(@server_below7)
+      @server_below7 = server_below?("7.0.0")
+    end
+    @server_below7
+  end
 
-    # TODO add in next major version
-    # if !klass
-    #   index_name = Array(options[:index_name])
-    #   if index_name.size == 1 && index_name.first.respond_to?(:searchkick_index)
-    #     klass = index_name.first
-    #   end
-    # end
+  def self.search(term = "*", model: nil, **options, &block)
+    options = options.dup
+    klass = model
 
-    query = Searchkick::Query.new(klass, term, options.except(:model))
-    block.call(query.body) if block
+    # convert index_name into models if possible
+    # this should allow for easier upgrade
+    if options[:index_name] && !options[:models] && Array(options[:index_name]).all? { |v| v.respond_to?(:searchkick_index) }
+      options[:models] = options.delete(:index_name)
+    end
+
+    # make Searchkick.search(models: [Product]) and Product.search equivalent
+    unless klass
+      models = Array(options[:models])
+      if models.size == 1
+        klass = models.first
+        options.delete(:models)
+      end
+    end
+
+    if klass
+      if (options[:models] && Array(options[:models]) != [klass]) || Array(options[:index_name]).any? { |v| v.respond_to?(:searchkick_index) && v != klass }
+        raise ArgumentError, "Use Searchkick.search to search multiple models"
+      end
+    end
+
+    options = options.merge(block: block) if block
+    query = Searchkick::Query.new(klass, term, **options)
     if options[:execute] == false
       query
     else
@@ -102,8 +124,8 @@ module Searchkick
     end
   end
 
-  def self.multi_search(queries, retry_misspellings: false)
-    Searchkick::MultiSearch.new(queries, retry_misspellings: retry_misspellings).perform
+  def self.multi_search(queries)
+    Searchkick::MultiSearch.new(queries).perform
   end
 
   # callbacks
@@ -116,17 +138,22 @@ module Searchkick
     self.callbacks_value = false
   end
 
-  def self.callbacks?
-    Thread.current[:searchkick_callbacks_enabled].nil? || Thread.current[:searchkick_callbacks_enabled]
+  def self.callbacks?(default: true)
+    if callbacks_value.nil?
+      default
+    else
+      callbacks_value != false
+    end
   end
 
-  def self.callbacks(value)
+  def self.callbacks(value = nil)
     if block_given?
       previous_value = callbacks_value
       begin
         self.callbacks_value = value
-        yield
+        result = yield
         indexer.perform if callbacks_value == :bulk
+        result
       ensure
         self.callbacks_value = previous_value
       end
@@ -136,23 +163,27 @@ module Searchkick
   end
 
   def self.aws_credentials=(creds)
-    require "faraday_middleware/aws_signers_v4"
+    begin
+      # TODO remove in Searchkick 5 (just use aws_sigv4)
+      require "faraday_middleware/aws_signers_v4"
+    rescue LoadError
+      require "faraday_middleware/aws_sigv4"
+    end
     @aws_credentials = creds
     @client = nil # reset client
   end
 
   def self.reindex_status(index_name)
-    if redis
-      batches_left = Searchkick::Index.new(index_name).batches_left
-      {
-        completed: batches_left == 0,
-        batches_left: batches_left
-      }
-    else
-      raise Searchkick::Error, "Redis not configured"
-    end
+    raise Searchkick::Error, "Redis not configured" unless redis
+
+    batches_left = Searchkick::Index.new(index_name).batches_left
+    {
+      completed: batches_left == 0,
+      batches_left: batches_left
+    }
   end
 
+  # TODO use ConnectionPool::Wrapper when redis is set so this is no longer needed
   def self.with_redis
     if redis
       if redis.respond_to?(:with)
@@ -165,6 +196,10 @@ module Searchkick
     end
   end
 
+  def self.warn(message)
+    super("[searchkick] WARNING: #{message}")
+  end
+
   # private
   def self.load_records(records, ids)
     records =
@@ -200,10 +235,44 @@ module Searchkick
   def self.callbacks_value=(value)
     Thread.current[:searchkick_callbacks_enabled] = value
   end
+
+  # private
+  def self.signer_middleware_key
+    defined?(FaradayMiddleware::AwsSignersV4) ? :aws_signers_v4 : :aws_sigv4
+  end
+
+  # private
+  def self.signer_middleware_aws_params
+    if signer_middleware_key == :aws_sigv4
+      {service: "es", region: "us-east-1"}.merge(aws_credentials)
+    else
+      {
+        credentials: aws_credentials[:credentials] || Aws::Credentials.new(aws_credentials[:access_key_id], aws_credentials[:secret_access_key]),
+        service_name: "es",
+        region: aws_credentials[:region] || "us-east-1"
+      }
+    end
+  end
+
+  # private
+  # methods are forwarded to base class
+  # this check to see if scope exists on that class
+  # it's a bit tricky, but this seems to work
+  def self.relation?(klass)
+    if klass.respond_to?(:current_scope)
+      !klass.current_scope.nil?
+    elsif defined?(Mongoid::Threaded)
+      !Mongoid::Threaded.current_scope(klass).nil?
+    end
+  end
 end
 
-# TODO find better ActiveModel hook
-ActiveModel::Callbacks.send(:include, Searchkick::Model)
+require "active_model/callbacks"
+ActiveModel::Callbacks.include(Searchkick::Model)
+# TODO use
+# ActiveSupport.on_load(:mongoid) do
+#   Mongoid::Document::ClassMethods.include Searchkick::Model
+# end
 
 ActiveSupport.on_load(:active_record) do
   extend Searchkick::Model

data/lib/tasks/searchkick.rake

@@ -0,0 +1,34 @@
+namespace :searchkick do
+  desc "reindex a model (specify CLASS)"
+  task reindex: :environment do
+    class_name = ENV["CLASS"]
+    abort "USAGE: rake searchkick:reindex CLASS=Product" unless class_name
+
+    model = class_name.safe_constantize
+    abort "Could not find class: #{class_name}" unless model
+    abort "#{class_name} is not a searchkick model" unless Searchkick.models.include?(model)
+
+    puts "Reindexing #{model.name}..."
+    model.reindex
+    puts "Reindex successful"
+  end
+
+  namespace :reindex do
+    desc "reindex all models"
+    task all: :environment do
+      # eager load models to populate Searchkick.models
+      if Rails.respond_to?(:autoloaders) && Rails.autoloaders.zeitwerk_enabled?
+        # fix for https://github.com/rails/rails/issues/37006
+        Zeitwerk::Loader.eager_load_all
+      else
+        Rails.application.eager_load!
+      end
+
+      Searchkick.models.each do |model|
+        puts "Reindexing #{model.name}..."
+        model.reindex
+      end
+      puts "Reindex complete"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 4.4.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-09 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -52,66 +52,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Intelligent search made easy
-email:
-- andrew@chartkick.com
+description: 
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmark/Gemfile
-- benchmark/benchmark.rb
 - lib/searchkick.rb
+- lib/searchkick/bulk_indexer.rb
 - lib/searchkick/bulk_reindex_job.rb
+- lib/searchkick/hash_wrapper.rb
 - lib/searchkick/index.rb
 - lib/searchkick/index_options.rb
 - lib/searchkick/indexer.rb
@@ -122,59 +75,14 @@ files:
 - lib/searchkick/process_batch_job.rb
 - lib/searchkick/process_queue_job.rb
 - lib/searchkick/query.rb
+- lib/searchkick/railtie.rb
+- lib/searchkick/record_data.rb
+- lib/searchkick/record_indexer.rb
 - lib/searchkick/reindex_queue.rb
 - lib/searchkick/reindex_v2_job.rb
 - lib/searchkick/results.rb
-- lib/searchkick/tasks.rb
 - lib/searchkick/version.rb
-- searchkick.gemspec
-- test/aggs_test.rb
-- test/autocomplete_test.rb
-- test/boost_test.rb
-- test/callbacks_test.rb
-- test/ci/before_install.sh
-- test/errors_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
-- test/gemfiles/activerecord41.gemfile
-- test/gemfiles/activerecord42.gemfile
-- test/gemfiles/activerecord50.gemfile
-- test/gemfiles/apartment.gemfile
-- test/gemfiles/cequel.gemfile
-- test/gemfiles/mongoid2.gemfile
-- test/gemfiles/mongoid3.gemfile
-- test/gemfiles/mongoid4.gemfile
-- test/gemfiles/mongoid5.gemfile
-- test/gemfiles/mongoid6.gemfile
-- test/gemfiles/nobrainer.gemfile
-- test/gemfiles/parallel_tests.gemfile
-- test/geo_shape_test.rb
-- test/highlight_test.rb
-- test/index_test.rb
-- test/inheritance_test.rb
-- test/marshal_test.rb
-- test/match_test.rb
-- test/misspellings_test.rb
-- test/model_test.rb
-- test/multi_search_test.rb
-- test/multi_tenancy_test.rb
-- test/order_test.rb
-- test/pagination_test.rb
-- test/partial_reindex_test.rb
-- test/query_test.rb
-- test/records_test.rb
-- test/reindex_test.rb
-- test/reindex_v2_job_test.rb
-- test/routing_test.rb
-- test/should_index_test.rb
-- 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
+- lib/tasks/searchkick.rake
 homepage: https://github.com/ankane/searchkick
 licenses:
 - MIT
@@ -187,67 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Searchkick learns what your users are looking for. As more people search,
-  it gets smarter and the results get better. It’s friendly for developers - and magical
-  for your users.
-test_files:
-- benchmark/Gemfile
-- benchmark/benchmark.rb
-- test/aggs_test.rb
-- test/autocomplete_test.rb
-- test/boost_test.rb
-- test/callbacks_test.rb
-- test/ci/before_install.sh
-- test/errors_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
-- test/gemfiles/activerecord41.gemfile
-- test/gemfiles/activerecord42.gemfile
-- test/gemfiles/activerecord50.gemfile
-- test/gemfiles/apartment.gemfile
-- test/gemfiles/cequel.gemfile
-- test/gemfiles/mongoid2.gemfile
-- test/gemfiles/mongoid3.gemfile
-- test/gemfiles/mongoid4.gemfile
-- test/gemfiles/mongoid5.gemfile
-- test/gemfiles/mongoid6.gemfile
-- test/gemfiles/nobrainer.gemfile
-- test/gemfiles/parallel_tests.gemfile
-- test/geo_shape_test.rb
-- test/highlight_test.rb
-- test/index_test.rb
-- test/inheritance_test.rb
-- test/marshal_test.rb
-- test/match_test.rb
-- test/misspellings_test.rb
-- test/model_test.rb
-- test/multi_search_test.rb
-- test/multi_tenancy_test.rb
-- test/order_test.rb
-- test/pagination_test.rb
-- test/partial_reindex_test.rb
-- test/query_test.rb
-- test/records_test.rb
-- test/reindex_test.rb
-- test/reindex_v2_job_test.rb
-- test/routing_test.rb
-- test/should_index_test.rb
-- 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
+summary: Intelligent search made easy with Rails and Elasticsearch
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-*.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.log
-.DS_Store
-.ruby-*
-.idea/
-*.sqlite3

data/.travis.yml

@@ -1,39 +0,0 @@
-sudo: false
-language: ruby
-rvm: 2.3.1
-services:
-  - mongodb
-  - redis-server
-before_install:
-  - ./test/ci/before_install.sh
-script: bundle exec rake test
-before_script:
-  - psql -c 'create database searchkick_test;' -U postgres
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-gemfile:
-  - Gemfile
-  - test/gemfiles/activerecord50.gemfile
-  - test/gemfiles/activerecord42.gemfile
-  - test/gemfiles/mongoid5.gemfile
-  - test/gemfiles/mongoid6.gemfile
-env:
-  - ELASTICSEARCH_VERSION=5.5.0
-jdk: oraclejdk8
-matrix:
-  include:
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=2.0.0
-      jdk: oraclejdk7
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=2.4.3
-      jdk: oraclejdk7
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=5.0.1
-      jdk: oraclejdk8
-  allow_failures:
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=6.0.0-beta1
-      jdk: oraclejdk8

data/Gemfile

@@ -1,16 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in searchkick.gemspec
-gemspec
-
-gem "sqlite3"
-gem "activerecord", "~> 5.1.0"
-gem "gemoji-parser"
-gem "typhoeus"
-gem "activejob"
-gem "redis"
-gem "connection_pool"
-
-# kaminari
-gem "actionpack"
-gem "kaminari"

data/Rakefile

@@ -1,20 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-begin
-  require "parallel_tests/tasks"
-  require "shellwords"
-rescue LoadError
-  # do nothing
-end
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.warning = false
-end
-
-task :benchmark do
-  require_relative "benchmark/benchmark"
-end