mongoid 6.4.8 → 7.5.4

data/lib/mongoid/relations/builders/nested_attributes/one.rb

@@ -1,126 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Builders
-      module NestedAttributes
-        class One < NestedBuilder
-
-          attr_accessor :destroy
-
-          # Builds the relation 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 relation, a replacement of the relation with a new
-          #   document, or a removal of the relation.
-          #
-          # @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(metadata.name)
-            if update?
-              attributes.delete_id
-              existing.assign_attributes(attributes)
-            elsif replace?
-              parent.send(metadata.setter, Factory.build(metadata.klass, attributes))
-            elsif delete?
-              parent.send(metadata.setter, nil)
-            end
-          end
-
-          # Create the new builder for nested attributes on one-to-one
-          # relations.
-          #
-          # @example Instantiate the builder.
-          #   One.new(metadata, attributes)
-          #
-          # @param [ Metadata ] metadata The relation metadata.
-          # @param [ Hash ] attributes The attributes hash to attempt to set.
-          # @param [ Hash ] options The options defined.
-          #
-          # @since 2.0.0
-          def initialize(metadata, attributes, options)
-            @attributes = attributes.with_indifferent_access
-            @metadata = metadata
-            @options = options
-            @destroy = @attributes.delete(:_destroy)
-          end
-
-          private
-
-          # Is the id in the attribtues acceptable for allowing an update to
-          # the existing relation?
-          #
-          # @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 relation be deleted?
-          #
-          # @example Can the existing object be deleted?
-          #   one.delete?
-          #
-          # @return [ true, false ] If the relation should be deleted.
-          #
-          # @since 2.0.0
-          def delete?
-            destroyable? && !attributes[:id].nil?
-          end
-
-          # Can the existing relation potentially be destroyed?
-          #
-          # @example Is the object destroyable?
-          #   one.destroyable?({ :_destroy => "1" })
-          #
-          # @return [ true, false ] If the relation 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/relations/builders/referenced/in.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Builders
-      module Referenced
-        class In < Builder
-
-          # This builder either takes a foreign key and queries for the
-          # object or a document, where it will just return it.
-          #
-          # @example Build the document.
-          #   Builder.new(meta, attrs).build
-          #
-          # @param [ String ] type The type of document to query for.
-          #
-          # @return [ Document ] A single document.
-          def build(type = nil)
-            return object unless query?
-            model = type ? type.constantize : metadata.klass
-            metadata.criteria(object, model).first
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/builders/referenced/many.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Builders
-      module Referenced
-        class Many < Builder
-
-          # This builder either takes a hash and queries for the
-          # object or an array of documents, where it will just return tem.
-          #
-          # @example Build the documents.
-          #   Builder.new(meta, attrs).build
-          #
-          # @param [ String ] type The type of document to query for.
-          #
-          # @return [ Array<Document> ] The documents.
-          def build(type = nil)
-            return object unless query?
-            return [] if object.is_a?(Array)
-            metadata.criteria(Conversions.flag(object, metadata), base.class)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/builders/referenced/many_to_many.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Builders
-      module Referenced
-        class ManyToMany < Builder
-
-          # This builder either takes a hash and queries for the
-          # object or an array of documents, where it will just return them.
-          #
-          # @example Build the documents.
-          #   Builder.new(meta, attrs).build
-          #
-          # @param [ String ] type The type of document to query for.
-          #
-          # @return [ Array<Document> ] The documents.
-          def build(type = nil)
-            return object.try(:dup) unless query?
-            ids = object || []
-            metadata.criteria(ids, base.class)
-          end
-
-          # Do we need to perform a database query? It will be so if the object we
-          # have is not a document.
-          #
-          # @example Should we query the database?
-          #   builder.query?
-          #
-          # @return [ true, false ] Whether a database query should happen.
-          #
-          # @since 2.0.0.rc.1
-          def query?
-            object.nil? || !object.first.is_a?(Mongoid::Document)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/builders/referenced/one.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Builders
-      module Referenced
-        class One < Builder
-
-          # This builder either takes an _id or an object and queries for the
-          # inverse side using the id or sets the object.
-          #
-          # @example Build the document.
-          #   Builder.new(meta, attrs).build
-          #
-          # @param [ String ] type The type of document to query for.
-          #
-          # @return [ Document ] A single document.
-          def build(type = nil)
-            return object unless query?
-            return nil if base.new_record?
-            metadata.criteria(Conversions.flag(object, metadata), base.class).first
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/builders.rb

@@ -1,106 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/builder"
-require "mongoid/relations/nested_builder"
-require "mongoid/relations/builders/embedded/in"
-require "mongoid/relations/builders/embedded/many"
-require "mongoid/relations/builders/embedded/one"
-require "mongoid/relations/builders/nested_attributes/one"
-require "mongoid/relations/builders/nested_attributes/many"
-require "mongoid/relations/builders/referenced/in"
-require "mongoid/relations/builders/referenced/many"
-require "mongoid/relations/builders/referenced/many_to_many"
-require "mongoid/relations/builders/referenced/one"
-
-module Mongoid
-  module Relations
-
-    # This module is responsible for defining the build and create methods used
-    # in one to one relations.
-    #
-    # @example Methods that get created.
-    #
-    #   class Person
-    #     include Mongoid::Document
-    #     embeds_one :name
-    #   end
-    #
-    #   # The following methods get created:
-    #   person.build_name({ :first_name => "Durran" })
-    #   person.create_name({ :first_name => "Durran" })
-    #
-    # @since 2.0.0.rc.1
-    module Builders
-      extend ActiveSupport::Concern
-
-      private
-
-      # Parse out the attributes and the options from the args passed to a
-      # build_ or create_ methods.
-      #
-      # @example Parse the args.
-      #   doc.parse_args(:name => "Joe")
-      #
-      # @param [ Array ] args The arguments.
-      #
-      # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
-      def parse_args(*args)
-        [ args.first || {}, args.size > 1 ? args[1] : {} ]
-      end
-
-      module ClassMethods
-
-        # Defines a builder method for an embeds_one relation. This is
-        # defined as #build_name.
-        #
-        # @example
-        #   Person.builder("name")
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def builder(name, metadata)
-          re_define_method("build_#{name}") do |*args|
-            attributes, _options = parse_args(*args)
-            document = Factory.build(metadata.klass, attributes)
-            _building do
-              child = send("#{name}=", document)
-              child.run_callbacks(:build)
-              child
-            end
-          end
-          self
-        end
-
-        # Defines a creator method for an embeds_one relation. This is
-        # defined as #create_name. After the object is built it will
-        # immediately save.
-        #
-        # @example
-        #   Person.creator("name")
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def creator(name, metadata)
-          re_define_method("create_#{name}") do |*args|
-            attributes, _options = parse_args(*args)
-            document = Factory.build(metadata.klass, attributes)
-            doc = _assigning do
-              send("#{name}=", document)
-            end
-            doc.save
-            save if new_record? && metadata.stores_foreign_key?
-            doc
-          end
-          self
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/cascading/delete.rb

@@ -1,44 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Cascading
-      class Delete
-
-        attr_accessor :document, :relation, :metadata
-
-        # Initialize the new cascade strategy, which will set up the relation
-        # and the metadata.
-        #
-        # @example Instantiate the strategy
-        #   Strategy.new(document, metadata)
-        #
-        # @param [ Document ] document The document to cascade from.
-        # @param [ Metadata ] metadata The relation's metadata.
-        #
-        # @return [ Strategy ] The new strategy.
-        def initialize(document, metadata)
-          @document, @metadata = document, metadata
-          @relation = document.send(metadata.name)
-        end
-
-        # Execute the cascading deletion for the relation if it already exists.
-        # This should be optimized in the future potentially not to load all
-        # objects from the db.
-        #
-        # @example Perform the cascading delete.
-        #   strategy.cascade
-        #
-        # @since 2.0.0
-        def cascade
-          if relation
-            if relation.cascades.empty?
-              relation.clear
-            else
-              ::Array.wrap(relation).each { |doc| doc.delete }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/cascading/destroy.rb

@@ -1,43 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Cascading
-      class Destroy
-
-        attr_accessor :document, :relation, :metadata
-
-        # Initialize the new cascade strategy, which will set up the relation
-        # and the metadata.
-        #
-        # @example Instantiate the strategy
-        #   Strategy.new(document, metadata)
-        #
-        # @param [ Document ] document The document to cascade from.
-        # @param [ Metadata ] metadata The relation's metadata.
-        #
-        # @return [ Strategy ] The new strategy.
-        def initialize(document, metadata)
-          @document, @metadata = document, metadata
-          @relation = document.send(metadata.name)
-        end
-
-        # Execute the cascading deletion for the relation if it already exists.
-        # This should be optimized in the future potentially not to load all
-        # objects from the db.
-        #
-        # @example Perform the cascading destroy.
-        #   strategy.cascade
-        def cascade
-          if relation
-            if relation.is_a?(Enumerable)
-              relation.entries
-              relation.each { |doc| doc.destroy }
-            else
-              relation.destroy
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/cascading/nullify.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Cascading
-      class Nullify
-
-        attr_accessor :document, :relation, :metadata
-
-        # Initialize the new cascade strategy, which will set up the relation
-        # and the metadata.
-        #
-        # @example Instantiate the strategy
-        #   Strategy.new(document, metadata)
-        #
-        # @param [ Document ] document The document to cascade from.
-        # @param [ Metadata ] metadata The relation's metadata.
-        #
-        # @return [ Strategy ] The new strategy.
-        def initialize(document, metadata)
-          @document, @metadata = document, metadata
-          @relation = document.send(metadata.name)
-        end
-
-        # This cascade does not delete the referenced relations, but instead
-        # sets the foreign key values to nil.
-        #
-        # @example Nullify the reference.
-        #   strategy.cascade
-        def cascade
-          relation.nullify if relation
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/cascading/restrict.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-    module Cascading
-      class Restrict
-
-        attr_accessor :document, :relation, :metadata
-
-        # Initialize the new cascade strategy, which will set up the relation
-        # and the metadata.
-        #
-        # @example Instantiate the strategy
-        #   Strategy.new(document, metadata)
-        #
-        # @param [ Document ] document The document to cascade from.
-        # @param [ Metadata ] metadata The relation's metadata.
-        #
-        # @return [ Strategy ] The new strategy.
-        def initialize(document, metadata)
-          @document, @metadata = document, metadata
-          @relation = document.send(metadata.name)
-        end
-
-        # Execute the cascading deletion for the relation if it already exists.
-        # This should be optimized in the future potentially not to load all
-        # objects from the db.
-        #
-        # @example Perform the cascading delete.
-        #   strategy.cascade
-        def cascade
-          unless relation.blank?
-            raise Errors::DeleteRestriction.new(document, metadata.name)
-          end
-        end
-      end
-    end
-  end
-end
-

data/lib/mongoid/relations/cascading.rb

@@ -1,56 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/cascading/delete"
-require "mongoid/relations/cascading/destroy"
-require "mongoid/relations/cascading/nullify"
-require "mongoid/relations/cascading/restrict"
-
-module Mongoid
-  module Relations
-
-    # This module defines the behaviour for setting up cascading deletes and
-    # nullifies for relations, and how to delegate to the approriate strategy.
-    module Cascading
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :cascades
-        self.cascades = []
-      end
-
-      # Perform all cascading deletes, destroys, or nullifies. Will delegate to
-      # the appropriate strategy to perform the operation.
-      #
-      # @example Execute cascades.
-      #   document.cascade!
-      #
-      # @since 2.0.0.rc.1
-      def cascade!
-        cascades.each do |name|
-          if meta = relations[name]
-            strategy = meta.cascade_strategy
-            strategy.new(self, meta).cascade if strategy
-          end
-        end
-      end
-
-      module ClassMethods
-
-        # Attempt to add the cascading information for the document to know how
-        # to handle associated documents on a removal.
-        #
-        # @example Set up cascading information
-        #   Movie.cascade(metadata)
-        #
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class of the document.
-        #
-        # @since 2.0.0.rc.1
-        def cascade(metadata)
-          cascades.push(metadata.name.to_s) if metadata.dependent?
-          self
-        end
-      end
-    end
-  end
-end

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