Merge #156

156: Add synchronous bang methods r=curquiza a=CaroFG



Co-authored-by: CaroFG <[email protected]>
Co-authored-by: CaroFG <[email protected]>

Author: bors[bot]

.rubocop_todo.yml

@@ -1,21 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-07-05 14:27:43 UTC using RuboCop version 0.86.0.
+# on 2021-03-16 11:04:59 UTC using RuboCop version 1.11.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 19
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/DateAssignment:
+  Exclude:
+    - 'meilisearch.gemspec'
+
+# Offense count: 30
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 465
+  Max: 432
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 190
+  Max: 212
 
 # Offense count: 1
 Naming/AccessorMethodName:

lib/meilisearch/index.rb

@@ -57,12 +57,25 @@ def add_documents(documents, primary_key = nil)
     alias replace_documents add_documents
     alias add_or_replace_documents add_documents
 
+    def add_documents!(documents, primary_key = nil)
+      update = add_documents(documents, primary_key)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias replace_documents! add_documents!
+    alias add_or_replace_documents! add_documents!
+
     def update_documents(documents, primary_key = nil)
       documents = [documents] if documents.is_a?(Hash)
       http_put "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact
     end
     alias add_or_update_documents update_documents
 
+    def update_documents!(documents, primary_key = nil)
+      update = update_documents(documents, primary_key)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias add_or_update_documents! update_documents!
+
     def delete_documents(documents_ids)
       if documents_ids.is_a?(Array)
         http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
@@ -72,16 +85,33 @@ def delete_documents(documents_ids)
     end
     alias delete_multiple_documents delete_documents
 
+    def delete_documents!(documents_ids)
+      update = delete_documents(documents_ids)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias delete_multiple_documents! delete_documents!
+
     def delete_document(document_id)
       encode_document = URI.encode_www_form_component(document_id)
       http_delete "/indexes/#{@uid}/documents/#{encode_document}"
     end
     alias delete_one_document delete_document
 
+    def delete_document!(document_id)
+      update = delete_document(document_id)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias delete_one_document! delete_document!
+
     def delete_all_documents
       http_delete "/indexes/#{@uid}/documents"
     end
 
+    def delete_all_documents!
+      update = delete_all_documents
+      wait_for_pending_update(update['updateId'])
+    end
+
     ### SEARCH
 
     def search(query, options = {})

spec/meilisearch/index/documents_spec.rb

@@ -35,6 +35,16 @@
       expect(index.documents.count).to eq(documents.count)
     end
 
+    it 'adds documents synchronously (as an array of documents)' do
+      response = index.add_documents!(documents)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.count).to eq(documents.count)
+    end
+
     it 'infers order of fields' do
       response = index.document(1)
       expect(response.keys).to eq(['objectId', 'title', 'comment'])
@@ -99,6 +109,28 @@
       expect(doc2['comment']).to eq(documents.detect { |doc| doc[:objectId] == id2 }[:comment])
     end
 
+    it 'updates documents synchronously in index (as an array of documents)' do
+      id1 = 123
+      id2 = 456
+      updated_documents = [
+        { objectId: id1,  title: 'Sense and Sensibility' },
+        { objectId: id2,  title: 'The Little Prince' }
+      ]
+      response = index.update_documents!(updated_documents)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      doc1 = index.document(id1)
+      doc2 = index.document(id2)
+      expect(index.documents.count).to eq(documents.count)
+      expect(doc1['title']).to eq(updated_documents.detect { |doc| doc[:objectId] == id1 }[:title])
+      expect(doc1['comment']).to eq(documents.detect { |doc| doc[:objectId] == id1 }[:comment])
+      expect(doc2['title']).to eq(updated_documents.detect { |doc| doc[:objectId] == id2 }[:title])
+      expect(doc2['comment']).to eq(documents.detect { |doc| doc[:objectId] == id2 }[:comment])
+    end
+
     it 'updates one document in index (as an hash of one document)' do
       id = 123
       updated_document = { objectId: id, title: 'Emma' }
@@ -112,6 +144,21 @@
       expect(new_doc['comment']).to eq(documents.detect { |doc| doc[:objectId] == id }[:comment])
     end
 
+    it 'updates one document synchronously in index (as an hash of one document)' do
+      id = 123
+      updated_document = { objectId: id, title: 'Emma' }
+      response = index.update_documents!(updated_document)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.count).to eq(documents.count)
+      new_doc = index.document(id)
+      expect(new_doc['title']).to eq(updated_document[:title])
+      expect(new_doc['comment']).to eq(documents.detect { |doc| doc[:objectId] == id }[:comment])
+    end
+
     it 'adds only one document to index (as an hash of one document)' do
       id = 30
       title = 'Hamlet'
@@ -126,6 +173,22 @@
       index.wait_for_pending_update(response['updateId'])
     end
 
+    it 'adds only one document synchronously to index (as an hash of one document)' do
+      id = 30
+      title = 'Hamlet'
+      new_doc = { objectId: id, title: title }
+      response = index.add_documents!(new_doc)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.count).to eq(documents.count + 1)
+      expect(index.document(id)['title']).to eq(title)
+      response = index.delete_document(id)
+      index.wait_for_pending_update(response['updateId'])
+    end
+
     it 'update a document with new fields' do
       id = 2
       doc = { objectId: id, note: '8/10' }
@@ -163,6 +226,18 @@
       expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
     end
 
+    it 'deletes one document synchronously from index' do
+      id = 456
+      response = index.delete_document!(id)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.size).to eq(documents.count - 1)
+      expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
+    end
+
     it 'does nothing when trying to delete a document which does not exist' do
       id = 111
       response = index.delete_document(id)
@@ -183,6 +258,18 @@
       expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
     end
 
+    it 'deletes one document synchronously from index (with delete-batch route)' do
+      id = 2
+      response = index.delete_documents!(id)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.size).to eq(documents.count - 2)
+      expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
+    end
+
     it 'deletes one document from index (with delete-batch route as an array of one uid)' do
       id = 123
       response = index.delete_documents([id])
@@ -193,6 +280,18 @@
       expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
     end
 
+    it 'deletes one document synchronously from index (with delete-batch route as an array of one uid)' do
+      id = 123
+      response = index.delete_documents!([id])
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.size).to eq(documents.count - 3)
+      expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
+    end
+
     it 'deletes multiples documents from index' do
       docs_to_delete = [1, 4]
       response = index.delete_documents(docs_to_delete)
@@ -202,6 +301,17 @@
       expect(index.documents.size).to eq(documents.count - 3 - docs_to_delete.count)
     end
 
+    it 'deletes multiples documents synchronously from index' do
+      docs_to_delete = [1, 4]
+      response = index.delete_documents!(docs_to_delete)
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents.size).to eq(documents.count - 3 - docs_to_delete.count)
+    end
+
     it 'clears all documents from index' do
       response = index.delete_all_documents
       index.wait_for_pending_update(response['updateId'])
@@ -211,6 +321,17 @@
       expect(index.documents.size).to eq(0)
     end
 
+    it 'clears all documents synchronously from index' do
+      response = index.delete_all_documents!
+      expect(response).to be_a(Hash)
+      expect(response).to have_key('updateId')
+      expect(response).to have_key('status')
+      expect(response['status']).not_to eql('enqueued')
+      expect(response['status']).to eql('processed')
+      expect(index.documents).to be_empty
+      expect(index.documents.size).to eq(0)
+    end
+
     it 'fails to add document with bad primary-key format' do
       response = index.add_documents(objectId: 'toto et titi', title: 'Unknown')
       index.wait_for_pending_update(response['updateId'])