mongoid 5.4.1 → 7.4.0

data/lib/mongoid/relations/accessors.rb

@@ -1,264 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains all the behaviour related to accessing relations
-    # through the getters and setters, and how to delegate to builders to
-    # create new ones.
-    module Accessors
-      extend ActiveSupport::Concern
-
-      # Builds the related document and creates the relation unless the
-      # document is nil, then sets the relation on this document.
-      #
-      # @example Build the relation.
-      #   person.__build__(:addresses, { :_id => 1 }, metadata)
-      #
-      # @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.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def __build__(name, object, metadata)
-        relation = create_relation(object, metadata)
-        set_relation(name, relation)
-      end
-
-      # Create a relation from an object and metadata.
-      #
-      # @example Create the relation.
-      #   person.create_relation(document, metadata)
-      #
-      # @param [ Document, Array<Document> ] object The relation target.
-      # @param [ Metadata ] metadata The relation metadata.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def create_relation(object, metadata)
-        type = @attributes[metadata.inverse_type]
-        target = metadata.builder(self, object).build(type)
-        target ? metadata.relation.new(self, target, metadata) : nil
-      end
-
-      # Resets the criteria inside the relation proxy. Used by many to many
-      # relations to keep the underlying ids array in sync.
-      #
-      # @example Reset the relation criteria.
-      #   person.reset_relation_criteria(:preferences)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 3.0.14
-      def reset_relation_criteria(name)
-        if instance_variable_defined?("@_#{name}")
-          send(name).reset_unloaded
-        end
-      end
-
-      # Set the supplied relation to an instance variable on the class with the
-      # provided name. Used as a helper just for code cleanliness.
-      #
-      # @example Set the proxy on the document.
-      #   person.set(:addresses, addresses)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Proxy ] relation The relation to set.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def set_relation(name, relation)
-        instance_variable_set("@_#{name}", relation)
-      end
-
-      private
-
-      # Get the relation. Extracted out from the getter method to avoid
-      # infinite recursion when overriding the getter.
-      #
-      # @api private
-      #
-      # @example Get the relation.
-      #   document.get_relation(:name, metadata)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      # @param [ Metadata ] metadata The relation metadata.
-      # @param [ true, false ] reload If the relation is to be reloaded.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 3.0.16
-      def get_relation(name, metadata, object, reload = false)
-        if !reload && (value = ivar(name)) != false
-          value
-        else
-          _building do
-            _loading do
-              if object && needs_no_database_query?(object, metadata)
-                __build__(name, object, metadata)
-              else
-                __build__(name, attributes[metadata.key], metadata)
-              end
-            end
-          end
-        end
-      end
-
-      def needs_no_database_query?(object, metadata)
-        object.is_a?(Document) && !object.embedded? &&
-          object._id == attributes[metadata.key]
-      end
-
-      # Is the current code executing without autobuild functionality?
-      #
-      # @example Is autobuild disabled?
-      #   document.without_autobuild?
-      #
-      # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
-      def without_autobuild?
-        Threaded.executing?(:without_autobuild)
-      end
-
-      # Yield to the block with autobuild functionality turned off.
-      #
-      # @example Execute without autobuild.
-      #   document.without_autobuild do
-      #     document.name
-      #   end
-      #
-      # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
-      def without_autobuild
-        Threaded.begin_execution("without_autobuild")
-        yield
-      ensure
-        Threaded.exit_execution("without_autobuild")
-      end
-
-      module ClassMethods
-
-        # Adds the existence check for relations.
-        #
-        # @example Add the existence check.
-        #   Person.existence_check(:name, meta)
-        #
-        # @example Check if a relation exists.
-        #   person = Person.new
-        #   person.has_game?
-        #   person.game?
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The model being set up.
-        #
-        # @since 3.0.0
-        def existence_check(name)
-          module_eval <<-END, __FILE__, __LINE__ + 1
-            def #{name}?
-              without_autobuild { !__send__(:#{name}).blank? }
-            end
-            alias :has_#{name}? :#{name}?
-          END
-          self
-        end
-
-        # Defines the getter for the relation. Nothing too special here: just
-        # return the instance variable for the relation if it exists or build
-        # the thing.
-        #
-        # @example Set up the getter for the relation.
-        #   Person.getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def getter(name, metadata)
-          re_define_method(name) do |reload = false|
-            value = get_relation(name, metadata, nil, reload)
-            if value.nil? && metadata.autobuilding? && !without_autobuild?
-              value = send("build_#{name}")
-            end
-            value
-          end
-          self
-        end
-
-        # Defines the getter for the ids of documents in the relation. Should
-        # be specify only for referenced many relations.
-        #
-        # @example Set up the ids getter for the relation.
-        #   Person.ids_getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The class being set up.
-        def ids_getter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids"
-          re_define_method(ids_method) do
-            send(name).only(:id).map(&:id)
-          end
-          self
-        end
-
-        # Defines the setter for the relation. This does a few things based on
-        # some conditions. If there is an existing association, a target
-        # substitution will take place, otherwise a new relation will be
-        # created with the supplied target.
-        #
-        # @example Set up the setter for the relation.
-        #   Person.setter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def setter(name, metadata)
-          re_define_method("#{name}=") do |object|
-            without_autobuild do
-              if value = get_relation(name, metadata, object)
-                if value.respond_to?(:substitute)
-                  set_relation(name, value.substitute(object.substitutable))
-                end
-              else
-                __build__(name, object.substitutable, metadata)
-              end
-            end
-          end
-          self
-        end
-
-        # Defines the setter method that allows you to set documents
-        # in this relation by their ids. The defined setter, finds
-        # documents with given ids and invokes regular relation setter
-        # with found documents. Ids setters should be defined only for
-        # referenced many relations.
-        #
-        # @example Set up the id_setter for the relation.
-        #   Person.ids_setter("addesses", metadata)
-        #
-        #  @param [ String, Symbol ] name The name of the relation.
-        #  @param [ Metadata ] metadata The metadata for the relation.
-        #
-        #  @return [ Class ] The class being set up.
-        def ids_setter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids="
-          re_define_method(ids_method) do |ids|
-            send(metadata.setter, metadata.klass.find(ids.reject(&:blank?)))
-          end
-          self
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/auto_save.rb

@@ -1,86 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains the behaviour for auto-saving relations in
-    # different collections.
-    module AutoSave
-      extend ActiveSupport::Concern
-
-      # Used to prevent infinite loops in associated autosaves.
-      #
-      # @example Is the document autosaved?
-      #   document.autosaved?
-      #
-      # @return [ true, false ] Has the document already been autosaved?
-      #
-      # @since 3.0.0
-      def autosaved?
-        Threaded.autosaved?(self)
-      end
-
-      # Begin the associated autosave.
-      #
-      # @example Begin autosave.
-      #   document.__autosaving__
-      #
-      # @since 3.1.3
-      def __autosaving__
-        Threaded.begin_autosave(self)
-        yield
-      ensure
-        Threaded.exit_autosave(self)
-      end
-
-      # Check if there is changes for auto-saving
-      #
-      # @example Return true if there is changes on self or in
-      #           autosaved relations.
-      #   document.changed_for_autosave?
-      #
-      # @since 3.1.3
-      def changed_for_autosave?(doc)
-        doc.new_record? || doc.changed? || doc.marked_for_destruction?
-      end
-
-      module ClassMethods
-
-        # Set up the autosave behaviour for references many and references one
-        # relations. When the option is set to true, these relations will get
-        # saved automatically when the parent saved, if they are dirty.
-        #
-        # @example Set up autosave options.
-        #   Person.autosave(metadata)
-        #
-        # @param [ Metadata ] metadata The relation metadata.
-        #
-        # @since 2.0.0.rc.1
-        def autosave(metadata)
-          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)
-                    else
-                      Array(relation).each { |d| d.with(options).save if changed_for_autosave?(d) }
-                    end
-                  end
-                end
-              end
-            end
-
-            after_save save_method, unless: :autosaved?
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/mongoid/relations/binding.rb

@@ -1,218 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # Superclass for all objects that bind relations together.
-    class Binding
-      include Threaded::Lifecycle
-
-      attr_reader :base, :target, :metadata
-
-      # Create the new binding.
-      #
-      # @example Initialize a binding.
-      #   Binding.new(base, target, metadata)
-      #
-      # @param [ Document ] base The base of the binding.
-      # @param [ Document, Array<Document> ] target The target of the binding.
-      # @param [ Metadata ] metadata The relation's metadata.
-      #
-      # @since 2.0.0.rc.1
-      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 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, record_id(base))
-        bind_polymorphic_type(doc, base.class.name)
-        bind_inverse(doc, base)
-      end
-
-      def record_id(base)
-        base.__send__(metadata.primary_key)
-      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)
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Bindings
-      module Embedded
-
-        # Binding class for embedded_in relations.
-        class In < 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 the documents.
-          #   name.person.bind(:continue => true)
-          #   name.person = Person.new
-          #
-          # @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
-            base.__metadata = metadata.inverse_metadata(target) unless base.__metadata
-            base.parentize(target)
-            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
-
-          # Unbinds the base object and the inverse, caused by setting the
-          # reference to nil.
-          #
-          # @example Unbind the document.
-          #   name.person.unbind(:continue => true)
-          #   name.person = nil
-          #
-          # @option options [ true, false ] :continue Do we continue unbinding?
-          #
-          # @since 2.0.0.rc.1
-          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
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Bindings
-      module Embedded
-
-        # Binding class for embeds_many relations.
-        class Many < Binding
-
-          # Binds a single document with the inverse relation. Used
-          # specifically when appending to the proxy.
-          #
-          # @example Bind one document.
-          #   person.addresses.bind_one(address)
-          #
-          # @param [ Document ] doc The single document to bind.
-          #
-          # @since 2.0.0.rc.1
-          def bind_one(doc)
-            doc.parentize(base)
-            binding do
-              doc.do_or_do_not(metadata.inverse_setter(target), base)
-            end
-          end
-
-          # Unbind a single document.
-          #
-          # @example Unbind the document.
-          #   person.addresses.unbind_one(document)
-          #
-          # @param [ Document ] doc The single document to unbind.
-          #
-          # @since 2.0.0.rc.1
-          def unbind_one(doc)
-            binding do
-              doc.do_or_do_not(metadata.inverse_setter(target), nil)
-            end
-          end
-        end
-      end
-    end
-  end
-end