elasticsearch-model 6.1.1 → 7.2.1

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

@@ -1,2 +1,19 @@
+# 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.
+
 require 'elasticsearch/model/response/pagination/kaminari'
 require 'elasticsearch/model/response/pagination/will_paginate'

data/lib/elasticsearch/model/response/records.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
@@ -28,7 +45,6 @@ module Elasticsearch
           metaclass.__send__ :include, adapter.records_mixin
 
           self.options = options
-          self
         end
 
         # Returns the hit IDs

data/lib/elasticsearch/model/response/result.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/results.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
@@ -25,6 +42,7 @@ module Elasticsearch
           response.response['hits']['hits'].map { |hit| Result.new(hit) }
         end
 
+        alias records results
       end
     end
   end

data/lib/elasticsearch/model/response/suggestions.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.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/searching.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/serializing.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/version.rb

@@ -1,5 +1,22 @@
+# 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
-    VERSION = '6.1.1'
+    VERSION = "7.2.1"
   end
 end

data/lib/elasticsearch/model.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.
+
 require 'hashie/mash'
 
 require 'active_support/core_ext/module/delegation'
@@ -72,9 +89,10 @@ module Elasticsearch
 
     # Adds the `Elasticsearch::Model` functionality to the including class.
     #
-    # * Creates the `__elasticsearch__` class and instance methods, pointing to the proxy object
-    # * Includes the necessary modules in the proxy classes
-    # * Sets up delegation for crucial methods such as `search`, etc.
+    # * Creates the `__elasticsearch__` class and instance method. These methods return a proxy object with
+    #   other common methods defined on them.
+    # * The module includes other modules with further functionality.
+    # * Sets up delegation for common methods such as `import` and `search`.
     #
     # @example Include the module in the `Article` model definition
     #
@@ -91,44 +109,16 @@ module Elasticsearch
       base.class_eval do
         include Elasticsearch::Model::Proxy
 
-        Elasticsearch::Model::Proxy::ClassMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::ClassMethods
-          include Elasticsearch::Model::Naming::ClassMethods
-          include Elasticsearch::Model::Indexing::ClassMethods
-          include Elasticsearch::Model::Searching::ClassMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::InstanceMethods
-          include Elasticsearch::Model::Naming::InstanceMethods
-          include Elasticsearch::Model::Indexing::InstanceMethods
-          include Elasticsearch::Model::Serializing::InstanceMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval <<-CODE, __FILE__, __LINE__ + 1
-          def as_indexed_json(options={})
-            target.respond_to?(:as_indexed_json) ? target.__send__(:as_indexed_json, options) : super
-          end
-        CODE
-
-        # Delegate important methods to the `__elasticsearch__` proxy, unless they are defined already
-        #
+        # Delegate common methods to the `__elasticsearch__` ClassMethodsProxy, unless they are defined already
         class << self
           METHODS.each do |method|
             delegate method, to: :__elasticsearch__ unless self.public_instance_methods.include?(method)
           end
         end
-
-        # Mix the importing module into the proxy
-        #
-        self.__elasticsearch__.class_eval do
-          include Elasticsearch::Model::Importing::ClassMethods
-          include Adapter.from_class(base).importing_mixin
-        end
-
-        # Add to the registry if it's a class (and not in intermediate module)
-        Registry.add(base) if base.is_a?(Class)
       end
+
+      # Add to the model to the registry if it's a class (and not in intermediate module)
+      Registry.add(base) if base.is_a?(Class)
     end
 
     module ClassMethods
@@ -137,7 +127,7 @@ module Elasticsearch
       # @example Get the client
       #
       #     Elasticsearch::Model.client
-      #     => #<Elasticsearch::Transport::Client:0x007f96a7d0d000 @transport=... >
+      #     => #<Elasticsearch::Client:0x007f96a7d0d000... >
       #
       def client
         @client ||= Elasticsearch::Client.new
@@ -148,7 +138,7 @@ module Elasticsearch
       # @example Configure (set) the client for all models
       #
       #     Elasticsearch::Model.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
-      #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
+      #     => #<Elasticsearch::Client:0x007f96a6dd0d80... >
       #
       # @note You have to set the client before you call Elasticsearch methods on the model,
       #       or set it directly on the model; see {Elasticsearch::Model::Client::ClassMethods#client}
@@ -182,36 +172,11 @@ module Elasticsearch
         Response::Response.new(models, request)
       end
 
-      # Check if inheritance is enabled
-      #
-      # @note Inheritance is disabled by default.
-      #
-      def inheritance_enabled
-        @settings[:inheritance_enabled] ||= false
-      end
-
-      # Enable inheritance of index_name and document_type
-      #
-      # @example Enable inheritance
-      #
-      #     Elasticsearch::Model.inheritance_enabled = true
-      #
-      def inheritance_enabled=(inheritance_enabled)
-        warn STI_DEPRECATION_WARNING if inheritance_enabled
-        @settings[:inheritance_enabled] = inheritance_enabled
-      end
-
       # Access the module settings
       #
       def settings
         @settings ||= {}
       end
-
-      private
-
-      STI_DEPRECATION_WARNING = "DEPRECATION WARNING: Support for Single Table Inheritance (STI) is deprecated " +
-        "and will be removed in version 7.0.0.\nPlease save different model documents in separate indices and refer " +
-        "to the Elasticsearch documentation for more information.".freeze
     end
     extend ClassMethods
 

data/spec/elasticsearch/model/adapter_spec.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.
+
 require 'spec_helper'
 
 describe Elasticsearch::Model::Adapter do

data/spec/elasticsearch/model/adapters/active_record/associations_spec.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.
+
 require 'spec_helper'
 
 describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do