mongoid 5.2.1 → 5.4.0

data/lib/mongoid/findable.rb

@@ -71,7 +71,7 @@ module Mongoid
     # @example Do any documents exist for the conditions?
     #   Person.exists?
     #
-    # @param [ Array ] args The conditions.
+    # @return [ true, false ] If any documents exist for the conditions.
     def exists?
       with_default_scope.exists?
     end

data/lib/mongoid/indexable.rb

@@ -90,7 +90,7 @@ module Mongoid
       #     index({ name: 1 }, { background: true })
       #   end
       #
-      # @param [ Symbol ] name The name of the field.
+      # @param [ Symbol ] spec The index spec.
       # @param [ Hash ] options The index options.
       #
       # @return [ Hash ] The index options.
@@ -108,7 +108,8 @@ module Mongoid
       # @example Get the index specification.
       #   Model.index_specification(name: 1)
       #
-      # @param [ Hash ] key The index key/direction pair.
+      # @param [ Hash ] index_hash The index key/direction pair.
+      # @param [ String ] index_name The index name.
       #
       # @return [ Specification ] The found specification.
       #

data/lib/mongoid/indexable/specification.rb

@@ -99,7 +99,7 @@ module Mongoid
       # @example Normalize the index options.
       #   specification.normalize_options(drop_dups: true)
       #
-      # @param [ Hash ] options The index options.
+      # @param [ Hash ] opts The index options.
       #
       # @return [ Hash ] The normalized options.
       #

data/lib/mongoid/interceptable.rb

@@ -46,7 +46,7 @@ module Mongoid
     # @example Is the callback executable?
     #   document.callback_executable?(:save)
     #
-    # @param [ Symbol ] kin The type of callback.
+    # @param [ Symbol ] kind The type of callback.
     #
     # @return [ true, false ] If the callback can be executed.
     #
@@ -118,7 +118,7 @@ module Mongoid
     #   end
     #
     # @param [ Symbol ] kind The type of callback to execute.
-    # @param [ Array ] *args Any options.
+    # @param [ Array ] args Any options.
     #
     # @return [ Document ] The document
     #

data/lib/mongoid/loggable.rb

@@ -25,7 +25,7 @@ module Mongoid
     # @example Set the logger.
     #   Loggable.logger = Logger.new($stdout)
     #
-    # @param [ Logger ] The logger to set.
+    # @param [ Logger ] logger The logger to set.
     #
     # @return [ Logger ] The new logger.
     #

data/lib/mongoid/matchable.rb

@@ -82,7 +82,7 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     # @param [ Symbol, String ] key The field name.
-    # @param [ Object, Hash ] The value or selector.
+    # @param [ Object, Hash ] value The value or selector.
     #
     # @return [ Matcher ] The matcher.
     #
@@ -103,7 +103,7 @@ module Mongoid
       #
       # @param [ Document ] document The document to check.
       # @param [ Symbol, String ] key The field name.
-      # @param [ Object, Hash ] The value or selector.
+      # @param [ Object, Hash ] value The value or selector.
       #
       # @return [ Matcher ] The matcher.
       #

data/lib/mongoid/persistable.rb

@@ -69,8 +69,6 @@ module Mongoid
     # @example Raise the validation error.
     #   Person.fail_due_to_validation!(person)
     #
-    # @param [ Document ] document The document to fail.
-    #
     # @raise [ Errors::Validations ] The validation error.
     #
     # @since 4.0.0
@@ -83,7 +81,6 @@ module Mongoid
     # @example Raise the callback error.
     #   Person.fail_due_to_callback!(person, :create!)
     #
-    # @param [ Document ] document The document to fail.
     # @param [ Symbol ] method The method being called.
     #
     # @raise [ Errors::Callback ] The callback error.

data/lib/mongoid/persistable/creatable.rb

@@ -165,8 +165,6 @@ module Mongoid
         #
         # @param [ Hash, Array ] attributes The attributes to create with, or an
         #   Array of multiple attributes for multiple documents.
-        # @param [ Hash ] options A mass-assignment protection options. Supports
-        #   :as and :without_protection
         #
         # @return [ Document, Array<Document> ] The newly created document(s).
         #

data/lib/mongoid/query_cache.rb

@@ -221,7 +221,7 @@ module Mongoid
           super
         else
           unless cursor = cached_cursor
-            server = read.select_server(cluster)
+            server = read_or_server_selector.select_server(cluster)
             cursor = CachedCursor.new(view, send_initial_query(server), server)
             QueryCache.cache_table[cache_key] = cursor
           end
@@ -234,6 +234,10 @@ module Mongoid
 
       private
 
+      def read_or_server_selector
+        respond_to?(:server_selector, true) ? server_selector : read
+      end
+
       def cached_cursor
         if limit
           key = [ collection.namespace, selector, nil, skip, sort, projection, collation  ]

data/lib/mongoid/relations/accessors.rb

@@ -17,7 +17,6 @@ module Mongoid
       # @param [ String, Symbol ] name The name of the relation.
       # @param [ Hash, BSON::ObjectId ] object The id or attributes to use.
       # @param [ Metadata ] metadata The relation's metadata.
-      # @param [ true, false ] building If we are in a build operation.
       #
       # @return [ Proxy ] The relation.
       #
@@ -32,7 +31,7 @@ module Mongoid
       # @example Create the relation.
       #   person.create_relation(document, metadata)
       #
-      # @param [ Document, Array<Document ] object The relation target.
+      # @param [ Document, Array<Document> ] object The relation target.
       # @param [ Metadata ] metadata The relation metadata.
       #
       # @return [ Proxy ] The relation.

data/lib/mongoid/relations/bindings/embedded/in.rb

@@ -17,8 +17,6 @@ module Mongoid
           #   name.person.bind(:continue => true)
           #   name.person = Person.new
           #
-          # @param [ Hash ] options The binding options.
-          #
           # @option options [ true, false ] :continue Continue binding the inverse.
           # @option options [ true, false ] :binding Are we in build mode?
           #
@@ -42,8 +40,6 @@ module Mongoid
           #   name.person.unbind(:continue => true)
           #   name.person = nil
           #
-          # @param [ Hash ] options The options to pass through.
-          #
           # @option options [ true, false ] :continue Do we continue unbinding?
           #
           # @since 2.0.0.rc.1

data/lib/mongoid/relations/bindings/embedded/many.rb

@@ -14,10 +14,6 @@ module Mongoid
           #   person.addresses.bind_one(address)
           #
           # @param [ Document ] doc The single document to bind.
-          # @param [ Hash ] options The binding options.
-          #
-          # @option options [ true, false ] :continue Continue binding the inverse.
-          # @option options [ true, false ] :binding Are we in build mode?
           #
           # @since 2.0.0.rc.1
           def bind_one(doc)
@@ -32,10 +28,7 @@ module Mongoid
           # @example Unbind the document.
           #   person.addresses.unbind_one(document)
           #
-          # @param [ Hash ] options The binding options.
-          #
-          # @option options [ true, false ] :continue Continue binding the inverse.
-          # @option options [ true, false ] :binding Are we in build mode?
+          # @param [ Document ] doc The single document to unbind.
           #
           # @since 2.0.0.rc.1
           def unbind_one(doc)

data/lib/mongoid/relations/bindings/embedded/one.rb

@@ -17,11 +17,6 @@ module Mongoid
           #   person.name.bind(:continue => true)
           #   person.name = Name.new
           #
-          # @param [ Hash ] options The options to pass through.
-          #
-          # @option options [ true, false ] :continue Do we continue binding?
-          # @option options [ true, false ] :binding Are we in build mode?
-          #
           # @since 2.0.0.rc.1
           def bind_one
             target.parentize(base)
@@ -37,11 +32,6 @@ module Mongoid
           #   person.name.unbind(:continue => true)
           #   person.name = nil
           #
-          # @param [ Hash ] options The options to pass through.
-          #
-          # @option options [ true, false ] :continue Do we continue unbinding?
-          # @option options [ true, false ] :binding Are we in build mode?
-          #
           # @since 2.0.0.rc.1
           def unbind_one
             binding do

data/lib/mongoid/relations/bindings/referenced/many.rb

@@ -13,8 +13,6 @@ module Mongoid
           # @example Bind one document.
           #   person.posts.bind_one(post)
           #
-          # @param [ Document ] doc The single document to bind.
-          #
           # @since 2.0.0.rc.1
           def bind_one(doc)
             binding do
@@ -27,8 +25,6 @@ module Mongoid
           # @example Unbind the document.
           #   person.posts.unbind_one(document)
           #
-          # @param [ Document ] document The document to unbind.
-          #
           # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do

data/lib/mongoid/relations/builders/embedded/one.rb

@@ -12,7 +12,7 @@ module Mongoid
           # @example Build the document.
           #   Builder.new(meta, attrs).build
           #
-          # @param [ String ] type Not used in this context.
+          # @param [ String ] _type Not used in this context.
           #
           # @return [ Document ] A single document.
           def build(_type = nil)

data/lib/mongoid/relations/builders/nested_attributes/many.rb

@@ -60,7 +60,7 @@ module Mongoid
           # @example Is the document destroyable?
           #   destroyable?({ :_destroy => "1" })
           #
-          # @parma [ Hash ] attributes The attributes to pull the flag from.
+          # @param [ Hash ] attributes The attributes to pull the flag from.
           #
           # @return [ true, false ] If the relation can potentially be deleted.
           def destroyable?(attributes)

data/lib/mongoid/relations/conversions.rb

@@ -13,7 +13,7 @@ module Mongoid
       #   Conversions.flag(metadata, 15)
       #
       # @param [ Object ] object The object to flag.
-      # @param [ Metadata ] The relation metadata.
+      # @param [ Metadata ] metadata The relation metadata.
       #
       # @return [ Object ] The provided object.
       #

data/lib/mongoid/relations/counter_cache.rb

@@ -11,7 +11,7 @@ module Mongoid
       # @example Reset the given counter cache
       #   post.reset_counters(:comments)
       #
-      # @param [ Symbol, Array ] One or more counter caches to reset
+      # @param [ Symbol, Array ] counters One or more counter caches to reset
       #
       # @since 4.0.0
       def reset_counters(*counters)
@@ -27,8 +27,8 @@ module Mongoid
         # @example Reset the given counter cache
         #   Post.reset_counters('50e0edd97c71c17ea9000001', :comments)
         #
-        # @param [ String ] The id of the object that will be reset.
-        # @param [ Symbol, Array ] One or more counter caches to reset
+        # @param [ String ] id The id of the object that will be reset.
+        # @param [ Symbol, Array ] counters One or more counter caches to reset
         #
         # @since 3.1.0
         def reset_counters(id, *counters)
@@ -49,8 +49,8 @@ module Mongoid
         #   Post.update_counters('50e0edd97c71c17ea9000001',
         #              :comments_count => 5, :likes_count => -2)
         #
-        # @param [ String ] The id of the object to update.
-        # @param [ Hash ] Key = counter_cache and Value = factor.
+        # @param [ String ] id The id of the object to update.
+        # @param [ Hash ] counters
         #
         # @since 3.1.0
         def update_counters(id, counters)
@@ -64,8 +64,8 @@ module Mongoid
         # @example Increment comments counter
         #   Post.increment_counter(:comments_count, '50e0edd97c71c17ea9000001')
         #
-        # @param [ Symbol ] Counter cache name
-        # @param [ String ] The id of the object that will have its counter incremented.
+        # @param [ Symbol ] counter_name Counter cache name
+        # @param [ String ] id The id of the object that will have its counter incremented.
         #
         # @since 3.1.0
         def increment_counter(counter_name, id)
@@ -79,8 +79,8 @@ module Mongoid
         # @example Decrement comments counter
         #   Post.decrement_counter(:comments_count, '50e0edd97c71c17ea9000001')
         #
-        # @param [ Symbol ] Counter cache name
-        # @param [ String ] The id of the object that will have its counter decremented.
+        # @param [ Symbol ] counter_name Counter cache name
+        # @param [ String ] id The id of the object that will have its counter decremented.
         #
         # @since 3.1.0
         def decrement_counter(counter_name, id)
@@ -96,7 +96,7 @@ module Mongoid
         # @example Add the touchable.
         #   Person.add_counter_cache_callbacks(meta)
         #
-        # @param [ Metadata ] metadata The metadata for the relation.
+        # @param [ Metadata ] meta The metadata for the relation.
         #
         # @since 3.1.0
         def add_counter_cache_callbacks(meta)

data/lib/mongoid/relations/eager/base.rb

@@ -12,8 +12,8 @@ module Mongoid
         # @example Create the new belongs to eager load preloader.
         #   BelongsTo.new(relations_metadata, parent_docs)
         #
-        # @param [ Array<Metadata> ] Relations to eager load
-        # @param [ Array<Document> ] Documents to preload the relations
+        # @param [ Array<Metadata> ] associations Relations to eager load
+        # @param [ Array<Document> ] docs Documents to preload the relations
         #
         # @return [ Base ] The eager load preloader
         #
@@ -84,7 +84,7 @@ module Mongoid
         # @example Set docs into parent with pk = "foo"
         #   loader.set_on_parent("foo", docs)
         #
-        # @param [ ObjectId ] parent`s id
+        # @param [ ObjectId ] id parent`s id
         # @param [ Document, Array ] element to push into the parent
         #
         # @since 4.0.0
@@ -140,7 +140,7 @@ module Mongoid
         # @example Set docs into parent using the current relation name.
         #   loader.set_relation(doc, docs)
         #
-        # @param [ Document ] document
+        # @param [ Document ] doc
         # @param [ Document, Array ] element to set into the parent
         #
         # @since 4.0.0

data/lib/mongoid/relations/embedded/batchable.rb

@@ -13,15 +13,15 @@ module Mongoid
         # made to the database.
         #
         # @example Execute the batch push.
-        #   batchable.batch_insert([ doc_one, doc_two ])
+        #   batchable.batch_push([ doc_one, doc_two ])
         #
         # @param [ Array<Document> ] docs The docs to add.
         #
         # @return [ Array<Hash> ] The inserts.
         #
-        # @since 3.0.0
-        def batch_insert(docs)
-          execute_batch_insert(docs, "$pushAll")
+        # @since 5.4.0
+        def batch_push(docs)
+          execute_batch_push(docs)
         end
 
         # Clear all of the docs out of the relation in a single swipe.
@@ -89,7 +89,7 @@ module Mongoid
             base.delayed_atomic_sets.clear unless _assigning?
             docs = normalize_docs(docs).compact
             target.clear and _unscoped.clear
-            inserts = execute_batch_insert(docs, "$set")
+            inserts = execute_batch_set(docs)
             add_atomic_sets(inserts)
           end
         end
@@ -122,26 +122,50 @@ module Mongoid
         # @api private
         #
         # @example Perform a batch operation.
-        #   batchable.execute_batch(docs, "$set")
+        #   batchable.execute_batch_set(docs)
         #
         # @param [ Array<Document> ] docs The docs to persist.
         # @param [ String ] operation The atomic operation.
         #
         # @return [ Array<Hash> ] The inserts.
         #
-        # @since 3.0.0
-        def execute_batch_insert(docs, operation)
+        # @since 5.4.0
+        def execute_batch_set(docs)
           self.inserts_valid = true
           inserts = pre_process_batch_insert(docs)
           if insertable?
             collection.find(selector).update_one(
-              positionally(selector, operation => { path => inserts })
+              positionally(selector, '$set' => { path => inserts })
             )
             post_process_batch_insert(docs)
           end
           inserts
         end
 
+        # Perform a batch persist of the provided documents with $push and $each.
+        #
+        # @api private
+        #
+        # @example Perform a batch push.
+        #   batchable.execute_batch_push(docs)
+        #
+        # @param [ Array<Document> ] docs The docs to persist.
+        # @param [ String ] operation The atomic operation.
+        #
+        # @return [ Array<Hash> ] The inserts.
+        #
+        # @since 5.4.0
+        def execute_batch_push(docs)
+          self.inserts_valid = true
+          pushes = pre_process_batch_insert(docs)
+          if insertable?
+            collection.find(selector).update_one(
+                positionally(selector, '$push' => { path => { '$each' => pushes } }))
+            post_process_batch_insert(docs)
+          end
+          pushes
+        end
+
         # Are we in a state to be able to batch insert?
         #
         # @api private

data/lib/mongoid/relations/embedded/in.rb

@@ -31,7 +31,7 @@ module Mongoid
         # @example Substitute the new document.
         #   person.name.substitute(new_name)
         #
-        # @param [ Document ] other A document to replace the target.
+        # @param [ Document ] replacement A document to replace the target.
         #
         # @return [ Document, nil ] The relation or nil.
         #
@@ -55,8 +55,6 @@ module Mongoid
         # @example Get the binding.
         #   binding([ address ])
         #
-        # @param [ Proxy ] new_target The new documents to bind with.
-        #
         # @return [ Binding ] A binding object.
         #
         # @since 2.0.0.rc.1