mongoid 6.4.4 → 7.3.2

data/lib/mongoid/relations/nested_builder.rb

@@ -1,74 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This is the superclass for builders that are in charge of handling
-    # creation, deletion, and updates of documents through that ever so lovely
-    # #accepts_nested_attributes_for.
-    class NestedBuilder
-      attr_accessor :attributes, :existing, :metadata, :options
-
-      # Determines if destroys are allowed for this document.
-      #
-      # @example Do we allow a destroy?
-      #   builder.allow_destroy?
-      #
-      # @return [ true, false ] True if the allow destroy option was set.
-      #
-      # @since 2.0.0.rc.1
-      def allow_destroy?
-        options[:allow_destroy] || false
-      end
-
-      # Returns the reject if option defined with the macro.
-      #
-      # @example Is there a reject proc?
-      #   builder.reject?
-      #
-      # @param [ Document ] document 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.
-      #
-      # @since 2.0.0.rc.1
-      def reject?(document, attrs)
-        case callback = options[:reject_if]
-        when Symbol
-          document.method(callback).arity == 0 ? document.send(callback) : document.send(callback, attrs)
-        when Proc
-          callback.call(attrs)
-        else
-         false
-        end
-      end
-
-      # Determines if only updates can occur. Only valid for one-to-one
-      # relations.
-      #
-      # @example Is this update only?
-      #   builder.update_only?
-      #
-      # @return [ true, false ] True if the update_only option was set.
-      #
-      # @since 2.0.0.rc.1
-      def update_only?
-        options[:update_only] || false
-      end
-
-      # Convert an id to its appropriate type.
-      #
-      # @example Convert the id.
-      #   builder.convert_id(Person, "4d371b444835d98b8b000010")
-      #
-      # @param [ Class ] klass The class we're trying to convert for.
-      # @param [ String ] id The id, usually coming from the form.
-      #
-      # @return [ BSON::ObjectId, String, Object ] The converted id.
-      #
-      # @since 2.0.0.rc.6
-      def convert_id(klass, id)
-        klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
-      end
-    end
-  end
-end

data/lib/mongoid/relations/one.rb

@@ -1,60 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This is the superclass for one to one relations and defines the common
-    # behaviour or those proxies.
-    class One < Proxy
-
-      # Clear this relation - same as calling #delete on the document.
-      #
-      # @example Clear the relation.
-      #   relation.clear
-      #
-      # @return [ true, false ] If the delete suceeded.
-      #
-      # @since 3.0.0
-      def clear
-        target.delete
-      end
-
-      # Get all the documents in the relation that are loaded into memory.
-      #
-      # @example Get the in memory documents.
-      #   relation.in_memory
-      #
-      # @return [ Array<Document> ] The documents in memory.
-      #
-      # @since 2.1.0
-      def in_memory
-        [ target ]
-      end
-
-      # Since method_missing is overridden we should override this as well.
-      #
-      # @example Does the proxy respond to the method?
-      #   relation.respond_to?(:name)
-      #
-      # @param [ Symbol ] name The method name.
-      #
-      # @return [ true, false ] If the proxy responds to the method.
-      #
-      # @since 2.1.8
-      def respond_to?(name, include_private = false)
-        target.respond_to?(name, include_private) || super
-      end
-
-      # Evolve the proxy document into an object id.
-      #
-      # @example Evolve the proxy document.
-      #   proxy.__evolve_object_id__
-      #
-      # @return [ Object ] The proxy document's id.
-      #
-      # @since 4.0.0
-      def __evolve_object_id__
-        target._id
-      end
-    end
-  end
-end

data/lib/mongoid/relations/options.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains the validating logic for options passed to relation
-    # macros.
-    module Options
-      extend self
-
-      # These options are available to all relations.
-      COMMON = [
-        :class_name,
-        :counter_cache,
-        :extend,
-        :inverse_class_name,
-        :inverse_of,
-        :name,
-        :relation,
-        :validate
-      ].freeze
-
-      # Determine if the provided options are valid for the relation.
-      #
-      # @example Check the options.
-      #   Options.validate!(:name => :comments)
-      #
-      # @param [ Hash ] options The options to check.
-      #
-      # @raise [ ArgumentError ] If the options are invalid.
-      #
-      # @return [ true, false ] If the options are valid.
-      #
-      # @since 2.1.0
-      def validate!(options)
-        valid_options = options[:relation]::VALID_OPTIONS + COMMON
-        options.keys.each do |key|
-          if !valid_options.include?(key)
-            raise Errors::InvalidOptions.new(
-              options[:name],
-              key,
-              valid_options
-            )
-          end
-        end
-        true
-      end
-    end
-  end
-end

data/lib/mongoid/relations/polymorphic.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains the behaviour for handling polymorphic relational
-    # associations.
-    module Polymorphic
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :polymorphic
-      end
-
-      module ClassMethods
-
-        # Attempts to set up the information needed to handle a polymorphic
-        # relation, if the metadata checks out.
-        #
-        # @example Set up the polymorphic information.
-        #   Movie.polymorph(metadata)
-        #
-        # @param [ Metadata ] metadata The relation metadata.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def polymorph(metadata)
-          if metadata.polymorphic?
-            self.polymorphic = true
-            if metadata.relation.stores_foreign_key?
-              field(metadata.inverse_type, type: String)
-            end
-          end
-          self
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/proxy.rb

@@ -1,215 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/marshalable"
-
-module Mongoid
-  module Relations
-
-    # This class is the superclass for all relation proxy objects, and contains
-    # common behaviour for all of them.
-    class Proxy
-      alias :extend_proxy :extend
-
-      # 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|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
-      end
-
-      include Threaded::Lifecycle
-      include Marshalable
-
-      attr_accessor :base, :__metadata, :target
-      alias :relation_metadata :__metadata
-
-      # Backwards compatibility with Mongoid beta releases.
-      delegate :foreign_key, :inverse_foreign_key, to: :__metadata
-      delegate :bind_one, :unbind_one, to: :binding
-      delegate :collection_name, to: :base
-
-      # Convenience for setting the target and the metadata properties since
-      # all proxies will need to do this.
-      #
-      # @example Initialize the proxy.
-      #   proxy.init(person, name, metadata)
-      #
-      # @param [ Document ] base The base document on the proxy.
-      # @param [ Document, Array<Document> ] target The target of the proxy.
-      # @param [ Metadata ] metadata The relation's metadata.
-      #
-      # @since 2.0.0.rc.1
-      def init(base, target, metadata)
-        @base, @target, @__metadata = base, target, metadata
-        yield(self) if block_given?
-        extend_proxies(metadata.extension) if metadata.extension?
-      end
-
-      # Allow extension to be an array and extend each module
-      def extend_proxies(*extension)
-        extension.flatten.each {|ext| extend_proxy(ext) }
-      end
-
-      # Get the class from the metadata, or return nil if no metadata present.
-      #
-      # @example Get the class.
-      #   proxy.klass
-      #
-      # @return [ Class ] The relation class.
-      #
-      # @since 3.0.15
-      def klass
-        __metadata ? __metadata.klass : 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.preferences.reset_relation_criteria
-      #
-      # @since 3.0.14
-      def reset_unloaded
-        target.reset_unloaded(criteria)
-      end
-
-      # The default substitutable object for a relation proxy is the clone of
-      # the target.
-      #
-      # @example Get the substitutable.
-      #   proxy.substitutable
-      #
-      # @return [ Object ] A clone of the target.
-      #
-      # @since 2.1.6
-      def substitutable
-        target
-      end
-
-      protected
-
-      # Get the collection from the root of the hierarchy.
-      #
-      # @example Get the collection.
-      #   relation.collection
-      #
-      # @return [ Collection ] The root's collection.
-      #
-      # @since 2.0.0
-      def collection
-        root = base._root
-        root.collection unless root.embedded?
-      end
-
-      # Takes the supplied document and sets the metadata on it.
-      #
-      # @example Set the metadata.
-      #   proxt.characterize_one(name)
-      #
-      # @param [ Document ] document The document to set on.
-      #
-      # @since 2.0.0.rc.4
-      def characterize_one(document)
-        document.__metadata = __metadata unless document.__metadata
-      end
-
-      # Default behavior of method missing should be to delegate all calls
-      # 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.
-      #
-      def method_missing(name, *args, &block)
-        target.send(name, *args, &block)
-      end
-
-      # When the base document illegally references an embedded document this
-      # error will get raised.
-      #
-      # @example Raise the error.
-      #   relation.raise_mixed
-      #
-      # @raise [ Errors::MixedRelations ] The error.
-      #
-      # @since 2.0.0
-      def raise_mixed
-        raise Errors::MixedRelations.new(base.class, __metadata.klass)
-      end
-
-      # When the base is not yet saved and the user calls create or create!
-      # on the relation, this error will get raised.
-      #
-      # @example Raise the error.
-      #   relation.raise_unsaved(post)
-      #
-      # @param [ Document ] doc The child document getting created.
-      #
-      # @raise [ Errors::UnsavedDocument ] The error.
-      #
-      # @since 2.0.0.rc.6
-      def raise_unsaved(doc)
-        raise Errors::UnsavedDocument.new(base, doc)
-      end
-
-      # Return the name of defined callback method
-      #
-      # @example returns the before_add callback method name
-      #   callback_method(:before_add)
-      #
-      # @param [ Symbol ] callback_name Which callback
-      #
-      # @return [ Array ] with callback methods to be executed, the array may have symbols and Procs
-      #
-      # @since 3.1.0
-      def callback_method(callback_name)
-        methods = []
-        metadata = __metadata[callback_name]
-        if metadata
-          if metadata.is_a?(Array)
-            methods.concat(metadata)
-          else
-            methods << metadata
-          end
-        end
-        methods
-      end
-
-      # Executes a callback method
-      #
-      # @example execute the before add callback
-      #   execute_callback(:before_add)
-      #
-      # @param [ Symbol ] callback to be executed
-      #
-      # @since 3.1.0
-      def execute_callback(callback, doc)
-        callback_method = callback_method(callback)
-        if callback_method
-          callback_method.each do |c|
-            if c.is_a? Proc
-              c.call(base, doc)
-            else
-              base.send c, doc
-            end
-          end
-        end
-      end
-
-      class << self
-
-        # Apply ordering to the criteria if it was defined on the relation.
-        #
-        # @example Apply the ordering.
-        #   Proxy.apply_ordering(criteria, metadata)
-        #
-        # @param [ Criteria ] criteria The criteria to modify.
-        # @param [ Metadata ] metadata The relation metadata.
-        #
-        # @return [ Criteria ] The ordered criteria.
-        #
-        # @since 3.0.6
-        def apply_ordering(criteria, metadata)
-          metadata.order ? criteria.order_by(metadata.order) : criteria
-        end
-      end
-    end
-  end
-end

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

@@ -1,304 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Referenced
-
-      # This class handles all behaviour for relations that are either
-      # one-to-many or one-to-one, where the foreign key is store on this side
-      # of the relation and the reference is to document(s) in another
-      # collection.
-      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.
-        #   Referenced::In.new(game, person, metadata)
-        #
-        # @param [ Document ] base The document this relation hangs off of.
-        # @param [ Document, Array<Document> ] target The target (parent) of the
-        #   relation.
-        # @param [ Metadata ] metadata The relation's metadata.
-        def initialize(base, target, metadata)
-          init(base, target, metadata) do
-            characterize_one(target)
-            bind_one
-          end
-        end
-
-        # Removes the association between the base document and the target
-        # document by deleting the foreign key and the reference, orphaning
-        # the target document in the process.
-        #
-        # @example Nullify the relation.
-        #   person.game.nullify
-        #
-        def nullify
-          unbind_one
-          target.save
-        end
-
-        # Substitutes the supplied target documents for the existing document
-        # in the relation.
-        #
-        # @example Substitute the relation.
-        #   name.substitute(new_name)
-        #
-        # @param [ Document, Array<Document> ] replacement The replacement.
-        #
-        # @return [ In, nil ] The relation or nil.
-        #
-        # @since 2.0.0.rc.1
-        def substitute(replacement)
-          unbind_one
-          return nil unless replacement
-          self.target = normalize(replacement)
-          bind_one
-          self
-        end
-
-        private
-
-        # Instantiate the binding associated with this relation.
-        #
-        # @example Get the binding object.
-        #   binding([ address ])
-        #
-        # @return [ Binding ] The binding object.
-        #
-        # @since 2.0.0.rc.1
-        def binding
-          Bindings::Referenced::In.new(base, target, __metadata)
-        end
-
-        # Normalize the value provided as a replacement for substitution.
-        #
-        # @api private
-        #
-        # @example Normalize the substitute.
-        #   proxy.normalize(id)
-        #
-        # @param [ Document, Object ] replacement The replacement object.
-        #
-        # @return [ Document ] The document.
-        #
-        # @since 3.1.5
-        def normalize(replacement)
-          return replacement if replacement.is_a?(Document)
-          __metadata.builder(klass, replacement).build
-        end
-
-        # Are we able to persist this relation?
-        #
-        # @example Can we persist the relation?
-        #   relation.persistable?
-        #
-        # @return [ true, false ] If the relation is persistable.
-        #
-        # @since 2.1.0
-        def persistable?
-          target.persisted? && !_binding? && !_building?
-        end
-
-        class << self
-
-          # Return the builder that is responsible for generating the documents
-          # that will be used by this relation.
-          #
-          # @example Get the builder.
-          #   Referenced::In.builder(meta, object)
-          #
-          # @param [ Document ] base The base document.
-          # @param [ Metadata ] meta The metadata of the relation.
-          # @param [ Document, Hash ] object A document or attributes to build
-          #   with.
-          #
-          # @return [ Builder ] A new builder object.
-          #
-          # @since 2.0.0.rc.1
-          def builder(base, meta, object)
-            Builders::Referenced::In.new(base, meta, object)
-          end
-
-          # Get the standard criteria used for querying this relation.
-          #
-          # @example Get the criteria.
-          #   Proxy.criteria(meta, id, Model)
-          #
-          # @param [ Metadata ] metadata The metadata.
-          # @param [ Object ] object The value of the foreign key.
-          # @param [ Class ] type The optional type.
-          #
-          # @return [ Criteria ] The criteria.
-          #
-          # @since 2.1.0
-          def criteria(metadata, object, type = nil)
-            type.where(metadata.primary_key => object)
-          end
-
-          def eager_load_klass
-            Relations::Eager::BelongsTo
-          end
-
-          # Returns true if the relation is an embedded one. In this case
-          # always false.
-          #
-          # @example Is this relation embedded?
-          #   Referenced::In.embedded?
-          #
-          # @return [ false ] Always false.
-          #
-          # @since 2.0.0.rc.1
-          def embedded?
-            false
-          end
-
-          # Get the foreign key for the provided name.
-          #
-          # @example Get the foreign key.
-          #   Referenced::In.foreign_key(:person)
-          #
-          # @param [ Symbol ] name The name.
-          #
-          # @return [ String ] The foreign key.
-          #
-          # @since 3.0.0
-          def foreign_key(name)
-            "#{name}#{foreign_key_suffix}"
-          end
-
-          # Get the default value for the foreign key.
-          #
-          # @example Get the default.
-          #   Referenced::In.foreign_key_default
-          #
-          # @return [ nil ] Always nil.
-          #
-          # @since 2.0.0.rc.1
-          def foreign_key_default
-            nil
-          end
-
-          # Returns the suffix of the foreign key field, either "_id" or "_ids".
-          #
-          # @example Get the suffix for the foreign key.
-          #   Referenced::In.foreign_key_suffix
-          #
-          # @return [ String ] "_id"
-          #
-          # @since 2.0.0.rc.1
-          def foreign_key_suffix
-            "_id"
-          end
-
-          # Returns the macro for this relation. Used mostly as a helper in
-          # reflection.
-          #
-          # @example Get the macro.
-          #   Referenced::In.macro
-          #
-          # @return [ Symbol ] :belongs_to
-          def macro
-            :belongs_to
-          end
-
-          # Return the nested builder that is responsible for generating the documents
-          # that will be used by this relation.
-          #
-          # @example Get the nested builder.
-          #   Referenced::In.builder(attributes, options)
-          #
-          # @param [ Metadata ] metadata The relation metadata.
-          # @param [ Hash ] attributes The attributes to build with.
-          # @param [ Hash ] options The options for the builder.
-          #
-          # @option options [ true, false ] :allow_destroy Can documents be
-          #   deleted?
-          # @option options [ Integer ] :limit Max number of documents to
-          #   create at once.
-          # @option options [ Proc, Symbol ] :reject_if If documents match this
-          #   option then they are ignored.
-          # @option options [ true, false ] :update_only Only existing documents
-          #   can be modified.
-          #
-          # @return [ NestedBuilder ] A newly instantiated nested builder object.
-          #
-          # @since 2.0.0.rc.1
-          def nested_builder(metadata, attributes, options)
-            Builders::NestedAttributes::One.new(metadata, attributes, options)
-          end
-
-          # Get the path calculator for the supplied document.
-          #
-          # @example Get the path calculator.
-          #   Proxy.path(document)
-          #
-          # @param [ Document ] document The document to calculate on.
-          #
-          # @return [ Root ] The root atomic path calculator.
-          #
-          # @since 2.1.0
-          def path(document)
-            Mongoid::Atomic::Paths::Root.new(document)
-          end
-
-          # Tells the caller if this relation is one that stores the foreign
-          # key on its own objects.
-          #
-          # @example Does this relation store a foreign key?
-          #   Referenced::In.stores_foreign_key?
-          #
-          # @return [ true ] Always true.
-          #
-          # @since 2.0.0.rc.1
-          def stores_foreign_key?
-            true
-          end
-
-          # Get the valid options allowed with this relation.
-          #
-          # @example Get the valid options.
-          #   Relation.valid_options
-          #
-          # @return [ Array<Symbol> ] The valid options.
-          #
-          # @since 2.1.0
-          def valid_options
-            VALID_OPTIONS
-          end
-
-          # Get the default validation setting for the relation. Determines if
-          # by default a validates associated will occur.
-          #
-          # @example Get the validation default.
-          #   Proxy.validation_default
-          #
-          # @return [ true, false ] The validation default.
-          #
-          # @since 2.1.9
-          def validation_default
-            false
-          end
-        end
-      end
-    end
-  end
-end