mongoid 6.4.8 → 7.0.0.beta

data/lib/mongoid/association/referenced.rb

@@ -0,0 +1,7 @@
+require 'mongoid/association/referenced/auto_save'
+require 'mongoid/association/referenced/counter_cache'
+require 'mongoid/association/referenced/syncable'
+require 'mongoid/association/referenced/belongs_to'
+require 'mongoid/association/referenced/has_many'
+require 'mongoid/association/referenced/has_and_belongs_to_many'
+require 'mongoid/association/referenced/has_one'

data/lib/mongoid/association/referenced/auto_save.rb

@@ -0,0 +1,79 @@
+module Mongoid
+  module Association
+    module Referenced
+
+      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
+
+        # Define the autosave method on an association's owning class for
+        # an associated object.
+        #
+        # @example Define the autosave method:
+        #   Association::Referenced::Autosave.define_autosave!(association)
+        #
+        # @param [ Association ] association The association for which autosaving is enabled.
+        #
+        # @return [ Class ] The association's owner class.
+        #
+        # @since 7.0
+        def self.define_autosave!(association)
+          association.inverse_class.tap do |klass|
+            save_method = :"autosave_documents_for_#{association.name}"
+            klass.send(:define_method, save_method) do
+              if before_callback_halted?
+                self.before_callback_halted = false
+              else
+                __autosaving__ do
+                  if relation = ivar(association.name)
+                    Array(relation).each do |doc|
+                      doc.with(persistence_context) do |d|
+                        d.save
+                      end
+                    end
+                  end
+                end
+              end
+            end
+            klass.after_save save_method, unless: :autosaved?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/association/referenced/belongs_to.rb

@@ -0,0 +1,248 @@
+require 'mongoid/association/referenced/belongs_to/binding'
+require 'mongoid/association/referenced/belongs_to/buildable'
+require 'mongoid/association/referenced/belongs_to/proxy'
+require 'mongoid/association/referenced/belongs_to/eager'
+
+module Mongoid
+  module Association
+    module Referenced
+
+      # The BelongsTo type association.
+      #
+      # @since 7.0
+      class BelongsTo
+        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 = [
+            :autobuild,
+            :autosave,
+            :counter_cache,
+            :dependent,
+            :foreign_key,
+            :index,
+            :polymorphic,
+            :primary_key,
+            :touch,
+            :optional,
+            :required
+        ].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 type of the field holding the foreign key.
+        #
+        # @return [ Object ]
+        #
+        # @since 7.0
+        FOREIGN_KEY_FIELD_TYPE = Object
+
+        # 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 ||= [ HasMany, HasOne ].freeze
+        end
+
+        # Setup the instance methods, fields, etc. on the association owning class.
+        #
+        # @return [ self ]
+        #
+        # @since 7.0
+        def setup!
+          setup_instance_methods!
+          @owner_class.aliased_fields[name.to_s] = foreign_key
+          self
+        end
+
+        # Does this association type store the foreign key?
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 7.0
+        def stores_foreign_key?; true; 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 [ false ] Always false.
+        #
+        # @since 7.0
+        def validation_default; false; end
+
+        # Get the foreign key field for saving the association reference.
+        #
+        # @return [ String ] The foreign key field 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
+
+        # Get the relation proxy class for this association type.
+        #
+        # @return [ Association::BelongsTo::Proxy ] The proxy class.
+        #
+        # @since 7.0
+        def relation
+          Proxy
+        end
+
+        # Is this association polymorphic?
+        #
+        # @return [ true, false ] Whether this association is polymorphic.
+        #
+        # @since 7.0
+        def polymorphic?
+          @polymorphic ||= !!@options[:polymorphic]
+        end
+
+        # The name of the field used to store the type of polymorphic relation.
+        #
+        # @return [ String ] The field used to store the type of polymorphic relation.
+        #
+        # @since 7.0
+        def inverse_type
+          (@inverse_type ||= "#{name}_type") if polymorphic?
+        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::One ] The Nested Builder object.
+        #
+        # @since 7.0
+        def nested_builder(attributes, options)
+          Nested::One.new(self, attributes, options)
+        end
+
+        # Get the path calculator for the supplied document.
+        #
+        # @example Get the path calculator.
+        #   association.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 setup_instance_methods!
+          define_getter!
+          define_setter!
+          define_existence_check!
+          define_builder!
+          define_creator!
+          define_autosaver!
+          define_counter_cache_callbacks!
+          polymorph!
+          define_dependency!
+          create_foreign_key_field!
+          setup_index!
+          define_touchable!
+          @owner_class.validates_associated(name) if validate?
+          @owner_class.validates(name, presence: true) if require_association?
+        end
+
+        def index_spec
+          if polymorphic?
+            { key => 1, inverse_type => 1 }
+          else
+            { key => 1 }
+          end
+        end
+
+        def default_primary_key
+          PRIMARY_KEY_DEFAULT
+        end
+
+        def default_foreign_key_field
+          @default_foreign_key_field ||= "#{name}#{FOREIGN_KEY_SUFFIX}"
+        end
+
+        def polymorph!
+          if polymorphic?
+            @owner_class.polymorphic = true
+            @owner_class.field(inverse_type, type: String)
+          end
+        end
+
+        def polymorphic_inverses(other = nil)
+          if other
+            matches = other.relations.values.select do |rel|
+              relation_complements.include?(rel.class) &&
+                  rel.as == name &&
+                  rel.relation_class_name == inverse_class_name
+            end
+            matches.collect { |m| m.name }
+          end
+        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
+            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
+          end
+          matches.collect { |m| m.name }
+        end
+
+        # If set to true, then the associated object will be validated when this object is saved
+        def require_association?
+          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
+
+        def create_foreign_key_field!
+          @owner_class.field(
+              foreign_key,
+              type: FOREIGN_KEY_FIELD_TYPE,
+              identity: true,
+              overwrite: true,
+              association: self,
+              default: nil
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/association/referenced/belongs_to/binding.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      class BelongsTo
+
+        # Binding class for belongs_to associations.
+        class Binding
+          include Bindable
+
+          # 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 association on the inverse object as well as the
+          # document itself.
+          #
+          # @example Bind the documents.
+          #   game.person.bind(:continue => true)
+          #   game.person = Person.new
+          #
+          # @since 2.0.0.rc.1
+          def bind_one
+            binding do
+              check_polymorphic_inverses!(_target)
+              bind_foreign_key(_base, record_id(_target))
+              bind_polymorphic_inverse_type(_base, _target.class.name)
+              if inverse = _association.inverse(_target)
+                if set_base_association
+                  if _base.referenced_many?
+                    _target.__send__(inverse).push(_base)
+                  else
+                    _target.set_relation(inverse, _base)
+                  end
+                end
+              end
+            end
+          end
+
+          # Unbinds the base object and the inverse, caused by setting the
+          # reference to nil.
+          #
+          # @example Unbind the document.
+          #   game.person.unbind(:continue => true)
+          #   game.person = nil
+          #
+          # @since 2.0.0.rc.1
+          def unbind_one
+            binding do
+              inverse = _association.inverse(_target)
+              bind_foreign_key(_base, nil)
+              bind_polymorphic_inverse_type(_base, nil)
+              if inverse
+                set_base_association
+                if _base.referenced_many?
+                  _target.__send__(inverse).delete(_base)
+                else
+                  _target.set_relation(inverse, nil)
+                end
+              end
+            end
+          end
+
+          private
+
+          # 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_polymorphic_inverses!(doc)
+            inverses = _association.inverses(doc)
+            if inverses.count > 1 && _base.send(_association.foreign_key).nil?
+              raise Errors::InvalidSetPolymorphicRelation.new(
+                  _association.name, _base.class.name, _target.class.name
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/association/referenced/belongs_to/buildable.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      class BelongsTo
+
+        # The Builder behavior for belongs_to associations.
+        #
+        # @since 7.0
+        module Buildable
+
+          # This method either takes an _id or an object and queries for the
+          # inverse side using the id or sets the object.
+          #
+          # @example Build the document.
+          #   relation.build(meta, attrs)
+          #
+          # @param [ Object ] base The base object.
+          # @param [ Object ] object The object to use to build the relation.
+          # @param [ String ] type The type of the relation.
+          #
+          # @return [ Document ] A single document.
+          def build(base, object, type = nil)
+            return object unless query?(object)
+            execute_query(object, type)
+          end
+
+          private
+
+          def execute_query(object, type)
+            query_criteria(object, type).limit(-1).first(id_sort: :none)
+          end
+
+          def query_criteria(object, type)
+            model = type ? type.constantize : relation_class
+            model.where(primary_key => object)
+          end
+
+          def query?(object)
+            object && !object.is_a?(Mongoid::Document)
+          end
+        end
+      end
+    end
+  end
+end