mongoid 7.0.2 → 7.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e3c2f9aa40e2f20c7620a2ae7684da4ebfc1699e32357dd4aa663d93b7ade33
-  data.tar.gz: 9f0d2145026c3db222638b7d00d842a690294cc6101a582a14a75607c44474a1
+  metadata.gz: 6f9840f2a5bdcfd628358c56f70818857080118680059a6ca299c6de3b4554c2
+  data.tar.gz: f8700656e769546f2c8d2555013aa601d10552e9e48faf37f24c66fded700b1d
 SHA512:
-  metadata.gz: 0f9b11ae060df18208b48b911ee39c2954a7855ac7ffc19b073aa21a707e51805bb465b73b7634abb425d983b3d57fbbab044a202853e532c0fc8331141b9734
-  data.tar.gz: 24d37b3c3b77d110d45ec6df6209e8cf4a7821fb787c4d369cd87f01bcf66db0292e101928f8ab2a102f5020c6bb4d7b4b19b13fc2c7765096f5f409251825ff
+  metadata.gz: a05fb92510939cf2ccff55855219033db8a9a45399865f725e695af95a9501f72a0db72422766dd54fc9946854e0065b9beb870bfeb3a02b8ac9e605962419e0
+  data.tar.gz: 267ff19b100ca5ef83f383ddd8d4ece8ce0e122a16cbc6c1605bc872e391ad775bd6336beb53af733ba8d7b47d9ec01d9842f5502c7f0c135cdc2fa258b80b47

data/README.md

@@ -21,7 +21,7 @@ Project Tracking
 Compatibility
 -------------
 
-Mongoid is tested against MRI 2.2, 2.3 and JRuby (9.1).
+Mongoid is tested against MRI 2.2-2.5 and JRuby 9.1-9.2.
 
 Documentation
 -------------

data/lib/mongoid/association/referenced/eager.rb

@@ -64,7 +64,10 @@ module Mongoid
           #
           # @since 4.0.0
           def each_loaded_document
-            criteria = @association.klass.any_in(key => keys_from_docs)
+            doc_keys = keys_from_docs
+            return @association.klass.none if doc_keys.all?(&:nil?)
+
+            criteria = @association.klass.any_in(key => doc_keys)
             criteria.inclusions = criteria.inclusions - [@association]
             criteria.each do |doc|
               yield doc

data/lib/mongoid/association/referenced/has_and_belongs_to_many/proxy.rb

@@ -135,7 +135,9 @@ module Mongoid
             end
             unless _association.forced_nil_inverse?
               if replacement
-                objects_to_clear = _base.send(foreign_key) - replacement.collect(&:id)
+                objects_to_clear = _base.send(foreign_key) - replacement.collect do |object|
+                  object.send(_association.primary_key)
+                end
                 criteria(objects_to_clear).pull(inverse_foreign_key => _base._id)
               else
                 criteria.pull(inverse_foreign_key => _base._id)

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -284,7 +284,7 @@ module Mongoid
               new_ids = new_docs.map { |doc| doc._id }
               remove_not_in(new_ids)
               new_docs.each do |doc|
-                docs.push(doc) if doc.send(foreign_key) != _base._id
+                docs.push(doc) if doc.send(foreign_key) != _base.send(_association.primary_key)
               end
               concat(docs)
             else
@@ -303,7 +303,7 @@ module Mongoid
           #
           # @since 2.4.0
           def unscoped
-            klass.unscoped.where(foreign_key => _base._id)
+            klass.unscoped.where(foreign_key => _base.send(_association.primary_key))
           end
 
           private

data/lib/mongoid/association/relatable.rb

@@ -147,23 +147,64 @@ module Mongoid
 
       # The class name of the relation object(s).
       #
-      # @return [ String ] The relation objects' class name.
+      # The class name may be fully qualified or may be specified relative
+      # to the class on which the association is defined (this class is
+      # accessible as inverse_class). If :class_name option is given in the
+      # association, the exact value of that option is returned here for
+      # backwards compatibility reasons. If :class_name option is not given,
+      # the name of the class computed by Mongoid to be the association target
+      # is returned, and it will be fully qualified.
+      #
+      # The class name returned by this method may not correspond to a defined
+      # class. The return value of the method is the class name that Mongoid
+      # would reference, relative to the host document class, when it needs to
+      # perform operations on the association target.
+      #
+      # @note The return value of this method should not be used to determine
+      #   whether two associations have the same target class, because the
+      #   return value is not always a fully qualified class name. To compare
+      #   classes, retrieve the class instance of the association target using
+      #   the +relation_class+ method.
+      #
+      # @return [ String ] The association objects' class name.
       #
       # @since 7.0
       def relation_class_name
-        @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name_with_module)
+        @class_name ||= @options[:class_name] || begin
+          cls_name = ActiveSupport::Inflector.classify(name)
+          begin
+            cls_name = resolve_name(inverse_class, cls_name).name
+          rescue NameError
+            # ignore
+          end
+          cls_name
+        end
       end
       alias :class_name :relation_class_name
 
       # The class of the relation object(s).
       #
-      # @return [ String ] The relation objects' class.
+      # This method returns the class instance corresponding to
+      # +relation_class_name+, resolved relative to the host document class.
+      #
+      # If the class does not exist, this method raises NameError. This can
+      # happen because the target class has not yet been defined. Note that
+      # polymorphic associations generally do not have a well defined target
+      # class because the target class can change from one object to another,
+      # and calling this method on a polymorphic association will generally
+      # fail with a NameError or produce misleading results (if a class does
+      # happen to be defined with the same name as the association name).
+      #
+      # @return [ String ] The association objects' class.
       #
       # @since 7.0
-      def klass
-        @klass ||= relation_class_name.constantize
+      def relation_class
+        @klass ||= begin
+          cls_name = @options[:class_name] || ActiveSupport::Inflector.classify(name)
+          resolve_name(inverse_class, cls_name)
+        end
       end
-      alias :relation_class :klass
+      alias :klass :relation_class
 
       # The class name of the object owning this relation.
       #
@@ -325,10 +366,6 @@ module Mongoid
 
       private
 
-      def name_with_module
-        @module_path + name.to_s.capitalize
-      end
-
       # Gets the model classes with inverse associations of this model. This is used to determine
       # the classes on the other end of polymorphic relations with models.
       def inverse_association_classes
@@ -424,6 +461,49 @@ module Mongoid
       def default_inverse
         @default_inverse ||= klass.relations[inverse_klass.name.underscore]
       end
+
+      # Returns an array of classes/modules forming the namespace hierarchy
+      # where symbols referenced in the provided class/module would be looked
+      # up by Ruby. For example, if mod is Foo::Bar, this method would return
+      # [Foo::Bar, Foo, Object].
+      def namespace_hierarchy(mod)
+        parent = Object
+        hier = [parent]
+        mod.name.split('::').each do |part|
+          parent = parent.const_get(part)
+          hier << parent
+        end
+        hier.reverse
+      end
+
+      # Resolves the given class/module name in the context of the specified
+      # module, as Ruby would when a constant is referenced in the source.
+      def resolve_name(mod, name)
+        cls = exc = nil
+        parts = name.to_s.split('::')
+        namespace_hierarchy(mod).each do |ns|
+          begin
+            parts.each do |part|
+              # Simple const_get sometimes pulls names out of weird scopes,
+              # perhaps confusing the receiver (ns in this case) with the
+              # local scope. Walk the class hierarchy ourselves one node
+              # at a time by specifying false as the second argument.
+              ns = ns.const_get(part, false)
+            end
+            cls = ns
+            break
+          rescue NameError => e
+            if exc.nil?
+              exc = e
+            end
+          end
+        end
+        if cls.nil?
+          # Raise the first exception, this is from the most specific namespace
+          raise exc
+        end
+        cls
+      end
     end
   end
 end

data/lib/mongoid/clients/options.rb

@@ -20,11 +20,12 @@ module Mongoid
       #
       # @since 6.0.0
       def with(options_or_context, &block)
+        original_context = PersistenceContext.get(self)
         original_cluster = persistence_context.cluster
         set_persistence_context(options_or_context)
         yield self
       ensure
-        clear_persistence_context(original_cluster)
+        clear_persistence_context(original_cluster, original_context)
       end
 
       def collection(parent = nil)
@@ -51,8 +52,8 @@ module Mongoid
         PersistenceContext.set(self, options_or_context)
       end
 
-      def clear_persistence_context(original_cluster = nil)
-        PersistenceContext.clear(self, original_cluster)
+      def clear_persistence_context(original_cluster = nil, context = nil)
+        PersistenceContext.clear(self, original_cluster, context)
       end
 
       module ClassMethods
@@ -92,11 +93,12 @@ module Mongoid
         #
         # @since 6.0.0
         def with(options, &block)
+          original_context = PersistenceContext.get(self)
           original_cluster = persistence_context.cluster
           PersistenceContext.set(self, options)
           yield self
         ensure
-          PersistenceContext.clear(self, original_cluster)
+          PersistenceContext.clear(self, original_cluster, original_context)
         end
 
         def persistence_context

data/lib/mongoid/copyable.rb

@@ -73,8 +73,8 @@ module Mongoid
         next unless attrs.present? && attrs[association.key].present?
 
         if association.is_a?(Association::Embedded::EmbedsMany)
-          attrs[association.name.to_s].each do |attr|
-            embedded_klass = attr.fetch('_type', association.class_name).constantize
+          attrs[association.key].each do |attr|
+            embedded_klass = attr.fetch('_type', association.relation_class_name).constantize
             process_localized_attributes(embedded_klass, attr)
           end
         else

data/lib/mongoid/criteria/options.rb

@@ -17,8 +17,8 @@ module Mongoid
         PersistenceContext.set(klass, options)
       end
 
-      def clear_persistence_context(original_cluster)
-        PersistenceContext.clear(klass, original_cluster)
+      def clear_persistence_context(original_cluster, original_context)
+        PersistenceContext.clear(klass, original_cluster, original_context)
       end
     end
   end

data/lib/mongoid/criteria/queryable/selectable.rb

@@ -134,13 +134,21 @@ module Mongoid
           ::Boolean.evolve(value)
         end
 
-        # Add a $geoIntersects or $geoWithin selection. Symbol operators must be used as shown in
-        # the examples to expand the criteria.
+        # Add a $geoIntersects or $geoWithin selection. Symbol operators must
+        # be used as shown in the examples to expand the criteria.
         #
         # @note The only valid geometry shapes for a $geoIntersects are:
         #   :intersects_line, :intersects_point, and :intersects_polygon.
         #
-        # @note The only valid geometry shape for a $geoWithin is :within_polygon
+        # @note The only valid options for a $geoWithin query are the geometry
+        #   shape :within_polygon and the operator :within_box.
+        #
+        # @note The :within_box operator for the $geoWithin query expects the
+        #   lower left (south west) coordinate pair as the first argument and
+        #   the upper right (north east) as the second argument.
+        #   Important: When latitude and longitude are passed, longitude is
+        #   expected as the first element of the coordinate pair.
+        #   Source: https://docs.mongodb.com/manual/reference/operator/query/box/
         #
         # @example Add a geo intersect criterion for a line.
         #   query.geo_spacial(:location.intersects_line => [[ 1, 10 ], [ 2, 10 ]])
@@ -154,6 +162,9 @@ module Mongoid
         # @example Add a geo within criterion for a polygon.
         #   query.geo_spacial(:location.within_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
         #
+        # @example Add a geo within criterion for a box.
+        #   query.geo_spacial(:location.within_box => [[ 1, 10 ], [ 2, 10 ])
+        #
         # @param [ Hash ] criterion The criterion.
         #
         # @return [ Selectable ] The cloned selectable.
@@ -174,6 +185,7 @@ module Mongoid
         key :within_polygon, :override, "$geoWithin", "$geometry" do |value|
           { "type" => POLYGON, "coordinates" => value }
         end
+        key :within_box, :override, "$geoWithin", "$box"
 
         # Add the $gt criterion to the selector.
         #
@@ -501,6 +513,11 @@ module Mongoid
         # @example Construct a text search selector with options.
         #   selectable.text_search("testing", :$language => "fr")
         #
+        # @note Per https://docs.mongodb.com/manual/reference/operator/query/text/
+        #   it is not currently possible to supply multiple text search
+        #   conditions in a query. Mongoid will build such a query but the
+        #   server will return an error when trying to execute it.
+        #
         # @param [ String, Symbol ] terms A string of terms that MongoDB parses
         #   and uses to query the text index.
         # @param [ Hash ] opts Text search options. See MongoDB documentation
@@ -512,9 +529,19 @@ module Mongoid
         def text_search(terms, opts = nil)
           clone.tap do |query|
             if terms
-              criterion = { :$text => { :$search => terms } }
-              criterion[:$text].merge!(opts) if opts
-              query.selector = criterion
+              criterion = {'$text' => { '$search' => terms }}
+              criterion['$text'].merge!(opts) if opts
+              if query.selector['$text']
+                # Per https://docs.mongodb.com/manual/reference/operator/query/text/
+                # multiple $text expressions are not currently supported by
+                # MongoDB server, but build the query correctly instead of
+                # overwriting previous text search condition with the currently
+                # given one.
+                Mongoid.logger.warn('Multiple $text expressions per query are not currently supported by the server')
+                query.selector = {'$and' => [query.selector]}.merge(criterion)
+              else
+                query.selector = query.selector.merge(criterion)
+              end
             end
           end
         end

data/lib/mongoid/document.rb

@@ -180,6 +180,13 @@ module Mongoid
 
     # Calls #as_json on the document with additional, Mongoid-specific options.
     #
+    # @note Rails 6 changes return value of as_json for non-primitive types
+    #   such as BSON::ObjectId. In Rails <= 5, as_json returned these as
+    #   instances of the class. In Rails 6, these are returned serialized to
+    #   primitive types (e.g. {"$oid"=>"5bcfc40bde340b37feda98e9"}).
+    #   See https://github.com/rails/rails/commit/2e5cb980a448e7f4ab00df6e9ad4c1cc456616aa
+    #   for more information.
+    #
     # @example Get the document as json.
     #   document.as_json(compact: true)
     #
@@ -192,11 +199,11 @@ module Mongoid
     #
     # @since 5.1.0
     def as_json(options = nil)
-      if options && (options[:compact] == true)
-        super(options).reject! { |k,v| v.nil? }
-      else
-        super(options)
+      rv = super
+      if options && options[:compact]
+        rv = rv.compact
       end
+      rv
     end
 
     # Returns an instance of the specified class with the attributes,

data/lib/mongoid/extensions/big_decimal.rb

@@ -53,7 +53,7 @@ module Mongoid
         #
         # @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.

data/lib/mongoid/extensions/regexp.rb

@@ -17,6 +17,7 @@ module Mongoid
         #
         # @since 3.0.0
         def mongoize(object)
+          return nil if object.nil?
           ::Regexp.new(object)
         end
       end

data/lib/mongoid/matchable.rb

@@ -2,6 +2,7 @@
 require "mongoid/matchable/default"
 require "mongoid/matchable/all"
 require "mongoid/matchable/and"
+require "mongoid/matchable/eq"
 require "mongoid/matchable/exists"
 require "mongoid/matchable/gt"
 require "mongoid/matchable/gte"
@@ -32,6 +33,7 @@ module Mongoid
       "$all" => All,
       "$elemMatch" => ElemMatch,
       "$and" => And,
+      "$eq" => Eq,
       "$exists" => Exists,
       "$gt" => Gt,
       "$gte" => Gte,
@@ -42,7 +44,7 @@ module Mongoid
       "$nin" => Nin,
       "$or" => Or,
       "$nor" => Nor,
-      "$size" => Size
+      "$size" => Size,
     }.with_indifferent_access.freeze
 
     # Determines if this document has the attributes to match the supplied

data/lib/mongoid/matchable/eq.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# encoding: utf-8
+module Mongoid
+  module Matchable
+
+    # Performs equivalency checks.
+    class Eq < Default
+
+      # Return true if the attribute and first value are equal.
+      #
+      # @example Do the values match?
+      #   matcher._matches?({ :key => 10 })
+      #
+      # @param [ Hash ] value The values to check.
+      #
+      # @return [ true, false ] True if matches, false if not.
+      def _matches?(value)
+        super(value.values.first)
+      end
+    end
+  end
+end

data/lib/mongoid/matchable/ne.rb

@@ -12,7 +12,7 @@ module Mongoid
       #
       # @param [ Hash ] value The values to check.
       #
-      # @return [ true, false ] If a value exists.
+      # @return [ true, false ] True if matches, false if not.
       def _matches?(value)
         !super(value.values.first)
       end

data/lib/mongoid/persistence_context.rb

@@ -169,6 +169,9 @@ module Mongoid
 
       # Set the persistence context for a particular class or model instance.
       #
+      # If there already is a persistence context set, options in the existing
+      # context are combined with options given to the set call.
+      #
       # @example Set the persistence context for a class or model instance.
       #  PersistenceContext.set(model)
       #
@@ -180,9 +183,19 @@ module Mongoid
       #
       # @since 6.0.0
       def set(object, options_or_context)
-        context = PersistenceContext.new(object, options_or_context.is_a?(PersistenceContext) ?
-                                                   options_or_context.options : options_or_context)
-        Thread.current["[mongoid][#{object.object_id}]:context"] = context
+        key = "[mongoid][#{object.object_id}]:context"
+        existing_context = Thread.current[key]
+        existing_options = if existing_context
+          existing_context.options
+        else
+          {}
+        end
+        if options_or_context.is_a?(PersistenceContext)
+          options_or_context = options_or_context.options
+        end
+        new_options = existing_options.merge(options_or_context)
+        context = PersistenceContext.new(object, new_options)
+        Thread.current[key] = context
       end
 
       # Get the persistence context for a particular class or model instance.
@@ -206,14 +219,16 @@ module Mongoid
       #
       # @param [ Class, Object ] object The class or model instance.
       # @param [ Mongo::Cluster ] cluster The original cluster before this context was used.
+      # @param [ Mongoid::PersistenceContext ] original_context The original persistence
+      #   context that was set before this context was used.
       #
       # @since 6.0.0
-      def clear(object, cluster = nil)
+      def clear(object, cluster = nil, original_context = nil)
         if context = get(object)
           context.client.close unless (context.cluster.equal?(cluster) || cluster.nil?)
         end
       ensure
-        Thread.current["[mongoid][#{object.object_id}]:context"] = nil
+        Thread.current["[mongoid][#{object.object_id}]:context"] = original_context
       end
     end
   end