mongodb/mongoid

View on GitHub
lib/mongoid/association/referenced/has_many.rb

Summary

Maintainability
A
3 hrs
Test Coverage
# frozen_string_literal: true
# encoding: utf-8

require 'mongoid/association/referenced/has_many/binding'
require 'mongoid/association/referenced/has_many/buildable'
require 'mongoid/association/referenced/has_many/proxy'
require 'mongoid/association/referenced/has_many/enumerable'
require 'mongoid/association/referenced/has_many/eager'

module Mongoid
  module Association
    module Referenced

      # The has_many association.
      #
      # @since 7.0
      class HasMany
        include Relatable
        include Buildable

        # The options available for this type of association, in addition to the
        # common ones.
        #
        # @return [ Array<Symbol> ] The extra valid options.
        #
        # @since 7.0
        ASSOCIATION_OPTIONS = [
            :after_add,
            :after_remove,
            :as,
            :autosave,
            :before_add,
            :before_remove,
            :dependent,
            :foreign_key,
            :order,
            :primary_key
        ].freeze

        # The complete list of valid options for this association, including
        # the shared ones.
        #
        # @return [ Array<Symbol> ] The valid options.
        #
        # @since 7.0
        VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze

        # The default foreign key suffix.
        #
        # @return [ String ] '_id'
        #
        # @since 7.0
        FOREIGN_KEY_SUFFIX = '_id'.freeze

        # The list of association complements.
        #
        # @return [ Array<Association> ] The association complements.
        #
        # @since 7.0
        def relation_complements
          @relation_complements ||= [ Referenced::BelongsTo ].freeze
        end

        # Setup the instance methods, fields, etc. on the association owning class.
        #
        # @return [ self ]
        #
        # @since 7.0
        def setup!
          setup_instance_methods!
          self
        end

        # Setup the instance methods on the class having this association type.
        #
        # @return [ self ]
        #
        # @since 7.0
        def setup_instance_methods!
          define_getter!
          define_ids_getter!
          define_setter!
          define_ids_setter!
          define_existence_check!
          define_autosaver!
          polymorph!
          define_dependency!
          @owner_class.validates_associated(name) if validate?
          self
        end


        # Get the foreign key field on the inverse for saving the association reference.
        #
        # @return [ String ] The foreign key field on the inverse for saving the
        #   association reference.
        #
        # @since 7.0
        def foreign_key
          @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                             default_foreign_key_field
        end

        # Is this association type embedded?
        #
        # @return [ false ] Always false.
        #
        # @since 7.0
        def embedded?; false; end

        # The default for validation the association object.
        #
        # @return [ true ] Always true.
        #
        # @since 7.0
        def validation_default; true; end

        # Does this association type store the foreign key?
        #
        # @return [ true ] Always true.
        #
        # @since 7.0
        def stores_foreign_key?; false; end

        # Get the association proxy class for this association type.
        #
        # @return [ Association::HasMany::Proxy ] The proxy class.
        #
        # @since 7.0
        def relation
          Proxy
        end

        # The criteria used for querying this association.
        #
        # @return [ Mongoid::Criteria ] The criteria used for querying this association.
        #
        # @since 7.0
        def criteria(base)
          query_criteria(base.send(primary_key), base)
        end

        # The type of this association if it's polymorphic.
        #
        # @note Only relevant for polymorphic associations.
        #
        # @return [ String, nil ] The type field.
        #
        # @since 7.0
        def type
          @type ||= "#{as}_type" if polymorphic?
        end

        # Add polymorphic query criteria to a Criteria object, if this association is
        #  polymorphic.
        #
        # @param [ Mongoid::Criteria ] criteria The criteria object to add to.
        # @param [ Class ] object_class The object class.
        #
        # @return [ Mongoid::Criteria ] The criteria object.
        #
        # @since 7.0
        def add_polymorphic_criterion(criteria, object_class)
          if polymorphic?
            criteria.where(type => object_class.name)
          else
            criteria
          end
        end

        # Is this association polymorphic?
        #
        # @return [ true, false ] Whether this association is polymorphic.
        #
        # @since 7.0
        def polymorphic?
          @polymorphic ||= !!as
        end

        # Whether trying to bind an object using this association should raise
        # an error.
        #
        # @param [ Document ] doc The document to be bound.
        #
        # @return [ true, false ] Whether the document can be bound.
        def bindable?(doc)
          forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
        end

        # The nested builder object.
        #
        # @param [ Hash ] attributes The attributes to use to build the association object.
        # @param [ Hash ] options The options for the association.
        #
        # @return [ Association::Nested::Many ] The Nested Builder object.
        #
        # @since 7.0
        def nested_builder(attributes, options)
          Nested::Many.new(self, 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

        private

        def default_foreign_key_field
          @default_foreign_key_field ||= "#{inverse}#{FOREIGN_KEY_SUFFIX}"
        end

        def polymorphic_inverses(other)
          [ as ]
        end

        def determine_inverses(other)
          matches = (other || relation_class).relations.values.select do |rel|
            relation_complements.include?(rel.class) &&
                rel.relation_class_name == inverse_class_name

          end
          if matches.size > 1
            return [ default_inverse.name ] if default_inverse
            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
          end
          matches.collect { |m| m.name } unless matches.blank?
        end

        def default_primary_key
          PRIMARY_KEY_DEFAULT
        end

        def query_criteria(object, base)
          crit = klass.where(foreign_key => object)
          crit = with_polymorphic_criterion(crit, base)
          crit.association = self
          crit.parent_document = base
          with_ordering(crit)
        end

        def with_polymorphic_criterion(criteria, base)
          if polymorphic?
            criteria.where(type => base.class.name)
          else
            criteria
          end
        end

        def with_ordering(criteria)
          if order
            criteria.order_by(order)
          else
            criteria
          end
        end

        def with_inverse_field_criterion(criteria)
          inverse_association = inverse_association(klass)
          if inverse_association.try(:inverse_of)
            criteria.any_in(inverse_association.inverse_of => [name, nil])
          else
            criteria
          end
        end
      end
    end
  end
end