mongoid 7.0.0 → 7.4.0

data/lib/mongoid/errors.rb

@@ -1,12 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/errors/mongoid_error"
 require "mongoid/errors/ambiguous_relationship"
 require "mongoid/errors/callback"
+require "mongoid/errors/criteria_argument_required"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
+require "mongoid/errors/empty_config_file"
 require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
@@ -17,6 +21,13 @@ require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
 require "mongoid/errors/invalid_path"
 require "mongoid/errors/invalid_persistence_option"
+require "mongoid/errors/invalid_query"
+# Must be after invalid_query.
+require "mongoid/errors/invalid_discriminator_key_target"
+require "mongoid/errors/invalid_elem_match_operator"
+require "mongoid/errors/invalid_estimated_count_criteria"
+require "mongoid/errors/invalid_expression_operator"
+require "mongoid/errors/invalid_field_operator"
 require "mongoid/errors/invalid_relation"
 require "mongoid/errors/invalid_relation_option"
 require "mongoid/errors/invalid_scope"

data/lib/mongoid/evolvable.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # Contains behaviour specific to evolving for queryable queries.
+  # Contains behavior specific to evolving for queryable queries.
   module Evolvable
 
     # Evolve the document into an object id.
@@ -10,10 +11,8 @@ module Mongoid
     #   document.__evolve_object_id__
     #
     # @return [ Object ] The document's id.
-    #
-    # @since 3.0.0
     def __evolve_object_id__
-      id
+      _id
     end
   end
 end

data/lib/mongoid/extensions/array.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Array
@@ -9,8 +10,6 @@ module Mongoid
       #   [ id ].__evolve_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         map!(&:__evolve_object_id__)
         self
@@ -22,8 +21,6 @@ module Mongoid
       #   [ 1, 2, 3 ].__find_args__
       #
       # @return [ Array ] The array of args.
-      #
-      # @since 3.0.0
       def __find_args__
         flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s }
       end
@@ -34,8 +31,6 @@ module Mongoid
       #   [ id ].__mongoize_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         map!(&:__mongoize_object_id__).compact!
         self
@@ -43,26 +38,37 @@ module Mongoid
 
       # Converts the array for storing as a time.
       #
+      # @note Returns a local time in the default time zone.
+      #
       # @example Convert the array to a time.
       #   [ 2010, 1, 1 ].__mongoize_time__
+      #   # => 2010-01-01 00:00:00 -0500
       #
-      # @return [ Time ] The time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to date/time components
+      #   in this array.
       def __mongoize_time__
         ::Time.configured.local(*self)
       end
 
-      # Check if the array is part of a blank relation criteria.
-      #
-      # @example Is the array blank criteria?
-      #   [].blank_criteria?
-      #
-      # @return [ true, false ] If the array is blank criteria.
-      #
-      # @since 3.1.0
+      # Checks whether conditions given in this array are known to be
+      # unsatisfiable, i.e., querying with this array will always return no
+      # documents.
+      #
+      # This method used to assume that the array is the list of criteria
+      # to be used with an $and operator. This assumption is no longer made;
+      # therefore, since the interpretation of conditions in the array differs
+      # between $and, $or and $nor operators, this method now always returns
+      # false.
+      #
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only. It always returns false.
+      #
+      # @return [ false ] Always false.
+      # @deprecated
       def blank_criteria?
-        any?(&:blank_criteria?)
+        false
       end
 
       # Is the array a set of multiple arguments in a method?
@@ -71,8 +77,6 @@ module Mongoid
       #   [ 1, 2, 3 ].multi_arged?
       #
       # @return [ true, false ] If the array is multi args.
-      #
-      # @since 3.0.0
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
@@ -84,16 +88,13 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Array ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         ::Array.mongoize(self)
       end
 
       # Delete the first object in the array that is equal to the supplied
       # object and return it. This is much faster than performing a standard
-      # delete for large arrays ince it attempt to delete multiple in the
-      # other.
+      # delete for large arrays since it does not perform multiple deletes.
       #
       # @example Delete the first object.
       #   [ "1", "2", "1" ].delete_one("1")
@@ -101,21 +102,17 @@ module Mongoid
       # @param [ Object ] object The object to delete.
       #
       # @return [ Object ] The deleted object.
-      #
-      # @since 2.1.0
       def delete_one(object)
         position = index(object)
         position ? delete_at(position) : nil
       end
 
-      # Is the object's size changable?
+      # Returns whether the object's size can be changed.
       #
       # @example Is the object resizable?
       #   object.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -131,8 +128,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
-        #
-        # @since 3.0.0
         def __mongoize_fk__(association, object)
           if object.resizable?
             object.blank? ? object : association.convert_to_foreign_key(object)
@@ -150,8 +145,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           if object.is_a?(::Array)
             evolve(object).collect{ |obj| obj.class.mongoize(obj) }
@@ -160,14 +153,12 @@ module Mongoid
           end
         end
 
-        # Is the object's size changable?
+        # Returns whether the object's size can be changed.
         #
         # @example Is the object resizable?
         #   Array.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end

data/lib/mongoid/extensions/big_decimal.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module BigDecimal
@@ -9,8 +10,6 @@ module Mongoid
       #   bd.__to_inc__
       #
       # @return [ Float ] The big decimal as a float.
-      #
-      # @since 3.0.3
       def __to_inc__
         to_f
       end
@@ -22,8 +21,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         to_s
       end
@@ -34,8 +31,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 6.0.0
       def numeric?
         true
       end
@@ -50,10 +45,8 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ BigDecimal, nil ] A BigDecimal derived from the object or nil.
-        #
-        # @since 3.0.0
         def demongoize(object)
-          object && object.numeric? ? ::BigDecimal.new(object.to_s) : nil
+          object && object.numeric? ? BigDecimal(object.to_s) : nil
         end
 
         # Mongoize an object of any type to how it's stored in the db as a String.
@@ -64,8 +57,6 @@ module Mongoid
         # @param [ Object ] object The object to Mongoize
         #
         # @return [ String, nil ] A String representing the object or nil.
-        #
-        # @since 3.0.7
         def mongoize(object)
           object && object.numeric? ? object.to_s : nil
         end

data/lib/mongoid/extensions/boolean.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Boolean
 
@@ -11,12 +12,9 @@ module Mongoid
       #   Boolean.mongoize("123.11")
       #
       # @return [ String ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize(object)
-        ::Boolean.evolve(object)
+        evolve(object)
       end
-      alias :evolve :mongoize
     end
   end
 end

data/lib/mongoid/extensions/date.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Date
@@ -12,11 +13,12 @@ module Mongoid
       # Convert the date into a time.
       #
       # @example Convert the date to a time.
-      #   date.__mongoize_time__
-      #
-      # @return [ Time ] The converted time.
+      #   Date.new(2018, 11, 1).__mongoize_time__
+      #   # => Thu, 01 Nov 2018 00:00:00 EDT -04:00
       #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to local midnight of
+      #   this date.
       def __mongoize_time__
         ::Time.configured.local(year, month, day)
       end
@@ -28,8 +30,6 @@ module Mongoid
       #   date.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Date.mongoize(self)
       end
@@ -44,8 +44,6 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ Date ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Date.new(object.year, object.month, object.day) if object
         end
@@ -59,12 +57,15 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             begin
-              time = object.__mongoize_time__
+              if object.is_a?(String)
+                # https://jira.mongodb.org/browse/MONGOID-4460
+                time = ::Time.parse(object)
+              else
+                time = object.__mongoize_time__
+              end
               ::Time.utc(time.year, time.month, time.day)
             rescue ArgumentError
               nil

data/lib/mongoid/extensions/date_time.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module DateTime
@@ -8,13 +9,10 @@ module Mongoid
       # @example Mongoize the date time.
       #   date_time.__mongoize_time__
       #
-      # @return [ Time ] The mongoized time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
       def __mongoize_time__
-        return to_time if utc? && Mongoid.use_utc?
         if Mongoid.use_activesupport_time_zone?
-          in_time_zone(::Time.zone).to_time
+          in_time_zone(::Time.zone)
         else
           time = to_time
           time.respond_to?(:getlocal) ? time.getlocal : time
@@ -28,8 +26,6 @@ module Mongoid
       #   date_time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::DateTime.mongoize(self)
       end
@@ -44,8 +40,6 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ DateTime ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Time.demongoize(object).try(:to_datetime)
         end
@@ -59,8 +53,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           ::Time.mongoize(object)
         end

data/lib/mongoid/extensions/decimal128.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Decimal128
@@ -9,8 +10,6 @@ module Mongoid
       #   decimal128.__evolve_decimal128__
       #
       # @return [ BSON::Decimal128 ] self.
-      #
-      # @since 6.1.0
       def __evolve_decimal128__
         self
       end
@@ -25,8 +24,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::Decimal128 ] The decimal128.
-        #
-        # @since 6.1.0
         def evolve(object)
           object.__evolve_decimal128__
         end

data/lib/mongoid/extensions/false_class.rb

@@ -1,16 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module FalseClass
 
-      # Get the value of the object as a mongo friendy sort value.
+      # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 0.
-      #
-      # @since 3.0.0
       def __sortable__
         0
       end
@@ -23,10 +22,8 @@ module Mongoid
       # @param [ Class ] other The class to check.
       #
       # @return [ true, false ] If the other is a boolean.
-      #
-      # @since 1.0.0
       def is_a?(other)
-        if other == ::Boolean || other.class == ::Boolean
+        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true
         end
         super(other)

data/lib/mongoid/extensions/float.rb

@@ -1,18 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Float
 
-      # Convert the float into a time.
+      # Converts the float into a time as the number of seconds since the epoch.
       #
       # @example Convert the float into a time.
       #   1335532685.117847.__mongoize_time__
       #
-      # @return [ Time ] The float as a time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.at(self)
+        ::Time.configured.at(self)
       end
 
       # Is the float a number?
@@ -21,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -38,8 +35,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             __numeric__(object).to_f rescue 0.0

data/lib/mongoid/extensions/hash.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Hash
@@ -9,8 +10,6 @@ module Mongoid
       #   { field: id }.__evolve_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         update_values(&:__evolve_object_id__)
       end
@@ -21,8 +20,6 @@ module Mongoid
       #   { field: id }.__mongoize_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         if id = self['$oid']
           BSON::ObjectId.from_string(id)
@@ -37,8 +34,6 @@ module Mongoid
       #   { name: "Placebo" }.__consolidate__
       #
       # @return [ Hash ] A new consolidated hash.
-      #
-      # @since 3.0.0
       def __consolidate__(klass)
         consolidated = {}
         each_pair do |key, value|
@@ -46,36 +41,72 @@ module Mongoid
             value.each_pair do |_key, _value|
               value[_key] = (key == "$rename") ? _value.to_s : mongoize_for(key, klass, _key, _value)
             end
-            (consolidated[key] ||= {}).merge!(value)
+            consolidated[key] ||= {}
+            consolidated[key].update(value)
           else
-            (consolidated["$set"] ||= {}).merge!(key => mongoize_for(key, klass, key, value))
+            consolidated["$set"] ||= {}
+            consolidated["$set"].update(key => mongoize_for(key, klass, key, value))
           end
         end
         consolidated
       end
 
-      # Check if the hash is part of a blank relation criteria.
+      # Checks whether conditions given in this hash are known to be
+      # unsatisfiable, i.e., querying with this hash will always return no
+      # documents.
+      #
+      # This method only handles condition shapes that Mongoid itself uses when
+      # it builds association queries. It does not guarantee that a false
+      # return value means the condition can produce a non-empty document set -
+      # only that if the return value is true, the condition always produces
+      # an empty document set.
       #
-      # @example Is the hash blank criteria?
-      #   {}.blank_criteria?
+      # @example Unsatisfiable conditions
+      #   {'_id' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => true
       #
-      # @return [ true, false ] If the hash is blank criteria.
+      # @example Conditions which could be satisfiable
+      #   {'_id' => '123'}._mongoid_unsatisfiable_criteria?
+      #   # => false
       #
-      # @since 3.1.0
-      def blank_criteria?
-        self == { "_id" => { "$in" => [] }}
+      # @example Conditions which are unsatisfiable that this method does not handle
+      #   {'foo' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => false
+      #
+      # @return [ true | false ] Whether hash contains known unsatisfiable
+      #   conditions.
+      # @api private
+      def _mongoid_unsatisfiable_criteria?
+        unsatisfiable_criteria = { "_id" => { "$in" => [] }}
+        return true if self == unsatisfiable_criteria
+        return false unless length == 1 && keys == %w($and)
+        value = values.first
+        value.is_a?(Array) && value.any? do |sub_v|
+          sub_v.is_a?(Hash) && sub_v._mongoid_unsatisfiable_criteria?
+        end
       end
 
+      # Checks whether conditions given in this hash are known to be
+      # unsatisfiable, i.e., querying with this hash will always return no
+      # documents.
+      #
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only.
+      #
+      # @return [ true | false ] Whether hash contains known unsatisfiable
+      #   conditions.
+      # @deprecated
+      alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
+
       # Deletes an id value from the hash.
       #
       # @example Delete an id value.
       #   {}.delete_id
       #
       # @return [ Object ] The deleted value, or nil.
-      #
-      # @since 3.0.2
       def delete_id
-        delete("_id") || delete("id") || delete(:id) || delete(:_id)
+        delete("_id") || delete(:_id) || delete("id") || delete(:id)
       end
 
       # Get the id attribute from this hash, whether it's prefixed with an
@@ -85,10 +116,8 @@ module Mongoid
       #   { :_id => 1 }.extract_id
       #
       # @return [ Object ] The value of the id.
-      #
-      # @since 2.3.2
       def extract_id
-        self["_id"] || self["id"] || self[:id] || self[:_id]
+        self["_id"] || self[:_id] || self["id"] || self[:id]
       end
 
       # Fetch a nested value via dot syntax.
@@ -99,8 +128,6 @@ module Mongoid
       # @param [ String ] string the dot syntax string.
       #
       # @return [ Object ] The matching value.
-      #
-      # @since 3.0.15
       def __nested__(string)
         keys = string.split(".")
         value = self
@@ -122,8 +149,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Hash ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -134,8 +159,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -148,8 +171,6 @@ module Mongoid
       #   { klass: Band, where: { name: "Depeche Mode" }.to_criteria
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.7
       def to_criteria
         criteria = Criteria.new(delete(:klass) || delete("klass"))
         each_pair do |method, args|
@@ -173,8 +194,6 @@ module Mongoid
       # @param [ Object ] value The value to mongoize.
       #
       # @return [ Object ] The mongoized value.
-      #
-      # @since 3.1.0
       def mongoize_for(operator, klass, key, value)
         field = klass.fields[key.to_s]
         if field
@@ -199,8 +218,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           return if object.nil?
           evolve(object.dup).update_values { |value| value.mongoize }
@@ -212,8 +229,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end