mongoid 6.1.0 → 6.2.0

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/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
@@ -260,8 +254,12 @@ module Mongoid
           chain.append(callback) if callback.kind == place
         end
         self.class.send :define_method, name do
-          runner = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
-          chain.compile.call(runner).value
+          env = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
+          sequence = chain.compile
+          sequence.invoke_before(env)
+          env.value = !env.halted
+          sequence.invoke_after(env)
+          env.value
         end
         self.class.send :protected, name
       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/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

data/lib/mongoid/matchable/lte.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is less 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/ne.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute and first value are not 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 a value exists.
-      def matches?(value)
+      def _matches?(value)
         !super(value.values.first)
       end
     end

data/lib/mongoid/matchable/nin.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute is not in the value list.
       #
       # @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)
         attribute_array.none? { |e| value.values.first.include?(e) }
       end

data/lib/mongoid/matchable/or.rb

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

data/lib/mongoid/matchable/regexp.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module Matchable
+
+    # Defines behavior for handling regular expressions in embedded documents.
+    class Regexp < Default
+
+      # Does the supplied query match the attribute?
+      #
+      # @example Does this match?
+      #   matcher._matches?(/^Em/)
+      #   matcher._matches?(BSON::Regex::Raw.new("^Em"))
+      #
+      # @param [ BSON::Regexp::Raw, Regexp ] regexp The regular expression object.
+      #
+      # @return [ true, false ] True if matches, false if not.
+      #
+      # @since 5.2.1
+      def _matches?(regexp)
+        if native_regexp = regexp.try(:compile)
+          super(native_regexp)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matchable/size.rb

@@ -8,12 +8,12 @@ module Mongoid
       # Return true if the attribute size is equal to the first 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)
         @attribute.size == value.values.first
       end
     end

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/persistable/creatable.rb

@@ -42,7 +42,7 @@ module Mongoid
       #
       # @since 2.1.0
       def atomic_inserts
-        { atomic_insert_modifier => { atomic_position => as_document }}
+        { atomic_insert_modifier => { atomic_position => as_attributes }}
       end
 
       # Insert the embedded document.
@@ -76,7 +76,7 @@ module Mongoid
       #
       # @since 4.0.0
       def insert_as_root
-        collection.insert_one(as_document)
+        collection.insert_one(as_attributes)
       end
 
       # Post process an insert, which sets the new record attribute to false
@@ -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/persistable/deletable.rb

@@ -137,7 +137,7 @@ module Mongoid
         # @since 1.0.0
         def delete_all(conditions = {})
           selector = hereditary? ? conditions.merge(_type: name) : conditions
-          collection.find(selector).delete_many.deleted_count
+          where(selector).delete
         end
       end
     end

data/lib/mongoid/persistable/settable.rb

@@ -28,7 +28,7 @@ module Mongoid
 
             if fields[field] && fields[field].type == Hash && attributes.key?(field)
               merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
-              value = attributes[field].merge(field_and_value_hash[field], &merger)
+              value = (attributes[field] || {}).merge(field_and_value_hash[field], &merger)
               process_attribute(field.to_s, value)
             else
               process_attribute(field.to_s, field_and_value_hash[field])

data/lib/mongoid/persistable/upsertable.rb

@@ -21,7 +21,7 @@ module Mongoid
       # @since 3.0.0
       def upsert(options = {})
         prepare_upsert(options) do
-          collection.find(atomic_selector).update_one(as_document, upsert: true)
+          collection.find(atomic_selector).update_one(as_attributes, upsert: true)
         end
       end
 

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/persistence_context.rb

@@ -44,7 +44,7 @@ module Mongoid
     # @example Create a new persistence context.
     #   PersistenceContext.new(model, collection: 'other')
     #
-    # @param [ Object ] parent The class or model instance for which a persistence context
+    # @param [ Object ] object The class or model instance for which a persistence context
     #   should be created.
     # @param [ Hash ] opts The persistence context options.
     #
@@ -67,8 +67,7 @@ module Mongoid
     #
     # @since 6.0.0
     def collection(parent = nil)
-      name = parent ? parent.collection_name : collection_name
-      client[name.to_sym]
+      parent ? parent.collection.with(client_options) : client[collection_name.to_sym]
     end
 
     # Get the collection name for this persistence context.

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