chewy 0.9.0 → 5.2.0

data/chewy.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'chewy/version'
@@ -6,8 +5,8 @@ require 'chewy/version'
 Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.name          = 'chewy'
   spec.version       = Chewy::VERSION
-  spec.authors       = ['pyromaniac']
-  spec.email         = ['kinwizard@gmail.com']
+  spec.authors       = ['Toptal, LLC', 'pyromaniac']
+  spec.email         = ['open-source@toptal.com', 'kinwizard@gmail.com']
   spec.summary       = 'Elasticsearch ODM client wrapper'
   spec.description   = 'Chewy provides functionality for Elasticsearch index handling, documents import mappings and chainable query DSL'
   spec.homepage      = 'https://github.com/toptal/chewy'
@@ -18,22 +17,22 @@ Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rspec-collection_matchers'
-  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'elasticsearch-extensions'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'resque_spec'
+  spec.add_development_dependency 'rspec', '>= 3.7.0'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop', '0.52.1'
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubysl', '~> 2.0' if RUBY_ENGINE == 'rbx'
 
   spec.add_development_dependency 'method_source'
   spec.add_development_dependency 'unparser'
 
-  spec.add_dependency 'activesupport', '>= 3.2'
-  spec.add_dependency 'elasticsearch', '>= 1.0.0'
+  spec.add_dependency 'activesupport', '>= 5.2'
+  spec.add_dependency 'elasticsearch', '>= 2.0.0'
+  spec.add_dependency 'elasticsearch-dsl'
 end

data/gemfiles/rails.5.2.activerecord.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+gem "activejob", "~> 5.2.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "aws-sdk-sqs", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.1.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+gem 'rspec_junit_formatter', '~> 0.4.1'
+
+gemspec path: "../"

data/gemfiles/rails.5.2.mongoid.6.4.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 6.4.0"
+gem "activesupport", "~> 5.2.0"
+gem "activejob", "~> 5.2.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "aws-sdk-sqs", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.1.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+gem 'rspec_junit_formatter', '~> 0.4.1'
+
+gemspec path: "../"

data/gemfiles/rails.6.0.activerecord.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+gem "activejob", "~> 6.0.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "aws-sdk-sqs", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.1.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+gem 'rspec_junit_formatter', '~> 0.4.1'
+
+gemspec path: "../"

data/gemfiles/rails.6.1.activerecord.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "activejob", "~> 6.1.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "aws-sdk-sqs", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.1.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+gem 'rspec_junit_formatter', '~> 0.4.1'
+
+eval(File.read('gemfiles/ruby3.gemfile'), nil, 'gemfiles/ruby3.gemfile') if RUBY_VERSION >= '3.0.0'
+
+gemspec path: "../"

data/gemfiles/ruby3.gemfile

@@ -0,0 +1,10 @@
+# kwargs support was added here:
+#   https://github.com/rspec/rspec-mocks/blob/main/lib/rspec/mocks/method_double.rb#L66
+# but this change was not released yet so for the time being use main branch
+gem 'rspec', github: 'rspec/rspec', branch: 'main'
+gem 'rspec-core', github: 'rspec/rspec-core', branch: 'main'
+gem 'rspec-expectations', github: 'rspec/rspec-expectations', branch: 'main'
+gem 'rspec-mocks', github: 'rspec/rspec-mocks', branch: 'main'
+gem 'rspec-support', github: 'rspec/rspec-support', branch: 'main'
+# extracted from stdlib
+gem 'rexml'

data/gemfiles/sequel.4.45.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sequel", "~> 4.45.0"
+gem "activesupport", "~> 5.1.0"
+gem "kaminari-core", "~> 1.1.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/lib/chewy.rb

@@ -1,3 +1,4 @@
+require 'active_support/version'
 require 'active_support/concern'
 require 'active_support/deprecation'
 require 'active_support/json'
@@ -16,9 +17,32 @@ require 'active_support/core_ext/string/inflections'
 require 'i18n/core_ext/hash'
 require 'chewy/backports/deep_dup' unless Object.respond_to?(:deep_dup)
 require 'singleton'
+require 'base64'
 
 require 'elasticsearch'
 
+def try_require(path)
+  require path
+rescue LoadError
+  nil
+end
+
+try_require 'kaminari'
+try_require 'kaminari/core'
+try_require 'will_paginate'
+try_require 'will_paginate/collection'
+try_require 'parallel'
+
+ActiveSupport.on_load(:active_record) do
+  try_require 'will_paginate/active_record'
+  try_require 'kaminari/activerecord'
+end
+
+ActiveSupport.on_load(:mongoid) do
+  try_require 'will_paginate/mongoid'
+  try_require 'kaminari/mongoid'
+end
+
 require 'chewy/version'
 require 'chewy/errors'
 require 'chewy/config'
@@ -34,29 +58,8 @@ require 'chewy/fields/root'
 require 'chewy/journal'
 require 'chewy/railtie' if defined?(::Rails::Railtie)
 
-begin
-  require 'kaminari'
-  require 'chewy/query/pagination/kaminari'
-rescue LoadError
-  nil
-end
-
-begin
-  require 'will_paginate'
-  require 'will_paginate/collection'
-  require 'chewy/query/pagination/will_paginate'
-rescue LoadError
-  nil
-end
-
 ActiveSupport.on_load(:active_record) do
   extend Chewy::Type::Observe::ActiveRecordMethods
-
-  begin
-    require 'will_paginate/active_record'
-  rescue LoadError
-    nil
-  end
 end
 
 ActiveSupport.on_load(:mongoid) do
@@ -67,13 +70,6 @@ ActiveSupport.on_load(:mongoid) do
       end
     end
   end
-
-  begin
-    require 'will_paginate/mongoid'
-    require 'chewy/query/pagination/will_paginate'
-  rescue LoadError
-    nil
-  end
 end
 
 module Chewy
@@ -87,29 +83,47 @@ module Chewy
   class << self
     attr_accessor :adapters
 
-    # Derives type from string `index#type` representation:
-    #
-    #   Chewy.derive_type('users#user') # => UsersIndex::User
-    #
-    # If index has only one type - it is possible to derive it without specification:
+    # Derives a single type for the passed string identifier if possible.
     #
-    #   Chewy.derive_type('users') # => UsersIndex::User
-    #
-    # If index has more then one type - it raises Chewy::UnderivableType.
+    # @example
+    #   Chewy.derive_types(UsersIndex::User) # => UsersIndex::User
+    #   Chewy.derive_types('namespace/users') # => Namespace::UsersIndex::User
+    #   Chewy.derive_types('places') # => raises Chewy::UnderivableType
+    #   Chewy.derive_types('places#city') # => PlacesIndex::City
     #
+    # @param name [String, Chewy::Type] string type identifier
+    # @raise [Chewy::UnderivableType] in cases when it is impossble to find index or type or more than one type found
+    # @return [Chewy::Type] an array of derived types
     def derive_type(name)
       return name if name.is_a?(Class) && name < Chewy::Type
 
-      index_name, type_name = name.split('#', 2)
-      class_name = "#{index_name.camelize}Index"
+      types = derive_types(name)
+      raise Chewy::UnderivableType, "Index `#{types.first.index}` has more than one type, please specify type via `#{types.first.index.derivable_name}#type_name`" unless types.one?
+      types.first
+    end
+
+    # Derives all the types for the passed string identifier if possible.
+    #
+    # @example
+    #   Chewy.derive_types('namespace/users') # => [Namespace::UsersIndex::User]
+    #   Chewy.derive_types('places') # => [PlacesIndex::City, PlacesIndex::Country]
+    #   Chewy.derive_types('places#city') # => [PlacesIndex::City]
+    #
+    # @param from [String] string type identifier
+    # @raise [Chewy::UnderivableType] in cases when it is impossible to find index or type
+    # @return [Array<Chewy::Type>] an array of derived types
+    def derive_types(from)
+      return from.types if from.is_a?(Class) && (from < Chewy::Index || from < Chewy::Type)
+
+      index_name, type_name = from.split('#', 2)
+      class_name = "#{index_name.camelize.gsub(/Index\z/, '')}Index"
       index = class_name.safe_constantize
       raise Chewy::UnderivableType, "Can not find index named `#{class_name}`" unless index && index < Chewy::Index
       if type_name.present?
-        index.type_hash[type_name] or raise Chewy::UnderivableType, "Index `#{class_name}` doesn`t have type named `#{type_name}`"
-      elsif index.types.one?
-        index.types.first
+        type = index.type_hash[type_name] or raise Chewy::UnderivableType, "Index `#{class_name}` doesn`t have type named `#{type_name}`"
+        [type]
       else
-        raise Chewy::UnderivableType, "Index `#{class_name}` has more than one type, please specify type via `#{index_name}#type_name`"
+        index.types
       end
     end
 
@@ -118,7 +132,7 @@ module Chewy
     def create_type(index, target, options = {}, &block)
       type = Class.new(Chewy::Type)
 
-      adapter = adapters.find { |klass| klass.accepts?(target) }.new(target, options)
+      adapter = adapters.find { |klass| klass.accepts?(target) }.new(target, **options)
 
       index.const_set(adapter.name, type)
       type.send(:define_singleton_method, :index) { index }
@@ -152,7 +166,7 @@ module Chewy
     # Be careful, if current prefix is blank, this will destroy all the indexes.
     #
     def massacre
-      Chewy.client.indices.delete(index: [Chewy.configuration[:prefix], '*'].delete_if(&:blank?).join('_'))
+      Chewy.client.indices.delete(index: [Chewy.configuration[:prefix], '*'].reject(&:blank?).join('_'))
       Chewy.wait_for_status
     end
     alias_method :delete_all, :massacre
@@ -202,5 +216,26 @@ module Chewy
       Chewy::Repository.instance
     end
     delegate(*Chewy::Repository.delegated, to: :repository)
+
+    def create_indices
+      Chewy::Index.descendants.each(&:create)
+    end
+
+    def create_indices!
+      Chewy::Index.descendants.each(&:create!)
+    end
+
+    def eager_load!
+      return unless defined?(Chewy::Railtie)
+      dirs = Chewy::Railtie.all_engines.map { |engine| engine.paths[Chewy.configuration[:indices_path]] }.compact.map(&:existent).flatten.uniq
+
+      dirs.each do |dir|
+        Dir.glob(File.join(dir, '**/*.rb')).each do |file|
+          require_dependency file
+        end
+      end
+    end
   end
 end
+
+require 'chewy/stash'

data/lib/chewy/backports/duplicable.rb

@@ -79,7 +79,7 @@ end
 require 'bigdecimal'
 class BigDecimal
   begin
-    BigDecimal.new('4.56').dup
+    BigDecimal('4.56').dup
 
     def duplicable?
       true

data/lib/chewy/config.rb

@@ -2,45 +2,56 @@ module Chewy
   class Config
     include Singleton
 
-    attr_accessor :settings, :transport_logger, :transport_tracer, :logger,
-
+    attr_accessor :settings, :logger,
       # Default query compilation mode. `:must` by default.
       # See Chewy::Query#query_mode for details
       #
       :query_mode,
-
       # Default filters compilation mode. `:and` by default.
       # See Chewy::Query#filter_mode for details
       #
       :filter_mode,
-
       # Default post_filters compilation mode. `nil` by default.
       # See Chewy::Query#post_filter_mode for details
       #
       :post_filter_mode,
-
       # The first strategy in stack. `:base` by default.
       # If you need to return to the previous chewy behavior -
       # just set it to `:bypass`
       #
       :root_strategy,
-
       # Default request strategy middleware, used in e.g
       # Rails controllers. See Chewy::Railtie::RequestStrategy
       # for more info.
       #
       :request_strategy,
-
       # Use after_commit callbacks for RDBMS instead of
       # after_save and after_destroy. True by default. Useful
       # in tests with transactional fixtures or transactional
       # DatabaseCleaner strategy.
       #
       :use_after_commit_callbacks,
-
       # Where Chewy expects to find index definitions
       # within a Rails app folder.
-      :indices_path
+      :indices_path,
+      # Set index refresh_interval setting to -1 before reset and put the original value after.
+      # If setting not present, put back to default 1s
+      # https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
+      :reset_disable_refresh_interval,
+      # Set number_of_replicas to 0 before reset and put the original value after
+      # https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
+      :reset_no_replicas,
+      # Refresh or not when import async (sidekiq, resque, activejob)
+      :disable_refresh_async,
+      # Default options for root of Chewy type. Allows to set default options
+      # for type mappings like `_all`.
+      :default_root_options,
+      # Default field type for any field in any Chewy type. Defaults to 'string'.
+      :default_field_type
+
+    attr_reader :transport_logger, :transport_tracer,
+      # Chewy search request DSL base class, used by every index.
+      :search_class
 
     def self.delegated
       public_instance_methods - superclass.public_instance_methods - Singleton.public_instance_methods
@@ -53,7 +64,13 @@ module Chewy
       @root_strategy = :base
       @request_strategy = :atomic
       @use_after_commit_callbacks = true
+      @reset_disable_refresh_interval = false
+      @reset_no_replicas = false
+      @disable_refresh_async = false
       @indices_path = 'app/chewy'
+      @default_root_options = {}
+      @default_field_type = 'text'.freeze
+      self.search_class = Chewy::Search::Request
     end
 
     def transport_logger=(logger)
@@ -66,6 +83,10 @@ module Chewy
       @transport_tracer = tracer
     end
 
+    def search_class=(base)
+      @search_class = build_search_class(base)
+    end
+
     # Chewy core configurations. There is two ways to set it up:
     # use `Chewy.settings=` method or, for Rails application,
     # create `config/chewy.yml` file. Btw, `config/chewy.yml` supports
@@ -92,7 +113,7 @@ module Chewy
     #
     #      :wait_for_status - if this option set - chewy actions such
     #      as creating or deleting index, importing data will wait for
-    #      the status specified. Extremely useful for tests under havy
+    #      the status specified. Extremely useful for tests under heavy
     #      indexes manipulations.
     #
     #        test:
@@ -117,25 +138,30 @@ module Chewy
       end
     end
 
-    def configuration=(options)
-      ActiveSupport::Deprecation.warn("`Chewy.configuration = {foo: 'bar'}` method is deprecated and will be removed soon, use `Chewy.settings = {foo: 'bar'}` method instead")
-      self.settings = options
-    end
-
   private
 
     def yaml_settings
       @yaml_settings ||= begin
-        if defined?(Rails)
+        if defined?(Rails::VERSION)
           file = Rails.root.join('config', 'chewy.yml')
 
           if File.exist?(file)
             yaml = ERB.new(File.read(file)).result
-            hash = YAML.load(yaml)
+            hash = YAML.load(yaml) # rubocop:disable Security/YAMLLoad
             hash[Rails.env].try(:deep_symbolize_keys) if hash
           end
         end || {}
       end
     end
+
+    def build_search_class(base)
+      Class.new(base).tap do |search_class|
+        if defined?(::Kaminari)
+          search_class.send :include, Chewy::Search::Pagination::Kaminari
+        elsif defined?(::WillPaginate)
+          search_class.send :include, Chewy::Search::Pagination::WillPaginate
+        end
+      end
+    end
   end
 end