Move to a options = {} impl in Index#delete_documents method

Author: brunoocasali

lib/meilisearch/index.rb

@@ -155,19 +155,21 @@ def update_documents_in_batches!(documents, batch_size = 1000, primary_key = nil
 
     # Public: Delete documents from an index
     #
-    # documents_ids - An array with document ids (deprecated, optional)
-    # filter - A hash containing a filter that should match documents.
-    #          Available ONLY with Meilisearch v1.2 and newer (optional)
+    # options: A Hash or an Array containing documents_ids or a hash with filter:.
+    #   filter: - A hash containing a filter that should match documents.
+    #             Available ONLY with Meilisearch v1.2 and newer (optional)
     #
     # Returns a Task object.
-    def delete_documents(documents_ids = nil, filter: nil)
+    def delete_documents(options = {})
       Utils.version_error_handler(__method__) do
-        if documents_ids.nil?
-          http_post "/indexes/#{@uid}/documents/delete", { filter: filter }
+        if options.is_a?(Hash) && options.key?(:filter)
+          http_post "/indexes/#{@uid}/documents/delete", options
         else
-          documents_ids = [documents_ids] unless documents_ids.is_a?(Array)
+          # backwards compatibility:
+          # expect to be a array or/number/string to send alongside as documents_ids.
+          options = [options] unless options.is_a?(Array)
 
-          http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
+          http_post "/indexes/#{@uid}/documents/delete-batch", options
         end
       end
     end

spec/meilisearch/index/documents_spec.rb

@@ -393,29 +393,20 @@
       it 'deletes documents based on filter from index (with delete route)' do
         expect do
           index.update_filterable_attributes(['objectId'])
-          task = index.delete_documents(nil, filter: ['objectId > 0'])
+          task = index.delete_documents(filter: ['objectId > 0'])
 
           client.wait_for_task(task['taskUid'])
         end.to(change { index.documents['results'].size }.by(-documents.size))
       end
 
       it 'ignores filter even when documents_ids is empty (with delete-batch route)' do
         expect do
-          task = index.delete_documents([], filter: ['objectId > 0'])
+          task = index.delete_documents(filter: ['objectId > 0'])
 
           client.wait_for_task(task['taskUid'])
         end.to(change { index.documents['results'].size }.by(0))
       end
 
-      it 'deletes documents based on ids even when receive a filter (with delete-batch route)' do
-        expect do
-          index.update_filterable_attributes(['objectId'])
-          task = index.delete_documents([2], filter: ['objectId > 0'])
-
-          client.wait_for_task(task['taskUid'])
-        end.to(change { index.documents['results'].size }.by(-1))
-      end
-
       it 'deletes one document synchronously from index (with delete-batch route)' do
         id = 2
         expect do