RUBY-3087 reinstate ability to call insert_many with Enumerable inputs which are not Array instances (#2594)

* RUBY-3087 add a test for insert_many with enumerable inputs

* RUBY-3087 raise exception on bulk_write without using an Array method

* RUBY-3087 add test, docs

* add docs, release notes

* Fix the description of empty bulk_write spec to match the behavior

* Update docs/release-notes.txt

* change docstrings to use enumerables

Co-authored-by: Neil Shweky <neilshweky@gmail.com>

Author: 2 people

lib/mongo/bulk_write.rb

@@ -115,7 +115,8 @@ def execute
     #   )
     #
     # @param [ Mongo::Collection ] collection The collection.
-    # @param [ Array<Hash, BSON::Document> ] requests The requests, cannot be empty.
+    # @param [ Enumerable<Hash, BSON::Document> ] requests The requests,
+    #   cannot be empty.
     # @param [ Hash, BSON::Document ] options The options.
     #
     # @since 2.1.0
@@ -330,10 +331,9 @@ def can_hint?(connection)
     #   ArgumentError ]
     #   if the document is invalid.
     def validate_requests!
-      if @requests.empty?
-        raise ArgumentError, "Bulk write requests cannot be empty"
-      end
+      requests_empty = true
       @requests.each do |req|
+        requests_empty = false
         if op = req.keys.first
           if [:update_one, :update_many].include?(op)
             if doc = maybe_first(req.dig(op, :update))
@@ -359,6 +359,8 @@ def validate_requests!
             end
           end
         end
+      end.tap do
+        raise ArgumentError, "Bulk write requests cannot be empty" if requests_empty
       end
     end
 

lib/mongo/collection.rb

@@ -783,7 +783,7 @@ def insert_one(document, opts = {})
     # @example Insert documents into the collection.
     #   collection.insert_many([{ name: 'test' }])
     #
-    # @param [ Array<Hash> ] documents The documents to insert.
+    # @param [ Enumerable<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
     # @option options [ true | false ] :bypass_document_validation Whether or
@@ -811,7 +811,7 @@ def insert_many(documents, options = {})
     # @example Execute a bulk write.
     #   collection.bulk_write(operations, options)
     #
-    # @param [ Array<Hash> ] requests The bulk write requests.
+    # @param [ Enumerable<Hash> ] requests The bulk write requests.
     # @param [ Hash ] options The options.
     #
     # @option options [ true | false ] :ordered Whether the operations

lib/mongo/collection/view/writable.rb

@@ -98,8 +98,6 @@ def find_one_and_delete(opts = {})
           end.first&.fetch('value', nil)
         end
 
-        # db['users'].bulk_write([{insert_one: {x: 1}}, {insert_one: {x: 2}}])
-
         # Finds a single document and replaces it.
         #
         # @example Find a document and replace it, returning the original.

spec/mongo/collection_crud_spec.rb

@@ -362,6 +362,42 @@
       expect(result.inserted_ids.size).to eq(2)
     end
 
+    context 'when an enumerable is used instead of an array' do
+
+      context 'when the enumerable is not empty' do
+
+        let(:source_data) do
+          [{ name: 'test1' }, { name: 'test2' }]
+        end
+
+        let(:result) do
+          authorized_collection.insert_many(source_data.lazy)
+        end
+
+        it 'should accepts them without raising an error' do
+          expect { result }.to_not raise_error
+          expect(result.inserted_count).to eq(source_data.size)
+        end
+      end
+
+      context 'when the enumerable is empty' do
+
+        let(:source_data) do
+          []
+        end
+
+        let(:result) do
+          authorized_collection.insert_many(source_data.lazy)
+        end
+
+        it 'should raise ArgumentError' do
+          expect do
+            result
+          end.to raise_error(ArgumentError, /Bulk write requests cannot be empty/)
+        end
+      end
+    end
+
     context 'when a session is provided' do
 
       let(:session) do