elasticsearch-model 7.2.0 → 8.0.0

data/lib/elasticsearch/model/naming.rb

@@ -17,15 +17,10 @@
 
 module Elasticsearch
   module Model
-
-    # Provides methods for getting and setting index name and document type for the model
+    # Provides methods for getting and setting index and name for the model
     #
     module Naming
-
-      DEFAULT_DOC_TYPE = '_doc'.freeze
-
       module ClassMethods
-
         # Get or set the name of the index
         #
         # @example Set the index name for the `Article` model
@@ -64,46 +59,18 @@ module Elasticsearch
           @index_name = name
         end
 
-        # Get or set the document type
-        #
-        # @example Set the document type for the `Article` model
-        #
-        #     class Article
-        #       document_type "my-article"
-        #     end
-        #
-        # @example Directly set the document type for the `Article` model
-        #
-        #     Article.document_type "my-article"
-        #
-        def document_type name=nil
-          @document_type = name || @document_type || implicit(:document_type)
-        end
-
-
-        # Set the document type
-        #
-        # @see document_type
-        #
-        def document_type=(name)
-          @document_type = name
-        end
-
         private
 
-          def implicit(prop)
-            self.send("default_#{prop}")
-          end
-
-          def default_index_name
-            self.model_name.collection.gsub(/\//, '-')
-          end
+        def implicit(prop)
+          self.send("default_#{prop}")
+        end
 
-          def default_document_type; end
+        def default_index_name
+          self.model_name.collection.gsub(/\//, '-')
+        end
       end
 
       module InstanceMethods
-
         # Get or set the index name for the model instance
         #
         # @example Set the index name for an instance of the `Article` model
@@ -129,25 +96,7 @@ module Elasticsearch
         def index_name=(name)
           @index_name = name
         end
-
-        # @example Set the document type for an instance of the `Article` model
-        #
-        #     @article.document_type "my-article"
-        #     @article.__elasticsearch__.update_document
-        #
-        def document_type name=nil
-          @document_type = name || @document_type || self.class.document_type
-        end
-
-        # Set the document type
-        #
-        # @see document_type
-        #
-        def document_type=(name)
-          @document_type = name
-        end
       end
-
     end
   end
 end

data/lib/elasticsearch/model/proxy.rb

@@ -17,7 +17,6 @@
 
 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.
     #
@@ -45,7 +44,6 @@ module Elasticsearch
     #     # => true
     #
     module Proxy
-
       # Define the `__elasticsearch__` class and instance methods in the including class
       # and register a callback for intercepting changes in the model.
       #
@@ -53,9 +51,7 @@ 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__`
           def self.__elasticsearch__ &block
             @__elasticsearch__ ||= ClassMethodsProxy.new(self)
@@ -115,15 +111,18 @@ module Elasticsearch
           @target = target
         end
 
-        # Delegate methods to `@target`
+        def self.ruby2_keywords(*) # :nodoc:
+        end if RUBY_VERSION < "2.7"
+
+        # Delegate methods to `@target`. As per [the Ruby 3.0 explanation for keyword arguments](https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/), the only way to work on Ruby <2.7, and 2.7, and 3.0+ is to use `ruby2_keywords`.
         #
-        def method_missing(method_name, *arguments, &block)
+        ruby2_keywords def method_missing(method_name, *arguments, &block)
           target.respond_to?(method_name) ? target.__send__(method_name, *arguments, &block) : super
         end
 
         # Respond to methods from `@target`
         #
-        def respond_to?(method_name, include_private = false)
+        def respond_to_missing?(method_name, include_private = false)
           target.respond_to?(method_name) || super
         end
 

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

@@ -40,12 +40,6 @@ module Elasticsearch
           @result['_id']
         end
 
-        # Return document `_type` as `_type`
-        #
-        def type
-          @result['_type']
-        end
-
         # Delegate methods to `@result` or `@result._source`
         #
         def method_missing(name, *arguments)

data/lib/elasticsearch/model/searching.rb

@@ -37,7 +37,6 @@ module Elasticsearch
           @options = options
 
           __index_name    = options[:index] || klass.index_name
-          __document_type = options[:type]  || klass.document_type
 
           case
             # search query: ...
@@ -54,9 +53,9 @@ module Elasticsearch
           end
 
           if body
-            @definition = { index: __index_name, type: __document_type, body: body }.update options
+            @definition = { index: __index_name, body: body }.update options
           else
-            @definition = { index: __index_name, type: __document_type, q: q }.update options
+            @definition = { index: __index_name, q: q }.update options
           end
         end
 

data/lib/elasticsearch/model/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Model
-    VERSION = "7.2.0"
+    VERSION = '8.0.0'.freeze
   end
 end

data/lib/elasticsearch/model.rb

@@ -62,7 +62,6 @@ when defined?(::WillPaginate)
 end
 
 module Elasticsearch
-
   # Elasticsearch integration for Ruby models
   # =========================================
   #
@@ -85,7 +84,7 @@ module Elasticsearch
   #     # ...
   #
   module Model
-    METHODS = [:search, :mapping, :mappings, :settings, :index_name, :document_type, :import]
+    METHODS = [:search, :mapping, :mappings, :settings, :index_name, :import]
 
     # Adds the `Elasticsearch::Model` functionality to the including class.
     #
@@ -108,12 +107,16 @@ module Elasticsearch
     def self.included(base)
       base.class_eval do
         include Elasticsearch::Model::Proxy
-
         # 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
+
+          def inherited(subclass)
+            super
+            Registry.add(subclass) if subclass.is_a?(Class)
+          end
         end
       end
 

data/spec/elasticsearch/model/adapter_spec.rb

@@ -18,7 +18,6 @@
 require 'spec_helper'
 
 describe Elasticsearch::Model::Adapter do
-
   before(:all) do
     class ::DummyAdapterClass; end
     class ::DummyAdapterClassWithAdapter; end
@@ -37,14 +36,12 @@ describe Elasticsearch::Model::Adapter do
   end
 
   describe '#from_class' do
-
     it 'should return an Adapter instance' do
       expect(Elasticsearch::Model::Adapter.from_class(DummyAdapterClass)).to be_a(Elasticsearch::Model::Adapter::Adapter)
     end
   end
 
   describe 'register' do
-
     before do
       expect(Elasticsearch::Model::Adapter::Adapter).to receive(:register).and_call_original
       Elasticsearch::Model::Adapter.register(:foo, lambda { |c| false })
@@ -55,7 +52,6 @@ describe Elasticsearch::Model::Adapter do
     end
 
     context 'when a specific adapter class is set' do
-
       before do
         expect(Elasticsearch::Model::Adapter::Adapter).to receive(:register).and_call_original
         Elasticsearch::Model::Adapter::Adapter.register(DummyAdapter,
@@ -73,7 +69,6 @@ describe Elasticsearch::Model::Adapter do
   end
 
   describe 'default adapter' do
-
     let(:adapter) do
       Elasticsearch::Model::Adapter::Adapter.new(DummyAdapterClass)
     end
@@ -84,11 +79,9 @@ describe Elasticsearch::Model::Adapter do
   end
 
   describe '#records_mixin' do
-
     before do
       Elasticsearch::Model::Adapter::Adapter.register(DummyAdapter,
                                                       lambda { |c| c == DummyAdapterClassWithAdapter })
-
     end
 
     let(:adapter) do
@@ -101,11 +94,9 @@ describe Elasticsearch::Model::Adapter do
   end
 
   describe '#callbacks_mixin' do
-
     before do
       Elasticsearch::Model::Adapter::Adapter.register(DummyAdapter,
                                                       lambda { |c| c == DummyAdapterClassWithAdapter })
-
     end
 
     let(:adapter) do
@@ -118,11 +109,9 @@ describe Elasticsearch::Model::Adapter do
   end
 
   describe '#importing_mixin' do
-
     before do
       Elasticsearch::Model::Adapter::Adapter.register(DummyAdapter,
                                                       lambda { |c| c == DummyAdapterClassWithAdapter })
-
     end
 
     let(:adapter) do

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

@@ -18,7 +18,6 @@
 require 'spec_helper'
 
 describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
-
   before(:all) do
     ActiveRecord::Schema.define(version: 1) do
       create_table :categories do |t|
@@ -76,7 +75,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   context 'when a document is created' do
-
     before do
       Post.create!(title: 'Test')
       Post.create!(title: 'Testing Coding')
@@ -97,9 +95,7 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   describe 'has_many_and_belongs_to association' do
-
-      context 'when an association is updated' do
-
+    context 'when an association is updated' do
       before do
         post.categories = [category_a,  category_b]
         Post.__elasticsearch__.refresh_index!
@@ -119,20 +115,20 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
 
       let(:search_result) do
         Post.search(query: {
-            bool: {
-                must: {
-                    multi_match: {
-                        fields: ['title'],
-                        query: 'first'
-                    }
-                },
-                filter: {
-                    terms: {
-                        categories: ['One']
-                    }
-                }
-            }
-        } )
+                      bool: {
+                        must: {
+                          multi_match: {
+                            fields: ['title'],
+                            query: 'first'
+                          }
+                        },
+                        filter: {
+                          terms: {
+                            categories: ['One']
+                          }
+                        }
+                      }
+                    } )
       end
 
       it 'applies the update with' do
@@ -144,7 +140,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
     end
 
     context 'when an association is deleted' do
-
       before do
         post.categories = [category_a,  category_b]
         post.categories = [category_b]
@@ -165,20 +160,20 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
 
       let(:search_result) do
         Post.search(query: {
-            bool: {
-                must: {
-                    multi_match: {
-                        fields: ['title'],
-                        query: 'first'
-                    }
-                },
-                filter: {
-                    terms: {
-                        categories: ['One']
-                    }
-                }
-            }
-        } )
+                      bool: {
+                        must: {
+                          multi_match: {
+                            fields: ['title'],
+                            query: 'first'
+                          }
+                        },
+                        filter: {
+                          terms: {
+                            categories: ['One']
+                          }
+                        }
+                      }
+                    } )
       end
 
       it 'applies the update with a reindex' do
@@ -189,9 +184,7 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   describe 'has_many through association' do
-
     context 'when the association is updated' do
-
       before do
         author_a = Author.where(first_name: "John", last_name: "Smith").first_or_create!
         author_b = Author.where(first_name: "Mary", last_name: "Smith").first_or_create!
@@ -210,33 +203,17 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
         Post.__elasticsearch__.refresh_index!
       end
 
-      context 'if active record is at least 4' do
-
-        let(:search_result) do
-          Post.search('authors.full_name:john')
-        end
-
-        it 'applies the update', if: active_record_at_least_4? do
-          expect(search_result.results.size).to eq(2)
-          expect(search_result.records.size).to eq(2)
-        end
+      let(:search_result) do
+        Post.search('authors.full_name:john')
       end
 
-      context 'if active record is less than 4' do
-
-        let(:search_result) do
-          Post.search('authors.author.full_name:john')
-        end
-
-        it 'applies the update', if: !active_record_at_least_4? do
-          expect(search_result.results.size).to eq(2)
-          expect(search_result.records.size).to eq(2)
-        end
+      it 'applies the update' do
+        expect(search_result.results.size).to eq(2)
+        expect(search_result.records.size).to eq(2)
       end
     end
 
-    context 'when an association is added', if: active_record_at_least_4? do
-
+    context 'when an association is added' do
       before do
         author_a = Author.where(first_name: "John", last_name: "Smith").first_or_create!
         author_b = Author.where(first_name: "Mary", last_name: "Smith").first_or_create!
@@ -262,9 +239,7 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   describe 'has_many association' do
-
-    context 'when an association is added', if: active_record_at_least_4? do
-
+    context 'when an association is added' do
       before do
         # Create posts
         post_1 = Post.create!(title: "First Post", text: "This is the first post...")
@@ -282,18 +257,18 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
 
       let(:search_result) do
         Post.search(query: {
-            nested: {
-                path: 'comments',
-                query: {
-                    bool: {
-                        must: [
-                            { match: { 'comments.author' => 'john' } },
-                            { match: { 'comments.text'   => 'good' } }
-                        ]
-                    }
-                }
-            }
-        })
+                      nested: {
+                        path: 'comments',
+                        query: {
+                          bool: {
+                            must: [
+                              { match: { 'comments.author' => 'john' } },
+                              { match: { 'comments.text'   => 'good' } }
+                            ]
+                          }
+                        }
+                      }
+                    })
       end
 
       it 'adds the association' do
@@ -303,9 +278,7 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   describe '#touch' do
-
     context 'when a touch callback is defined on the model' do
-
       before do
         # Create categories
         category_a = Category.where(title: "One").first_or_create!
@@ -329,7 +302,6 @@ describe 'Elasticsearch::Model::Adapter::ActiveRecord Associations' do
   end
 
   describe '#includes' do
-
     before do
       post_1 = Post.create(title: 'One')
       post_2 = Post.create(title: 'Two')