mongoid 7.2.1 → 9.0.0

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

@@ -1,184 +0,0 @@
-# frozen_string_literal: true
-# 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 associations
-          #
-          # @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 associations 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 association.
-          #
-          # This method should be implemented in the subclass
-          #
-          # @example Preload the current association into the documents.
-          #   loader.preload
-          #
-          # @since 4.0.0
-          def preload
-            raise NotImplementedError
-          end
-
-          # Retrieves the documents referenced by the association, and
-          # yields each one sequentially to the provided block. If the
-          # association is not polymorphic, all documents are retrieved in
-          # a single query. If the association is polymorphic, one query is
-          # issued per association target class.
-          #
-          # @since 4.0.0
-          def each_loaded_document(&block)
-            each_loaded_document_of_class(@association.klass, keys_from_docs, &block)
-          end
-
-          # Retrieves the documents of the specified class, that have the
-          # foreign key included in the specified list of keys.
-          #
-          # When the documents are retrieved, the set of inclusions applied
-          # is the set of inclusions applied to the host document minus the
-          # association that is being eagerly loaded.
-          private def each_loaded_document_of_class(cls, keys)
-            # Note: keys should not include nil elements.
-            # Upstream code is responsible for eliminating nils from keys.
-            return cls.none if keys.empty?
-
-            criteria = cls.any_in(key => keys)
-            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.
-          #
-          # Documents that do not have a value for the association being loaded
-          # are not returned.
-          #
-          # @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.reject do |k, v|
-              k.nil?
-            end
-          end
-
-          # Group the documents and return the keys.
-          #
-          # This method omits nil keys (i.e. keys from documents that do not
-          # have a value for the association being loaded).
-          #
-          # @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 association name.
-          #   loader.set_relation(doc, docs)
-          #
-          # @param [ Document ] doc The object to set the association 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

data/lib/mongoid/association/referenced/has_one/nested_builder.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Association
-    module Referenced
-      module NestedAttributes
-        class One < NestedBuilder
-
-          attr_accessor :destroy
-
-          # Builds the association depending on the attributes and the options
-          # passed to the macro.
-          #
-          # @example Build a 1-1 nested document.
-          #   one.build(person, as: :admin)
-          #
-          # @note This attempts to perform 3 operations, either one of an update of
-          #   the existing association, a replacement of the association with a new
-          #   document, or a removal of the association.
-          #
-          # @param [ Document ] parent The parent document.
-          #
-          # @return [ Document ] The built document.
-          #
-          # @since 2.0.0
-          def build(parent)
-            return if reject?(parent, attributes)
-            @existing = parent.send(association.name)
-            if update?
-              attributes.delete_id
-              existing.assign_attributes(attributes)
-            elsif replace?
-              parent.send(association.setter, Factory.build(association.klass, attributes))
-            elsif delete?
-              parent.send(association.setter, nil)
-            end
-          end
-
-          # Create the new builder for nested attributes on one-to-one
-          # associations.
-          #
-          # @example Instantiate the builder.
-          #   One.new(association, attributes)
-          #
-          # @param [ Association ] association The association metadata.
-          # @param [ Hash ] attributes The attributes hash to attempt to set.
-          # @param [ Hash ] options The options defined.
-          #
-          # @since 2.0.0
-          def initialize(association, attributes, options)
-            @attributes = attributes.with_indifferent_access
-            @association = association
-            @options = options
-            @destroy = @attributes.delete(:_destroy)
-          end
-
-          private
-
-          # Is the id in the attribtues acceptable for allowing an update to
-          # the existing association?
-          #
-          # @api private
-          #
-          # @example Is the id acceptable?
-          #   one.acceptable_id?
-          #
-          # @return [ true, false ] If the id part of the logic will allow an update.
-          #
-          # @since 2.0.0
-          def acceptable_id?
-            id = convert_id(existing.class, attributes[:id])
-            existing._id == id || id.nil? || (existing._id != id && update_only?)
-          end
-
-          # Can the existing association be deleted?
-          #
-          # @example Can the existing object be deleted?
-          #   one.delete?
-          #
-          # @return [ true, false ] If the association should be deleted.
-          #
-          # @since 2.0.0
-          def delete?
-            destroyable? && !attributes[:id].nil?
-          end
-
-          # Can the existing association potentially be destroyed?
-          #
-          # @example Is the object destroyable?
-          #   one.destroyable?({ :_destroy => "1" })
-          #
-          # @return [ true, false ] If the association can potentially be
-          #   destroyed.
-          #
-          # @since 2.0.0
-          def destroyable?
-            [ 1, "1", true, "true" ].include?(destroy) && allow_destroy?
-          end
-
-          # Is the document to be replaced?
-          #
-          # @example Is the document to be replaced?
-          #   one.replace?
-          #
-          # @return [ true, false ] If the document should be replaced.
-          #
-          # @since 2.0.0
-          def replace?
-            !existing && !destroyable? && !attributes.blank?
-          end
-
-          # Should the document be updated?
-          #
-          # @example Should the document be updated?
-          #   one.update?
-          #
-          # @return [ true, false ] If the object should have its attributes updated.
-          #
-          # @since 2.0.0
-          def update?
-            existing && !destroyable? && acceptable_id?
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/contextual/geo_near.rb

@@ -1,269 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Contextual
-    class GeoNear
-      extend Forwardable
-      include Enumerable
-      include Command
-
-      def_delegator :results, :[]
-      def_delegators :entries, :==, :empty?
-
-      # Get the average distance for all documents from the point in the
-      # command.
-      #
-      # @example Get the average distance.
-      #   geo_near.average_distance
-      #
-      # @return [ Float, nil ] The average distance.
-      #
-      # @since 3.1.0
-      def average_distance
-        average = stats["avgDistance"]
-        (average.nil? || average.nan?) ? nil : average
-      end
-
-      # Iterates over each of the documents in the $geoNear, excluding the
-      # extra information that was passed back from the database.
-      #
-      # @example Iterate over the results.
-      #   geo_near.each do |doc|
-      #     p doc
-      #   end
-      #
-      # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.1.0
-      def each
-        if block_given?
-          documents.each do |doc|
-            yield doc
-          end
-        else
-          to_enum
-        end
-      end
-
-      # Provide a distance multiplier to be used for each returned distance.
-      #
-      # @example Provide the distance multiplier.
-      #   geo_near.distance_multiplier(13113.1)
-      #
-      # @param [ Integer, Float ] value The distance multiplier.
-      #
-      # @return [ GeoNear ] The GeoNear wrapper.
-      #
-      # @since 3.1.0
-      def distance_multiplier(value)
-        command[:distanceMultiplier] = value
-        self
-      end
-
-      # Initialize the new map/reduce directive.
-      #
-      # @example Initialize the new map/reduce.
-      #   MapReduce.new(criteria, map, reduce)
-      #
-      # @param [ Mongo::Collection ] collection The collection to run the
-      #   operation on.
-      # @param [ Criteria ] criteria The Mongoid criteria.
-      # @param [ String ] near
-      #
-      # @since 3.0.0
-      def initialize(collection, criteria, near)
-        @collection, @criteria = collection, criteria
-        command[:geoNear] = collection.name.to_s
-        command[:near] = near
-        apply_criteria_options
-      end
-
-      # Get a pretty string representation of the command.
-      #
-      # @example Inspect the geoNear.
-      #   geo_near.inspect
-      #
-      # @return [ String ] The inspection string.
-      #
-      # @since 3.1.0
-      def inspect
-%Q{#<Mongoid::Contextual::GeoNear
-  selector:   #{criteria.selector.inspect}
-  class:      #{criteria.klass}
-  near:       #{command[:near]}
-  multiplier: #{command[:distanceMultiplier] || "N/A"}
-  max:        #{command[:maxDistance] || "N/A"}
-  min:        #{command[:minDistance] || "N/A"}
-  unique:     #{command[:unique].nil? ? true : command[:unique]}
-  spherical:  #{command[:spherical] || false}>
-}
-      end
-
-      # Specify the maximum distance to find documents for, or get the value of
-      # the document with the furthest distance.
-      #
-      # @example Set the max distance.
-      #   geo_near.max_distance(0.5)
-      #
-      # @example Get the max distance.
-      #   geo_near.max_distance
-      #
-      # @param [ Integer, Float ] value The maximum distance.
-      #
-      # @return [ GeoNear, Float ] The GeoNear command or the value.
-      #
-      # @since 3.1.0
-      def max_distance(value = nil)
-        if value
-          command[:maxDistance] = value
-          self
-        else
-          stats["maxDistance"]
-        end
-      end
-
-      # Specify the minimum distance to find documents for.
-      #
-      # @example Set the min distance.
-      #   geo_near.min_distance(0.5)
-      #
-      # @param [ Integer, Float ] value The minimum distance.
-      #
-      # @return [ GeoNear ] The GeoNear command.
-      #
-      # @since 3.1.0
-      def min_distance(value)
-        command[:minDistance] = value
-        self
-      end
-
-      # Tell the command to calculate based on spherical distances.
-      #
-      # @example Add the spherical flag.
-      #   geo_near.spherical
-      #
-      # @return [ GeoNear ] The command.
-      #
-      # @since 3.1.0
-      def spherical
-        command[:spherical] = true
-        self
-      end
-
-      # Tell the command whether or not the retured results should be unique.
-      #
-      # @example Set the unique flag.
-      #   geo_near.unique(false)
-      #
-      # @param [ true, false ] value Whether to return unique documents.
-      #
-      # @return [ GeoNear ] The command.
-      #
-      # @since 3.1.0
-      def unique(value = true)
-        command[:unique] = value
-        self
-      end
-
-      # Execute the $geoNear, returning the raw output.
-      #
-      # @example Run the $geoNear
-      #   geo_near.execute
-      #
-      # @return [ Hash ] The raw output
-      #
-      # @since 3.1.0
-      def execute
-        results
-      end
-
-      # Get the stats for the command run.
-      #
-      # @example Get the stats.
-      #   geo_near.stats
-      #
-      # @return [ Hash ] The stats from the command run.
-      #
-      # @since 3.1.0
-      def stats
-        results["stats"]
-      end
-
-      # Get the execution time of the command.
-      #
-      # @example Get the execution time.
-      #   geo_near.time
-      #
-      # @return [ Float ] The execution time.
-      #
-      # @since 3.1.0
-      def time
-        stats["time"]
-      end
-
-      # Is this context's criteria considered empty?
-      #
-      # @example Is this context's criteria considered empty?
-      #   geo_near.empty_and_chainable?
-      #
-      # @return [ true ] Always true.
-      #
-      # @since 5.1.0
-      def empty_and_chainable?
-        true
-      end
-
-      private
-
-      # Apply criteria specific options - query, limit.
-      #
-      # @api private
-      #
-      # @example Apply the criteria options
-      #   geo_near.apply_criteria_options
-      #
-      # @return [ nil ] Nothing.
-      #
-      # @since 3.0.0
-      def apply_criteria_options
-        command[:query] = criteria.selector
-        if limit = criteria.options[:limit]
-          command[:num] = limit
-        end
-      end
-
-      # Get the result documents from the $geoNear.
-      #
-      # @api private
-      #
-      # @example Get the documents.
-      #   geo_near.documents
-      #
-      # @return [ Array, Cursor ] The documents.
-      #
-      # @since 3.0.0
-      def documents
-        results["results"].map do |attributes|
-          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria)
-          doc.attributes["geo_near_distance"] = attributes["dis"]
-          doc
-        end
-      end
-
-      # Execute the $geoNear command and get the results.
-      #
-      # @api private
-      #
-      # @example Get the results.
-      #   geo_near.results
-      #
-      # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
-      def results
-        @results ||= client.command(command).first
-      end
-    end
-  end
-end

data/lib/mongoid/errors/eager_load.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Errors
-
-    # This error is raised when attempting to eager load a many to many
-    # association.
-    #
-    # @deprecated No longer used by Mongoid per MONGOID-4841.
-    class EagerLoad < MongoidError
-
-      # Create the new eager load error.
-      #
-      # @example Create the new eager load error.
-      #   EagerLoad.new(:preferences)
-      #
-      # @param [ Symbol ] name The name of the association.
-      #
-      # @since 2.2.0
-      def initialize(name)
-        super(compose_message("eager_load", { name: name }))
-      end
-    end
-  end
-end

data/lib/mongoid/errors/invalid_session_use.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Errors
-
-    # This error is raised when a session is attempted to be used with a model whose client cannot use it, if
-    #   sessions are nested, or if the mongodb deployment doesn't support sessions.
-    #
-    # @since 6.4.0
-    class InvalidSessionUse < MongoidError
-
-      # Create the error.
-      #
-      # @example Create the error.
-      #   InvalidSessionUse.new(:invalid_session_use)
-      #
-      # @param [ :invalid_sesion_use, :invalid_session_nesting ] error_type The type of session misuse.
-      #
-      # @since 6.4.0
-      def initialize(error_type)
-        super(compose_message(error_type.to_s))
-      end
-    end
-  end
-end

data/lib/mongoid/errors/invalid_storage_parent.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Errors
-
-    # Raised when calling store_in in a sub-class of Mongoid::Document
-    class InvalidStorageParent < MongoidError
-
-      # Create the new error.
-      #
-      # @example Create the new error.
-      #    InvalidStorageParent.new(Person)
-      #
-      # @param [ Class ] klass The model class.
-      #
-      # @since 4.0.0
-      def initialize(klass)
-        super(
-          compose_message(
-            "invalid_storage_parent",
-            { klass: klass }
-          )
-        )
-      end
-    end
-  end
-end

data/lib/mongoid/errors/invalid_value.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-
-module Mongoid
-  module Errors
-
-    # This error is raised when trying to set an attribute with an invalid value.
-    # For example when try to set an Array value to a Hash attribute.
-    #
-    class InvalidValue < MongoidError
-      def initialize(field_class, value_class)
-        super(
-          compose_message("invalid_value", { value_class: value_class, field_class: field_class  })
-        )
-      end
-    end
-  end
-end