elasticsearch-model 7.0.0.pre → 7.1.2.pre

data/lib/elasticsearch/model/adapters/active_record.rb

@@ -102,7 +102,7 @@ module Elasticsearch
             scope = scope.__send__(named_scope) if named_scope
             scope = scope.instance_exec(&query) if query
 
-            scope.find_in_batches(options) do |batch|
+            scope.find_in_batches(**options) do |batch|
               batch = self.__send__(preprocess, batch) if preprocess
               yield(batch) if batch.present?
             end

data/lib/elasticsearch/model/importing.rb

@@ -53,7 +53,29 @@ module Elasticsearch
         #
         # @yield [Hash] Gives the Hash with the Elasticsearch response to the block
         #
-        # @return [Fixnum] Number of errors encountered during importing
+        # @return [Fixnum] default, number of errors encountered during importing
+        # @return [Array<Hash>] if +return+ option is specified to be +"errors"+,
+        #   contains only those failed items in the response +items+ key, e.g.:
+        #
+        #     [
+        #       {
+        #         "index" => {
+        #           "error" => 'FAILED',
+        #           "_index" => "test",
+        #           "_type" => "_doc",
+        #           "_id" => '1',
+        #           "_version" => 1,
+        #           "result" => "foo",
+        #           "_shards" => {
+        #             "total" => 1,
+        #             "successful" => 0,
+        #             "failed" => 1
+        #           },
+        #           "status" => 400
+        #         }
+        #       }
+        #     ]
+        #
         #
         # @example Import all records into the index
         #
@@ -99,20 +121,19 @@ module Elasticsearch
         #
         # @example Update the batch before yielding it
         #
-        #     class Article
-        #       # ...
-        #       def self.enrich(batch)
-        #         batch.each do |item|
-        #           item.metadata = MyAPI.get_metadata(item.id)
-        #         end
-        #         batch
-        #       end
-        #     end
+        #    class Article
+        #      # ...
+        #      def self.enrich(batch)
+        #        batch.each do |item|
+        #          item.metadata = MyAPI.get_metadata(item.id)
+        #        end
+        #        batch
+        #      end
+        #    end
         #
         #    Article.import preprocess: :enrich
         #
-        # @example Return an array of error elements instead of the number of errors, eg.
-        #          to try importing these records again
+        # @example Return an array of error elements instead of the number of errors, e.g. to try importing these records again
         #
         #    Article.import return: 'errors'
         #
@@ -122,6 +143,7 @@ module Elasticsearch
           target_index = options.delete(:index)     || index_name
           target_type  = options.delete(:type)      || document_type
           transform    = options.delete(:transform) || __transform
+          pipeline     = options.delete(:pipeline)
           return_value = options.delete(:return)    || 'count'
 
           unless transform.respond_to?(:call)
@@ -137,10 +159,15 @@ module Elasticsearch
           end
 
           __find_in_batches(options) do |batch|
-            response = client.bulk \
-                         index:   target_index,
-                         type:    target_type,
-                         body:    __batch_to_bulk(batch, transform)
+            params = {
+              index: target_index,
+              type:  target_type,
+              body:  __batch_to_bulk(batch, transform)
+            }
+
+            params[:pipeline] = pipeline if pipeline
+
+            response = client.bulk params
 
             yield response if block_given?
 

data/lib/elasticsearch/model/indexing.rb

@@ -30,7 +30,7 @@ module Elasticsearch
     #
     module Indexing
 
-      # Wraps the [index settings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-configuration.html#configuration-index-settings)
+      # Wraps the [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)
       #
       class Settings
         attr_accessor :settings
@@ -48,7 +48,7 @@ module Elasticsearch
         end
       end
 
-      # Wraps the [index mappings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html)
+      # Wraps the [index mappings](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)
       #
       class Mappings
         attr_accessor :options, :type
@@ -270,7 +270,7 @@ module Elasticsearch
         def index_exists?(options={})
           target_index = options[:index] || self.index_name
 
-          self.client.indices.exists(index: target_index) rescue false
+          self.client.indices.exists(index: target_index, ignore: 404)
         end
 
         # Deletes the index with corresponding name
@@ -308,7 +308,7 @@ module Elasticsearch
         #
         #     Article.__elasticsearch__.refresh_index! index: 'my-index'
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
         #
         def refresh_index!(options={})
           target_index = options.delete(:index) || self.index_name
@@ -338,13 +338,17 @@ module Elasticsearch
           #
           # @see #update_document
           #
-          base.before_save do |i|
-            if i.class.instance_methods.include?(:changes_to_save) # Rails 5.1
-              i.instance_variable_set(:@__changed_model_attributes,
-                                      Hash[ i.changes_to_save.map { |key, value| [key, value.last] } ])
-            elsif i.class.instance_methods.include?(:changes)
-              i.instance_variable_set(:@__changed_model_attributes,
-                                      Hash[ i.changes.map { |key, value| [key, value.last] } ])
+          base.before_save do |obj|
+            if obj.respond_to?(:changes_to_save) # Rails 5.1
+              changes_to_save = obj.changes_to_save
+            elsif obj.respond_to?(:changes)
+              changes_to_save = obj.changes
+            end
+
+            if changes_to_save
+              attrs = obj.instance_variable_get(:@__changed_model_attributes) || {}
+              latest_changes = changes_to_save.inject({}) { |latest_changes, (k,v)| latest_changes.merge!(k => v.last) }
+              obj.instance_variable_set(:@__changed_model_attributes, attrs.merge(latest_changes))
             end
           end if base.respond_to?(:before_save)
         end
@@ -364,14 +368,13 @@ module Elasticsearch
         # @see http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions:index
         #
         def index_document(options={})
-          document = self.as_indexed_json
-
-          client.index(
-            { index: index_name,
-              type:  document_type,
-              id:    self.id,
-              body:  document }.merge(options)
-          )
+          document = as_indexed_json
+          request = { index: index_name,
+                      id:    id,
+                      body:  document }
+          request.merge!(type: document_type) if document_type
+
+          client.index(request.merge!(options))
         end
 
         # Deletes the model instance from the index
@@ -388,11 +391,11 @@ module Elasticsearch
         # @see http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions:delete
         #
         def delete_document(options={})
-          client.delete(
-            { index: index_name,
-              type:  document_type,
-              id:    self.id }.merge(options)
-          )
+          request = { index: index_name,
+                      id:    self.id }
+          request.merge!(type: document_type) if document_type
+
+          client.delete(request.merge!(options))
         end
 
         # Tries to gather the changed attributes of a model instance
@@ -427,12 +430,14 @@ module Elasticsearch
               attributes_in_database
             end
 
-            client.update(
-              { index: index_name,
-                type:  document_type,
-                id:    self.id,
-                body:  { doc: attributes } }.merge(options)
-            ) unless attributes.empty?
+            unless attributes.empty?
+              request = { index: index_name,
+                          id:    self.id,
+                          body:  { doc: attributes } }
+              request.merge!(type: document_type) if document_type
+
+              client.update(request.merge!(options))
+            end
           else
             index_document(options)
           end
@@ -453,12 +458,12 @@ module Elasticsearch
         # @return [Hash] The response from Elasticsearch
         #
         def update_document_attributes(attributes, options={})
-          client.update(
-            { index: index_name,
-              type:  document_type,
-              id:    self.id,
-              body:  { doc: attributes } }.merge(options)
-          )
+          request = { index: index_name,
+                      id:    self.id,
+                      body:  { doc: attributes } }
+          request.merge!(type: document_type) if document_type
+
+          client.update(request.merge!(options))
         end
       end
 

data/lib/elasticsearch/model/multimodel.rb

@@ -85,7 +85,7 @@ module Elasticsearch
       # @return [Array] the list of document types used for retrieving documents
       #
       def document_type
-        models.map { |m| m.document_type }
+        models.map { |m| m.document_type }.compact.presence
       end
 
       # Get the client common for all models

data/lib/elasticsearch/model/naming.rb

@@ -92,16 +92,7 @@ module Elasticsearch
         private
 
           def implicit(prop)
-            value = nil
-
-            if Elasticsearch::Model.settings[:inheritance_enabled]
-              self.ancestors.each do |klass|
-                next if klass == self
-                break if value = klass.respond_to?(prop) && klass.send(prop)
-              end
-            end
-
-            value || self.send("default_#{prop}")
+            self.send("default_#{prop}")
           end
 
           def default_index_name

data/lib/elasticsearch/model/proxy.rb

@@ -19,15 +19,15 @@ module Elasticsearch
   module Model
 
     # This module provides a proxy interfacing between the including class and
-    # {Elasticsearch::Model}, preventing the pollution of the including class namespace.
+    # `Elasticsearch::Model`, preventing the pollution of the including class namespace.
     #
     # The only "gateway" between the model and Elasticsearch::Model is the
-    # `__elasticsearch__` class and instance method.
+    # `#__elasticsearch__` class and instance method.
     #
     # The including class must be compatible with
     # [ActiveModel](https://github.com/rails/rails/tree/master/activemodel).
     #
-    # @example Include the {Elasticsearch::Model} module into an `Article` model
+    # @example Include the `Elasticsearch::Model` module into an `Article` model
     #
     #     class Article < ActiveRecord::Base
     #       include Elasticsearch::Model
@@ -53,21 +53,19 @@ module Elasticsearch
       #       module and the functionality is accessible via the proxy.
       #
       def self.included(base)
+
         base.class_eval do
-          # {ClassMethodsProxy} instance, accessed as `MyModel.__elasticsearch__`
-          #
+
+          # `ClassMethodsProxy` instance, accessed as `MyModel.__elasticsearch__`
           def self.__elasticsearch__ &block
             @__elasticsearch__ ||= ClassMethodsProxy.new(self)
             @__elasticsearch__.instance_eval(&block) if block_given?
             @__elasticsearch__
           end
 
-          # {InstanceMethodsProxy}, accessed as `@mymodel.__elasticsearch__`
-          #
-          def __elasticsearch__ &block
-            @__elasticsearch__ ||= InstanceMethodsProxy.new(self)
-            @__elasticsearch__.instance_eval(&block) if block_given?
-            @__elasticsearch__
+          # Mix the importing module into the `ClassMethodsProxy`
+          self.__elasticsearch__.class_eval do
+            include Adapter.from_class(base).importing_mixin
           end
 
           # Register a callback for storing changed attributes for models which implement
@@ -75,18 +73,28 @@ module Elasticsearch
           #
           # @see http://api.rubyonrails.org/classes/ActiveModel/Dirty.html
           #
-          before_save do |i|
-            if i.class.instance_methods.include?(:changes_to_save) # Rails 5.1
-              a = i.__elasticsearch__.instance_variable_get(:@__changed_model_attributes) || {}
-              i.__elasticsearch__.instance_variable_set(:@__changed_model_attributes,
-                                                        a.merge(Hash[ i.changes_to_save.map { |key, value| [key, value.last] } ]))
-            elsif i.class.instance_methods.include?(:changes)
-              a = i.__elasticsearch__.instance_variable_get(:@__changed_model_attributes) || {}
-              i.__elasticsearch__.instance_variable_set(:@__changed_model_attributes,
-                                                        a.merge(Hash[ i.changes.map { |key, value| [key, value.last] } ]))
+          before_save do |obj|
+            if obj.respond_to?(:changes_to_save) # Rails 5.1
+              changes_to_save = obj.changes_to_save
+            elsif obj.respond_to?(:changes)
+              changes_to_save = obj.changes
+            end
+
+            if changes_to_save
+              attrs = obj.__elasticsearch__.instance_variable_get(:@__changed_model_attributes) || {}
+              latest_changes = changes_to_save.inject({}) { |latest_changes, (k,v)| latest_changes.merge!(k => v.last) }
+              obj.__elasticsearch__.instance_variable_set(:@__changed_model_attributes, attrs.merge(latest_changes))
             end
           end if respond_to?(:before_save)
         end
+
+        # {InstanceMethodsProxy}, accessed as `@mymodel.__elasticsearch__`
+        #
+        def __elasticsearch__ &block
+          @__elasticsearch__ ||= InstanceMethodsProxy.new(self)
+          @__elasticsearch__.instance_eval(&block) if block_given?
+          @__elasticsearch__
+        end
       end
 
       # @overload dup
@@ -130,6 +138,11 @@ module Elasticsearch
       #
       class ClassMethodsProxy
         include Base
+        include Elasticsearch::Model::Client::ClassMethods
+        include Elasticsearch::Model::Naming::ClassMethods
+        include Elasticsearch::Model::Indexing::ClassMethods
+        include Elasticsearch::Model::Searching::ClassMethods
+        include Elasticsearch::Model::Importing::ClassMethods
       end
 
       # A proxy interfacing between Elasticsearch::Model instance methods and model instance methods
@@ -138,6 +151,10 @@ module Elasticsearch
       #
       class InstanceMethodsProxy
         include Base
+        include Elasticsearch::Model::Client::InstanceMethods
+        include Elasticsearch::Model::Naming::InstanceMethods
+        include Elasticsearch::Model::Indexing::InstanceMethods
+        include Elasticsearch::Model::Serializing::InstanceMethods
 
         def klass
           target.class
@@ -153,8 +170,11 @@ module Elasticsearch
         def as_json(options={})
           target.as_json(options)
         end
-      end
 
+        def as_indexed_json(options={})
+          target.respond_to?(:as_indexed_json) ? target.__send__(:as_indexed_json, options) : super
+        end
+      end
     end
   end
 end

data/lib/elasticsearch/model/response/records.rb

@@ -45,7 +45,6 @@ module Elasticsearch
           metaclass.__send__ :include, adapter.records_mixin
 
           self.options = options
-          self
         end
 
         # Returns the hit IDs

data/lib/elasticsearch/model/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Model
-    VERSION = "7.0.0.pre"
+    VERSION = "7.1.2.pre"
   end
 end

data/spec/elasticsearch/model/adapters/active_record/import_spec.rb

@@ -18,7 +18,6 @@
 require 'spec_helper'
 
 describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
-
   before(:all) do
     ActiveRecord::Schema.define(:version => 1) do
       create_table :import_articles do |t|
@@ -43,11 +42,9 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
   end
 
   describe '#import' do
-
     context 'when no search criteria is specified' do
-
       before do
-        10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
+        10.times { |i| ImportArticle.create! title: 'Test', views: i.to_s }
         ImportArticle.import
         ImportArticle.__elasticsearch__.refresh_index!
       end
@@ -58,7 +55,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when batch size is specified' do
-
       before do
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
       end
@@ -82,7 +78,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when a scope is specified' do
-
       before do
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         ImportArticle.import(scope: 'popular', force: true)
@@ -95,7 +90,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when a query is specified' do
-
       before do
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         ImportArticle.import(query: -> { where('views >= 3') })
@@ -108,7 +102,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when there are invalid documents' do
-
       let!(:result) do
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         new_article
@@ -132,7 +125,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when a transform proc is specified' do
-
       before do
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         ImportArticle.import( transform: ->(a) {{ index: { data: { name: a.title, foo: 'BAR' } }}} )
@@ -151,7 +143,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when the model has a default scope' do
-
       around(:all) do |example|
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         ImportArticle.instance_eval { default_scope { where('views > 3') } }
@@ -170,7 +161,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when there is a default scope and a query specified' do
-
       around(:all) do |example|
         10.times { |i| ImportArticle.create! title: 'Test', views: "#{i}" }
         ImportArticle.instance_eval { default_scope { where('views > 3') } }
@@ -189,7 +179,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Importing' do
     end
 
     context 'when the batch is empty' do
-
       before do
         ImportArticle.delete_all
         ImportArticle.import