mongoid 6.1.0 → 6.1.1

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

@@ -85,7 +85,7 @@ module Mongoid
             else
               batch_remove(target.dup)
             end
-          else
+          elsif target != docs
             base.delayed_atomic_sets.clear unless _assigning?
             docs = normalize_docs(docs).compact
             target.clear and _unscoped.clear
@@ -279,7 +279,7 @@ module Mongoid
                 self.inserts_valid = false
               end
             end
-            doc.as_document
+            doc.send(:as_attributes)
           end
         end
 
@@ -308,7 +308,7 @@ module Mongoid
             _unscoped.delete_one(doc)
             unbind_one(doc)
             execute_callback :after_remove, doc
-            doc.as_document
+            doc.send(:as_attributes)
           end
         end
 

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

@@ -43,7 +43,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.
         #
@@ -67,8 +67,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

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

@@ -36,7 +36,8 @@ module Mongoid
         # @example Push a document.
         #   person.addresses.push(address)
         #
-        # @param [ Document, Array<Document> ] *args Any number of documents.
+        # @param [ Document, Array<Document> ] args Any number of documents.
+        #
         def <<(*args)
           docs = args.flatten
           return concat(docs) if docs.size > 1
@@ -57,11 +58,7 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def as_document
-          attributes = []
-          _unscoped.each do |doc|
-            attributes.push(doc.as_document)
-          end
-          attributes
+          as_attributes.collect { |attrs| BSON::Document.new(attrs) }
         end
 
         # Appends an array of documents to the relation. Performs a batch
@@ -354,8 +351,6 @@ module Mongoid
         # @example Create the binding.
         #   relation.binding([ address ])
         #
-        # @param [ Array<Document> ] new_target The new documents to bind with.
-        #
         # @return [ Binding ] The many binding.
         #
         # @since 2.0.0.rc.1
@@ -478,7 +473,7 @@ module Mongoid
         #   relation.remove_all({ :num => 1 }, true)
         #
         # @param [ Hash ] conditions Conditions to filter by.
-        # @param [ true, false ] destroy If true then destroy, else delete.
+        # @param [ true, false ] method
         #
         # @return [ Integer ] The number of documents removed.
         def remove_all(conditions = {}, method = :delete)
@@ -514,6 +509,14 @@ module Mongoid
           @_unscoped = docs
         end
 
+        def as_attributes
+          attributes = []
+          _unscoped.each do |doc|
+            attributes.push(doc.as_document)
+          end
+          attributes
+        end
+
         class << self
 
           # Return the builder that is responsible for generating the documents

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

@@ -44,7 +44,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.
         #
@@ -74,8 +74,6 @@ module Mongoid
         # @example Get the binding.
         #   relation.binding([ address ])
         #
-        # @param [ Document ] new_target The new document to bind with.
-        #
         # @return [ Binding ] The relation's binding.
         #
         # @since 2.0.0.rc.1

data/lib/mongoid/relations/macros.rb

@@ -198,7 +198,7 @@ module Mongoid
           reference(meta, Array)
           autosave(meta)
           validates_relation(meta)
-          synced(meta)
+          _synced(meta)
           meta
         end
 
@@ -327,7 +327,8 @@ module Mongoid
         #   Model.reference_one_to_one(:name, meta)
         #
         # @param [ Symbol ] name The name of the relation.
-        # @param [ Metadata ] meta The relation metadata.
+        # @param [ Symbol ] options The association options.
+        # @param [ Metadata ] relation The relation.
         #
         # @return [ Class ] The model class.
         #

data/lib/mongoid/relations/metadata.rb

@@ -920,7 +920,7 @@ module Mongoid
       # @example Find the module from the parts.
       #   metadata.find_from_parts([ "Namespace", "Module" ])
       #
-      # @param [ Array<String> ] The modules.
+      # @param [ Array<String> ] modules The modules.
       #
       # @return [ String ] The matching module.
       #
@@ -1127,7 +1127,7 @@ module Mongoid
       # @example Find the inverses.
       #   metadata.lookup_inverses(other)
       #
-      # @param [ Document ] : The inverse document.
+      # @param [ Document ] other The inverse document.
       #
       # @return [ Array<String> ] The inverse names.
       def lookup_inverses(other)
@@ -1150,7 +1150,7 @@ module Mongoid
       # @example Find the inverse.
       #   metadata.lookup_inverse(other)
       #
-      # @param [ Document ] : The inverse document.
+      # @param [ Document ] other The inverse document.
       #
       # @return [ String ] The inverse name.
       #

data/lib/mongoid/relations/nested_builder.rb

@@ -25,7 +25,7 @@ module Mongoid
       # @example Is there a reject proc?
       #   builder.reject?
       #
-      # @param The parent document of the relation
+      # @param [ Document ] document The parent document of the relation
       # @param [ Hash ] attrs The attributes to check for rejection.
       #
       # @return [ true, false ] True and call proc or method if rejectable, false if not.

data/lib/mongoid/relations/proxy.rb

@@ -115,7 +115,8 @@ module Mongoid
       # to the target of the proxy. This can be overridden in special cases.
       #
       # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] *args The arguments passed to the method.
+      # @param [ Array ] args The arguments passed to the method.
+      #
       def method_missing(name, *args, &block)
         target.send(name, *args, &block)
       end
@@ -153,7 +154,7 @@ module Mongoid
       # @example returns the before_add callback method name
       #   callback_method(:before_add)
       #
-      # @param [ Symbol ] which callback
+      # @param [ Symbol ] callback_name Which callback
       #
       # @return [ Array ] with callback methods to be executed, the array may have symbols and Procs
       #

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

@@ -62,8 +62,7 @@ module Mongoid
         # @example Substitute the relation.
         #   name.substitute(new_name)
         #
-        # @param [ Document, Array<Document> ] new_target The replacement.
-        # @param [ true, false ] building Are we in build mode?
+        # @param [ Document, Array<Document> ] replacement The replacement.
         #
         # @return [ In, nil ] The relation or nil.
         #
@@ -83,8 +82,6 @@ module Mongoid
         # @example Get the binding object.
         #   binding([ address ])
         #
-        # @param [ Document, Array<Document> ] new_target The replacement.
-        #
         # @return [ Binding ] The binding object.
         #
         # @since 2.0.0.rc.1

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

@@ -40,7 +40,7 @@ module Mongoid
         # @example Concat with other documents.
         #   person.posts.concat([ post_one, post_two ])
         #
-        # @param [ Document, Array<Document> ] *args Any number of documents.
+        # @param [ Document, Array<Document> ] args Any number of documents.
         #
         # @return [ Array<Document> ] The loaded docs.
         #
@@ -208,7 +208,7 @@ module Mongoid
         # @note This will keep matching documents in memory for iteration
         #   later.
         #
-        # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] arg The ids.
+        # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] args The ids.
         #
         # @return [ Document, Criteria ] The matching document(s).
         #
@@ -385,8 +385,6 @@ module Mongoid
         # @example Get the binding.
         #   relation.binding([ address ])
         #
-        # @param [ Array<Document> ] new_target The new documents to bind with.
-        #
         # @return [ Binding ] The binding.
         #
         # @since 2.0.0.rc.1
@@ -510,7 +508,7 @@ module Mongoid
         #   person.posts.delete_all({ :title => "Testing" })
         #
         # @param [ Hash ] conditions Optional conditions to delete with.
-        # @param [ Symbol ] The deletion method to call.
+        # @param [ Symbol ] method The deletion method to call.
         #
         # @return [ Integer ] The number of documents deleted.
         #
@@ -519,7 +517,7 @@ module Mongoid
           selector = conditions || {}
           removed = klass.send(method, selector.merge!(criteria.selector))
           target.delete_if do |doc|
-            if doc.matches?(selector)
+            if doc._matches?(selector)
               unbind_one(doc) and true
             end
           end
@@ -569,7 +567,7 @@ module Mongoid
           if doc.new_record? && doc.valid?(:create)
             doc.run_before_callbacks(:save, :create)
             docs.push(doc)
-            inserts.push(doc.as_document)
+            inserts.push(doc.send(:as_attributes))
           else
             doc.save
           end

data/lib/mongoid/relations/referenced/many_to_many.rb

@@ -37,7 +37,7 @@ module Mongoid
         # @example Concat with other documents.
         #   person.posts.concat([ post_one, post_two ])
         #
-        # @param [ Document, Array<Document> ] *args Any number of documents.
+        # @param [ Document, Array<Document> ] args Any number of documents.
         #
         # @return [ Array<Document> ] The loaded docs.
         #
@@ -284,7 +284,7 @@ module Mongoid
         #
         # @since 3.0.0
         def unsynced(doc, key)
-          doc.synced[key] = false
+          doc._synced[key] = false
           true
         end
 

data/lib/mongoid/relations/referenced/one.rb

@@ -83,8 +83,6 @@ module Mongoid
         # @example Get the binding.
         #   relation.binding([ address ])
         #
-        # @param [ Document ] new_target The new target of the relation.
-        #
         # @return [ Binding ] The binding object.
         def binding
           Bindings::Referenced::One.new(base, target, __metadata)

data/lib/mongoid/relations/reflections.rb

@@ -24,7 +24,7 @@ module Mongoid
       # @example Find multiple relation metadata by macro.
       #   person.reflect_on_all_associations(:embeds_many)
       #
-      # @param [ Array<Symbol> ] *macros The relation macros.
+      # @param [ Array<Symbol> ] macros The relation macros.
       #
       # @return [ Array<Metadata> ] The matching relation metadata.
       def reflect_on_all_associations(*macros)
@@ -50,7 +50,7 @@ module Mongoid
         # @example Find multiple relation metadata by macro.
         #   Person.reflect_on_all_associations(:embeds_many)
         #
-        # @param [ Array<Symbol> ] *macros The relation macros.
+        # @param [ Array<Symbol> ] macros The relation macros.
         #
         # @return [ Array<Metadata> ] The matching relation metadata.
         def reflect_on_all_associations(*macros)

data/lib/mongoid/relations/synchronization.rb

@@ -11,41 +11,41 @@ module Mongoid
       # the key has changed and the relation bindings have not been run.
       #
       # @example Are the foreign keys syncable?
-      #   document.syncable?(metadata)
+      #   document._syncable??(metadata)
       #
       # @param [ Metadata ] metadata The relation metadata.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def syncable?(metadata)
-        !synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
+      def _syncable?(metadata)
+        !_synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
       end
 
       # Get the synced foreign keys.
       #
       # @example Get the synced foreign keys.
-      #   document.synced
+      #   document._synced
       #
       # @return [ Hash ] The synced foreign keys.
       #
       # @since 2.1.0
-      def synced
-        @synced ||= {}
+      def _synced
+        @_synced ||= {}
       end
 
       # Has the document been synced for the foreign key?
       #
       # @example Has the document been synced?
-      #   document.synced?
+      #   document._synced??
       #
       # @param [ String ] foreign_key The foreign key.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def synced?(foreign_key)
-        !!synced[foreign_key]
+      def _synced?(foreign_key)
+        !!_synced[foreign_key]
       end
 
       # Update the inverse keys on destroy.
@@ -110,7 +110,7 @@ module Mongoid
         # @param [ Metadata ] metadata The relation metadata.
         #
         # @since 2.1.0
-        def synced(metadata)
+        def _synced(metadata)
           unless metadata.forced_nil_inverse?
             synced_save(metadata)
             synced_destroy(metadata)
@@ -137,7 +137,7 @@ module Mongoid
           set_callback(
             :save,
             :after,
-            if: ->(doc){ doc.syncable?(metadata) }
+            if: ->(doc){ doc._syncable?(metadata) }
           ) do |doc|
             doc.update_inverse_keys(metadata)
           end

data/lib/mongoid/scopable.rb

@@ -80,7 +80,7 @@ module Mongoid
       #     default_scope ->{ where(active: true) }
       #   end
       #
-      # @param [ Proc, Criteria ] scope The default scope.
+      # @param [ Proc, Criteria ] value The default scope.
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
       #
@@ -136,7 +136,7 @@ module Mongoid
       #   end
       #
       # @param [ Symbol ] name The name of the scope.
-      # @param [ Proc ] conditions The conditions of the scope.
+      # @param [ Proc ] value The conditions of the scope.
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a proc.
       # @raise [ Errors::ScopeOverwrite ] If the scope name already exists.

data/lib/mongoid/serializable.rb

@@ -66,7 +66,7 @@ module Mongoid
     #
     # @since 3.0.0
     def field_names(options)
-      names = (as_document.keys + attribute_names).uniq.sort
+      names = (as_attributes.keys + attribute_names).uniq.sort
 
       only = Array.wrap(options[:only]).map(&:to_s)
       except = Array.wrap(options[:except]).map(&:to_s)
@@ -138,7 +138,7 @@ module Mongoid
     # @example Get the relation names.
     #   document.relation_names(:include => [ :addresses ])
     #
-    # @param [ Hash, Symbol, Array<Symbol ] inclusions The inclusions.
+    # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     #
     # @return [ Array<Symbol> ] The names of the included relations.
     #
@@ -153,7 +153,8 @@ module Mongoid
     # @example Get the relation options.
     #   document.relation_names(:include => [ :addresses ])
     #
-    # @param [ Hash, Symbol, Array<Symbol ] inclusions The inclusions.
+    # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
+    # @param [ Hash ] options The options.
     # @param [ Symbol ] name The name of the relation.
     #
     # @return [ Hash ] The options for the relation.