mongoid 5.4.1 → 7.4.0

data/lib/mongoid/contextual/none.rb

@@ -1,12 +1,38 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "mongoid/contextual/aggregable/none"
+
 module Mongoid
   module Contextual
     class None
       include Enumerable
+      alias :old_sum :sum
+
+      include Aggregable::None
       include Queryable
 
       attr_reader :criteria, :klass
 
+      alias :new_sum :sum
+
+      # Get the sum in the null context.
+      #
+      # @example Get the sum of null context.
+      #     context.sum(_field)
+      #
+      # @param [ Symbol ] _field The field to sum.
+      #
+      # @return [ Integer | Symbol ] If Mongoid.broken_aggregables is
+      #   set to false, this will always be zero. Otherwise, it will return the
+      #   field name as a symbol.
+      def sum(_field = nil)
+        if Mongoid.broken_aggregables
+          old_sum(_field)
+        else
+          new_sum(_field)
+        end
+      end
+
       # Check if the context is equal to the other object.
       #
       # @example Check equality.
@@ -15,23 +41,31 @@ module Mongoid
       # @param [ Array ] other The other array.
       #
       # @return [ true, false ] If the objects are equal.
-      #
-      # @since 4.0.0
       def ==(other)
         other.is_a?(None)
       end
 
+      # Get the distinct field values in null context.
+      #
+      # @example Get the distinct values in null context.
+      #   context.distinct(:name)
+      #
+      # @param [ String, Symbol ] _field The name of the field.
+      #
+      # @return [ Array ] An empty Array.
+      def distinct(_field)
+        []
+      end
+
       # Iterate over the null context. There are no documents to iterate over
       # in this case.
       #
-      # @example Iterate over the context.
+      # @example Iterate over the null context.
       #   context.each do |doc|
       #     puts doc.name
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 4.0.0
       def each
         if block_given?
           [].each { |doc| yield(doc) }
@@ -43,23 +77,20 @@ module Mongoid
 
       # Do any documents exist for the context.
       #
-      # @example Do any documents exist for the context.
+      # @example Do any documents exist in the null context.
       #   context.exists?
       #
-      # @return [ true, false ] If the count is more than zero.
-      #
-      # @since 4.0.0
+      # @return [ false ] Always false.
       def exists?; false; end
 
-
-      # Allow pluck for null context.
+      # Pluck the field values in null context.
       #
-      # @example Allow pluck for null context.
+      # @example Get the values for null context.
       #   context.pluck(:name)
       #
       # @param [ String, Symbol, Array ] args Field or fields to pluck.
       #
-      # @return [ Array ] Emtpy Array
+      # @return [ Array ] An empty Array.
       def pluck(*args)
         []
       end
@@ -70,34 +101,31 @@ module Mongoid
       #   Null.new(criteria)
       #
       # @param [ Criteria ] criteria The criteria.
-      #
-      # @since 4.0.0
       def initialize(criteria)
         @criteria, @klass = criteria, criteria.klass
       end
 
       # Always returns nil.
       #
-      # @example Get the last document.
+      # @example Get the last document in null context.
       #   context.last
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 4.0.0
       def last; nil; end
 
       # Always returns zero.
       #
-      # @example Get the length of matching documents.
+      # @example Get the length of null context.
       #   context.length
       #
       # @return [ Integer ] Always zero.
-      #
-      # @since 4.0.0
       def length
-        entries.length
+        Mongoid.broken_aggregables ? 0 : entries.length
       end
       alias :size :length
+
+      alias :find_first :first
+      alias :one :first
     end
   end
 end

data/lib/mongoid/contextual/queryable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Queryable
@@ -14,8 +15,6 @@ module Mongoid
       #   context.blank?
       #
       # @return [ true, false ] If the context is empty.
-      #
-      # @since 3.0.0
       def blank?
         !exists?
       end

data/lib/mongoid/contextual.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
 require "mongoid/contextual/memory"
@@ -6,21 +7,22 @@ require "mongoid/contextual/none"
 
 module Mongoid
   module Contextual
+    extend Forwardable
 
     # The aggregate operations provided in the aggregate module get delegated
     # through to the context from the criteria.
-    delegate(*Aggregable::Mongo.public_instance_methods(false), to: :context)
+    def_delegators :context, *Aggregable::Mongo.public_instance_methods(false)
 
     # The atomic operations provided in the atomic context get delegated
     # through to the context from the criteria.
-    delegate(*Atomic.public_instance_methods(false), to: :context)
+    def_delegators :context, *Atomic.public_instance_methods(false)
 
     # The methods in the contexts themselves should all get delegated to,
     # including destructive, modification, and optional methods.
-    delegate(*(Mongo.public_instance_methods(false) - [ :skip, :limit ]), to: :context)
+    def_delegators :context, *(Mongo.public_instance_methods(false) - [ :skip, :limit ])
 
     # This gets blank and empty included.
-    delegate(*Queryable.public_instance_methods(false), to: :context)
+    def_delegators :context, *Queryable.public_instance_methods(false)
 
     # Get the context in which criteria queries should execute. This is either
     # in memory (for embedded documents) or mongo (for root level documents.)
@@ -29,8 +31,6 @@ module Mongoid
     #   criteria.context
     #
     # @return [ Memory, Mongo ] The context.
-    #
-    # @since 3.0.0
     def context
       @context ||= create_context
     end
@@ -46,8 +46,6 @@ module Mongoid
     #   contextual.create_context
     #
     # @return [ Mongo, Memory ] The context.
-    #
-    # @since 3.0.0
     def create_context
       return None.new(self) if empty_and_chainable?
       embedded ? Memory.new(self) : Mongo.new(self)

data/lib/mongoid/copyable.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains the behaviour of Mongoid's clone/dup of documents.
+  # This module contains the behavior of Mongoid's clone/dup of documents.
   module Copyable
     extend ActiveSupport::Concern
 
@@ -19,12 +20,23 @@ module Mongoid
       # @note This next line is here to address #2704, even though having an
       # _id and id field in the document would cause problems with Mongoid
       # elsewhere.
-      attrs = clone_document.except("_id", "id")
-      begin
-        self.class.new(attrs)
-      rescue Errors::UnknownAttribute
-        self.class.send(:include, Attributes::Dynamic)
-        self.class.new(attrs)
+      attrs = clone_document.except(*self.class.id_fields)
+      dynamic_attrs = {}
+      _attribute_names = self.attribute_names
+      attrs.reject! do |attr_name, value|
+        unless _attribute_names.include?(attr_name)
+          dynamic_attrs[attr_name] = value
+          true
+        end
+      end
+      self.class.new(attrs).tap do |object|
+        dynamic_attrs.each do |attr_name, value|
+          if object.respond_to?("#{attr_name}=")
+            object.send("#{attr_name}=", value)
+          else
+            object.attributes[attr_name] = value
+          end
+        end
       end
     end
     alias :dup :clone
@@ -37,10 +49,8 @@ module Mongoid
     #
     # @example clone document
     #   model.clone_document
-    #
-    # @since 3.0.22
     def clone_document
-      attrs = as_document.__deep_copy__
+      attrs = as_attributes.__deep_copy__
       process_localized_attributes(self, attrs)
       attrs
     end
@@ -54,23 +64,26 @@ module Mongoid
     #   model.process_localized_attributes(attributes)
     #
     # @param [ Hash ] attrs The attributes.
-    #
-    # @since 3.0.20
     def process_localized_attributes(klass, attrs)
       klass.localized_fields.keys.each do |name|
         if value = attrs.delete(name)
           attrs["#{name}_translations"] = value
         end
       end
-      klass.embedded_relations.each do |_, metadata|
-        next unless attrs.present? && attrs[metadata.key].present?
+      klass.embedded_relations.each do |_, association|
+        next unless attrs.present? && attrs[association.key].present?
 
-        if metadata.macro == :embeds_many
-          attrs[metadata.key].each do |attr|
-            process_localized_attributes(metadata.klass, attr)
+        if association.is_a?(Association::Embedded::EmbedsMany)
+          attrs[association.key].each do |attr|
+            embedded_klass = if type = attr[self.class.discriminator_key]
+              association.relation_class.get_discriminator_mapping(type) || association.relation_class
+            else
+              association.relation_class
+            end
+            process_localized_attributes(embedded_klass, attr)
           end
         else
-          process_localized_attributes(metadata.klass, attrs[metadata.key])
+          process_localized_attributes(association.klass, attrs[association.key])
         end
       end
     end

data/lib/mongoid/criteria/findable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Findable
@@ -14,8 +15,6 @@ module Mongoid
       # @raise [ Errors::DocumentNotFound ] If nothing returned.
       #
       # @return [ Document, Array<Document> ] The document(s).
-      #
-      # @since 2.0.0
       def execute_or_raise(ids, multi)
         result = multiple_from_db(ids)
         check_for_missing_documents!(result, ids)
@@ -33,8 +32,6 @@ module Mongoid
       # @param [ Array<BSON::ObjectId> ] args The ids to search for.
       #
       # @return [ Array<Document>, Document ] The matching document(s).
-      #
-      # @since 1.0.0
       def find(*args)
         ids = args.__find_args__
         raise_invalid if ids.any?(&:nil?)
@@ -86,8 +83,6 @@ module Mongoid
       #   criteria.id_finder
       #
       # @return [ Symbol ] The name of the finder method.
-      #
-      # @since 3.1.0
       def id_finder
         @id_finder ||= extract_id ? :all_of : :where
       end
@@ -102,10 +97,16 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to fetch with.
       #
       # @return [ Array<Document> ] The matching documents.
-      #
-      # @since 3.0.0
       def from_database(ids)
-        (ids.size > 1 ? any_in(id: ids) : where(id: ids.first)).entries
+        from_database_selector(ids).entries
+      end
+
+      private def from_database_selector(ids)
+        if ids.size > 1
+          any_in(_id: ids)
+        else
+          where(_id: ids.first)
+        end
       end
 
       # Convert all the ids to their proper types.
@@ -118,11 +119,9 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to convert.
       #
       # @return [ Array<Object> ] The converted ids.
-      #
-      # @since 3.0.0
       def mongoize_ids(ids)
         ids.map do |id|
-          id = id[:id] if id.respond_to?(:keys) && id[:id]
+          id = id[:_id] if id.respond_to?(:keys) && id[:_id]
           klass.fields["_id"].mongoize(id)
         end
       end
@@ -133,8 +132,6 @@ module Mongoid
       #   criteria.raise_invalid
       #
       # @raise [ Errors::InvalidOptions ] The error.
-      #
-      # @since 2.0.0
       def raise_invalid
         raise Errors::InvalidFind.new
       end

data/lib/mongoid/criteria/includable.rb

@@ -1,15 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
 
     # Module providing functionality for parsing (nested) inclusion definitions.
     module Includable
 
-      # Eager loads all the provided relations. Will load all the documents
+      # Eager loads all the provided associations. Will load all the documents
       # into the identity map whose ids match based on the extra query for the
       # ids.
       #
-      # @note This will work for embedded relations that reference another
+      # @note This will work for embedded associations that reference another
       #   collection via belongs_to as well.
       #
       # @note Eager loading brings all the documents into memory, so there is a
@@ -17,15 +18,13 @@ module Mongoid
       #   eager loading becomes slower around 100k documents, but this will
       #   naturally depend on the specific application.
       #
-      # @example Eager load the provided relations.
+      # @example Eager load the provided associations.
       #   Person.includes(:posts, :game)
       #
-      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the relations to eager
+      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the associations to eager
       #   load.
       #
       # @return [ Criteria ] The cloned criteria.
-      #
-      # @since 2.2.0
       def includes(*relations)
         extract_includes_list(klass, relations)
         clone
@@ -36,9 +35,7 @@ module Mongoid
       # @example Get the eager loading inclusions.
       #   Person.includes(:game).inclusions
       #
-      # @return [ Array<Metadata> ] The inclusions.
-      #
-      # @since 2.2.0
+      # @return [ Array<Association> ] The inclusions.
       def inclusions
         @inclusions ||= []
       end
@@ -46,13 +43,11 @@ module Mongoid
       # Set the inclusions for the criteria.
       #
       # @example Set the inclusions.
-      #   criteria.inclusions = [ meta ]
+      #   criteria.inclusions = [ association ]
       #
-      # @param [ Array<Metadata> ] value The inclusions.
+      # @param [ Array<Association> ] value The inclusions.
       #
-      # @return [ Array<Metadata> ] The new inclusions.
-      #
-      # @since 3.0.0
+      # @return [ Array<Association> ] The new inclusions.
       def inclusions=(value)
         @inclusions = value
       end
@@ -65,28 +60,26 @@ module Mongoid
       #   criteria.add_inclusion(Person, :posts)
       #
       # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
-      # @param [ Symbol ] metadata The relation.
-      #
-      # @raise [ Errors::InvalidIncludes ] If no relation is found.
+      # @param [ Symbol ] association The association.
       #
-      # @since 5.1.0
-      def add_inclusion(_klass, metadata)
-        inclusions.push(metadata) unless inclusions.include?(metadata)
+      # @raise [ Errors::InvalidIncludes ] If no association is found.
+      def add_inclusion(_klass, association)
+        inclusions.push(association) unless inclusions.include?(association)
       end
 
       def extract_includes_list(_parent_class, *relations_list)
         relations_list.flatten.each do |relation_object|
           if relation_object.is_a?(Hash)
             relation_object.each do |relation, _includes|
-              metadata = _parent_class.reflect_on_association(relation)
-              raise Errors::InvalidIncludes.new(_klass, [ relation ]) unless metadata
-              add_inclusion(_parent_class, metadata)
-              extract_includes_list(metadata.klass, _includes)
+              association = _parent_class.reflect_on_association(relation)
+              raise Errors::InvalidIncludes.new(_klass, [ relation ]) unless association
+              add_inclusion(_parent_class, association)
+              extract_includes_list(association.klass, _includes)
             end
           else
-            metadata = _parent_class.reflect_on_association(relation_object)
-            raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless metadata
-            add_inclusion(_parent_class, metadata)
+            association = _parent_class.reflect_on_association(relation_object)
+            raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless association
+            add_inclusion(_parent_class, association)
           end
         end
       end

data/lib/mongoid/criteria/inspectable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Inspectable
@@ -10,8 +11,6 @@ module Mongoid
       #   criteria.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 1.0.0
       def inspect
 %Q{#<Mongoid::Criteria
   selector: #{selector.inspect}

data/lib/mongoid/criteria/marshalable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Marshalable
@@ -9,8 +10,6 @@ module Mongoid
       #   Marshal.dump(criteria)
       #
       # @return [ Array<Object> ] The dumped data.
-      #
-      # @since 3.0.15
       def marshal_dump
         data = [ klass, driver, inclusions, documents, strategy, negating ]
         data.push(scoping_options).push(dump_hash(:selector)).push(dump_hash(:options))
@@ -22,13 +21,11 @@ module Mongoid
       #   Marshal.load(criteria)
       #
       # @param [ Array ] data The raw data.
-      #
-      # @since 3.0.15
       def marshal_load(data)
         @scoping_options, raw_selector, raw_options = data.pop(3)
         @klass, @driver, @inclusions, @documents, @strategy, @negating = data
-        @selector = load_hash(Origin::Selector, raw_selector)
-        @options = load_hash(Origin::Options, raw_options)
+        @selector = load_hash(Queryable::Selector, raw_selector)
+        @options = load_hash(Queryable::Options, raw_options)
       end
 
       private

data/lib/mongoid/criteria/modifiable.rb

@@ -1,8 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Modifiable
 
+      # @attribute [r] create_attrs Additional attributes to add to the Document upon creation.
+      # @api private
+      attr_reader :create_attrs
+
       # Build a document given the selector and return it.
       # Complex criteria, such as $in and $or operations will get ignored.
       #
@@ -13,8 +18,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).build
       #
       # @return [ Document ] A non-persisted document.
-      #
-      # @since 2.0.0
       def build(attrs = {}, &block)
         create_document(:new, attrs, &block)
       end
@@ -30,8 +33,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).create
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 2.0.0.rc.1
       def create(attrs = {}, &block)
         create_document(:create, attrs, &block)
       end
@@ -49,22 +50,24 @@ module Mongoid
       # @raise [ Errors::Validations ] on a validation error.
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 3.0.0
       def create!(attrs = {}, &block)
         create_document(:create!, attrs, &block)
       end
 
       # Define attributes with which new documents will be created.
       #
+      # Note that if `find_or_create_by` is called after this in a method chain, the attributes in
+      # the query will override those from this method.
+      #
       # @example Define attributes to be used when a new document is created.
       #   Person.create_with(job: 'Engineer').find_or_create_by(employer: 'MongoDB')
       #
       # @return [ Mongoid::Criteria ] A criteria.
-      #
-      # @since 5.1.0
       def create_with(attrs = {})
-        where(selector.merge(attrs))
+        tap do
+          @create_attrs ||= {}
+          @create_attrs.update(attrs)
+        end
       end
 
       # Find the first +Document+ given the conditions, or creates a new document
@@ -118,8 +121,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create(attrs = nil, &block)
         first_or(:create, attrs, &block)
       end
@@ -134,8 +135,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create!(attrs = nil, &block)
         first_or(:create!, attrs, &block)
       end
@@ -149,8 +148,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly initialized document.
-      #
-      # @since 3.1.0
       def first_or_initialize(attrs = nil, &block)
         first_or(:new, attrs, &block)
       end
@@ -169,20 +166,23 @@ module Mongoid
       # @param [ Hash ] attrs Additional attributes to use.
       #
       # @return [ Document ] The new or saved document.
-      #
-      # @since 3.0.0
       def create_document(method, attrs = nil, &block)
-        attributes = selector.reduce(attrs ? attrs.dup : {}) do |hash, (key, value)|
-          unless key.to_s =~ /\$/ || value.is_a?(Hash)
+        attrs = (create_attrs || {}).merge(attrs || {})
+        attributes = selector.reduce(attrs) do |hash, (key, value)|
+          unless invalid_key?(hash, key) || invalid_embedded_doc?(value)
             hash[key] = value
           end
           hash
         end
         if embedded?
           attributes[:_parent] = parent_document
-          attributes[:__metadata] = metadata
+          attributes[:_association] = association
+        end
+        if polymorphic? && @criterion
+          klass.__send__(method, attributes.merge(@criterion), &block)
+        else
+          klass.__send__(method, attributes, &block)
         end
-        klass.__send__(method, attributes, &block)
       end
 
       # Find the first object or create/initialize it.
@@ -211,11 +211,25 @@ module Mongoid
       # @param [ Hash ] attrs The attributes to query or set.
       #
       # @return [ Document ] The first or new document.
-      #
-      # @since 3.1.0
       def first_or(method, attrs = {}, &block)
         first || create_document(method, attrs, &block)
       end
+
+      private
+
+      def invalid_key?(hash, key)
+        # @todo Change this to BSON::String::ILLEGAL_KEY when ruby driver 2.3.0 is
+        # released and mongoid is updated to depend on driver >= 2.3.0
+        key.to_s =~ Mongoid::Document::ILLEGAL_KEY || hash.key?(key.to_sym) || hash.key?(key)
+      end
+
+      def invalid_embedded_doc?(value)
+        # @todo Change this to BSON::String::ILLEGAL_KEY when ruby driver 2.3.0 is
+        # released and mongoid is updated to depend on driver >= 2.3.0
+        value.is_a?(Hash) && value.any? do |key, v|
+          key.to_s =~ Mongoid::Document::ILLEGAL_KEY || invalid_embedded_doc?(v)
+        end
+      end
     end
   end
 end