mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/relations/binding.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
+module Mongoid
+  module Relations
 
     # Superclass for all objects that bind relations together.
     class Binding
@@ -21,6 +21,215 @@ module Mongoid # :nodoc:
       def initialize(base, target, metadata)
         @base, @target, @metadata = base, target, metadata
       end
+
+      # Execute the provided block inside a binding.
+      #
+      # @example Execute the binding block.
+      #   binding.binding do
+      #     base.foreign_key = 1
+      #   end
+      #
+      # @return [ Object ] The result of the yield.
+      #
+      # @since 3.0.0
+      def binding
+        unless _binding?
+          _binding do
+            yield(self) if block_given?
+          end
+        end
+      end
+
+      private
+
+      # Check if the inverse is properly defined.
+      #
+      # @api private
+      #
+      # @example Check the inverse definition.
+      #   binding.check_inverse!(doc)
+      #
+      # @param [ Document ] doc The document getting bound.
+      #
+      # @raise [ Errors::InverseNotFound ] If no inverse found.
+      #
+      # @since 3.0.0
+      def check_inverse!(doc)
+        if !metadata.forced_nil_inverse? &&
+          !doc.respond_to?(metadata.foreign_key_setter)
+          raise Errors::InverseNotFound.new(
+            base.class,
+            metadata.name,
+            doc.class,
+            metadata.foreign_key
+          )
+        end
+      end
+
+      # Check for problems with multiple inverse definitions.
+      #
+      # @api private
+      #
+      # @example Check for inverses errors.
+      #   binding.check_inverses!(doc)
+      #
+      # @param [ Document ] doc The document to check.
+      #
+      # @since 3.0.0
+      def check_inverses!(doc)
+        inverses = metadata.inverses(doc)
+        if inverses.count > 1 && base.send(metadata.foreign_key).nil?
+          raise Errors::InvalidSetPolymorphicRelation.new(
+            metadata.name, base.class.name, target.class.name
+          )
+        end
+      end
+
+      # Set the id of the related document in the foreign key field on the
+      # keyed document.
+      #
+      # @api private
+      #
+      # @example Bind the foreign key.
+      #   binding.bind_foreign_key(post, person.id)
+      #
+      # @param [ Document ] keyed The document that stores the foreign key.
+      # @param [ Object ] id The id of the bound document.
+      #
+      # @since 3.0.0
+      def bind_foreign_key(keyed, id)
+        unless keyed.frozen?
+          keyed.you_must(metadata.foreign_key_setter, id)
+        end
+      end
+
+      # Set the type of the related document on the foreign type field, used
+      # when relations are polymorphic.
+      #
+      # @api private
+      #
+      # @example Bind the polymorphic type.
+      #   binding.bind_polymorphic_type(post, "Person")
+      #
+      # @param [ Document ] typed The document that stores the type field.
+      # @param [ String ] name The name of the model.
+      #
+      # @since 3.0.0
+      def bind_polymorphic_type(typed, name)
+        if metadata.type
+          typed.you_must(metadata.type_setter, name)
+        end
+      end
+
+      # Set the type of the related document on the foreign type field, used
+      # when relations are polymorphic.
+      #
+      # @api private
+      #
+      # @example Bind the polymorphic type.
+      #   binding.bind_polymorphic_inverse_type(post, "Person")
+      #
+      # @param [ Document ] typed The document that stores the type field.
+      # @param [ String ] name The name of the model.
+      #
+      # @since 3.0.0
+      def bind_polymorphic_inverse_type(typed, name)
+        if metadata.inverse_type
+          typed.you_must(metadata.inverse_type_setter, name)
+        end
+      end
+
+      # Bind the inverse document to the child document so that the in memory
+      # instances are the same.
+      #
+      # @api private
+      #
+      # @example Bind the inverse.
+      #   binding.bind_inverse(post, person)
+      #
+      # @param [ Document ] doc The base document.
+      # @param [ Document ] inverse The inverse document.
+      #
+      # @since 3.0.0
+      def bind_inverse(doc, inverse)
+        if doc.respond_to?(metadata.inverse_setter)
+          doc.you_must(metadata.inverse_setter, inverse)
+        end
+      end
+
+      # Bind the inverse of field, when in a polymorphic relation.
+      #
+      # @api private
+      #
+      # @example Bind the inverse of field.
+      #   binding.bind_inverse_of_field(doc)
+      #
+      # @param [ Document ] doc The document to bind.
+      # @param [ String ] name The name of the relation.
+      #
+      # @since 3.0.0
+      def bind_inverse_of_field(doc, name)
+        if inverse_metadata = metadata.inverse_metadata(doc)
+          if setter = inverse_metadata.inverse_of_field_setter
+            doc.you_must(setter, name)
+          end
+        end
+      end
+
+      # Bind the provided document with the base from the parent relation.
+      #
+      # @api private
+      #
+      # @example Bind the document with the base.
+      #   binding.bind_from_relational_parent(doc)
+      #
+      # @param [ Document ] doc The document to bind.
+      #
+      # @since 3.0.0
+      def bind_from_relational_parent(doc)
+        check_inverse!(doc)
+        bind_foreign_key(doc, base.id)
+        bind_polymorphic_type(doc, base.class.model_name)
+        bind_inverse(doc, base)
+        bind_inverse_of_field(doc, metadata.name)
+      end
+
+      # Ensure that the metadata on the base is correct, for the cases
+      # where we have multiple belongs to definitions and were are setting
+      # different parents in memory in order.
+      #
+      # @api private
+      #
+      # @example Set the base metadata.
+      #   binding.set_base_metadata
+      #
+      # @return [ true, false ] If the metadata changed.
+      #
+      # @since 2.4.4
+      def set_base_metadata
+        inverse_metadata = metadata.inverse_metadata(target)
+        if inverse_metadata != metadata && !inverse_metadata.nil?
+          base.metadata = inverse_metadata
+        end
+      end
+
+      # Bind the provided document with the base from the parent relation.
+      #
+      # @api private
+      #
+      # @example Bind the document with the base.
+      #   unbinding.unbind_from_relational_parent(doc)
+      #
+      # @param [ Document ] doc The document to unbind.
+      #
+      # @since 3.0.0
+      def unbind_from_relational_parent(doc)
+        check_inverse!(doc)
+        bind_foreign_key(doc, nil)
+        bind_polymorphic_type(doc, nil)
+        bind_inverse(doc, nil)
+        bind_inverse_of_field(doc, nil)
+      end
     end
   end
 end

data/lib/mongoid/relations/bindings/embedded/in.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Bindings #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Relations
+    module Bindings
+      module Embedded
 
         # Binding class for embedded_in relations.
         class In < Binding
@@ -23,20 +23,17 @@ module Mongoid # :nodoc:
           # @option options [ true, false ] :binding Are we in build mode?
           #
           # @since 2.0.0.rc.1
-          def bind
+          def bind_one
             base.metadata = metadata.inverse_metadata(target) unless base.metadata
             base.parentize(target)
-            unless _binding?
-              _binding do
-                if base.embedded_many?
-                  target.do_or_do_not(metadata.inverse(target)).push(base)
-                else
-                  target.do_or_do_not(metadata.inverse_setter(target), base)
-                end
+            binding do
+              if base.embedded_many?
+                target.do_or_do_not(metadata.inverse(target)).push(base)
+              else
+                target.do_or_do_not(metadata.inverse_setter(target), base)
               end
             end
           end
-          alias :bind_one :bind
 
           # Unbinds the base object and the inverse, caused by setting the
           # reference to nil.
@@ -50,18 +47,15 @@ module Mongoid # :nodoc:
           # @option options [ true, false ] :continue Do we continue unbinding?
           #
           # @since 2.0.0.rc.1
-          def unbind
-            unless _binding?
-              _binding do
-                if base.embedded_many?
-                  target.do_or_do_not(metadata.inverse(target)).delete(base)
-                else
-                  target.do_or_do_not(metadata.inverse_setter(target), nil)
-                end
+          def unbind_one
+            binding do
+              if base.embedded_many?
+                target.do_or_do_not(metadata.inverse(target)).delete(base)
+              else
+                target.do_or_do_not(metadata.inverse_setter(target), nil)
               end
             end
           end
-          alias :unbind_one :unbind
         end
       end
     end

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

@@ -1,32 +1,12 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Bindings #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Relations
+    module Bindings
+      module Embedded
 
         # Binding class for embeds_many relations.
         class Many < Binding
 
-          # Binds the base object to the inverse of the relation. This is so we
-          # are referenced to the actual objects themselves on both sides.
-          #
-          # This case sets the metadata on the inverse object as well as the
-          # document itself.
-          #
-          # @example Bind all the documents.
-          #   person.addresses.bind
-          #   person.addresses = [ Address.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?
-          #
-          # @since 2.0.0.rc.1
-          def bind
-            target.each { |doc| bind_one(doc) }
-          end
-
           # Binds a single document with the inverse relation. Used
           # specifically when appending to the proxy.
           #
@@ -42,32 +22,13 @@ module Mongoid # :nodoc:
           # @since 2.0.0.rc.1
           def bind_one(doc)
             doc.parentize(base)
-            unless _binding?
-              _binding do
-                unless metadata.versioned?
-                  doc.do_or_do_not(metadata.inverse_setter(target), base)
-                end
+            binding do
+              unless metadata.versioned?
+                doc.do_or_do_not(metadata.inverse_setter(target), base)
               end
             end
           end
 
-          # Unbinds the base object and the inverse, caused by setting the
-          # reference to nil.
-          #
-          # @example Unbind the documents.
-          #   person.addresses.unbind
-          #   person.addresses = nil
-          #
-          # @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 unbind
-            target.each { |doc| unbind_one(doc) }
-          end
-
           # Unbind a single document.
           #
           # @example Unbind the document.
@@ -80,10 +41,8 @@ module Mongoid # :nodoc:
           #
           # @since 2.0.0.rc.1
           def unbind_one(doc)
-            unless _binding?
-              _binding do
-                doc.do_or_do_not(metadata.inverse_setter(target), nil)
-              end
+            binding do
+              doc.do_or_do_not(metadata.inverse_setter(target), nil)
             end
           end
         end

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

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Bindings #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Relations
+    module Bindings
+      module Embedded
 
         # Binding class for embeds_one relations.
         class One < Binding
@@ -23,15 +23,12 @@ module Mongoid # :nodoc:
           # @option options [ true, false ] :binding Are we in build mode?
           #
           # @since 2.0.0.rc.1
-          def bind
+          def bind_one
             target.parentize(base)
-            unless _binding?
-              _binding do
-                target.do_or_do_not(metadata.inverse_setter(target), base)
-              end
+            binding do
+              target.do_or_do_not(metadata.inverse_setter(target), base)
             end
           end
-          alias :bind_one :bind
 
           # Unbinds the base object and the inverse, caused by setting the
           # reference to nil.
@@ -46,14 +43,11 @@ module Mongoid # :nodoc:
           # @option options [ true, false ] :binding Are we in build mode?
           #
           # @since 2.0.0.rc.1
-          def unbind
-            unless _binding?
-              _binding do
-                target.do_or_do_not(metadata.inverse_setter(target), nil)
-              end
+          def unbind_one
+            binding do
+              target.do_or_do_not(metadata.inverse_setter(target), nil)
             end
           end
-          alias :unbind_one :unbind
         end
       end
     end

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

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Bindings #:nodoc:
-      module Referenced #:nodoc:
+module Mongoid
+  module Relations
+    module Bindings
+      module Referenced
 
         # Binding class for all referenced_in relations.
         class In < Binding
@@ -18,27 +18,23 @@ module Mongoid # :nodoc:
           #   game.person = Person.new
           #
           # @since 2.0.0.rc.1
-          def bind
-            base.you_must(metadata.foreign_key_setter, target.id)
-            if metadata.inverse_type
-              base.you_must(metadata.inverse_type_setter, target.class.model_name)
-            end
-            unless _binding?
-              _binding do
-                inverse = metadata.inverse(target)
-                if inverse
-                  if set_base_metadata
-                    if base.referenced_many?
-                      target.send(inverse).push(base) unless Mongoid.identity_map_enabled?
-                    else
-                      target.do_or_do_not(metadata.inverse_setter(target), base)
-                    end
+          def bind_one
+            binding do
+              check_inverses!(target)
+              bind_foreign_key(base, target.id)
+              bind_polymorphic_inverse_type(base, target.class.model_name)
+              if inverse = metadata.inverse(target)
+                if set_base_metadata
+                  bind_inverse_of_field(base, base.metadata.name)
+                  if base.referenced_many?
+                    target.__send__(inverse).push(base) unless Mongoid.using_identity_map?
+                  else
+                    target.do_or_do_not(metadata.inverse_setter(target), base)
                   end
                 end
               end
             end
           end
-          alias :bind_one :bind
 
           # Unbinds the base object and the inverse, caused by setting the
           # reference to nil.
@@ -48,47 +44,25 @@ module Mongoid # :nodoc:
           #   game.person = nil
           #
           # @since 2.0.0.rc.1
-          def unbind
-            base.you_must(metadata.foreign_key_setter, nil)
-            if metadata.inverse_type
-              base.you_must(metadata.inverse_type_setter, nil)
-            end
-            unless _binding?
-              _binding do
-                inverse = metadata.inverse(target)
-                if inverse
-                  set_base_metadata
-                  if base.referenced_many?
-                    target.send(inverse).delete(base)
-                  else
-                    target.send(metadata.inverse_setter(target), nil)
-                  end
+          def unbind_one
+            binding do
+              inverse = metadata.inverse(target)
+              if !inverse && metadata.inverse_of_field
+                inverse = base.__send__(metadata.inverse_of_field)
+              end
+              bind_foreign_key(base, nil)
+              bind_polymorphic_inverse_type(base, nil)
+              bind_inverse_of_field(base, nil)
+              if inverse
+                set_base_metadata
+                if base.referenced_many?
+                  target.__send__(inverse).delete(base)
+                else
+                  target.__send__("#{inverse}=", nil)
                 end
               end
             end
           end
-          alias :unbind_one :unbind
-
-          private
-
-          # Ensure that the metadata on the base is correct, for the cases
-          # where we have multiple belongs to definitions and were are setting
-          # different parents in memory in order.
-          #
-          # @api private
-          #
-          # @example Set the base metadata.
-          #   binding.set_base_metadata
-          #
-          # @return [ true, false ] If the metadata changed.
-          #
-          # @since 2.4.4
-          def set_base_metadata
-            inverse_metadata = metadata.inverse_metadata(target)
-            if inverse_metadata != metadata && !inverse_metadata.nil?
-              base.metadata = inverse_metadata
-            end
-          end
         end
       end
     end