mongoid 6.4.8 → 7.0.0.beta

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

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      class BelongsTo
+
+        # Eager class for belongs_to associations.
+        class Eager < Association::Referenced::Eager::Base
+
+          private
+
+          def preload
+            raise Errors::EagerLoad.new(@association.name) if @association.polymorphic?
+
+            @docs.each do |d|
+              set_relation(d, nil)
+            end
+
+            each_loaded_document do |doc|
+              id = doc.send(key)
+              set_on_parent(id, doc)
+            end
+          end
+
+          def group_by_key
+            @association.foreign_key
+          end
+
+          def key
+            @association.primary_key
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      class BelongsTo
+
+        # This class handles all behaviour for relations that are either
+        # one-to-many or one-to-one, where the foreign key is stored on this side
+        # of the relation and the reference is to document(s) in another
+        # collection.
+        class Proxy < Association::One
+          include Evolvable
+
+          # Instantiate a new belongs_to association proxy.
+          #
+          # @example Create the new proxy.
+          #   Association::BelongsTo::Proxy.new(game, person, association)
+          #
+          # @param [ Document ] base The document this relation hangs off of.
+          # @param [ Document, Array<Document> ] target The target (parent) of the
+          #   relation.
+          # @param [ Association ] association The association object.
+          def initialize(base, target, association)
+            init(base, target, association) 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 [ self, nil ] The relation or nil.
+          #
+          # @since 2.0.0.rc.1
+          def substitute(replacement)
+            unbind_one
+            if replacement
+              self._target = normalize(replacement)
+              bind_one
+              self
+            end
+          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
+            BelongsTo::Binding.new(_base, _target, _association)
+          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)
+            _association.build(klass, replacement)
+          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
+
+            # Get the Eager object for this type of association.
+            #
+            # @example Get the eager loader object
+            #
+            # @param [ Association ] association The association object.
+            # @param [ Array<Document> ] docs The array of documents.
+            #
+            # @since 7.0
+            def eager_loader(association, docs)
+              Eager.new(association, docs)
+            end
+
+            # Returns true if the relation is an embedded one. In this case
+            # always false.
+            #
+            # @example Is this relation embedded?
+            #   Association::BelongsTo::Proxy.embedded?
+            #
+            # @return [ false ] Always false.
+            #
+            # @since 2.0.0.rc.1
+            def embedded?
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      module CounterCache
+        extend ActiveSupport::Concern
+
+        # Reset the given counter using the .count() query from the
+        # db. This method is usuful in case that a counter got
+        # corrupted, or a new counter was added to the collection.
+        #
+        # @example Reset the given counter cache
+        #   post.reset_counters(:comments)
+        #
+        # @param [ Symbol, Array ] counters One or more counter caches to reset
+        #
+        # @since 4.0.0
+        def reset_counters(*counters)
+          self.class.with(persistence_context) do |_class|
+            _class.reset_counters(self, *counters)
+          end
+        end
+
+        module ClassMethods
+
+          # Reset the given counter using the .count() query from the
+          # db. This method is usuful in case that a counter got
+          # corrupted, or a new counter was added to the collection.
+          #
+          # @example Reset the given counter cache
+          #   Post.reset_counters('50e0edd97c71c17ea9000001', :comments)
+          #
+          # @param [ String ] id The id of the object that will be reset.
+          # @param [ Symbol, Array ] counters One or more counter caches to reset
+          #
+          # @since 3.1.0
+          def reset_counters(id, *counters)
+            document = id.is_a?(Document) ? id : find(id)
+            counters.each do |name|
+              relation_association = relations[name]
+              counter_name = relation_association.inverse_association.counter_cache_column_name
+              document.update_attribute(counter_name, document.send(name).count)
+            end
+          end
+
+          # Update the given counters by the value factor. It uses the
+          # atomic $inc command.
+          #
+          # @example Add 5 to comments counter and remove 2 from likes
+          #   counter.
+          #   Post.update_counters('50e0edd97c71c17ea9000001',
+          #              :comments_count => 5, :likes_count => -2)
+          #
+          # @param [ String ] id The id of the object to update.
+          # @param [ Hash ] counters
+          #
+          # @since 3.1.0
+          def update_counters(id, counters)
+            where(:_id => id).inc(counters)
+          end
+
+          # Increment the counter name from the entries that match the
+          # id by one. This method is used on associations callbacks
+          # when counter_cache is enabled
+          #
+          # @example Increment comments counter
+          #   Post.increment_counter(:comments_count, '50e0edd97c71c17ea9000001')
+          #
+          # @param [ Symbol ] counter_name Counter cache name
+          # @param [ String ] id The id of the object that will have its counter incremented.
+          #
+          # @since 3.1.0
+          def increment_counter(counter_name, id)
+            update_counters(id, counter_name.to_sym => 1)
+          end
+
+          # Decrement the counter name from the entries that match the
+          # id by one. This method is used on associations callbacks
+          # when counter_cache is enabled
+          #
+          # @example Decrement comments counter
+          #   Post.decrement_counter(:comments_count, '50e0edd97c71c17ea9000001')
+          #
+          # @param [ Symbol ] counter_name Counter cache name
+          # @param [ String ] id The id of the object that will have its counter decremented.
+          #
+          # @since 3.1.0
+          def decrement_counter(counter_name, id)
+            update_counters(id, counter_name.to_sym => -1)
+          end
+        end
+
+        # Add the callbacks responsible for update the counter cache field.
+        #
+        # @api private
+        #
+        # @example Add the touchable.
+        #   Mongoid::Association::Referenced::CounterCache.define_callbacks!(association)
+        #
+        # @param [ Association ] association The association.
+        #
+        # @return [ Class ] The association's owning class.
+        #
+        # @since 7.0
+        def self.define_callbacks!(association)
+          name = association.name
+          cache_column = association.counter_cache_column_name.to_sym
+
+          association.inverse_class.tap do |klass|
+            klass.after_update do
+              if record = __send__(name)
+                foreign_key = association.foreign_key
+
+                if attribute_changed?(foreign_key)
+                  original, current = attribute_change(foreign_key)
+
+                  unless original.nil?
+                    record.class.with(persistence_context) do |_class|
+                      _class.decrement_counter(cache_column, original)
+                    end
+                  end
+
+                  unless current.nil?
+                    record[cache_column] = (record[cache_column] || 0) + 1
+                    record.class.with(record.persistence_context) do |_class|
+                      _class.increment_counter(cache_column, current) if record.persisted?
+                    end
+                  end
+                end
+              end
+            end
+
+            klass.after_create do
+              if record = __send__(name)
+                record[cache_column] = (record[cache_column] || 0) + 1
+
+                if record.persisted?
+                  record.class.with(record.persistence_context) do |_class|
+                    _class.increment_counter(cache_column, record._id)
+                  end
+                  record.remove_change(cache_column)
+                end
+              end
+            end
+
+            klass.before_destroy do
+              if record = __send__(name)
+                record[cache_column] = (record[cache_column] || 0) - 1 unless record.frozen?
+
+                if record.persisted?
+                  record.class.with(record.persistence_context) do |_class|
+                    _class.decrement_counter(cache_column, record._id)
+                  end
+                  record.remove_change(cache_column)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+# encoding: utf-8
+module Mongoid
+  module Association
+    module Referenced
+      module Eager
+
+        # Base class for eager load preload functions.
+        #
+        # @since 4.0.0
+        class Base
+
+          # Instantiate the eager load class.
+          #
+          # @example Create the new belongs to eager load preloader.
+          #   BelongsTo.new(association, parent_docs)
+          #
+          # @param [ Array<Association> ] associations Associations to eager load
+          # @param [ Array<Document> ] docs Documents to preload the relations
+          #
+          # @return [ Base ] The eager load preloader
+          #
+          # @since 4.0.0
+          def initialize(associations, docs)
+            @associations = associations
+            @docs = docs
+            @grouped_docs = {}
+          end
+
+          # Run the preloader.
+          #
+          # @example Preload the relations into the documents.
+          #   loader.run
+          #
+          # @return [ Array ] The list of documents given.
+          #
+          # @since 4.0.0
+          def run
+            @loaded = []
+            while shift_association
+              preload
+              @loaded << @docs.collect { |d| d.send(@association.name) if d.respond_to?(@association.name) }
+            end
+            @loaded.flatten
+          end
+
+          protected
+
+          # Preload the current relation.
+          #
+          # This method should be implemented in the subclass
+          #
+          # @example Preload the current relation into the documents.
+          #   loader.preload
+          #
+          # @since 4.0.0
+          def preload
+            raise NotImplementedError
+          end
+
+          # Run the preloader.
+          #
+          # @example Iterate over the documents loaded for the current relation
+          #   loader.each_loaded_document { |doc| }
+          #
+          # @since 4.0.0
+          def each_loaded_document
+            criteria = @association.klass.any_in(key => keys_from_docs)
+            criteria.inclusions = criteria.inclusions - [@association]
+            criteria.each do |doc|
+              yield doc
+            end
+          end
+
+          # Set the pre-loaded document into its parent.
+          #
+          # @example Set docs into parent with pk = "foo"
+          #   loader.set_on_parent("foo", docs)
+          #
+          # @param [ ObjectId ] id parent`s id
+          # @param [ Document, Array ] element to push into the parent
+          #
+          # @since 4.0.0
+          def set_on_parent(id, element)
+            grouped_docs[id].each do |d|
+              set_relation(d, element)
+            end
+          end
+
+          # Return a hash with the current documents grouped by key.
+          #
+          # @example Return a hash with the current documents grouped by key.
+          #   loader.grouped_docs
+          #
+          # @return [ Hash ] hash with grouped documents.
+          #
+          # @since 4.0.0
+          def grouped_docs
+            @grouped_docs[@association.name] ||= @docs.group_by do |doc|
+              doc.send(group_by_key) if doc.respond_to?(group_by_key)
+            end
+          end
+
+          # Group the documents and return the keys
+          #
+          # @example
+          #   loader.keys_from_docs
+          #
+          # @return [ Array ] keys, ids
+          #
+          # @since 4.0.0
+          def keys_from_docs
+            grouped_docs.keys
+          end
+
+          # Return the key to group the current documents.
+          #
+          # This method should be implemented in the subclass
+          #
+          # @example Return the key for group
+          #   loader.group_by_key
+          #
+          # @return [ Symbol ] Key to group by the current documents.
+          #
+          # @since 4.0.0
+          def group_by_key
+            raise NotImplementedError
+          end
+
+          # Set the pre-loaded document into its parent.
+          #
+          # @example Set docs into parent using the current relation name.
+          #   loader.set_relation(doc, docs)
+          #
+          # @param [ Document ] doc The object to set the relation on
+          # @param [ Document, Array ] element to set into the parent
+          #
+          # @since 4.0.0
+          def set_relation(doc, element)
+            doc.set_relation(@association.name, element) unless doc.blank?
+          end
+
+          private
+
+          # Shift the current association metadata
+          #
+          # @example Shift the current association.
+          #   loader.shift_association
+          #
+          # @return [ Association ] The association object.
+          #
+          # @since 4.0.0
+          def shift_association
+            @association = @associations.shift
+          end
+        end
+      end
+    end
+  end
+end