chewy 0.9.0 → 0.10.0

data/chewy.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'chewy/version'
@@ -28,12 +29,12 @@ Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.add_development_dependency 'elasticsearch-extensions'
   spec.add_development_dependency 'resque_spec'
   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 'rubocop', '0.48.1'
 
   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', '>= 4.0'
+  spec.add_dependency 'elasticsearch', '>= 2.0.0'
+  spec.add_dependency 'elasticsearch-dsl'
 end

data/gemfiles/rails.4.0.activerecord.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari", "~> 0.17.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.4.1.activerecord.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari", "~> 0.17.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.4.2.activerecord.gemfile

@@ -5,13 +5,11 @@ source "https://rubygems.org"
 gem "activerecord", "~> 4.2.0"
 gem "activesupport", "~> 4.2.0"
 gem "activejob", "~> 4.2.0"
-gem "resque", :require => false
-gem "sidekiq", :require => false
-
-group :test do
-  gem "guard"
-  gem "guard-rspec"
-  gem "listen", "~> 3.0.0"
-end
-
-gemspec :path => "../"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari", "~> 0.17.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.4.2.mongoid.5.1.gemfile

@@ -4,13 +4,12 @@ source "https://rubygems.org"
 
 gem "mongoid", "~> 5.1.0"
 gem "activesupport", "~> 4.2.0"
-gem "resque", :require => false
-gem "sidekiq", :require => false
-
-group :test do
-  gem "guard"
-  gem "guard-rspec"
-  gem "listen", "~> 3.0.0"
-end
-
-gemspec :path => "../"
+gem "activejob", "~> 4.2.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari", "~> 0.17.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.5.0.activerecord.gemfile

@@ -5,13 +5,11 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.0.0"
 gem "activesupport", "~> 5.0.0"
 gem "activejob", "~> 5.0.0"
-gem "resque", :require => false
-gem "sidekiq", :require => false
-
-group :test do
-  gem "guard"
-  gem "guard-rspec"
-  gem "listen", "~> 3.0.0"
-end
-
-gemspec :path => "../"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.0.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.5.0.mongoid.6.0.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 6.0.0"
+gem "activesupport", "~> 5.0.0"
+gem "activejob", "~> 5.0.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.0.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.5.1.activerecord.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+gem "activesupport", "~> 5.1.0"
+gem "activejob", "~> 5.1.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.0.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

data/gemfiles/rails.5.1.mongoid.6.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 6.1.0"
+gem "activesupport", "~> 5.1.0"
+gem "activejob", "~> 5.1.0"
+gem "resque", require: false
+gem "shoryuken", require: false
+gem "sidekiq", require: false
+gem "kaminari-core", "~> 1.0.0", require: false
+gem "will_paginate", require: false
+gem "parallel", require: false
+
+gemspec path: "../"

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.0.0"
+gem "kaminari-core", "~> 1.0.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'
@@ -19,6 +20,28 @@ require 'singleton'
 
 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 +57,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 +69,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 +82,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
 
@@ -152,7 +165,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 +215,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/config.rb

@@ -40,7 +40,29 @@ module Chewy
 
       # 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,
+
+      # 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 +75,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 = 'string'.freeze
+      self.search_class = Chewy::Search::Request
     end
 
     def transport_logger=(logger)
@@ -66,6 +94,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
@@ -117,11 +149,6 @@ 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
@@ -131,11 +158,21 @@ module Chewy
 
           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.include Chewy::Search::Pagination::Kaminari
+        elsif defined?(::WillPaginate)
+          search_class.include Chewy::Search::Pagination::WillPaginate
+        end
+      end
+    end
   end
 end