elasticsearch-persistence: Updates to elasticsearch 8, removes type, whitespace cleanup

Author: picandocodigo

elasticsearch-persistence/elasticsearch-persistence.gemspec

@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemodel',         '> 4'
   s.add_dependency 'activesupport',       '> 4'
-  s.add_dependency 'elasticsearch',       '~> 7'
+  s.add_dependency 'elasticsearch',       '~> 8'
   s.add_dependency 'elasticsearch-model', '7.2.1'
   s.add_dependency 'hashie'
 

elasticsearch-persistence/examples/notes/application.rb

@@ -75,7 +75,6 @@ class NoteRepository
   client Elasticsearch::Client.new url: ENV['ELASTICSEARCH_URL'], log: true
 
   index_name :notes
-  document_type  :note
 
   mapping do
     indexes :text,       analyzer: 'snowball'

elasticsearch-persistence/lib/elasticsearch/persistence/repository.rb

@@ -58,7 +58,6 @@ module ClassMethods
         # @param [ Proc ] block A block to evaluate on the new repository instance.
         #
         # @option options [ Symbol, String ] :index_name The name of the index.
-        # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
         # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
         # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
         #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
@@ -95,7 +94,6 @@ def create(options = {}, &block)
       # @param [ Hash ] options The options to use.
       #
       # @option options [ Symbol, String ] :index_name The name of the index.
-      # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
       # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
       # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
       #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
@@ -121,19 +119,6 @@ def client
                       Elasticsearch::Client.new
       end
 
-      # Get the document type used by the repository object.
-      #
-      # @example
-      #   repository.document_type
-      #
-      # @return [ String, Symbol ] The repository's document type.
-      #
-      # @since 6.0.0
-      def document_type
-        @document_type ||= @options[:document_type] ||
-                             __get_class_value(:document_type)
-      end
-
       # Get the index name used by the repository.
       #
       # @example
@@ -180,7 +165,6 @@ def klass
       def mapping(*args)
         @memoized_mapping ||= @options[:mapping] || (begin
           if _mapping = __get_class_value(:mapping)
-            _mapping.instance_variable_set(:@type, document_type)
             _mapping
           end
         end) || (super && @mapping)
@@ -229,7 +213,7 @@ def index_exists?(*args)
       #
       # @since 6.0.0
       def inspect
-        "#<#{self.class}:0x#{object_id} index_name=#{index_name} document_type=#{document_type} klass=#{klass}>"
+        "#<#{self.class}:0x#{object_id} index_name=#{index_name} klass=#{klass}>"
       end
 
       private

elasticsearch-persistence/lib/elasticsearch/persistence/repository/dsl.rb

@@ -23,7 +23,6 @@ module Repository
       #
       # @since 6.0.0
       module DSL
-
         def self.included(base)
           base.send(:extend, Elasticsearch::Model::Indexing::ClassMethods)
           base.send(:extend, ClassMethods)
@@ -34,19 +33,6 @@ def self.included(base)
         #
         # @since 6.0.0
         module ClassMethods
-
-          # Get or set the class-level document type setting.
-          #
-          # @example
-          #   MyRepository.document_type
-          #
-          # @return [ String, Symbol ] _type The repository's document type.
-          #
-          # @since 6.0.0
-          def document_type(_type = nil)
-            @document_type ||= _type
-          end
-
           # Get or set the class-level index name setting.
           #
           # @example

elasticsearch-persistence/lib/elasticsearch/persistence/repository/find.rb

@@ -64,7 +64,6 @@ def find(*args)
         #
         def exists?(id, options={})
           request = { index: index_name, id: id }
-          request[:type] = document_type if document_type
           client.exists(request.merge(options))
         end
 
@@ -84,7 +83,6 @@ def exists?(id, options={})
         #
         def __find_one(id, options={})
           request = { index: index_name, id: id }
-          request[:type] = document_type if document_type
           document = client.get(request.merge(options))
           deserialize(document)
         rescue Elastic::Transport::Transport::Errors::NotFound => e
@@ -95,7 +93,6 @@ def __find_one(id, options={})
         #
         def __find_many(ids, options={})
           request = { index: index_name, body: { ids: ids } }
-          request[:type] = document_type if document_type
           documents = client.mget(request.merge(options))
           documents[DOCS].map do |document|
             deserialize(document) if document[FOUND]

elasticsearch-persistence/lib/elasticsearch/persistence/repository/search.rb

@@ -60,8 +60,7 @@ module Search
         # @return [Elasticsearch::Persistence::Repository::Response::Results]
         #
         def search(query_or_definition, options={})
-          request = { index: index_name,
-                      type: document_type }
+          request = { index: index_name }
           if query_or_definition.respond_to?(:to_hash)
             request[:body] = query_or_definition.to_hash
           elsif query_or_definition.is_a?(String)
@@ -98,8 +97,7 @@ def search(query_or_definition, options={})
         #
         def count(query_or_definition=nil, options={})
           query_or_definition ||= { query: { match_all: {} } }
-          request = { index: index_name,
-                      type: document_type }
+          request = { index: index_name }
 
           if query_or_definition.respond_to?(:to_hash)
             request[:body] = query_or_definition.to_hash

elasticsearch-persistence/lib/elasticsearch/persistence/repository/store.rb

@@ -27,7 +27,7 @@ module Store
         #
         # @example
         #     repository.save(myobject)
-        #     => {"_index"=>"...", "_type"=>"...", "_id"=>"...", "_version"=>1, "created"=>true}
+        #     => {"_index"=>"...", "_id"=>"...", "_version"=>1, "created"=>true}
         #
         # @param [ Object ] document The document to save into Elasticsearch.
         # @param [ Hash ] options The save request options.
@@ -40,7 +40,6 @@ def save(document, options={})
           request = { index: index_name,
                       id: id,
                       body: serialized }
-          request[:type] = document_type if document_type
           client.index(request.merge(options))
         end
 
@@ -49,12 +48,12 @@ def save(document, options={})
         # @example Update the document with partial data
         #
         #     repository.update id: 1, title: 'UPDATED',  tags: []
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>2}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>2}
         #
         # @example Update the document with a script
         #
         #     repository.update 1, script: 'ctx._source.views += 1'
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>3}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>3}
         #
         # @param [ Object ] document_or_id The document to update or the id of the document to update.
         # @param [ Hash ] options The update request options.
@@ -65,7 +64,6 @@ def update(document_or_id, options = {})
           if document_or_id.is_a?(String) || document_or_id.is_a?(Integer)
             id = document_or_id
             body = options
-            type = document_type
           else
             document = serialize(document_or_id)
             id = __extract_id_from_document(document)
@@ -74,17 +72,16 @@ def update(document_or_id, options = {})
             else
               body = { doc: document }.merge(options)
             end
-            type = document.delete(:type) || document_type
           end
-          client.update(index: index_name, id: id, type: type, body: body)
+          client.update(index: index_name, id: id, body: body)
         end
 
         # Remove the serialized object or document with specified ID from Elasticsearch
         #
         # @example Remove the document with ID 1
         #
         #     repository.delete(1)
-        #     # => {"_index"=>"...", "_type"=>"...", "_id"=>"1", "_version"=>4}
+        #     # => {"_index"=>"...", "_id"=>"1", "_version"=>4}
         #
         # @param [ Object ] document_or_id The document to delete or the id of the document to delete.
         # @param [ Hash ] options The delete request options.
@@ -98,7 +95,7 @@ def delete(document_or_id, options = {})
             serialized = serialize(document_or_id)
             id = __get_id_from_document(serialized)
           end
-          client.delete({ index: index_name, type: document_type, id: id }.merge(options))
+          client.delete({ index: index_name, id: id }.merge(options))
         end
       end
     end

elasticsearch-persistence/spec/repository/find_spec.rb

@@ -18,7 +18,6 @@
 require 'spec_helper'
 
 describe Elasticsearch::Persistence::Repository::Find do
-
   after do
     begin; repository.delete_index!; rescue; end
   end
@@ -28,9 +27,7 @@
   end
 
   describe '#exists?' do
-
     context 'when the document exists' do
-
       let(:id) do
         repository.save(a: 1)['_id']
       end
@@ -41,30 +38,15 @@
     end
 
     context 'when the document does not exist' do
-
       it 'returns false' do
         expect(repository.exists?('1')).to be(false)
       end
     end
-
-    context 'when options are provided' do
-
-      let(:id) do
-        repository.save(a: 1)['_id']
-      end
-
-      it 'applies the options' do
-        expect(repository.exists?(id, type: 'other_type')).to be(false)
-      end
-    end
   end
 
   describe '#find' do
-
     context 'when options are not provided' do
-
       context 'when a single id is provided' do
-
         let!(:id) do
           repository.save(a: 1)['_id']
         end
@@ -75,51 +57,53 @@
       end
 
       context 'when an array of ids is provided' do
-
         let!(:ids) do
           3.times.collect do |i|
             repository.save(a: i)['_id']
           end
         end
 
         it 'retrieves the documents' do
-          expect(repository.find(ids)).to eq([{ 'a' =>0 },
-                                              { 'a' => 1 },
-                                              { 'a' => 2 }])
+          expect(repository.find(ids)).to eq([
+                                               { 'a' =>0 },
+                                               { 'a' => 1 },
+                                               { 'a' => 2 }
+                                             ])
         end
 
         context 'when some documents are found and some are not' do
-
           before do
             ids[1] = 22
             ids
           end
 
           it 'returns nil in the result list for the documents not found' do
-            expect(repository.find(ids)).to eq([{ 'a' =>0 },
+            expect(repository.find(ids)).to eq([
+                                                 { 'a' =>0 },
                                                  nil,
-                                                 { 'a' => 2 }])
+                                                 { 'a' => 2 }
+                                               ])
           end
         end
       end
 
       context 'when multiple ids are provided' do
-
         let!(:ids) do
           3.times.collect do |i|
             repository.save(a: i)['_id']
           end
         end
 
         it 'retrieves the documents' do
-          expect(repository.find(*ids)).to eq([{ 'a' =>0 },
-                                              { 'a' => 1 },
-                                              { 'a' => 2 }])
+          expect(repository.find(*ids)).to eq([
+                                                { 'a' =>0 },
+                                                { 'a' => 1 },
+                                                { 'a' => 2 }
+                                              ])
         end
       end
 
       context 'when the document cannot be found' do
-
         before do
           begin; repository.create_index!; rescue; end
         end
@@ -131,66 +115,5 @@
         end
       end
     end
-
-    context 'when options are provided' do
-
-      context 'when a single id is passed' do
-
-        let!(:id) do
-          repository.save(a: 1)['_id']
-        end
-
-        it 'applies the options' do
-          expect {
-            repository.find(id, type: 'none')
-          }.to raise_exception(Elasticsearch::Persistence::Repository::DocumentNotFound)
-        end
-      end
-
-      context 'when an array of ids is passed' do
-
-        let!(:ids) do
-          3.times.collect do |i|
-            repository.save(a: i)['_id']
-          end
-        end
-
-        it 'applies the options' do
-          expect(repository.find(ids, type: 'none')).to eq([nil, nil, nil])
-        end
-      end
-
-      context 'when multiple ids are passed' do
-
-        let!(:ids) do
-          3.times.collect do |i|
-            repository.save(a: i)['_id']
-          end
-        end
-
-        it 'applies the options' do
-          expect(repository.find(*ids, type: 'none')).to eq([nil, nil, nil])
-        end
-      end
-    end
-
-    context 'when a document_type is defined on the class' do
-
-      let(:repository) do
-        MyTestRepository.new(document_type:'other_type', client: DEFAULT_CLIENT, index_name: 'test')
-      end
-
-      let!(:ids) do
-        3.times.collect do |i|
-          repository.save(a: i)['_id']
-        end
-      end
-
-      it 'uses the document type in the query' do
-        expect(repository.find(ids)).to eq([{ 'a' =>0 },
-                                            { 'a' => 1 },
-                                            { 'a' => 2 }])
-      end
-    end
   end
 end