mongoid 5.4.0 → 6.4.8

data/lib/mongoid/railtie.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require "mongoid/railties/document"
 require "rails"
 require "rails/mongoid"
 
@@ -103,6 +102,23 @@ module Rails
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message
       end
+
+      # Include Controller extension that measures Mongoid runtime
+      # during request processing. The value then appears in Rails'
+      # instrumentation event `process_action.action_controller`.
+      #
+      # The measurement is made via internal Mongo monitoring subscription
+      initializer "mongoid.runtime-metric" do
+        require "mongoid/railties/controller_runtime"
+
+        ActiveSupport.on_load :action_controller do
+          include ::Mongoid::Railties::ControllerRuntime::ControllerExtension
+        end
+
+        Mongo::Monitoring::Global.subscribe Mongo::Monitoring::COMMAND,
+            ::Mongoid::Railties::ControllerRuntime::Collector.new
+      end
+
     end
   end
 end

data/lib/mongoid/railties/controller_runtime.rb

@@ -0,0 +1,86 @@
+module Mongoid
+  module Railties
+    module ControllerRuntime
+
+      # This extension mimics the Rails' internal method to
+      # measure ActiveRecord runtime during request processing.
+      # It appends MongoDB runtime value (`mongoid_runtime`) into payload
+      # of instrumentation event `process_action.action_controller`.
+      module ControllerExtension
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :mongoid_runtime
+
+        # Reset the runtime before each action.
+        def process_action(action, *args)
+          Collector.reset_runtime
+          super
+        end
+
+        # Override to collect the measurements.
+        def cleanup_view_runtime
+          mongo_rt_before_render = Collector.reset_runtime
+          runtime = super
+          mongo_rt_after_render = Collector.reset_runtime
+          self.mongoid_runtime = mongo_rt_before_render + mongo_rt_after_render
+          runtime - mongo_rt_after_render
+        end
+
+        # Add the measurement to the instrumentation event payload.
+        def append_info_to_payload(payload)
+          super
+          payload[:mongoid_runtime] = (mongoid_runtime || 0) + Collector.reset_runtime
+        end
+
+        module ClassMethods
+
+          # Append MongoDB runtime information to ActionController runtime
+          # log message.
+          def log_process_action(payload)
+            messages = super
+            mongoid_runtime = payload[:mongoid_runtime]
+            messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
+            messages
+          end
+
+        end
+
+      end
+
+      # The Collector of MongoDB runtime metric, that subscribes to Mongo
+      # driver command monitoring. Stores the value within a thread-local
+      # variable to provide correct accounting when an application issues
+      # MongoDB operations from background threads.
+      class Collector
+
+        VARIABLE_NAME = "Mongoid.controller_runtime".freeze
+
+        def started _; end
+
+        def _completed e
+          Collector.runtime += e.duration
+        end
+        alias :succeeded :_completed
+        alias :failed :_completed
+
+        def self.runtime
+          Thread.current[VARIABLE_NAME] ||= 0
+        end
+
+        def self.runtime= value
+          Thread.current[VARIABLE_NAME] = value
+        end
+
+        def self.reset_runtime
+          to_now = runtime
+          self.runtime = 0
+          to_now
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mongoid/relations/accessors.rb

@@ -229,6 +229,9 @@ module Mongoid
               if value = get_relation(name, metadata, object)
                 if value.respond_to?(:substitute)
                   set_relation(name, value.substitute(object.substitutable))
+                else
+                  value = __build__(name, value, metadata)
+                  set_relation(name, value.substitute(object.substitutable))
                 end
               else
                 __build__(name, object.substitutable, metadata)

data/lib/mongoid/relations/auto_save.rb

@@ -59,17 +59,25 @@ module Mongoid
           if metadata.autosave? && !metadata.embedded?
             save_method = :"autosave_documents_for_#{metadata.name}"
             define_method(save_method) do
-
               if before_callback_halted?
                 self.before_callback_halted = false
               else
                 __autosaving__ do
                   if relation = ivar(metadata.name)
-                    options = persistence_options || {}
                     if :belongs_to == metadata.macro
-                      relation.with(options).save if changed_for_autosave?(relation)
+                      if changed_for_autosave?(relation)
+                        relation.with(persistence_context) do |_relation|
+                          _relation.save
+                        end
+                      end
                     else
-                      Array(relation).each { |d| d.with(options).save if changed_for_autosave?(d) }
+                      Array(relation).each do |doc|
+                        if changed_for_autosave?(doc)
+                          doc.with(persistence_context) do |d|
+                            d.save
+                          end
+                        end
+                      end
                     end
                   end
                 end

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

@@ -26,8 +26,8 @@ module Mongoid
                 end
                 doc.reset_relation_criteria(metadata.inverse)
               end
-              base.synced[metadata.foreign_key] = true
-              doc.synced[metadata.inverse_foreign_key] = true
+              base._synced[metadata.foreign_key] = true
+              doc._synced[metadata.inverse_foreign_key] = true
             end
           end
 
@@ -45,8 +45,8 @@ module Mongoid
                 inverse_keys.delete_one(inverse_record_id(doc))
                 doc.reset_relation_criteria(metadata.inverse)
               end
-              base.synced[metadata.foreign_key] = true
-              doc.synced[metadata.inverse_foreign_key] = true
+              base._synced[metadata.foreign_key] = true
+              doc._synced[metadata.inverse_foreign_key] = true
             end
           end
 

data/lib/mongoid/relations/counter_cache.rb

@@ -15,7 +15,9 @@ module Mongoid
       #
       # @since 4.0.0
       def reset_counters(*counters)
-        self.class.reset_counters(self, *counters)
+        self.class.with(persistence_context) do |_class|
+          _class.reset_counters(self, *counters)
+        end
       end
 
       module ClassMethods
@@ -111,12 +113,16 @@ module Mongoid
                 original, current = attribute_change(foreign_key)
 
                 unless original.nil?
-                  record.class.decrement_counter(cache_column, original)
+                  record.class.with(persistence_context) do |_class|
+                    _class.decrement_counter(cache_column, original)
+                  end
                 end
 
                 unless current.nil?
                   record[cache_column] = (record[cache_column] || 0) + 1
-                  record.class.increment_counter(cache_column, current) if record.persisted?
+                  record.class.with(record.persistence_context) do |_class|
+                    _class.increment_counter(cache_column, current) if record.persisted?
+                  end
                 end
               end
             end
@@ -127,7 +133,9 @@ module Mongoid
               record[cache_column] = (record[cache_column] || 0) + 1
 
               if record.persisted?
-                record.class.increment_counter(cache_column, record._id)
+                record.class.with(record.persistence_context) do |_class|
+                  _class.increment_counter(cache_column, record._id)
+                end
                 record.remove_change(cache_column)
               end
             end
@@ -138,7 +146,9 @@ module Mongoid
               record[cache_column] = (record[cache_column] || 0) - 1 unless record.frozen?
 
               if record.persisted?
-                record.class.decrement_counter(cache_column, record._id)
+                record.class.with(record.persistence_context) do |_class|
+                  _class.decrement_counter(cache_column, record._id)
+                end
                 record.remove_change(cache_column)
               end
             end

data/lib/mongoid/relations/eager/base.rb

@@ -48,7 +48,7 @@ module Mongoid
           @loaded = []
           while shift_metadata
             preload
-            @loaded << @docs.collect { |d| d.send(@metadata.name) }
+            @loaded << @docs.collect { |d| d.send(@metadata.name) if d.respond_to?(@metadata.name) }
           end
           @loaded.flatten
         end
@@ -99,12 +99,12 @@ module Mongoid
         # @example Return a hash with the current documents grouped by key.
         #   loader.grouped_docs
         #
-        # @return [ Hash ] hash with groupd documents.
+        # @return [ Hash ] hash with grouped documents.
         #
         # @since 4.0.0
         def grouped_docs
           @grouped_docs[@metadata.name] ||= @docs.group_by do |doc|
-            doc.send(group_by_key)
+            doc.send(group_by_key) if doc.respond_to?(group_by_key)
           end
         end
 

data/lib/mongoid/relations/eager/has_and_belongs_to_many.rb

@@ -17,7 +17,7 @@ module Mongoid
 
           @docs.each do |d|
             keys = d.send(group_by_key)
-            docs = entries.values_at(*keys)
+            docs = entries.values_at(*keys).compact
             set_relation(d, docs)
           end
         end
@@ -31,7 +31,7 @@ module Mongoid
         end
 
         def set_relation(doc, element)
-          doc.__build__(@metadata.name, element, @metadata)
+          doc.__build__(@metadata.name, element, @metadata) unless doc.blank?
         end
 
         def group_by_key

data/lib/mongoid/relations/eager/has_many.rb

@@ -22,7 +22,7 @@ module Mongoid
         end
 
         def set_relation(doc, element)
-          doc.__build__(@metadata.name, element, @metadata)
+          doc.__build__(@metadata.name, element, @metadata) unless doc.blank?
         end
 
         def group_by_key

data/lib/mongoid/relations/eager.rb

@@ -22,19 +22,14 @@ module Mongoid
       end
 
       def preload(relations, docs)
-        grouped_relations = relations.group_by do |metadata|
-          metadata.inverse_class_name
-        end
-        grouped_relations.keys.each do |_klass|
-          grouped_relations[_klass] = grouped_relations[_klass].group_by do |metadata|
-            metadata.relation
+        relations.group_by(&:inverse_class_name)
+                 .values
+                 .each do |associations|
+          associations.group_by(&:relation)
+                      .each do |relation, association|
+            relation.eager_load_klass.new(association, docs).run
           end
         end
-        grouped_relations.each do |_klass, associations|
-          docs = associations.collect do |_relation, association|
-            _relation.eager_load_klass.new(association, docs).run
-          end.flatten
-        end
       end
     end
   end

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

@@ -8,19 +8,19 @@ module Mongoid
       module Batchable
         include Positional
 
-        # Insert new documents as a batch push ($pushAll). This ensures that
+        # Insert new documents as a batch push ($push with $each). This ensures that
         # all callbacks are run at the appropriate time and only 1 request is
         # made to the database.
         #
         # @example Execute the batch push.
-        #   batchable.batch_push([ doc_one, doc_two ])
+        #   batchable.batch_insert([ doc_one, doc_two ])
         #
         # @param [ Array<Document> ] docs The docs to add.
         #
         # @return [ Array<Hash> ] The inserts.
         #
-        # @since 5.4.0
-        def batch_push(docs)
+        # @since 3.0.0
+        def batch_insert(docs)
           execute_batch_push(docs)
         end
 
@@ -38,7 +38,8 @@ module Mongoid
           pre_process_batch_remove(docs, :delete)
           unless docs.empty?
             collection.find(selector).update_one(
-              positionally(selector, "$unset" => { path => true })
+              positionally(selector, "$unset" => { path => true }),
+              session: _session
             )
             post_process_batch_remove(docs, :delete)
           end
@@ -58,7 +59,8 @@ module Mongoid
           removals = pre_process_batch_remove(docs, method)
           if !docs.empty?
             collection.find(selector).update_one(
-              positionally(selector, "$pullAll" => { path => removals })
+              positionally(selector, "$pullAll" => { path => removals }),
+              session: _session
             )
             post_process_batch_remove(docs, method)
           end
@@ -85,7 +87,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
@@ -116,26 +118,25 @@ module Mongoid
           end
         end
 
-        # Perform a batch persist of the provided documents with the supplied
-        # operation.
+        # Perform a batch persist of the provided documents with a $set.
         #
         # @api private
         #
-        # @example Perform a batch operation.
+        #@example Perform a batch $set.
         #   batchable.execute_batch_set(docs)
         #
         # @param [ Array<Document> ] docs The docs to persist.
-        # @param [ String ] operation The atomic operation.
         #
         # @return [ Array<Hash> ] The inserts.
         #
-        # @since 5.4.0
+        # @since 7.0.0
         def execute_batch_set(docs)
           self.inserts_valid = true
           inserts = pre_process_batch_insert(docs)
           if insertable?
             collection.find(selector).update_one(
-              positionally(selector, '$set' => { path => inserts })
+                positionally(selector, '$set' => { path => inserts }),
+                session: _session
             )
             post_process_batch_insert(docs)
           end
@@ -150,17 +151,18 @@ module Mongoid
         #   batchable.execute_batch_push(docs)
         #
         # @param [ Array<Document> ] docs The docs to persist.
-        # @param [ String ] operation The atomic operation.
         #
         # @return [ Array<Hash> ] The inserts.
         #
-        # @since 5.4.0
+        # @since 7.0.0
         def execute_batch_push(docs)
           self.inserts_valid = true
           pushes = pre_process_batch_insert(docs)
           if insertable?
             collection.find(selector).update_one(
-                positionally(selector, '$push' => { path => { '$each' => pushes } }))
+                positionally(selector, '$push' => { path => { '$each' => pushes } }),
+                session: _session
+            )
             post_process_batch_insert(docs)
           end
           pushes
@@ -303,7 +305,7 @@ module Mongoid
                 self.inserts_valid = false
               end
             end
-            doc.as_document
+            doc.send(:as_attributes)
           end
         end
 
@@ -332,7 +334,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

@@ -8,6 +8,18 @@ module Mongoid
       # multiple documents.
       class In < Relations::One
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :autobuild,
+          :cyclic,
+          :polymorphic,
+          :touch
+         ].freeze
+
         # Instantiate a new embedded_in relation.
         #
         # @example Create the new relation.
@@ -207,7 +219,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :autobuild, :cyclic, :polymorphic, :touch ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

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

@@ -10,6 +10,23 @@ module Mongoid
       class Many < Relations::Many
         include Batchable
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :as,
+          :cascade_callbacks,
+          :cyclic,
+          :order,
+          :store_as,
+          :before_add,
+          :after_add,
+          :before_remove,
+          :after_remove
+         ].freeze
+
         # Appends a document or array of documents to the relation. Will set
         # the parent and update the index in the process.
         #
@@ -41,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
@@ -60,7 +73,7 @@ module Mongoid
         #
         # @since 2.4.0
         def concat(docs)
-          batch_push(docs) unless docs.empty?
+          batch_insert(docs) unless docs.empty?
           self
         end
 
@@ -281,6 +294,29 @@ module Mongoid
           end
         end
 
+        # Shift documents off the relation. This can be a single document or
+        # multiples, and will automatically persist the changes.
+        #
+        # @example Shift a single document.
+        #   relation.shift
+        #
+        # @example Shift multiple documents.
+        #   relation.shift(3)
+        #
+        # @param [ Integer ] count The number of documents to shift, or 1 if not
+        #   provided.
+        #
+        # @return [ Document, Array<Document> ] The shifted document(s).
+        def shift(count = nil)
+          if count
+            if target.size > 0 && docs = target[0, count]
+              docs.each { |doc| delete(doc) }
+            end
+          else
+            delete(target[0])
+          end
+        end
+
         # Substitutes the supplied target documents for the existing documents
         # in the relation.
         #
@@ -496,6 +532,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
@@ -617,10 +661,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :as, :cascade_callbacks, :cyclic, :order, :store_as,
-              :before_add, :after_add, :before_remove, :after_remove
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

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

@@ -7,6 +7,19 @@ module Mongoid
       # relations.
       class One < Relations::One
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :autobuild,
+          :as,
+          :cascade_callbacks,
+          :cyclic,
+          :store_as
+        ].freeze
+
         # Instantiate a new embeds_one relation.
         #
         # @example Create the new proxy.
@@ -200,7 +213,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :autobuild, :as, :cascade_callbacks, :cyclic, :store_as ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/macros.rb

@@ -140,6 +140,7 @@ module Mongoid
           aliased_fields[name.to_s] = meta.foreign_key
           touchable(meta)
           add_counter_cache_callbacks(meta) if meta.counter_cached?
+          validates(name, presence: true) if require_association?(options)
           meta
         end
 
@@ -197,7 +198,7 @@ module Mongoid
           reference(meta, Array)
           autosave(meta)
           validates_relation(meta)
-          synced(meta)
+          _synced(meta)
           meta
         end
 
@@ -350,9 +351,16 @@ module Mongoid
         # @param [ Symbol ] name The name of the relation.
         # @param [ Metadata ] metadata The metadata for the relation.
         def relate(name, metadata)
+          Fields::Validators::Macro.validate_relation(self, name)
           self.relations = relations.merge(name.to_s => metadata)
           getter(name, metadata).setter(name, metadata).existence_check(name)
         end
+
+        def require_association?(options = {})
+          required = options[:required] if options.key?(:required)
+          required = !options[:optional] if options.key?(:optional) && required.nil?
+          required.nil? ? Mongoid.belongs_to_required_by_default : required
+        end
       end
     end
   end

data/lib/mongoid/relations/many.rb

@@ -213,6 +213,10 @@ module Mongoid
 
       private
 
+      def _session
+        base.send(:_session)
+      end
+
       # Find the first object given the supplied attributes or create/initialize it.
       #
       # @example Find or create|initialize.

data/lib/mongoid/relations/metadata.rb

@@ -778,10 +778,10 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def validate?
-        unless self[:validate].nil?
-          self[:validate]
-        else
+        if self[:validate].nil?
           self[:validate] = relation.validation_default
+        else
+          self[:validate]
         end
       end
 

data/lib/mongoid/relations/options.rb

@@ -17,7 +17,7 @@ module Mongoid
         :name,
         :relation,
         :validate
-      ]
+      ].freeze
 
       # Determine if the provided options are valid for the relation.
       #
@@ -32,7 +32,7 @@ module Mongoid
       #
       # @since 2.1.0
       def validate!(options)
-        valid_options = options[:relation].valid_options.concat(COMMON)
+        valid_options = options[:relation]::VALID_OPTIONS + COMMON
         options.keys.each do |key|
           if !valid_options.include?(key)
             raise Errors::InvalidOptions.new(