mongoid 5.2.1 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5ae2a3a33da11eae20a6d6b268ad3e69d601a13
-  data.tar.gz: 661ff308d0402ab14a5a3920534a1a88f879e3ec
+SHA256:
+  metadata.gz: '08c29d43d146e27e4060d618a847e86dce00eb9ed09ccc040176bb36607c85d8'
+  data.tar.gz: 36e253fc8ba8ee3b873d3b86b644134a71927761ae6b3d3ee87681815552a22d
 SHA512:
-  metadata.gz: a910a280572a11c133f8f3900f878fdb719c548998381bb38c08714c911cbfc1ebfd508ffb84621489cdd8806a8e054cbb55aa041a189267f1fdb30d322d8895
-  data.tar.gz: 0bfeada8b1bc927fde4414f1accdfe30037b36d56776c5f9b904b041e5356bd4df7a202fbb69e40edda9c165d84a78cdc0f4971ebb7afcad021bd7526d9e6cf0
+  metadata.gz: 628fe19e7e6e0472e18d640d807c4aa611da9da1944992ee828717acf82d0d84f35891fcd149bf48d3fe12617e44c1d840323b6d014705d5f6691ff3e54ddbcb
+  data.tar.gz: 5ca94d2eff2fc0249af67f84ed337fcee8a6c433e5b2c16b51a25304226960e33ef3b3f634ba96b382f6277d39b4797298af969e1560b4ead3ed308c2272c222

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+�l�jY~�8�Kb�����6&l'Q�;Q�
,�K��7��q
���#�����И����Y�������!����|>�z��f0����l�f3���]fxi�Q�I�^~�%�?��W��r�O&laו��
m}�`����ܺfy���+ȶ�RyXƅ^f<��r�
3�\܁x3�gSղ#�	��j�ჟ�t$�vc�T�t�Zc��5��nG
��8��S�[)��j0�"�k�+D�I���6���rZ�d

data/lib/mongoid/atomic.rb

@@ -31,7 +31,7 @@ module Mongoid
     # @example Add the atomic pull.
     #   person.add_atomic_pull(address)
     #
-    # @param [ Document ] The embedded document to pull.
+    # @param [ Document ] document The embedded document to pull.
     #
     # @since 2.2.0
     def add_atomic_pull(document)

data/lib/mongoid/atomic/modifiers.rb

@@ -68,7 +68,7 @@ module Mongoid
         modifications.each_pair do |field, value|
           push_fields[field] = field
           mods = push_conflict?(field) ? conflicting_pushes : pushes
-          add_operation(mods, field, Array.wrap(value))
+          add_operation(mods, field, {'$each' => Array.wrap(value)})
         end
       end
 
@@ -118,8 +118,12 @@ module Mongoid
       # @since 2.2.0
       def add_operation(mods, field, value)
         if mods.has_key?(field)
-          value.each do |val|
-            mods[field].push(val)
+          if mods[field].is_a?(Array)
+            value.each do |val|
+              mods[field].push(val)
+            end
+          elsif mods[field]['$each']
+            mods[field]['$each'].concat(value['$each']) 
           end
         else
           mods[field] = value
@@ -190,7 +194,7 @@ module Mongoid
       #
       # @since 2.2.0
       def conflicting_pushes
-        conflicts["$pushAll"] ||= {}
+        conflicts["$push"] ||= {}
       end
 
       # Get the conflicting set modifications.
@@ -277,16 +281,16 @@ module Mongoid
         self["$pull"] ||= {}
       end
 
-      # Get the $pushAll operations or intialize a new one.
+      # Get the $push/$each operations or initialize a new one.
       #
-      # @example Get the $pushAll operations.
+      # @example Get the $push/$each operations.
       #   modifiers.pushes
       #
-      # @return [ Hash ] The $pushAll operations.
+      # @return [ Hash ] The $push/$each operations.
       #
       # @since 2.1.0
       def pushes
-        self["$pushAll"] ||= {}
+        self["$push"] ||= {}
       end
 
       # Get the $set operations or intialize a new one.

data/lib/mongoid/attributes.rb

@@ -218,7 +218,6 @@ module Mongoid
     #   person.attributes = { :title => "Mr." }
     #
     # @param [ Hash ] attrs The new attributes to set.
-    # @param [ Boolean ] guard_protected_attributes False to skip mass assignment protection.
     #
     # @since 1.0.0
     def write_attributes(attrs = nil)
@@ -332,7 +331,7 @@ module Mongoid
     # the value is valid for given a field.
     # For now, only Hash and Array fields are validated.
     #
-    # @param [ String, Symbol ] name The name of the attribute to validate.
+    # @param [ String, Symbol ] access The name of the attribute to validate.
     # @param [ Object ] value The to be validated.
     #
     # @since 3.0.10

data/lib/mongoid/attributes/dynamic.rb

@@ -13,7 +13,8 @@ module Mongoid
       # @example Does this object respond to the method?
       #   person.respond_to?(:title)
       #
-      # @param [ Array ] *args The name of the method.
+      # @param [ Array ] name The name of the method.
+      # @param [ true, false ] include_private
       #
       # @return [ true, false ] True if it does, false if not.
       #
@@ -126,7 +127,7 @@ module Mongoid
       #   document.method_missing(:test)
       #
       # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] *args The arguments to the method.
+      # @param [ Array ] args The arguments to the method.
       #
       # @return [ Object ] The result of the method call.
       #

data/lib/mongoid/attributes/nested.rb

@@ -34,7 +34,7 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] *args A list of relation names, followed
+        # @param [ Array<Symbol>, Hash ] args A list of relation names, followed
         #   by a hash of options.
         #
         # @option *args [ true, false ] :allow_destroy Can deletion occur?

data/lib/mongoid/attributes/processing.rb

@@ -118,8 +118,6 @@ module Mongoid
       # @example Process the pending items.
       #   document.process_pending
       #
-      # @param [ Hash ] options The mass assignment options.
-      #
       # @since 2.0.0.rc.7
       def process_pending
         process_nested and process_relations
@@ -132,8 +130,6 @@ module Mongoid
       # @example Process the relations.
       #   document.process_relations
       #
-      # @param [ Hash ] options The mass assignment options.
-      #
       # @since 2.0.0.rc.7
       def process_relations
         pending_relations.each_pair do |name, value|

data/lib/mongoid/changeable.rb

@@ -265,7 +265,7 @@ module Mongoid
       #   Model.create_dirty_methods("name", "name")
       #
       # @param [ String ] name The name of the field.
-      # @param [ String ] name The name of the accessor.
+      # @param [ String ] meth The name of the accessor.
       #
       # @return [ Module ] The fields module.
       #

data/lib/mongoid/clients/options.rb

@@ -135,7 +135,7 @@ module Mongoid
         #   Threaded.set_options(Band, { write: { w: 3 }})
         #
         # @param [ Class ] klass The model class.
-        # @param [ Mongo::Client ] client The client with options.
+        # @param [ Mongo::Client ] options The options.
         #
         # @return [ Mongo::Client, nil ] The client or nil if the cluster does not change.
         #
@@ -252,8 +252,9 @@ module Mongoid
         def with(options)
           if block_given?
             set_options(self, options)
-            yield self
+            result = yield self
             unset_options(self)
+            result
           else
             Proxy.new(self, (persistence_options || {}).merge(options))
           end

data/lib/mongoid/contextual/atomic.rb

@@ -106,18 +106,21 @@ module Mongoid
         view.update_many("$push" => collect_operations(pushes))
       end
 
-      # Perform an atomic $pushAll operation on the matching documents.
+      # Perform an atomic $push/$each operation on the matching documents.
       #
       # @example Push the values to the matching docs.
-      #   context.push(members: [ "Alan", "Fletch" ])
+      #   context.push_each(members: [ "Alan", "Fletch" ])
       #
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
       #
-      # @since 3.0.0
-      def push_all(pushes)
-        view.update_many("$pushAll" => collect_operations(pushes))
+      # @since 5.4.0
+      def push_each(pushes)
+        push_each_updates = collect_operations(pushes).each.inject({}) do |ops, (field, elements)|
+          ops.merge!(field => { '$each' => elements })
+        end
+        view.update_many("$push" => push_each_updates)
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -157,7 +160,7 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String, Symbol, Array ] fields The name of the fields.
+      # @param [ String, Symbol, Array ] args The name of the fields.
       #
       # @return [ nil ] Nil.
       #

data/lib/mongoid/contextual/geo_near.rb

@@ -63,9 +63,10 @@ module Mongoid
       # @example Initialize the new map/reduce.
       #   MapReduce.new(criteria, map, reduce)
       #
+      # @param [ Mongo::Collection ] collection The collection to run the
+      #   operation on.
       # @param [ Criteria ] criteria The Mongoid criteria.
-      # @param [ String ] map The map js function.
-      # @param [ String ] reduce The reduce js function.
+      # @param [ String ] near
       #
       # @since 3.0.0
       def initialize(collection, criteria, near)

data/lib/mongoid/contextual/map_reduce.rb

@@ -111,6 +111,7 @@ module Mongoid
       end
 
       # Specifies where the map/reduce output is to be stored.
+      # Please see MongoDB documentation for supported map reduce options.
       #
       # @example Store output in memory.
       #   map_reduce.out(inline: 1)
@@ -124,6 +125,9 @@ module Mongoid
       # @example Store output in a collection, reducing existing documents.
       #   map_reduce.out(reduce: "collection_name")
       #
+      # @example Return results from map reduce.
+      #   map_reduce.out(inline: 1)
+      #
       # @param [ Hash ] location The place to store the results.
       #
       # @return [ MapReduce ] The map/reduce object.

data/lib/mongoid/contextual/memory.rb

@@ -140,7 +140,7 @@ module Mongoid
       # @example Create the new context.
       #   Memory.new(criteria)
       #
-      # @param [ Criteria ] The criteria.
+      # @param [ Criteria ] criteria The criteria.
       #
       # @since 3.0.0
       def initialize(criteria)

data/lib/mongoid/contextual/mongo.rb

@@ -197,7 +197,7 @@ module Mongoid
       # @example Execute the command.
       #   context.find_one_and_update({ likes: 1 })
       #
-      # @param [ Hash ] update The updates.
+      # @param [ Hash ] replacement The replacement.
       # @param [ Hash ] options The command options.
       #
       # @option options [ :before, :after ] :return_document Return the updated document
@@ -298,7 +298,7 @@ module Mongoid
       # @example Map by some field.
       #   context.map(:field1)
       #
-      # @exmaple Map with block.
+      # @example Map with block.
       #   context.map(&:field1)
       #
       # @param [ Symbol ] field The field name.
@@ -407,7 +407,7 @@ module Mongoid
       # @note This method will return the raw db values - it performs no custom
       #   serialization.
       #
-      # @param [ String, Symbol, Array ] field Fields to pluck.
+      # @param [ String, Symbol, Array ] fields Fields to pluck.
       #
       # @return [ Array<Object, Array> ] The plucked values.
       #

data/lib/mongoid/contextual/none.rb

@@ -57,7 +57,7 @@ module Mongoid
       # @example Allow pluck for null context.
       #   context.pluck(:name)
       #
-      # @param [ String, Symbol, Array ] field or fields to pluck.
+      # @param [ String, Symbol, Array ] args Field or fields to pluck.
       #
       # @return [ Array ] Emtpy Array
       def pluck(*args)
@@ -69,7 +69,7 @@ module Mongoid
       # @example Create the new context.
       #   Null.new(criteria)
       #
-      # @param [ Criteria ] The criteria.
+      # @param [ Criteria ] criteria The criteria.
       #
       # @since 4.0.0
       def initialize(criteria)

data/lib/mongoid/copyable.rb

@@ -14,8 +14,6 @@ module Mongoid
     # @example Clone the document.
     #   document.clone
     #
-    # @param [ Document ] other The document getting cloned.
-    #
     # @return [ Document ] The new document.
     def clone
       # @note This next line is here to address #2704, even though having an
@@ -40,8 +38,6 @@ module Mongoid
     # @example clone document
     #   model.clone_document
     #
-    # @param [ Hash ] dcoument The document with hash format
-    #
     # @since 3.0.22
     def clone_document
       attrs = as_document.__deep_copy__

data/lib/mongoid/criteria.rb

@@ -386,7 +386,7 @@ module Mongoid
     # @example Add a javascript selection.
     #   criteria.where("this.name == 'syd'")
     #
-    # @param [ String, Hash ] criterion The javascript or standard selection.
+    # @param [ String, Hash ] expression The javascript or standard selection.
     #
     # @raise [ UnsupportedJavascript ] If provided a string and the criteria
     #   is embedded.

data/lib/mongoid/criteria/findable.rb

@@ -8,7 +8,8 @@ module Mongoid
       # @example Execute or raise
       #   criteria.execute_or_raise(id)
       #
-      # @param [ Object ] args The arguments passed.
+      # @param [ Object ] ids The arguments passed.
+      # @param [ true, false ] multi Whether there arguments were a list.
       #
       # @raise [ Errors::DocumentNotFound ] If nothing returned.
       #
@@ -66,7 +67,7 @@ module Mongoid
       # @example Get the documents from the map or criteria.
       #   criteria.multiple_from_map_or_db(ids)
       #
-      # @param [ ids ] The searched ids.
+      # @param [ Array<Object> ] ids The searched ids.
       #
       # @return [ Array<Document> ] The found documents.
       def multiple_from_db(ids)

data/lib/mongoid/criteria/includable.rb

@@ -48,7 +48,7 @@ module Mongoid
       # @example Set the inclusions.
       #   criteria.inclusions = [ meta ]
       #
-      # @param [ Array<Metadata> ] The inclusions.
+      # @param [ Array<Metadata> ] value The inclusions.
       #
       # @return [ Array<Metadata> ] The new inclusions.
       #
@@ -65,7 +65,7 @@ module Mongoid
       #   criteria.add_inclusion(Person, :posts)
       #
       # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
-      # @param [ Symbol ] relation The relation.
+      # @param [ Symbol ] metadata The relation.
       #
       # @raise [ Errors::InvalidIncludes ] If no relation is found.
       #

data/lib/mongoid/errors/delete_restriction.rb

@@ -11,8 +11,8 @@ module Mongoid
       # @example Create the new callbacks error.
       #   Callbacks.new(Post, :create!)
       #
-      # @param [ Class ] klass The class of the document.
-      # @param [ Symbol ] method The name of the method.
+      # @param [ Class ] document
+      # @param [ Symbol ] relation
       #
       # @since 3.0.0
       def initialize(document, relation)

data/lib/mongoid/errors/inverse_not_found.rb

@@ -12,7 +12,7 @@ module Mongoid
       #
       # @param [ Class ] base The base class.
       # @param [ Symbol ] name The name of the relation.
-      # @param [ Class ] The child class.
+      # @param [ Class ] klass The child class.
       # @param [ Symbol ] inverse The attempted inverse key.
       #
       # @since 3.0.0

data/lib/mongoid/extensions/hash.rb

@@ -161,10 +161,11 @@ module Mongoid
       # @api private
       #
       # @example Mongoize for the klass, field and value.
-      #   {}.mongoize_for(Band, "name", "test")
+      #   {}.mongoize_for("$push", Band, "name", "test")
       #
+      # @param [ String ] operator The operator.
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] The field key.
+      # @param [ String, Symbol ] key The field key.
       # @param [ Object ] value The value to mongoize.
       #
       # @return [ Object ] The mongoized value.

data/lib/mongoid/extensions/object.rb

@@ -94,7 +94,7 @@ module Mongoid
       #   object.do_or_do_not(:use, "The Force")
       #
       # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] *args The arguments.
+      # @param [ Array ] args The arguments.
       #
       # @return [ Object, nil ] The result of the method call or nil if the
       #   method does not exist.
@@ -209,7 +209,7 @@ module Mongoid
       #   object.you_must(:use, "The Force")
       #
       # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] *args The arguments.
+      # @param [ Array ] args The arguments.
       #
       # @return [ Object, nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.

data/lib/mongoid/extensions/time.rb

@@ -27,7 +27,7 @@ module Mongoid
         # @example Get the configured time.
         #   ::Time.configured
         #
-        # @retun [ Time ] The configured time.
+        # @return [ Time ] The configured time.
         #
         # @since 3.0.0
         def configured

data/lib/mongoid/factory.rb

@@ -14,7 +14,6 @@ module Mongoid
     #
     # @param [ Class ] klass The class to instantiate from if _type is not present.
     # @param [ Hash ] attributes The document attributes.
-    # @param [ Hash ] options The mass assignment scoping options.
     #
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)

data/lib/mongoid/fields/foreign_key.rb

@@ -14,8 +14,8 @@ module Mongoid
       # @param [ String ] name The name of the field.
       # @param [ String ] key The atomic location of the field.
       # @param [ Hash ] mods The current modifications.
-      # @param [ Array ] new The new elements to add.
-      # @param [ Array ] old The old elements getting removed.
+      # @param [ Array ] new_elements The new elements to add.
+      # @param [ Array ] old_elements The old elements getting removed.
       #
       # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new_elements, old_elements)