elasticsearch-model 6.1.1 → 7.1.1

data/lib/elasticsearch/model/indexing.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 
@@ -13,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
@@ -31,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
@@ -39,9 +56,7 @@ module Elasticsearch
         # @private
         TYPES_WITH_EMBEDDED_PROPERTIES = %w(object nested)
 
-        def initialize(type, options={})
-          raise ArgumentError, "`type` is missing" if type.nil?
-
+        def initialize(type = nil, options={})
           @type    = type
           @options = options
           @mapping = {}
@@ -72,7 +87,11 @@ module Elasticsearch
         end
 
         def to_hash
-          { @type.to_sym => @options.merge( properties: @mapping ) }
+          if @type
+            { @type.to_sym => @options.merge( properties: @mapping ) }
+          else
+            @options.merge( properties: @mapping )
+          end
         end
 
         def as_json(options={})
@@ -229,10 +248,12 @@ module Elasticsearch
           delete_index!(options.merge index: target_index) if options[:force]
 
           unless index_exists?(index: target_index)
-            self.client.indices.create index: target_index,
-                                       body: {
-                                         settings: settings,
-                                         mappings: mappings }
+            options.delete(:force)
+            self.client.indices.create({ index: target_index,
+                                         body: {
+                                           settings: settings,
+                                           mappings: mappings }
+                                       }.merge(options))
           end
         end
 
@@ -287,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
@@ -317,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
@@ -343,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
@@ -367,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
@@ -406,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
@@ -432,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

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

data/lib/elasticsearch/model/naming.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 
@@ -75,31 +92,14 @@ module Elasticsearch
         private
 
           def implicit(prop)
-            value = nil
-
-            if Elasticsearch::Model.settings[:inheritance_enabled]
-              self.ancestors.each do |klass|
-                # When Naming is included in Proxy::ClassMethods the actual model
-                # is among its ancestors. We don't want to call the actual model
-                # since it will result in the same call to the same instance of
-                # Proxy::ClassMethods. To prevent this we also skip the ancestor
-                # that is the target.
-                next if klass == self || self.respond_to?(:target) && klass == self.target
-                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
             self.model_name.collection.gsub(/\//, '-')
           end
 
-          def default_document_type
-            DEFAULT_DOC_TYPE
-          end
-
+          def default_document_type; end
       end
 
       module InstanceMethods

data/lib/elasticsearch/model/proxy.rb

@@ -1,16 +1,33 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 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
@@ -36,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
@@ -58,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
@@ -113,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
@@ -121,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
@@ -136,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.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

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

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Response

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

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Response
@@ -31,7 +48,11 @@ module Elasticsearch
         # Returns the total number of hits
         #
         def total
-          response.response['hits']['total']
+          if response.response['hits']['total'].respond_to?(:keys)
+            response.response['hits']['total']['value']
+          else
+            response.response['hits']['total']
+          end
         end
 
         # Returns the max_score