mongoid 5.4.1 → 6.1.1

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/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(

data/lib/mongoid/relations/proxy.rb

@@ -12,7 +12,7 @@ module Mongoid
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
         undef_method(method) unless
-          method =~ /(^__|^send|^object_id|^respond_to|^tap|^public_send|extend_proxy|extend_proxies)/
+          method =~ /^(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
       end
 
       include Threaded::Lifecycle
@@ -84,35 +84,6 @@ module Mongoid
         target
       end
 
-      # Tell the next persistence operation to store in a specific collection,
-      # database or client.
-      #
-      # @example Save the current document to a different collection.
-      #   model.with(collection: "secondary").save
-      #
-      # @example Save the current document to a different database.
-      #   model.with(database: "secondary").save
-      #
-      # @example Save the current document to a different client.
-      #   model.with(client: "replica_set").save
-      #
-      # @example Save with a combination of options.
-      #   model.with(client: "sharded", database: "secondary").save
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :client The client name.
-      #
-      # @return [ Document ] The current document.
-      #
-      # @since 3.0.0
-      def with(options)
-        @persistence_options = options
-        self
-      end
-
       protected
 
       # Get the collection from the root of the hierarchy.
@@ -125,7 +96,6 @@ module Mongoid
       # @since 2.0.0
       def collection
         root = base._root
-        root.with(@persistence_options)
         root.collection unless root.embedded?
       end
 

data/lib/mongoid/relations/referenced/in.rb

@@ -10,6 +10,24 @@ module Mongoid
       class In < Relations::One
         include Evolvable
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :autobuild,
+          :autosave,
+          :dependent,
+          :foreign_key,
+          :index,
+          :polymorphic,
+          :primary_key,
+          :touch,
+          :optional,
+          :required
+        ].freeze
+
         # Instantiate a new referenced_in relation.
         #
         # @example Create the new relation.
@@ -264,16 +282,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :autobuild,
-              :autosave,
-              :dependent,
-              :foreign_key,
-              :index,
-              :polymorphic,
-              :primary_key,
-              :touch
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

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

@@ -10,6 +10,24 @@ module Mongoid
         delegate :count, to: :criteria
         delegate :first, :in_memory, :last, :reset, :uniq, to: :target
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :after_add,
+          :after_remove,
+          :as,
+          :autosave,
+          :before_add,
+          :before_remove,
+          :dependent,
+          :foreign_key,
+          :order,
+          :primary_key
+        ].freeze
+
         # Appends a document or array of documents to the relation. Will set
         # the parent and update the index in the process.
         #
@@ -320,7 +338,6 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def append(document)
-          document.with(@persistence_options) if @persistence_options
           with_add_callbacks(document, already_related?(document)) do
             target.push(document)
             characterize_one(document)
@@ -500,7 +517,7 @@ module Mongoid
           selector = conditions || {}
           removed = klass.send(method, selector.merge!(criteria.selector))
           target.delete_if do |doc|
-            if doc.matches?(selector)
+            if doc._matches?(selector)
               unbind_one(doc) and true
             end
           end
@@ -550,7 +567,7 @@ module Mongoid
           if doc.new_record? && doc.valid?(:create)
             doc.run_before_callbacks(:save, :create)
             docs.push(doc)
-            inserts.push(doc.as_document)
+            inserts.push(doc.send(:as_attributes))
           else
             doc.save
           end
@@ -729,18 +746,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :after_add,
-              :after_remove,
-              :as,
-              :autosave,
-              :before_add,
-              :before_remove,
-              :dependent,
-              :foreign_key,
-              :order,
-              :primary_key
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if
@@ -795,8 +801,8 @@ module Mongoid
           # @since 3.0.0
           def with_inverse_field_criterion(criteria, metadata)
             inverse_metadata = metadata.inverse_metadata(metadata.klass)
-            if inverse_metadata.try(:inverse_of_field)
-              criteria.any_in(inverse_metadata.inverse_of_field => [ metadata.name, nil ])
+            if inverse_metadata.try(:inverse_of)
+              criteria.any_in(inverse_metadata.inverse_of => [ metadata.name, nil ])
             else
               criteria
             end

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

@@ -7,6 +7,24 @@ module Mongoid
       # many-to-many between documents in different collections.
       class ManyToMany < Many
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :after_add,
+          :after_remove,
+          :autosave,
+          :before_add,
+          :before_remove,
+          :dependent,
+          :foreign_key,
+          :index,
+          :order,
+          :primary_key
+        ].freeze
+
         # Appends a document or array of documents to the relation. Will set
         # the parent and update the index in the process.
         #
@@ -266,7 +284,7 @@ module Mongoid
         #
         # @since 3.0.0
         def unsynced(doc, key)
-          doc.synced[key] = false
+          doc._synced[key] = false
           true
         end
 
@@ -439,18 +457,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :after_add,
-              :after_remove,
-              :autosave,
-              :before_add,
-              :before_remove,
-              :dependent,
-              :foreign_key,
-              :index,
-              :order,
-              :primary_key
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

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

@@ -7,6 +7,20 @@ module Mongoid
       # one-to-one between documents in different collections.
       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 = [
+          :as,
+          :autobuild,
+          :autosave,
+          :dependent,
+          :foreign_key,
+          :primary_key
+        ].freeze
+
         # Instantiate a new references_one relation. Will set the foreign key
         # and the base on the inverse object.
         #
@@ -254,7 +268,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :as, :autobuild, :autosave, :dependent, :foreign_key, :primary_key ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/synchronization.rb

@@ -11,41 +11,41 @@ module Mongoid
       # the key has changed and the relation bindings have not been run.
       #
       # @example Are the foreign keys syncable?
-      #   document.syncable?(metadata)
+      #   document._syncable??(metadata)
       #
       # @param [ Metadata ] metadata The relation metadata.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def syncable?(metadata)
-        !synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
+      def _syncable?(metadata)
+        !_synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
       end
 
       # Get the synced foreign keys.
       #
       # @example Get the synced foreign keys.
-      #   document.synced
+      #   document._synced
       #
       # @return [ Hash ] The synced foreign keys.
       #
       # @since 2.1.0
-      def synced
-        @synced ||= {}
+      def _synced
+        @_synced ||= {}
       end
 
       # Has the document been synced for the foreign key?
       #
       # @example Has the document been synced?
-      #   document.synced?
+      #   document._synced??
       #
       # @param [ String ] foreign_key The foreign key.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def synced?(foreign_key)
-        !!synced[foreign_key]
+      def _synced?(foreign_key)
+        !!_synced[foreign_key]
       end
 
       # Update the inverse keys on destroy.
@@ -110,7 +110,7 @@ module Mongoid
         # @param [ Metadata ] metadata The relation metadata.
         #
         # @since 2.1.0
-        def synced(metadata)
+        def _synced(metadata)
           unless metadata.forced_nil_inverse?
             synced_save(metadata)
             synced_destroy(metadata)
@@ -137,7 +137,7 @@ module Mongoid
           set_callback(
             :save,
             :after,
-            if: ->(doc){ doc.syncable?(metadata) }
+            if: ->(doc){ doc._syncable?(metadata) }
           ) do |doc|
             doc.update_inverse_keys(metadata)
           end

data/lib/mongoid/relations/touchable.rb

@@ -53,7 +53,8 @@ module Mongoid
         def touchable(metadata)
           if metadata.touchable?
             name = metadata.name
-            method_name = define_relation_touch_method(name)
+            field = metadata[:touch].is_a?(Symbol) ? metadata[:touch] : nil
+            method_name = define_relation_touch_method(name, field)
             after_save method_name
             after_destroy method_name
             after_touch method_name
@@ -70,19 +71,21 @@ module Mongoid
         #
         # @example Define the touch relation.
         #   Model.define_relation_touch_method(:band)
+        #   Model.define_relation_touch_method(:band, :band_updated_at)
         #
         # @param [ Symbol ] name The name of the relation.
+        # @param [ Symbol ] extra_field Additional timestamp field to update.
         #
         # @since 3.1.0
         #
         # @return [ Symbol ] The method name.
-        def define_relation_touch_method(name)
+        def define_relation_touch_method(name, extra_field = nil)
           method_name = "touch_#{name}_after_create_or_destroy"
           class_eval <<-TOUCH, __FILE__, __LINE__ + 1
             def #{method_name}
               without_autobuild do
                 relation = __send__(:#{name})
-                relation.touch if relation
+                relation.touch #{":#{extra_field}" if extra_field} if relation
               end
             end
           TOUCH

data/lib/mongoid/reloadable.rb

@@ -71,7 +71,7 @@ module Mongoid
     # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        _root.collection.find(_id: _root._id).read(mode: :primary).first
+        collection(_root).find(_id: _root._id).read(mode: :primary).first
       ))
     end
 

data/lib/mongoid/serializable.rb

@@ -66,7 +66,7 @@ module Mongoid
     #
     # @since 3.0.0
     def field_names(options)
-      names = (as_document.keys + attribute_names).uniq.sort
+      names = (as_attributes.keys + attribute_names).uniq.sort
 
       only = Array.wrap(options[:only]).map(&:to_s)
       except = Array.wrap(options[:except]).map(&:to_s)