mongoid 7.0.6 → 7.1.2

data/lib/mongoid/extensions/big_decimal.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module BigDecimal

data/lib/mongoid/extensions/boolean.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Boolean
 

data/lib/mongoid/extensions/date.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Date
@@ -12,9 +14,12 @@ module Mongoid
       # Convert the date into a time.
       #
       # @example Convert the date to a time.
-      #   date.__mongoize_time__
+      #   Date.new(2018, 11, 1).__mongoize_time__
+      #   # => Thu, 01 Nov 2018 00:00:00 EDT -04:00
       #
-      # @return [ Time ] The converted time.
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to local midnight of
+      #   this date.
       #
       # @since 3.0.0
       def __mongoize_time__
@@ -64,7 +69,12 @@ module Mongoid
         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,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module DateTime
@@ -8,13 +10,12 @@ module Mongoid
       # @example Mongoize the date time.
       #   date_time.__mongoize_time__
       #
-      # @return [ Time ] The mongoized time.
+      # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
       #
       # @since 3.0.0
       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

data/lib/mongoid/extensions/decimal128.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Decimal128

data/lib/mongoid/extensions/false_class.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module FalseClass

data/lib/mongoid/extensions/float.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.
+      # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       #
       # @since 3.0.0
       def __mongoize_time__
-        ::Time.at(self)
+        ::Time.configured.at(self)
       end
 
       # Is the float a number?

data/lib/mongoid/extensions/hash.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Hash
@@ -46,25 +48,65 @@ 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 Unsatisfiable conditions
+      #   {'_id' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => true
+      #
+      # @example Conditions which could be satisfiable
+      #   {'_id' => '123'}._mongoid_unsatisfiable_criteria?
+      #   # => false
+      #
+      # @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.
       #
-      # @example Is the hash blank criteria?
-      #   {}.blank_criteria?
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only.
       #
-      # @return [ true, false ] If the hash is blank criteria.
+      # @return [ true | false ] Whether hash contains known unsatisfiable
+      #   conditions.
       #
       # @since 3.1.0
-      def blank_criteria?
-        self == { "_id" => { "$in" => [] }}
-      end
+      # @deprecated
+      alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
 
       # Deletes an id value from the hash.
       #

data/lib/mongoid/extensions/integer.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Integer
 
-      # Returns the integer as a time.
+      # Converts the integer into a time as the number of seconds since the epoch.
       #
       # @example Convert the integer to a time.
       #   1335532685.__mongoize_time__
       #
-      # @return [ Time ] The converted time.
+      # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       #
       # @since 3.0.0
       def __mongoize_time__
-        ::Time.at(self)
+        ::Time.configured.at(self)
       end
 
       # Is the integer a number?

data/lib/mongoid/extensions/module.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Module

data/lib/mongoid/extensions/nil_class.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module NilClass

data/lib/mongoid/extensions/object.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Object
@@ -30,12 +32,18 @@ module Mongoid
 
       # Mongoize a plain object into a time.
       #
+      # @note This method should not be used, because it does not
+      #   return correct results for non-Time objects. Override
+      #   __mongoize_time__ in classes that are time-like to return an
+      #   instance of Time or ActiveSupport::TimeWithZone.
+      #
       # @example Mongoize the object.
       #   object.__mongoize_time__
       #
       # @return [ Object ] self.
       #
       # @since 3.0.0
+      # @deprecated
       def __mongoize_time__
         self
       end
@@ -76,14 +84,18 @@ module Mongoid
         self
       end
 
-      # Check if the object is part of a blank relation criteria.
+      # Checks whether conditions given in this object are known to be
+      # unsatisfiable, i.e., querying with this object will always return no
+      # documents.
       #
-      # @example Is the object blank criteria?
-      #   "".blank_criteria?
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only. It always returns false.
       #
-      # @return [ true, false ] If the object is blank criteria.
+      # @return [ false ] Always false.
       #
       # @since 3.1.0
+      # @deprecated
       def blank_criteria?
         false
       end

data/lib/mongoid/extensions/object_id.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module ObjectId

data/lib/mongoid/extensions/range.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Range

data/lib/mongoid/extensions/regexp.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Regexp
@@ -9,7 +11,7 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Regexp.mongoize(/^[abc]/)
+        #   Regexp.mongoize(/\A[abc]/)
         #
         # @param [ Regexp, String ] object The object to mongoize.
         #

data/lib/mongoid/extensions/set.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Set

data/lib/mongoid/extensions/string.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module String
 
-      # @attribute [rw] unconvertable_to_bson If the document is unconvetable.
+      # @attribute [rw] unconvertable_to_bson If the document is unconvertable.
       attr_accessor :unconvertable_to_bson
 
       # Evolve the string into an object id if possible.
@@ -32,20 +34,27 @@ module Mongoid
 
       # Mongoize the string for storage.
       #
+      # @note Returns a local time in the default time zone.
+      #
       # @example Mongoize the string.
       #   "2012-01-01".__mongoize_time__
+      #   # => 2012-01-01 00:00:00 -0500
       #
-      # @note The extra parse from Time is because ActiveSupport::TimeZone
-      #   either returns nil or Time.now if the string is empty or invalid,
-      #   which is a regression from pre-3.0 and also does not agree with
-      #   the core Time API.
-      #
-      # @return [ Time ] The time.
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to this string.
       #
       # @since 3.0.0
       def __mongoize_time__
-        ::Time.parse(self)
-        ::Time.configured.parse(self)
+        # This extra parse from Time is because ActiveSupport::TimeZone
+        # either returns nil or Time.now if the string is empty or invalid,
+        # which is a regression from pre-3.0 and also does not agree with
+        # the core Time API.
+        parsed = ::Time.parse(self)
+        if ::Time == ::Time.configured
+          parsed
+        else
+          ::Time.configured.parse(self)
+        end
       end
 
       # Convert the string to a collection friendly name.

data/lib/mongoid/extensions/symbol.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Symbol

data/lib/mongoid/extensions/time.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Time
 
+      # Mongoizes a Time into a time.
+      #
+      # Time always mongoize into Time instances
+      # (which are themselves).
+      #
+      # @return [ Time ] self.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        self
+      end
+
       # Constant for epoch - used when passing invalid times.
       #
       # @deprecated No longer used as a return value from #mongoize passed

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module TimeWithZone
 
+      # Mongoizes an ActiveSupport::TimeWithZone into a time.
+      #
+      # TimeWithZone always mongoize into TimeWithZone instances
+      # (which are themselves).
+      #
+      # @return [ ActiveSupport::TimeWithZone ] self.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        self
+      end
+
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
       #

data/lib/mongoid/extensions/true_class.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module TrueClass

data/lib/mongoid/factory.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # Instantiates documents that came from the database.
@@ -29,17 +31,29 @@ module Mongoid
     # Builds a new +Document+ from the supplied attributes loaded from the
     # database.
     #
+    # If a criteria object is given, it is used in two ways:
+    # 1. If the criteria has a list of fields specified via #only,
+    #    only those fields are populated in the returned document.
+    # 2. If the criteria has a referencing association (i.e., this document
+    #    is being instantiated as an association of another document),
+    #    the other document is also populated in the returned document's
+    #    reverse association, if one exists.
+    #
     # @example Build the document.
     #   Mongoid::Factory.from_db(Person, { "name" => "Durran" })
     #
     # @param [ Class ] klass The class to instantiate from if _type is not present.
     # @param [ Hash ] attributes The document attributes.
-    # @param [ Array ] selected_fields If instantiated from a criteria using
-    #   #only we give the document a list of the selected fields.
+    # @param [ Criteria ] criteria Optional criteria object.
+    # @param [ Hash ] selected_fields Fields which were retrieved via
+    #   #only. If selected_fields are specified, fields not listed in it
+    #   will not be accessible in the returned document.
     #
     # @return [ Document ] The instantiated document.
-    def from_db(klass, attributes = nil, criteria = nil)
-      selected_fields = criteria.options[:fields] if criteria
+    def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      if criteria
+        selected_fields ||= criteria.options[:fields]
+      end
       type = (attributes || {})[TYPE]
       if type.blank?
         obj = klass.instantiate(attributes, selected_fields)
@@ -49,11 +63,20 @@ module Mongoid
         obj
       else
         camelized = type.camelize
+
+        # Check if the class exists
         begin
-          camelized.constantize.instantiate(attributes, selected_fields)
+          constantized = camelized.constantize
         rescue NameError
           raise Errors::UnknownModel.new(camelized, type)
         end
+
+        # Check if the class is a Document class
+        if !constantized.respond_to?(:instantiate)
+          raise Errors::UnknownModel.new(camelized, type)
+        end
+
+        constantized.instantiate(attributes, selected_fields)
       end
     end
   end