mongoid 6.4.4 → 7.1.7

data/lib/mongoid/relations/constraint.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # Used for converting foreign key values to the correct type based on the
-    # types of ids that the document stores.
-    #
-    # @note Durran: The name of this class is this way to match the metadata
-    #   getter, and foreign_key was already taken there.
-    class Constraint
-      attr_reader :metadata
-
-      # Create the new constraint with the metadata.
-      #
-      # @example Instantiate the constraint.
-      #   Constraint.new(metdata)
-      #
-      # @param [ Metadata ] metadata The metadata of the relation.
-      #
-      # @since 2.0.0.rc.7
-      def initialize(metadata)
-        @metadata = metadata
-      end
-
-      # Convert the supplied object to the appropriate type to set as the
-      # foreign key for a relation.
-      #
-      # @example Convert the object.
-      #   constraint.convert("12345")
-      #
-      # @param [ Object ] object The object to convert.
-      #
-      # @return [ Object ] The object cast to the correct type.
-      #
-      # @since 2.0.0.rc.7
-      def convert(object)
-        return convert_polymorphic(object) if metadata.polymorphic?
-        klass, field = metadata.klass, metadata.klass.fields["_id"]
-        if klass.using_object_ids?
-          BSON::ObjectId.mongoize(object)
-        elsif object.is_a?(::Array)
-          object.map!{ |obj| field.mongoize(obj) }
-        else
-          field.mongoize(object)
-        end
-      end
-
-      private
-      
-      def convert_polymorphic(object)
-        object.respond_to?(:id) ? object.id : object
-      end
-    end
-  end
-end

data/lib/mongoid/relations/conversions.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # Contains utility methods for object id conversion.
-    module Conversions
-      extend self
-
-      # Mark the provided object as unconvertable to bson or not, and always
-      # return the provided object.
-      #
-      # @example Flag the object.
-      #   Conversions.flag(metadata, 15)
-      #
-      # @param [ Object ] object The object to flag.
-      # @param [ Metadata ] metadata The relation metadata.
-      #
-      # @return [ Object ] The provided object.
-      #
-      # @since 2.3.0
-      def flag(object, metadata)
-        inverse = metadata.inverse_klass
-        if inverse.using_object_ids? || object.is_a?(BSON::ObjectId)
-          object
-        else
-          if object.is_a?(String)
-            object.unconvertable_to_bson = true
-          end
-          object
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/counter_cache.rb

@@ -1,160 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    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|
-            meta = reflect_on_association(name)
-            inverse = meta.klass.reflect_on_association(meta.inverse)
-            counter_name = inverse.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
-
-        private
-
-        # Add the callbacks responsible for update the counter cache field
-        #
-        # @api private
-        #
-        # @example Add the touchable.
-        #   Person.add_counter_cache_callbacks(meta)
-        #
-        # @param [ Metadata ] meta The metadata for the relation.
-        #
-        # @since 3.1.0
-        def add_counter_cache_callbacks(meta)
-          name = meta.name
-          cache_column = meta.counter_cache_column_name.to_sym
-
-          after_update do
-            if record = __send__(name)
-              foreign_key = meta.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
-
-          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
-
-          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

data/lib/mongoid/relations/cyclic.rb

@@ -1,107 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module provides convenience macros for using cyclic embedded
-    # relations.
-    module Cyclic
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :cyclic
-      end
-
-      module ClassMethods
-
-        # Create a cyclic embedded relation that creates a tree hierarchy for
-        # the document and many embedded child documents.
-        #
-        # @example Set up a recursive embeds many.
-        #
-        #   class Role
-        #     include Mongoid::Document
-        #     recursively_embeds_many
-        #   end
-        #
-        # @example The previous example is a shorcut for this.
-        #
-        #   class Role
-        #     include Mongoid::Document
-        #     embeds_many :child_roles, :class_name => "Role", :cyclic => true
-        #     embedded_in :parent_role, :class_name => "Role", :cyclic => true
-        #   end
-        #
-        # This provides the default nomenclature for accessing a parent document
-        # or its children.
-        #
-        # @since 2.0.0.rc.1
-        def recursively_embeds_many(options = {})
-          embeds_many(
-            cyclic_child_name,
-            options.merge(class_name: self.name, cyclic: true)
-          )
-          embedded_in cyclic_parent_name, class_name: self.name, cyclic: true
-        end
-
-        # Create a cyclic embedded relation that creates a single self
-        # referencing relationship for a parent and a single child.
-        #
-        # @example Set up a recursive embeds one.
-        #
-        #   class Role
-        #     include Mongoid::Document
-        #     recursively_embeds_one
-        #   end
-        #
-        # @example The previous example is a shorcut for this.
-        #
-        #   class Role
-        #     include Mongoid::Document
-        #     embeds_one :child_role, :class_name => "Role", :cyclic => true
-        #     embedded_in :parent_role, :class_name => "Role", :cyclic => true
-        #   end
-        #
-        # This provides the default nomenclature for accessing a parent document
-        # or its children.
-        #
-        # @since 2.0.0.rc.1
-        def recursively_embeds_one(options = {})
-          embeds_one(
-            cyclic_child_name(false),
-            options.merge(class_name: self.name, cyclic: true)
-          )
-          embedded_in cyclic_parent_name, class_name: self.name, cyclic: true
-        end
-
-        private
-
-        # Determines the parent name given the class.
-        #
-        # @example Determine the parent name.
-        #   Role.cyclic_parent_name
-        #
-        # @return [ String ] "parent_" plus the class name underscored.
-        #
-        # @since 2.0.0.rc.1
-        def cyclic_parent_name
-          ("parent_" << self.name.demodulize.underscore.singularize).to_sym
-        end
-
-        # Determines the child name given the class.
-        #
-        # @example Determine the child name.
-        #   Role.cyclic_child_name
-        #
-        # @param [ true, false ] many Is the a many relation?
-        #
-        # @return [ String ] "child_" plus the class name underscored in
-        #   singular or plural form.
-        #
-        # @since 2.0.0.rc.1
-        def cyclic_child_name(many = true)
-          ("child_" << self.name.demodulize.underscore.send(many ? :pluralize : :singularize)).to_sym
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/eager/base.rb

@@ -1,153 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    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(relations_metadata, parent_docs)
-        #
-        # @param [ Array<Metadata> ] associations Relations 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
-
-        # Shift the current relation metadata
-        #
-        # @example Shift the current metadata.
-        #   loader.shift_metadata
-        #
-        # @return [ Object ] The relation metadata object.
-        #
-        # @since 4.0.0
-        def shift_metadata
-          @metadata = @associations.shift
-        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_metadata
-            preload
-            @loaded << @docs.collect { |d| d.send(@metadata.name) if d.respond_to?(@metadata.name) }
-          end
-          @loaded.flatten
-        end
-
-        # 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 = @metadata.klass.any_in(key => keys_from_docs)
-          criteria.inclusions = criteria.inclusions - [ @metadata ]
-          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[@metadata.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
-
-        protected
-        # 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
-        # @param [ Document, Array ] element to set into the parent
-        #
-        # @since 4.0.0
-        def set_relation(doc, element)
-          doc.set_relation(@metadata.name, element) unless doc.blank?
-        end
-      end
-    end
-  end
-end