mongoid 6.4.8 → 7.5.4

data/lib/mongoid/relations/embedded/batchable.rb

@@ -1,384 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Embedded
-
-      # Contains behaviour for executing operations in batch on embedded
-      # documents.
-      module Batchable
-        include Positional
-
-        # Insert new documents as a batch push ($push with $each). This ensures that
-        # all callbacks are run at the appropriate time and only 1 request is
-        # made to the database.
-        #
-        # @example Execute the batch push.
-        #   batchable.batch_insert([ doc_one, doc_two ])
-        #
-        # @param [ Array<Document> ] docs The docs to add.
-        #
-        # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 3.0.0
-        def batch_insert(docs)
-          execute_batch_push(docs)
-        end
-
-        # Clear all of the docs out of the relation in a single swipe.
-        #
-        # @example Clear all docs.
-        #   batchable.batch_clear(docs)
-        #
-        # @param [ Array<Document> ] docs The docs to clear.
-        #
-        # @return [ Array ] The empty array.
-        #
-        # @since 3.0.0
-        def batch_clear(docs)
-          pre_process_batch_remove(docs, :delete)
-          unless docs.empty?
-            collection.find(selector).update_one(
-              positionally(selector, "$unset" => { path => true }),
-              session: _session
-            )
-            post_process_batch_remove(docs, :delete)
-          end
-          _unscoped.clear
-        end
-
-        # Batch remove the provided documents as a $pullAll.
-        #
-        # @example Batch remove the documents.
-        #   batchable.batch_remove([ doc_one, doc_two ])
-        #
-        # @param [ Array<Document> ] docs The docs to remove.
-        # @param [ Symbol ] method Delete or destroy.
-        #
-        # @since 3.0.0
-        def batch_remove(docs, method = :delete)
-          removals = pre_process_batch_remove(docs, method)
-          if !docs.empty?
-            collection.find(selector).update_one(
-              positionally(selector, "$pullAll" => { path => removals }),
-              session: _session
-            )
-            post_process_batch_remove(docs, method)
-          end
-          reindex
-        end
-
-        # Batch replace the provided documents as a $set.
-        #
-        # @example Batch replace the documents.
-        #   batchable.batch_replace([ doc_one, doc_two ])
-        #
-        # @param [ Array<Document> ] docs The docs to replace with.
-        #
-        # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 3.0.0
-        def batch_replace(docs)
-          if docs.blank?
-            if _assigning? && !empty?
-              base.add_atomic_unset(first)
-              target_duplicate = target.dup
-              pre_process_batch_remove(target_duplicate, :delete)
-              post_process_batch_remove(target_duplicate, :delete)
-            else
-              batch_remove(target.dup)
-            end
-          elsif target != docs
-            base.delayed_atomic_sets.clear unless _assigning?
-            docs = normalize_docs(docs).compact
-            target.clear and _unscoped.clear
-            inserts = execute_batch_set(docs)
-            add_atomic_sets(inserts)
-          end
-        end
-
-        private
-
-        # Add the atomic sets to the base document.
-        #
-        # @api private
-        #
-        # @example Add the atomic sets.
-        #   batchable.add_atomic_sets([{ field: value }])
-        #
-        # @param [ Array<Hash> ] sets The atomic sets.
-        #
-        # @since 3.0.0
-        def add_atomic_sets(sets)
-          if _assigning?
-            base.delayed_atomic_sets[path].try(:clear)
-            base.collect_children.each do |child|
-              child.delayed_atomic_sets.clear
-            end
-            base.delayed_atomic_sets[path] = sets
-          end
-        end
-
-        # Perform a batch persist of the provided documents with a $set.
-        #
-        # @api private
-        #
-        #@example Perform a batch $set.
-        #   batchable.execute_batch_set(docs)
-        #
-        # @param [ Array<Document> ] docs The docs to persist.
-        #
-        # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 7.0.0
-        def execute_batch_set(docs)
-          self.inserts_valid = true
-          inserts = pre_process_batch_insert(docs)
-          if insertable?
-            collection.find(selector).update_one(
-                positionally(selector, '$set' => { path => inserts }),
-                session: _session
-            )
-            post_process_batch_insert(docs)
-          end
-          inserts
-        end
-
-        # Perform a batch persist of the provided documents with $push and $each.
-        #
-        # @api private
-        #
-        # @example Perform a batch push.
-        #   batchable.execute_batch_push(docs)
-        #
-        # @param [ Array<Document> ] docs The docs to persist.
-        #
-        # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 7.0.0
-        def execute_batch_push(docs)
-          self.inserts_valid = true
-          pushes = pre_process_batch_insert(docs)
-          if insertable?
-            collection.find(selector).update_one(
-                positionally(selector, '$push' => { path => { '$each' => pushes } }),
-                session: _session
-            )
-            post_process_batch_insert(docs)
-          end
-          pushes
-        end
-
-        # Are we in a state to be able to batch insert?
-        #
-        # @api private
-        #
-        # @example Can inserts be performed?
-        #   batchable.insertable?
-        #
-        # @return [ true, false ] If inserts can be performed.
-        #
-        # @since 3.0.0
-        def insertable?
-          persistable? && !_assigning? && inserts_valid
-        end
-
-        # Are the inserts currently valid?
-        #
-        # @api private
-        #
-        # @example Are the inserts currently valid.
-        #   batchable.inserts_valid
-        #
-        # @return [ true, false ] If inserts are currently valid.
-        #
-        # @since 3.0.0
-        def inserts_valid
-          @inserts_valid
-        end
-
-        # Set the inserts valid flag.
-        #
-        # @api private
-        #
-        # @example Set the flag.
-        #   batchable.inserts_valid = true
-        #
-        # @param [ true, false ] value The flag.
-        #
-        # @return [ true, false ] The flag.
-        #
-        # @since 3.0.0
-        def inserts_valid=(value)
-          @inserts_valid = value
-        end
-
-        # Normalize the documents, in case they were provided as an array of
-        # hashes.
-        #
-        # @api private
-        #
-        # @example Normalize the docs.
-        #   batchable.normalize_docs(docs)
-        #
-        # @param [ Array<Hash, Document> ] docs The docs to normalize.
-        #
-        # @return [ Array<Document> ] The docs.
-        #
-        # @since 3.0.0
-        def normalize_docs(docs)
-          if docs.first.is_a?(::Hash)
-            docs.map do |doc|
-              attributes = { __metadata: __metadata, _parent: base }
-              attributes.merge!(doc)
-              Factory.build(klass, attributes)
-            end
-          else
-            docs
-          end
-        end
-
-        # Get the atomic path.
-        #
-        # @api private
-        #
-        # @example Get the atomic path.
-        #   batchable.path
-        #
-        # @return [ String ] The atomic path.
-        #
-        # @since 3.0.0
-        def path
-          @path ||= _unscoped.first.atomic_path
-        end
-
-        # Set the atomic path.
-        #
-        # @api private
-        #
-        # @example Set the atomic path.
-        #   batchable.path = "addresses"
-        #
-        # @param [ String ] value The path.
-        #
-        # @return [ String ] The path.
-        #
-        # @since 3.0.0
-        def path=(value)
-          @path = value
-        end
-
-        # Get the selector for executing atomic operations on the collection.
-        #
-        # @api private
-        #
-        # @example Get the selector.
-        #   batchable.selector
-        #
-        # @return [ Hash ] The atomic selector.
-        #
-        # @since 3.0.0
-        def selector
-          @selector ||= base.atomic_selector
-        end
-
-        # Pre processes the batch insert for the provided documents.
-        #
-        # @api private
-        #
-        # @example Pre process the documents.
-        #   batchable.pre_process_batch_insert(docs)
-        #
-        # @param [ Array<Document> ] docs The documents.
-        #
-        # @return [ Array<Hash> ] The documents as an array of hashes.
-        #
-        # @since 3.0.0
-        def pre_process_batch_insert(docs)
-          docs.map do |doc|
-            next unless doc
-            append(doc)
-            if persistable? && !_assigning?
-              self.path = doc.atomic_path unless path
-              if doc.valid?(:create)
-                doc.run_before_callbacks(:save, :create)
-              else
-                self.inserts_valid = false
-              end
-            end
-            doc.send(:as_attributes)
-          end
-        end
-
-        # Pre process the batch removal.
-        #
-        # @api private
-        #
-        # @example Pre process the documents.
-        #   batchable.pre_process_batch_remove(docs, :delete)
-        #
-        # @param [ Array<Document> ] docs The documents.
-        # @param [ Symbol ] method Delete or destroy.
-        #
-        # @return [ Array<Hash> ] The documents as hashes.
-        #
-        # @since 3.0.0
-        def pre_process_batch_remove(docs, method)
-          docs.map do |doc|
-            self.path = doc.atomic_path unless path
-            execute_callback :before_remove, doc
-            unless _assigning?
-              doc.cascade!
-              doc.run_before_callbacks(:destroy) if method == :destroy
-            end
-            target.delete_one(doc)
-            _unscoped.delete_one(doc)
-            unbind_one(doc)
-            execute_callback :after_remove, doc
-            doc.send(:as_attributes)
-          end
-        end
-
-        # Post process the documents after batch insert.
-        #
-        # @api private
-        #
-        # @example Post process the documents.
-        #   batchable.post_process_batch_insert(docs)
-        #
-        # @param [ Array<Documents> ] docs The inserted docs.
-        #
-        # @return [ Enumerable ] The document enum.
-        #
-        # @since 3.0.0
-        def post_process_batch_insert(docs)
-          docs.each do |doc|
-            doc.new_record = false
-            doc.run_after_callbacks(:create, :save)
-            doc.post_persist
-          end
-        end
-
-        # Post process the batch removal.
-        #
-        # @api private
-        #
-        # @example Post process the documents.
-        #   batchable.post_process_batch_remove(docs, :delete)
-        #
-        # @param [ Array<Document> ] docs The documents.
-        # @param [ Symbol ] method Delete or destroy.
-        #
-        # @return [ Array<Document> ] The documents.
-        #
-        # @since 3.0.0
-        def post_process_batch_remove(docs, method)
-          docs.each do |doc|
-            doc.run_after_callbacks(:destroy) if method == :destroy
-            doc.freeze
-            doc.destroyed = true
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/embedded/in.rb

@@ -1,241 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Embedded
-
-      # This class defines the behaviour necessary to handle relations that are
-      # embedded within another relation, either as a single document or
-      # multiple documents.
-      class In < Relations::One
-
-        # The allowed options when defining this relation.
-        #
-        # @return [ Array<Symbol> ] The allowed options when defining this relation.
-        #
-        # @since 6.0.0
-        VALID_OPTIONS = [
-          :autobuild,
-          :cyclic,
-          :polymorphic,
-          :touch
-         ].freeze
-
-        # Instantiate a new embedded_in relation.
-        #
-        # @example Create the new relation.
-        #   Embedded::In.new(name, person, metadata)
-        #
-        # @param [ Document ] base The document the relation hangs off of.
-        # @param [ Document ] target The target (parent) of the relation.
-        # @param [ Metadata ] metadata The relation metadata.
-        #
-        # @return [ In ] The proxy.
-        def initialize(base, target, metadata)
-          init(base, target, metadata) do
-            characterize_one(target)
-            bind_one
-          end
-        end
-
-        # Substitutes the supplied target documents for the existing document
-        # in the relation.
-        #
-        # @example Substitute the new document.
-        #   person.name.substitute(new_name)
-        #
-        # @param [ Document ] replacement A document to replace the target.
-        #
-        # @return [ Document, nil ] The relation or nil.
-        #
-        # @since 2.0.0.rc.1
-        def substitute(replacement)
-          unbind_one
-          unless replacement
-            base.delete if persistable?
-            return nil
-          end
-          base.new_record = true
-          self.target = replacement
-          bind_one
-          self
-        end
-
-        private
-
-        # Instantiate the binding associated with this relation.
-        #
-        # @example Get the binding.
-        #   binding([ address ])
-        #
-        # @return [ Binding ] A binding object.
-        #
-        # @since 2.0.0.rc.1
-        def binding
-          Bindings::Embedded::In.new(base, target, __metadata)
-        end
-
-        # Characterize the document.
-        #
-        # @example Set the base metadata.
-        #   relation.characterize_one(document)
-        #
-        # @param [ Document ] document The document to set the metadata on.
-        #
-        # @since 2.1.0
-        def characterize_one(document)
-          unless base.__metadata
-            base.__metadata = __metadata.inverse_metadata(document)
-          end
-        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
-
-          # Return the builder that is responsible for generating the documents
-          # that will be used by this relation.
-          #
-          # @example Get the builder.
-          #   Embedded::In.builder(meta, object, person)
-          #
-          # @param [ Document ] base The base document.
-          # @param [ Metadata ] meta The metadata of the relation.
-          # @param [ Document, Hash ] object A document or attributes to build with.
-          #
-          # @return [ Builder ] A newly instantiated builder object.
-          #
-          # @since 2.0.0.rc.1
-          def builder(base, meta, object)
-            Builders::Embedded::In.new(base, meta, object)
-          end
-
-          # Returns true if the relation is an embedded one. In this case
-          # always true.
-          #
-          # @example Is this relation embedded?
-          #   Embedded::In.embedded?
-          #
-          # @return [ true ] true.
-          #
-          # @since 2.0.0.rc.1
-          def embedded?
-            true
-          end
-
-          # Returns the suffix of the foreign key field, either "_id" or "_ids".
-          #
-          # @example Get the suffix for the foreign key.
-          #   Referenced::Many.foreign_key_suffix
-          #
-          # @return [ nil ] nil.
-          #
-          # @since 3.0.0
-          def foreign_key_suffix
-            nil
-          end
-
-          # Returns the macro for this relation. Used mostly as a helper in
-          # reflection.
-          #
-          # @example Get the macro.
-          #   Mongoid::Relations::Embedded::In.macro
-          #
-          # @return [ Symbol ] :embedded_in.
-          #
-          # @since 2.0.0.rc.1
-          def macro
-            :embedded_in
-          end
-
-          # Return the nested builder that is responsible for generating
-          # the documents that will be used by this relation.
-          #
-          # @example Get the builder.
-          #   NestedAttributes::One.builder(attributes, options)
-          #
-          # @param [ Metadata ] metadata The relation metadata.
-          # @param [ Hash ] attributes The attributes to build with.
-          # @param [ Hash ] options The options for the builder.
-          #
-          # @option options [ true, false ] :allow_destroy Can documents be
-          #   deleted?
-          # @option options [ Integer ] :limit Max number of documents to
-          #   create at once.
-          # @option options [ Proc, Symbol ] :reject_if If documents match this
-          #   option then they are ignored.
-          # @option options [ true, false ] :update_only Only existing documents
-          #   can be modified.
-          #
-          # @return [ Builder ] A newly instantiated nested builder object.
-          #
-          # @since 2.0.0.rc.1
-          def nested_builder(metadata, attributes, options)
-            Builders::NestedAttributes::One.new(metadata, 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
-
-          # Tells the caller if this relation is one that stores the foreign
-          # key on its own objects.
-          #
-          # @example Does this relation store a foreign key?
-          #   Embedded::In.stores_foreign_key?
-          #
-          # @return [ false ] false.
-          #
-          # @since 2.0.0.rc.1
-          def stores_foreign_key?
-            false
-          end
-
-          # Get the valid options allowed with this relation.
-          #
-          # @example Get the valid options.
-          #   Relation.valid_options
-          #
-          # @return [ Array<Symbol> ] The valid options.
-          #
-          # @since 2.1.0
-          def valid_options
-            VALID_OPTIONS
-          end
-
-          # Get the default validation setting for the relation. Determines if
-          # by default a validates associated will occur.
-          #
-          # @example Get the validation default.
-          #   Proxy.validation_default
-          #
-          # @return [ true, false ] The validation default.
-          #
-          # @since 2.1.9
-          def validation_default
-            false
-          end
-        end
-      end
-    end
-  end
-end