mongoid 6.1.0 → 6.1.1

data/lib/mongoid/criteria/queryable/options.rb

@@ -88,6 +88,22 @@ module Mongoid
           pipeline
         end
 
+        # Perform a deep copy of the options.
+        #
+        # @example Perform a deep copy.
+        #   options.__deep_copy__
+        #
+        # @return [ Options ] The copied options.
+        #
+        # @since 6.1.1
+        def __deep_copy__
+          self.class.new(aliases, serializers) do |copy|
+            each_pair do |key, value|
+              copy.merge!(key => value.__deep_copy__)
+            end
+          end
+        end
+
         private
 
         # Evolve a single key selection with various types of values.

data/lib/mongoid/criteria/queryable/selector.rb

@@ -83,7 +83,7 @@ module Mongoid
         # @example Evolve the multi-selection.
         #   selector.evolve_multi([{ field: "value" }])
         #
-        # @param [ Array<Hash> ] The multi-selection.
+        # @param [ Array<Hash> ] value The multi-selection.
         #
         # @return [ Array<Hash> ] The serialized values.
         #

data/lib/mongoid/document.rb

@@ -282,7 +282,7 @@ module Mongoid
           relation, stored = send(name), meta.store_as
           if attributes.key?(stored) || !relation.blank?
             if relation
-              attributes[stored] = relation.as_document
+              attributes[stored] = relation.send(:as_attributes)
             else
               attributes.delete(stored)
             end

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

@@ -162,10 +162,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

@@ -30,7 +30,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)

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

@@ -92,7 +92,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.
@@ -110,7 +110,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,19 +118,13 @@ 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
     #
     # @since 2.3.0
     def run_callbacks(kind, *args, &block)
       cascadable_children(kind).each do |child|
-        # This is returning false for some destroy tests on 4.1.0.beta1,
-        # causing them to fail since 4.1.0 expects a block to be passed if the
-        # callbacks for the type are empty. If no block is passed then the nil
-        # return value gets interpreted as false and halts the chain.
-        #
-        # @see https://github.com/rails/rails/blob/master/activesupport/lib/active_support/callbacks.rb#L79
         if child.run_callbacks(child_callback_type(kind, child), *args) == false
           return false
         end
@@ -196,7 +190,7 @@ module Mongoid
     #
     # @since 2.3.0
     def cascadable_child?(kind, child, metadata)
-      return false if kind == :initialize || kind == :find
+      return false if kind == :initialize || kind == :find || kind == :touch
       return false if kind == :validate && metadata.validate?
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end

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

@@ -13,6 +13,7 @@ require "mongoid/matchable/nin"
 require "mongoid/matchable/or"
 require "mongoid/matchable/size"
 require "mongoid/matchable/elem_match"
+require "mongoid/matchable/regexp"
 
 module Mongoid
 
@@ -46,26 +47,26 @@ module Mongoid
     # MongoDB selector. Used for matching on embedded associations.
     #
     # @example Does the document match?
-    #   document.matches?(:title => { "$in" => [ "test" ] })
+    #   document._matches?(:title => { "$in" => [ "test" ] })
     #
     # @param [ Hash ] selector The MongoDB selector.
     #
     # @return [ true, false ] True if matches, false if not.
     #
     # @since 1.0.0
-    def matches?(selector)
+    def _matches?(selector)
       selector.each_pair do |key, value|
         if value.is_a?(Hash)
           value.each do |item|
             if item[0].to_s == "$not".freeze
               item = item[1]
-              return false if matcher(self, key, item).matches?(item)
+              return false if matcher(self, key, item)._matches?(item)
             else
-              return false unless matcher(self, key, Hash[*item]).matches?(Hash[*item])
+              return false unless matcher(self, key, Hash[*item])._matches?(Hash[*item])
             end
           end
         else
-          return false unless matcher(self, key, value).matches?(value)
+          return false unless matcher(self, key, value)._matches?(value)
         end
       end
       true
@@ -83,7 +84,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.
     #
@@ -104,7 +105,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.
       #
@@ -117,6 +118,8 @@ module Mongoid
           else
             Default.new(extract_attribute(document, key))
           end
+        elsif value.regexp?
+          Regexp.new(extract_attribute(document, key))
         else
           case key.to_s
             when "$or" then Or.new(value, document)
@@ -143,9 +146,13 @@ module Mongoid
       # @since 2.2.1
       def extract_attribute(document, key)
         if (key_string = key.to_s) =~ /.+\..+/
-          key_string.split('.').inject(document.as_document) do |_attribs, _key|
+          key_string.split('.').inject(document.send(:as_attributes)) do |_attribs, _key|
             if _attribs.is_a?(::Array)
-              _attribs.map { |doc| doc.try(:[], _key) }
+              if _key =~ /\A\d+\z/ && _attribs.none? {|doc| doc.is_a?(Hash)}
+                _attribs.try(:[], _key.to_i)
+              else
+                _attribs.map { |doc| doc.try(:[], _key) }
+              end
             else
               _attribs.try(:[], _key)
             end

data/lib/mongoid/matchable/all.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute and first value in the hash are equal.
       #
       # @example Do the values match?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If the values match.
-      def matches?(value)
+      def _matches?(value)
         first = first(value)
         return false if first.is_a?(Array) && first.empty?
 

data/lib/mongoid/matchable/and.rb

@@ -8,19 +8,19 @@ module Mongoid
       # Does the supplied query match the attribute?
       #
       # @example Does this match?
-      #   matcher.matches?([ { field => value } ])
+      #   matcher._matches?([ { field => value } ])
       #
       # @param [ Array ] conditions The or expression.
       #
       # @return [ true, false ] True if matches, false if not.
       #
       # @since 2.3.0
-      def matches?(conditions)
+      def _matches?(conditions)
         conditions.each do |condition|
           condition.keys.each do |k|
             key = k
             value = condition[k]
-            return false unless document.matches?(key => value)
+            return false unless document._matches?(key => value)
           end
         end
         true

data/lib/mongoid/matchable/default.rb

@@ -24,14 +24,14 @@ module Mongoid
       # if the value is included.
       #
       # @example Does this value match?
-      #   default.matches?("value")
+      #   default._matches?("value")
       #
       # @param [ Object ] value The value to check if it matches.
       #
       # @return [ true, false ] True if matches, false if not.
       #
       # @since 1.0.0
-      def matches?(value)
+      def _matches?(value)
         attribute.is_a?(Array) && !value.is_a?(Array) ? attribute.any? { |_attribute| value === _attribute } : value === attribute
       end
 

data/lib/mongoid/matchable/elem_match.rb

@@ -7,19 +7,19 @@ module Mongoid
       # Return true if a given predicate matches a sub document entirely
       #
       # @example Do the values match?
-      #   matcher.matches?({"$elemMatch" => {"a" => 1, "b" => 2}})
+      #   matcher._matches?({"$elemMatch" => {"a" => 1, "b" => 2}})
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If the values match.
-      def matches?(value)
+      def _matches?(value)
         if !@attribute.is_a?(Array) || !value.kind_of?(Hash) || !value["$elemMatch"].kind_of?(Hash)
           return false
         end
 
         return @attribute.any? do |sub_document|
           value["$elemMatch"].all? do |k, v|
-            Matchable.matcher(sub_document, k, v).matches?(v)
+            Matchable.matcher(sub_document, k, v)._matches?(v)
           end
         end
       end

data/lib/mongoid/matchable/exists.rb

@@ -10,12 +10,12 @@ module Mongoid
       # non-existence.
       #
       # @example Does anything exist?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If a value exists.
-      def matches?(value)
+      def _matches?(value)
         @attribute.nil? != value.values.first
       end
     end

data/lib/mongoid/matchable/gt.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is greater than the value.
       #
       # @example Do the values match?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If a value exists.
-      def matches?(value)
+      def _matches?(value)
         determine(value, :>)
       rescue ArgumentError
         false

data/lib/mongoid/matchable/gte.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is greater than or equal to the value.
       #
       # @example Do the values match?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If a value exists.
-      def matches?(value)
+      def _matches?(value)
         determine(value, :>=)
       rescue ArgumentError
         false

data/lib/mongoid/matchable/in.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is in the values.
       #
       # @example Do the values match?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If a value exists.
-      def matches?(value)
+      def _matches?(value)
         attribute_array = @attribute.nil? ? [nil] : Array.wrap(@attribute)
         value.values.first.any? do |e|
           attribute_array.any? { |_attribute| e === _attribute }

data/lib/mongoid/matchable/lt.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is less than the value.
       #
       # @example Do the values match?
-      #   matcher.matches?({ :key => 10 })
+      #   matcher._matches?({ :key => 10 })
       #
       # @param [ Hash ] value The values to check.
       #
       # @return [ true, false ] If a value exists.
-      def matches?(value)
+      def _matches?(value)
         determine(value, :<)
       rescue ArgumentError
         false