mongoid 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c57e0133222699f9072fe67b609e7212327028ff
-  data.tar.gz: f2f799925ab8ca3b9126b16fe5a8d52c03fb1146
+  metadata.gz: 8df15f3d764e3c19bcc5719c656f833ce258bb65
+  data.tar.gz: 335173b371125d1e84100af19293bccf459df5b8
 SHA512:
-  metadata.gz: 8139bde85b47d8920a022f4f1a3c68796c446192128be7a7ceb59607c82be58404a956e89676e61ce61a6f39fd691b4b8f39bf2a31663ef64f482a5271986484
-  data.tar.gz: d500146fa38cbdf1e5d915fa164ef465f4b0ba3ffc7568d77fc85bc9576b61dab8efdbffa42ff8fb2b72063997b8207c264ec52a2f11c04140f09c2a5532b778
+  metadata.gz: e6fabe8ac17c05be402c8dd42bff52a4158e0a0d0650cd36363a7439ea19e32d0a3b28427b85fb88749df2941d2ba5fa4c639aa74f9b70ef0e4875acd4438ae6
+  data.tar.gz: 40cf34caa79067109baeee5b434f8e2497c654a91248a73a220ac1ded8d685fbc3ea13adaa0e4335246af64f09ed4942848b5b3e6beacb966ae7f7250c655ac8

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)
@@ -222,7 +222,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_pushes
-      pushable? ? { atomic_position => as_document } : {}
+      pushable? ? { atomic_position => as_attributes } : {}
     end
 
     # Get all the attributes that need to be set.
@@ -234,7 +234,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_sets
-      updateable? ? setters : settable? ? { atomic_path => as_document } : {}
+      updateable? ? setters : settable? ? { atomic_path => as_attributes } : {}
     end
 
     # Get all the attributes that need to be unset.

data/lib/mongoid/attributes.rb

@@ -215,7 +215,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)
@@ -333,7 +332,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

@@ -38,7 +38,7 @@ module Mongoid
       def mongo_client
         persistence_context.client
       end
-
+      
       def persistence_context
         PersistenceContext.get(self) ||
             PersistenceContext.get(self.class) ||

data/lib/mongoid/composable.rb

@@ -82,8 +82,10 @@ module Mongoid
       Traversable,
       Validatable,
       Equality,
+      Relations::Synchronization,
       ActiveModel::Model,
-      ActiveModel::Validations
+      ActiveModel::Validations,
+      PersistenceContext
     ]
 
     # These are methods names defined in included blocks that may conflict

data/lib/mongoid/contextual/atomic.rb

@@ -157,7 +157,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/memory.rb

@@ -44,7 +44,7 @@ module Mongoid
         deleted = count
         removed = map do |doc|
           prepare_remove(doc)
-          doc.as_document
+          doc.send(:as_attributes)
         end
         unless removed.empty?
           collection.find(selector).update_one(
@@ -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)
@@ -148,7 +148,7 @@ module Mongoid
         @documents = criteria.documents.select do |doc|
           @root ||= doc._root
           @collection ||= root.collection
-          doc.matches?(criteria.selector)
+          doc._matches?(criteria.selector)
         end
         apply_sorting
         apply_options

data/lib/mongoid/contextual/mongo.rb

@@ -200,7 +200,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
@@ -239,7 +239,7 @@ module Mongoid
       # @note Automatically adding a sort on _id when no other sort is
       #   defined on the criteria has the potential to cause bad performance issues.
       #   If you experience unexpected poor performance when using #first or #last
-      #   and have no sort defined on the criteria, use the option { sort: :none }.
+      #   and have no sort defined on the criteria, use the option { id_sort: :none }.
       #   Be aware that #first/#last won't guarantee order in this case.
       #
       # @param [ Hash ] opts The options for the query returning the first document.
@@ -313,7 +313,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.
@@ -354,7 +354,7 @@ module Mongoid
       # @note Automatically adding a sort on _id when no other sort is
       #   defined on the criteria has the potential to cause bad performance issues.
       #   If you experience unexpected poor performance when using #first or #last
-      #   and have no sort defined on the criteria, use the option { sort: :none }.
+      #   and have no sort defined on the criteria, use the option { id_sort: :none }.
       #   Be aware that #first/#last won't guarantee order in this case.
       #
       # @param [ Hash ] opts The options for the query returning the first document.
@@ -425,7 +425,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

@@ -21,6 +21,18 @@ module Mongoid
         other.is_a?(None)
       end
 
+      # Allow distinct for null context.
+      #
+      # @example Get the distinct values.
+      #   context.distinct(:name)
+      #
+      # @param [ String, Symbol ] field the name of the field.
+      #
+      # @return [ Array ] Empty Array
+      def distinct(field)
+        []
+      end
+
       # Iterate over the null context. There are no documents to iterate over
       # in this case.
       #
@@ -57,7 +69,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 +81,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
@@ -47,11 +45,9 @@ 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__
+      attrs = as_attributes.__deep_copy__
       process_localized_attributes(self, attrs)
       attrs
     end

data/lib/mongoid/criteria.rb

@@ -211,7 +211,7 @@ module Mongoid
     #
     # @example Merge the criteria with a hash. The hash must contain a klass
     #   key and the key/value pairs correspond to method names/args.
-
+    #
     #   criteria.merge({
     #     klass: Band,
     #     where: { name: "Depeche Mode" },
@@ -389,7 +389,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/criteria/queryable/aggregable.rb

@@ -60,7 +60,7 @@ module Mongoid
         # @example Add a projection to the pipeline.
         #   aggregable.project(author: 1, name: 0)
         #
-        # @param [ Hash ] criterion The projection to make.
+        # @param [ Hash ] operation The projection to make.
         #
         # @return [ Aggregable ] The aggregable.
         #

data/lib/mongoid/criteria/queryable/extensions/array.rb

@@ -162,7 +162,7 @@ module Mongoid
             # @example Evolve the object.
             #   Array.evolve(1)
             #
-            # @param [ Object ] The object to evolve.
+            # @param [ Object ] object The object to evolve.
             #
             # @return [ Object ] The evolved object.
             #

data/lib/mongoid/criteria/queryable/extensions/boolean.rb

@@ -14,7 +14,7 @@ module Mongoid
             # @example Evolve the value to a boolean.
             #   Boolean.evolve(true)
             #
-            # @param [ Object ] The object to evolve.
+            # @param [ Object ] object The object to evolve.
             #
             # @return [ true, false ] The boolean value.
             #

data/lib/mongoid/criteria/queryable/extensions/hash.rb

@@ -26,7 +26,7 @@ module Mongoid
           # @example Merge the hash into the array.
           #   { field: value }.__add_from_array__([ 1, 2 ])
           #
-          # @param [ Array ] value The array to add to.
+          # @param [ Array ] array The array to add to.
           #
           # @return [ Hash ] The merged hash.
           #
@@ -54,7 +54,7 @@ module Mongoid
           # @example Merge the hash into the array.
           #   { field: value }.__intersect_from_array__([ 1, 2 ])
           #
-          # @param [ Array ] value The array to intersect to.
+          # @param [ Array ] array The array to intersect to.
           #
           # @return [ Hash ] The merged hash.
           #
@@ -68,7 +68,7 @@ module Mongoid
           # @example Merge the hash into the object.
           #   { field: value }.__intersect_from_object__([ 1, 2 ])
           #
-          # @param [ Object ] value The object to intersect to.
+          # @param [ Object ] object The object to intersect to.
           #
           # @return [ Hash ] The merged hash.
           #
@@ -96,7 +96,7 @@ module Mongoid
           # @example Merge the hash into the object.
           #   { field: value }.__union_from_object__([ 1, 2 ])
           #
-          # @param [ Object ] value The object to union to.
+          # @param [ Object ] object The object to union to.
           #
           # @return [ Hash ] The merged hash.
           #

data/lib/mongoid/criteria/queryable/extensions/object.rb

@@ -26,7 +26,7 @@ module Mongoid
           # @example Merge the object into the array.
           #   4.__add_from_array__([ 1, 2 ])
           #
-          # @param [ Array ] value The array to add to.
+          # @param [ Array ] array The array to add to.
           #
           # @return [ Array ] The merged object.
           #
@@ -54,7 +54,7 @@ module Mongoid
           # @example Merge the object into the array.
           #   4.__intersect_from_array__([ 1, 2 ])
           #
-          # @param [ Array ] value The array to intersect to.
+          # @param [ Array ] array The array to intersect to.
           #
           # @return [ Array ] The merged object.
           #
@@ -68,7 +68,7 @@ module Mongoid
           # @example Merge the object into the array.
           #   4.__intersect_from_object__([ 1, 2 ])
           #
-          # @param [ Object ] value The value to intersect to.
+          # @param [ Object ] object The value to intersect to.
           #
           # @return [ Array ] The merged object.
           #
@@ -96,7 +96,7 @@ module Mongoid
           # @example Merge the object into the array.
           #   4.__union_from_object__([ 1, 2 ])
           #
-          # @param [ Object ] value The value to union to.
+          # @param [ Object ] object The value to union to.
           #
           # @return [ Array ] The merged object.
           #

data/lib/mongoid/criteria/queryable/extensions/regexp.rb

@@ -35,6 +35,38 @@ module Mongoid
               end
             end
           end
+
+          module Raw
+
+            # Is the object a regexp?
+            #
+            # @example Is the object a regex?
+            #   bson_raw_regexp.regexp?
+            #
+            # @return [ true ] Always true.
+            #
+            # @since 5.2.1
+            def regexp?; true; end
+
+            module ClassMethods
+
+              # Evolve the object into a raw bson regex.
+              #
+              # @example Evolve the object to a regex.
+              #   BSON::Regexp::Raw.evolve("^[123]")
+              #
+              # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
+              #
+              # @return [ BSON::Regexp::Raw ] The evolved raw regex.
+              #
+              # @since 5.2.1
+              def evolve(object)
+                __evolve__(object) do |obj|
+                  obj.is_a?(String) ? BSON::Regexp::Raw.new(obj) : obj
+                end
+              end
+            end
+          end
         end
       end
     end
@@ -43,3 +75,5 @@ end
 
 ::Regexp.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp)
 ::Regexp.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::ClassMethods)
+BSON::Regexp::Raw.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp::Raw)
+BSON::Regexp::Raw.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::Raw::ClassMethods)