mongoid 5.4.1 → 6.0.0.beta

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.
@@ -31,7 +43,7 @@ module Mongoid
         # @example Substitute the new document.
         #   person.name.substitute(new_name)
         #
-        # @param [ Document ] replacement A document to replace the target.
+        # @param [ Document ] other A document to replace the target.
         #
         # @return [ Document, nil ] The relation or nil.
         #
@@ -55,6 +67,8 @@ module Mongoid
         # @example Get the binding.
         #   binding([ address ])
         #
+        # @param [ Proxy ] new_target The new documents to bind with.
+        #
         # @return [ Binding ] A binding object.
         #
         # @since 2.0.0.rc.1
@@ -207,7 +221,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.
         #
@@ -19,8 +36,7 @@ module Mongoid
         # @example Push a document.
         #   person.addresses.push(address)
         #
-        # @param [ Document, Array<Document> ] args Any number of documents.
-        #
+        # @param [ Document, Array<Document> ] *args Any number of documents.
         def <<(*args)
           docs = args.flatten
           return concat(docs) if docs.size > 1
@@ -60,7 +76,7 @@ module Mongoid
         #
         # @since 2.4.0
         def concat(docs)
-          batch_push(docs) unless docs.empty?
+          batch_insert(docs) unless docs.empty?
           self
         end
 
@@ -338,6 +354,8 @@ module Mongoid
         # @example Create the binding.
         #   relation.binding([ address ])
         #
+        # @param [ Array<Document> ] new_target The new documents to bind with.
+        #
         # @return [ Binding ] The many binding.
         #
         # @since 2.0.0.rc.1
@@ -460,7 +478,7 @@ module Mongoid
         #   relation.remove_all({ :num => 1 }, true)
         #
         # @param [ Hash ] conditions Conditions to filter by.
-        # @param [ true, false ] method
+        # @param [ true, false ] destroy If true then destroy, else delete.
         #
         # @return [ Integer ] The number of documents removed.
         def remove_all(conditions = {}, method = :delete)
@@ -617,10 +635,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.
@@ -31,7 +44,7 @@ module Mongoid
         # @example Substitute the new document.
         #   person.name.substitute(new_name)
         #
-        # @param [ Document ] replacement A document to replace the target.
+        # @param [ Document ] other A document to replace the target.
         #
         # @return [ Document, nil ] The relation or nil.
         #
@@ -61,6 +74,8 @@ module Mongoid
         # @example Get the binding.
         #   relation.binding([ address ])
         #
+        # @param [ Document ] new_target The new document to bind with.
+        #
         # @return [ Binding ] The relation's binding.
         #
         # @since 2.0.0.rc.1
@@ -200,7 +215,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
 
@@ -326,8 +327,7 @@ module Mongoid
         #   Model.reference_one_to_one(:name, meta)
         #
         # @param [ Symbol ] name The name of the relation.
-        # @param [ Symbol ] options The association options.
-        # @param [ Metadata ] relation The relation.
+        # @param [ Metadata ] meta The relation metadata.
         #
         # @return [ Class ] The model class.
         #
@@ -350,9 +350,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

@@ -920,7 +920,7 @@ module Mongoid
       # @example Find the module from the parts.
       #   metadata.find_from_parts([ "Namespace", "Module" ])
       #
-      # @param [ Array<String> ] modules The modules.
+      # @param [ Array<String> ] The modules.
       #
       # @return [ String ] The matching module.
       #
@@ -1127,7 +1127,7 @@ module Mongoid
       # @example Find the inverses.
       #   metadata.lookup_inverses(other)
       #
-      # @param [ Document ] other The inverse document.
+      # @param [ Document ] : The inverse document.
       #
       # @return [ Array<String> ] The inverse names.
       def lookup_inverses(other)
@@ -1150,7 +1150,7 @@ module Mongoid
       # @example Find the inverse.
       #   metadata.lookup_inverse(other)
       #
-      # @param [ Document ] other The inverse document.
+      # @param [ Document ] : The inverse document.
       #
       # @return [ String ] The inverse name.
       #

data/lib/mongoid/relations/nested_builder.rb

@@ -25,7 +25,7 @@ module Mongoid
       # @example Is there a reject proc?
       #   builder.reject?
       #
-      # @param [ Document ] document The parent document of the relation
+      # @param The parent document of the relation
       # @param [ Hash ] attrs The attributes to check for rejection.
       #
       # @return [ true, false ] True and call proc or method if rejectable, false if not.

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

@@ -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
 
@@ -145,8 +115,7 @@ module Mongoid
       # to the target of the proxy. This can be overridden in special cases.
       #
       # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] args The arguments passed to the method.
-      #
+      # @param [ Array ] *args The arguments passed to the method.
       def method_missing(name, *args, &block)
         target.send(name, *args, &block)
       end
@@ -184,7 +153,7 @@ module Mongoid
       # @example returns the before_add callback method name
       #   callback_method(:before_add)
       #
-      # @param [ Symbol ] callback_name Which callback
+      # @param [ Symbol ] which callback
       #
       # @return [ Array ] with callback methods to be executed, the array may have symbols and Procs
       #

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.
@@ -44,7 +62,8 @@ module Mongoid
         # @example Substitute the relation.
         #   name.substitute(new_name)
         #
-        # @param [ Document, Array<Document> ] replacement The replacement.
+        # @param [ Document, Array<Document> ] new_target The replacement.
+        # @param [ true, false ] building Are we in build mode?
         #
         # @return [ In, nil ] The relation or nil.
         #
@@ -64,6 +83,8 @@ module Mongoid
         # @example Get the binding object.
         #   binding([ address ])
         #
+        # @param [ Document, Array<Document> ] new_target The replacement.
+        #
         # @return [ Binding ] The binding object.
         #
         # @since 2.0.0.rc.1
@@ -264,16 +285,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.
         #
@@ -22,7 +40,7 @@ module Mongoid
         # @example Concat with other documents.
         #   person.posts.concat([ post_one, post_two ])
         #
-        # @param [ Document, Array<Document> ] args Any number of documents.
+        # @param [ Document, Array<Document> ] *args Any number of documents.
         #
         # @return [ Array<Document> ] The loaded docs.
         #
@@ -190,7 +208,7 @@ module Mongoid
         # @note This will keep matching documents in memory for iteration
         #   later.
         #
-        # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] args The ids.
+        # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] arg The ids.
         #
         # @return [ Document, Criteria ] The matching document(s).
         #
@@ -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)
@@ -368,6 +385,8 @@ module Mongoid
         # @example Get the binding.
         #   relation.binding([ address ])
         #
+        # @param [ Array<Document> ] new_target The new documents to bind with.
+        #
         # @return [ Binding ] The binding.
         #
         # @since 2.0.0.rc.1
@@ -491,7 +510,7 @@ module Mongoid
         #   person.posts.delete_all({ :title => "Testing" })
         #
         # @param [ Hash ] conditions Optional conditions to delete with.
-        # @param [ Symbol ] method The deletion method to call.
+        # @param [ Symbol ] The deletion method to call.
         #
         # @return [ Integer ] The number of documents deleted.
         #
@@ -729,18 +748,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