chewy 5.0.0 → 7.0.1

data/lib/chewy.rb

@@ -132,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 }

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

@@ -3,18 +3,6 @@ module Chewy
     include Singleton
 
     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`
@@ -46,7 +34,7 @@ module Chewy
       # 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 for any field in any Chewy type. Defaults to 'text'.
       :default_field_type
 
     attr_reader :transport_logger, :transport_tracer,
@@ -59,8 +47,6 @@ module Chewy
 
     def initialize
       @settings = {}
-      @query_mode = :must
-      @filter_mode = :and
       @root_strategy = :base
       @request_strategy = :atomic
       @use_after_commit_callbacks = true
@@ -70,7 +56,7 @@ module Chewy
       @indices_path = 'app/chewy'
       @default_root_options = {}
       @default_field_type = 'text'.freeze
-      self.search_class = Chewy::Search::Request
+      @search_class = build_search_class(Chewy::Search::Request)
     end
 
     def transport_logger=(logger)
@@ -83,10 +69,6 @@ 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

data/lib/chewy/fields/base.rb

@@ -7,7 +7,7 @@ module Chewy
       def initialize(name, value: nil, **options)
         @name = name.to_sym
         @options = {}
-        update_options!(options)
+        update_options!(**options)
         @value = value
         @children = []
       end
@@ -34,12 +34,6 @@ module Chewy
         mapping.reverse_merge!(options)
         mapping.reverse_merge!(type: (children.present? ? 'object' : Chewy.default_field_type))
 
-        # This is done to support ES2 journaling and will be removed soon
-        if mapping[:type] == 'keyword' && Chewy::Runtime.version < '5.0'
-          mapping[:type] = 'string'
-          mapping[:index] = 'not_analyzed'
-        end
-
         {name => mapping}
       end
 

data/lib/chewy/fields/root.rb

@@ -6,8 +6,8 @@ module Chewy
       attr_reader :parent
       attr_reader :parent_id
 
-      def initialize(*)
-        super
+      def initialize(name, **options)
+        super(name, **options)
 
         @value ||= -> { self }
         @dynamic_templates = []

data/lib/chewy/index.rb

@@ -146,6 +146,8 @@ module Chewy
       # passed.
       #
       def define_type(target, options = {}, &block)
+        raise 'Multiple types are deprecated' if type_hash.present?
+
         type_class = Chewy.create_type(self, target, options, &block)
         self.type_hash = type_hash.merge(type_class.type_name => type_class)
       end

data/lib/chewy/index/actions.rb

@@ -30,8 +30,8 @@ module Chewy
         # Suffixed index names might be used for zero-downtime mapping change, for example.
         # Description: (http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/).
         #
-        def create(*args)
-          create!(*args)
+        def create(*args, **kwargs)
+          create!(*args, **kwargs)
         rescue Elasticsearch::Transport::Transport::Errors::BadRequest
           false
         end
@@ -59,7 +59,9 @@ module Chewy
 
           body = specification_hash
           body[:aliases] = {general_name => {}} if options[:alias] && suffixed_name != general_name
-          result = client.indices.create(index: suffixed_name, body: body)
+          args = {index: suffixed_name, body: body}
+          args[:include_type_name] = true if Runtime.version >= '6.7.0'
+          result = client.indices.create(**args)
 
           Chewy.wait_for_status if result
           result
@@ -74,7 +76,13 @@ module Chewy
         #   UsersIndex.delete '01-2014' # deletes `users_01-2014` index
         #
         def delete(suffix = nil)
-          result = client.indices.delete index: index_name(suffix: suffix)
+          # Verify that the index_name is really the index_name and not an alias.
+          #
+          #   "The index parameter in the delete index API no longer accepts alias names.
+          #   Instead, it accepts only index names (or wildcards which will expand to matching indices)."
+          #   https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes-6.0.html#_delete_index_api_resolves_indices_expressions_only_against_indices
+          index_names = client.indices.get_alias(index: index_name(suffix: suffix)).keys
+          result = client.indices.delete index: index_names.join(',')
           Chewy.wait_for_status if result
           result
           # es-ruby >= 1.0.10 handles Elasticsearch::Transport::Transport::Errors::NotFound
@@ -136,6 +144,8 @@ module Chewy
         %i[import import!].each do |method|
           class_eval <<-METHOD, __FILE__, __LINE__ + 1
             def #{method}(*args)
+              return true if args.first.blank? && !args.first.nil?
+
               options = args.extract_options!
               if args.one? && type_names.one?
                 objects = {type_names.first.to_sym => args.first}
@@ -172,7 +182,7 @@ module Chewy
         def reset!(suffix = nil, apply_journal: true, journal: false, **import_options)
           result = if suffix.present?
             start_time = Time.now
-            indexes = self.indexes
+            indexes = self.indexes - [index_name]
             create! suffix, alias: false
 
             general_name = index_name

data/lib/chewy/index/aliases.rb

@@ -5,14 +5,25 @@ module Chewy
 
       module ClassMethods
         def indexes
-          client.indices.get_alias(name: index_name).keys
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          []
+          get_args = {index: index_name}
+          get_args[:include_type_name] = true if Runtime.version >= '6.7.0'
+          indexes = empty_if_not_found { client.indices.get(**get_args).keys }
+          indexes += empty_if_not_found { client.indices.get_alias(name: index_name).keys }
+          indexes.compact.uniq
         end
 
         def aliases
-          name = index_name
-          client.indices.get_alias(index: name, name: '*')[name].try(:[], 'aliases').try(:keys) || []
+          empty_if_not_found do
+            client.indices.get_alias(index: index_name, name: '*').values.flat_map do |aliases|
+              aliases['aliases'].keys
+            end
+          end.compact.uniq
+        end
+
+      private
+
+        def empty_if_not_found
+          yield
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           []
         end

data/lib/chewy/multi_search.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Chewy
+  # `Chewy::MultiSearch` provides an interface for executing multiple
+  # queries via the Elasticsearch Multi Search API. When a MultiSearch
+  # is performed it wraps the responses from Elasticsearch and assigns
+  # them to the appropriate queries.
+  class MultiSearch
+    attr_reader :queries
+
+    # Instantiate a new MultiSearch instance.
+    #
+    # @param queries [Array<Chewy::Search::Request>]
+    # @option [Elasticsearch::Transport::Client] :client (Chewy.client)
+    #   The Elasticsearch client that should be used for issuing requests.
+    def initialize(queries, client: Chewy.client)
+      @client = client
+      @queries = Array(queries)
+    end
+
+    # Adds a query to be performed by the MultiSearch
+    #
+    # @param query [Chewy::Search::Request]
+    def add_query(query)
+      @queries << query
+    end
+
+    # Performs any unperformed queries and returns the responses for all queries.
+    #
+    # @return [Array<Chewy::Search::Response>]
+    def responses
+      perform
+      queries.map(&:response)
+    end
+
+    # Performs any unperformed queries.
+    def perform
+      unperformed_queries = queries.reject(&:performed?)
+      return if unperformed_queries.empty?
+
+      responses = msearch(unperformed_queries)['responses']
+      unperformed_queries.zip(responses).map { |query, response| query.response = response }
+    end
+
+  private
+
+    attr_reader :client
+
+    def msearch(queries_to_search)
+      body = queries_to_search.flat_map do |query|
+        rendered = query.render
+        [rendered.except(:body), rendered[:body]]
+      end
+
+      client.msearch(body: body)
+    end
+  end
+
+  def self.msearch(queries)
+    Chewy::MultiSearch.new(queries)
+  end
+end

data/lib/chewy/railtie.rb

@@ -68,7 +68,7 @@ module Chewy
     end
 
     initializer 'chewy.request_strategy' do |app|
-      app.config.middleware.insert_after(Rails::Rack::Logger, RequestStrategy)
+      app.config.middleware.insert_before(ActionDispatch::ShowExceptions, RequestStrategy)
     end
 
     initializer 'chewy.add_indices_path' do |_app|

data/lib/chewy/search.rb

@@ -1,5 +1,4 @@
 require 'chewy/search/scoping'
-require 'chewy/query'
 require 'chewy/search/scrolling'
 require 'chewy/search/query_proxy'
 require 'chewy/search/parameters'
@@ -15,9 +14,7 @@ module Chewy
   # {Chewy::Type}.
   #
   # The class used as a request DSL provider is
-  # inherited from {Chewy::Search::Request} by default, but if you
-  # need ES < 2.0 DSL support - you can switch it to {Chewy::Query}
-  # using {Chewy::Config#search_class}
+  # inherited from {Chewy::Search::Request}
   #
   # Also, the search class is refined with one of the pagination-
   # providing modules: {Chewy::Search::Pagination::Kaminari} or
@@ -58,11 +55,7 @@ module Chewy
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
       # @return [Hash] the request result
       def search_string(query, options = {})
-        options = options.merge(
-          index: all._indexes.map(&:index_name),
-          type: all._types.map(&:type_name),
-          q: query
-        )
+        options = options.merge(all.render.slice(:index, :type).merge(q: query))
         Chewy.client.search(options)
       end
 

data/lib/chewy/search/loader.rb

@@ -52,7 +52,7 @@ module Chewy
 
           type = derive_type(index_name, type_name)
           ids = hit_group.map { |hit| hit['_id'] }
-          loaded = type.adapter.load(ids, @options.merge(_type: type))
+          loaded = type.adapter.load(ids, **@options.merge(_type: type))
           loaded ||= hit_group.map { |hit| type.build(hit) }
 
           result.merge!(hit_group.zip(loaded).to_h)

data/lib/chewy/search/pagination/will_paginate.rb

@@ -20,7 +20,7 @@ module Chewy
           @page_multiplier = @current_page - 1
           @per_page = (options[:per_page] || @per_page || ::WillPaginate.per_page).to_i
 
-          # call Chewy::Query methods to limit results
+          # call Chewy::Search::Request methods to limit results
           limit(@per_page).offset(@page_multiplier * @per_page)
         end
 

data/lib/chewy/search/parameters.rb

@@ -10,6 +10,8 @@ module Chewy
     # @see Chewy::Search::Request#parameters
     # @see Chewy::Search::Parameters::Storage
     class Parameters
+      QUERY_STRING_STORAGES = %i[indices search_type request_cache allow_partial_search_results].freeze
+
       # Default storage classes warehouse. It is probably possible to
       # add your own classes here if necessary, but I'm not sure it will work.
       #
@@ -33,10 +35,11 @@ module Chewy
       #     limit: Chewy::Search::Parameters::Offset.new(10)
       #   )
       # @param initial [{Symbol => Object, Chewy::Search::Parameters::Storage}]
-      def initialize(initial = {})
+      def initialize(initial = {}, **kinitial)
         @storages = Hash.new do |hash, name|
           hash[name] = self.class.storages[name].new
         end
+        initial = initial.deep_dup.merge(kinitial)
         initial.each_with_object(@storages) do |(name, value), result|
           storage_class = self.class.storages[name]
           storage = value.is_a?(storage_class) ? value : storage_class.new(value)
@@ -101,11 +104,7 @@ module Chewy
       #
       # @return [Hash] request body
       def render
-        body = @storages.except(:filter, :query, :none).values.inject({}) do |result, storage|
-          result.merge!(storage.render || {})
-        end
-        body.merge!(render_query || {})
-        body.present? ? {body: body} : {}
+        render_query_string_params.merge(render_body)
       end
 
     protected
@@ -126,6 +125,25 @@ module Chewy
         names
       end
 
+      def render_query_string_params
+        query_string_storages = @storages.select do |storage_name, _|
+          QUERY_STRING_STORAGES.include?(storage_name)
+        end
+
+        query_string_storages.values.inject({}) do |result, storage|
+          result.merge!(storage.render || {})
+        end
+      end
+
+      def render_body
+        exceptions = %i[filter query none] + QUERY_STRING_STORAGES
+        body = @storages.except(*exceptions).values.inject({}) do |result, storage|
+          result.merge!(storage.render || {})
+        end
+        body.merge!(render_query || {})
+        {body: body}
+      end
+
       def render_query
         none = @storages[:none].render
 

data/lib/chewy/search/parameters/allow_partial_search_results.rb

@@ -0,0 +1,27 @@
+require 'chewy/search/parameters/storage'
+
+module Chewy
+  module Search
+    class Parameters
+      # Stores boolean value, but has 3 states: `true`, `false` and `nil`.
+      #
+      # @see Chewy::Search::Request#allow_partial_search_results
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/6.4/search-request-body.html#_parameters_4
+      class AllowPartialSearchResults < Storage
+        # We don't want to render `nil`, but render `true` and `false` values.
+        #
+        # @see Chewy::Search::Parameters::Storage#render
+        # @return [{Symbol => Object}, nil]
+        def render
+          {self.class.param_name => value} unless value.nil?
+        end
+
+      private
+
+        def normalize(value)
+          !!value unless value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/chewy/search/parameters/indices.rb

@@ -0,0 +1,123 @@
+require 'chewy/search/parameters/storage'
+
+module Chewy
+  module Search
+    class Parameters
+      # Stores indices and/or types to query.
+      # Renders it to lists of string accepted by ElasticSearch
+      # API.
+      #
+      # The semantics behind it can be described in the
+      # following statements:
+      # 1. If index is added to the storage, no matter, a class
+      # or a string/symbol, it gets appended to the list.
+      # 2. If type is added to the storage, it filters out types
+      # assigned via indices.
+      # 3. But when a type class with non-existing index is added,
+      # this index got also added to the list if indices.
+      # 4. In cases when of an index identifier added, type
+      # indetifiers also got appended instead of filtering.
+      class Indices < Storage
+        # Two index storages are equal if they produce the
+        # same output on render.
+        #
+        # @see Chewy::Search::Parameters::Storage#==
+        # @param other [Chewy::Search::Parameters::Storage] any storage instance
+        # @return [true, false] the result of comparision
+        def ==(other)
+          super || other.class == self.class && other.render == render
+        end
+
+        # Just adds types to types and indices to indices.
+        #
+        # @see Chewy::Search::Parameters::Storage#update!
+        # @param other_value [{Symbol => Array<Chewy::Index, Chewy::Type, String, Symbol>}] any acceptable storage value
+        # @return [{Symbol => Array<Chewy::Index, Chewy::Type, String, Symbol>}] updated value
+        def update!(other_value)
+          new_value = normalize(other_value)
+
+          @value = {
+            indices: value[:indices] | new_value[:indices],
+            types: value[:types] | new_value[:types]
+          }
+        end
+
+        # Returns desired index and type names.
+        #
+        # @see Chewy::Search::Parameters::Storage#render
+        # @return [{Symbol => Array<String>}] rendered value with the parameter name
+        def render
+          {
+            index: index_names.uniq.sort,
+            type: type_names.uniq.sort
+          }.reject { |_, v| v.blank? }
+        end
+
+        # Returns index classes used for the request.
+        # No strings/symbos included.
+        #
+        # @return [Array<Chewy::Index>] a list of index classes
+        def indices
+          index_classes | type_classes.map(&:index)
+        end
+
+        # Returns type classes used for the request.
+        # No strings/symbos included.
+        #
+        # @return [Array<Chewy::Type>] a list of types classes
+        def types
+          type_classes | (index_classes - type_classes.map(&:index)).flat_map(&:types)
+        end
+
+      private
+
+        def initialize_clone(origin)
+          @value = origin.value.dup
+        end
+
+        def normalize(value)
+          value ||= {}
+
+          {
+            indices: Array.wrap(value[:indices]).flatten.compact,
+            types: Array.wrap(value[:types]).flatten.compact
+          }
+        end
+
+        def index_classes
+          value[:indices].select do |klass|
+            klass.is_a?(Class) && klass < Chewy::Index
+          end
+        end
+
+        def index_identifiers
+          value[:indices] - index_classes
+        end
+
+        def index_names
+          indices.map(&:index_name) | index_identifiers.map(&:to_s)
+        end
+
+        def type_classes
+          value[:types].select do |klass|
+            klass.is_a?(Class) && klass < Chewy::Type
+          end
+        end
+
+        def type_identifiers
+          value[:types] - type_classes
+        end
+
+        def type_names
+          type_names = types.map(&:type_name)
+
+          if index_identifiers.blank? && type_identifiers.present?
+            (type_names & type_identifiers.map(&:to_s)).presence || type_names
+          else
+            type_names | type_identifiers.map(&:to_s)
+          end
+        end
+      end
+    end
+  end
+end