mongoid 6.4.2 → 7.0.3

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

@@ -24,7 +24,7 @@ module Mongoid
         # @since 2.0.0
         POLYGON = "Polygon"
 
-        # @attribute [rw] negating If the next expression is negated.
+        # @attribute [rw] negating If the next spression is negated.
         # @attribute [rw] selector The query selector.
         attr_accessor :negating, :selector
 
@@ -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
@@ -535,6 +562,9 @@ module Mongoid
         #
         # @since 1.0.0
         def where(criterion = nil)
+          # We need to save the criterion in an instance variable so Modifiable methods
+          # know how to create a polymorphic object.
+          @criterion = criterion
           criterion.is_a?(String) ? js_query(criterion) : expr_query(criterion)
         end
 

data/lib/mongoid/criteria.rb

@@ -27,8 +27,8 @@ module Mongoid
     include Modifiable
     include Scopable
     include Clients::Options
-    include Options
     include Clients::Sessions
+    include Options
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
@@ -36,7 +36,7 @@ module Mongoid
     # @since 4.0.0
     CHECK = []
 
-    attr_accessor :embedded, :klass, :parent_document, :metadata
+    attr_accessor :embedded, :klass, :parent_document, :association
 
     # Returns true if the supplied +Enumerable+ or +Criteria+ is equal to the results
     # of this +Criteria+ or the criteria itself.

data/lib/mongoid/document.rb

@@ -4,7 +4,6 @@ require "mongoid/evolvable"
 require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/threaded"
-require "mongoid/relations"
 require "mongoid/atomic"
 require "mongoid/attributes"
 require "mongoid/contextual"
@@ -14,7 +13,9 @@ require "mongoid/criteria"
 require "mongoid/factory"
 require "mongoid/fields"
 require "mongoid/timestamps"
+require "mongoid/association"
 require "mongoid/composable"
+require "mongoid/touchable"
 
 module Mongoid
 
@@ -23,6 +24,7 @@ module Mongoid
   module Document
     extend ActiveSupport::Concern
     include Composable
+    include Mongoid::Touchable::InstanceMethods
 
     attr_accessor :__selected_fields
     attr_reader :new_record
@@ -178,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)
     #
@@ -190,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,
@@ -281,7 +290,7 @@ module Mongoid
         without_autobuild do
           relation, stored = send(name), meta.store_as
           if attributes.key?(stored) || !relation.blank?
-            if relation
+            if !relation.nil?
               attributes[stored] = relation.send(:as_attributes)
             else
               attributes.delete(stored)

data/lib/mongoid/errors/invalid_dependent_strategy.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when an invalid strategy is defined for an association dependency.
+    class InvalidDependentStrategy < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidDependentStrategy.new(association, invalid_strategy, valid_strategies)
+      #
+      # @param [ Mongoid::Association ] association The association for which this
+      #   dependency is defined.
+      # @param [ Symbol, String ] invalid_strategy The attempted invalid strategy.
+      # @param [ Array<Symbol> ] valid_strategies The valid strategies.
+      #
+      # @since 7.0.0
+      def initialize(association, invalid_strategy, valid_strategies)
+        super(
+            compose_message(
+                "invalid_dependent_strategy",
+                { association: association,
+                  invalid_strategy: invalid_strategy,
+                  valid_strategies: valid_strategies
+                }
+            )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_relation_option.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when an option provided for a relation is invalid.
+    class InvalidRelationOption < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidRelationOption.new(Person, invalid_option: 'make_me_a_sandwich')
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] name The relation name.
+      # @param [ Symbol ] option The invalid option.
+      # @param [ Array<Symbol> ] valid_options The valid option.
+      #
+      # @since 3.0.0
+      def initialize(klass, name, option, valid_options)
+        super(
+            compose_message(
+                "invalid_relation_option",
+                { klass: klass, name: name, option: option, valid_options: valid_options }
+            )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unknown_model.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to instantiate a model object from the value in
+    # the '_type' field of a document and the class doesn't exist.
+    class UnknownModel < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   UnknownModel.new('InvalidClass', "invalid_class")
+      #
+      # @param [ String ] klass The model class.
+      # @param [ String ] value The value used to determine the (invalid) class.
+      #
+      # @since 7.0.0
+      def initialize(klass, value)
+        super(
+            compose_message("unknown_model", { klass: klass, value: value })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors.rb

@@ -8,6 +8,7 @@ require "mongoid/errors/eager_load"
 require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_collection"
 require "mongoid/errors/invalid_config_option"
+require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
 require "mongoid/errors/invalid_field_option"
 require "mongoid/errors/invalid_find"
@@ -17,6 +18,7 @@ require "mongoid/errors/invalid_options"
 require "mongoid/errors/invalid_path"
 require "mongoid/errors/invalid_persistence_option"
 require "mongoid/errors/invalid_relation"
+require "mongoid/errors/invalid_relation_option"
 require "mongoid/errors/invalid_scope"
 require "mongoid/errors/invalid_session_use"
 require "mongoid/errors/invalid_set_polymorphic_relation"
@@ -42,6 +44,7 @@ require "mongoid/errors/readonly_document"
 require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
 require "mongoid/errors/unknown_attribute"
+require "mongoid/errors/unknown_model"
 require "mongoid/errors/unsaved_document"
 require "mongoid/errors/unsupported_javascript"
 require "mongoid/errors/validations"

data/lib/mongoid/extensions/array.rb

@@ -122,22 +122,22 @@ module Mongoid
 
       module ClassMethods
 
-        # Convert the provided object to a propery array of foreign keys.
+        # Convert the provided object to a proper array of foreign keys.
         #
         # @example Mongoize the object.
         #   Array.__mongoize_fk__(constraint, object)
         #
-        # @param [ Constraint ] constraint The metadata constraint.
+        # @param [ Association ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
         #
         # @since 3.0.0
-        def __mongoize_fk__(constraint, object)
+        def __mongoize_fk__(association, object)
           if object.resizable?
-            object.blank? ? object : constraint.convert(object)
+            object.blank? ? object : association.convert_to_foreign_key(object)
           else
-            object.blank? ? [] : constraint.convert(Array(object))
+            object.blank? ? [] : association.convert_to_foreign_key(Array(object))
           end
         end
 

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/hash.rb

@@ -106,8 +106,11 @@ module Mongoid
         value = self
         keys.each do |key|
           return nil if value.nil?
-          nested = value[key] || value[key.to_i]
-          value = nested
+          value_for_key = value[key]
+          if value_for_key.nil? && key.to_i.to_s == key
+            value_for_key = value[key.to_i]
+          end
+          value = value_for_key
         end
         value
       end

data/lib/mongoid/extensions/object.rb

@@ -225,17 +225,17 @@ module Mongoid
         # contstraint.
         #
         # @example Convert the object to a fk.
-        #   Object.__mongoize_fk__(constraint, object)
+        #   Object.__mongoize_fk__(association, object)
         #
-        # @param [ Constraint ] constraint The constraint.
+        # @param [ Association ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
         #
         # @since 3.0.0
-        def __mongoize_fk__(constraint, object)
+        def __mongoize_fk__(association, object)
           return nil if !object || object == ""
-          constraint.convert(object)
+          association.convert_to_foreign_key(object)
         end
 
         # Convert the object from its mongo friendly ruby type to this type.

data/lib/mongoid/extensions/range.rb

@@ -70,6 +70,7 @@ module Mongoid
         def mongoize(object)
           return nil if object.nil?
           return object if object.is_a?(::Hash)
+          return object if object.is_a?(String)
           hash = { "min" => object.first, "max" => object.last }
           if object.respond_to?(:exclude_end?) && object.exclude_end?
             hash.merge!("exclude_end" => true)

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/extensions.rb

@@ -5,10 +5,6 @@ class BSON::ObjectId
   end
 end
 
-class Symbol
-  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
-end
-
 class BSON::Document
   # We need to override this as ActiveSupport creates a new Object, instead of a new Hash
   # see https://github.com/rails/rails/commit/f1bad130d0c9bd77c94e43b696adca56c46a66aa

data/lib/mongoid/factory.rb

@@ -38,12 +38,22 @@ module Mongoid
     #   #only we give the document a list of the selected fields.
     #
     # @return [ Document ] The instantiated document.
-    def from_db(klass, attributes = nil, selected_fields = nil)
+    def from_db(klass, attributes = nil, criteria = nil)
+      selected_fields = criteria.options[:fields] if criteria
       type = (attributes || {})[TYPE]
       if type.blank?
-        klass.instantiate(attributes, selected_fields)
+        obj = klass.instantiate(attributes, selected_fields)
+        if criteria && criteria.association && criteria.parent_document
+          obj.set_relation(criteria.association.inverse, criteria.parent_document)
+        end
+        obj
       else
-        type.camelize.constantize.instantiate(attributes, selected_fields)
+        camelized = type.camelize
+        begin
+          camelized.constantize.instantiate(attributes, selected_fields)
+        rescue NameError
+          raise Errors::UnknownModel.new(camelized, type)
+        end
       end
     end
   end

data/lib/mongoid/fields/foreign_key.rb

@@ -63,8 +63,8 @@ module Mongoid
       # @since 3.0.0
       def evolve(object)
         if object_id_field? || object.is_a?(Document)
-          if metadata.polymorphic? && constraint
-            constraint.convert(object)
+          if association.polymorphic?
+            association.convert_to_foreign_key(object)
           else
             object.__evolve_object_id__
           end
@@ -97,7 +97,7 @@ module Mongoid
       # @since 3.0.0
       def mongoize(object)
         if type.resizable? || object_id_field?
-          type.__mongoize_fk__(constraint, object)
+          type.__mongoize_fk__(association, object)
         else
           related_id_field.mongoize(object)
         end
@@ -113,7 +113,7 @@ module Mongoid
       # @since 2.2.0
       def object_id_field?
         @object_id_field ||=
-          metadata.polymorphic? ? true : metadata.klass.using_object_ids?
+            association.polymorphic? ? true : association.klass.using_object_ids?
       end
 
       # Returns true if an array, false if not.
@@ -156,7 +156,7 @@ module Mongoid
       #
       # @since 3.0.0
       def related_id_field
-        @related_id_field ||= metadata.klass.fields["_id"]
+        @related_id_field ||= association.klass.fields["_id"]
       end
 
       # This is used when default values need to be serialized. Most of the

data/lib/mongoid/fields/standard.rb

@@ -26,18 +26,6 @@ module Mongoid
         mods[key] = new
       end
 
-      # Get the constraint from the metadata once.
-      #
-      # @example Get the constraint.
-      #   field.constraint
-      #
-      # @return [ Constraint ] The relation's contraint.
-      #
-      # @since 2.1.0
-      def constraint
-        @constraint ||= metadata.constraint
-      end
-
       # Evaluate the default value and return it. Will handle the
       # serialization, proc calls, and duplication if necessary.
       #
@@ -127,8 +115,8 @@ module Mongoid
       # @return [ Metadata ] The relation metadata.
       #
       # @since 2.2.0
-      def metadata
-        @metadata ||= options[:metadata]
+      def association
+        @association ||= options[:association]
       end
 
       # Is the field a BSON::ObjectId?

data/lib/mongoid/fields/validators/macro.rb

@@ -14,7 +14,7 @@ module Mongoid
           :label,
           :localize,
           :fallbacks,
-          :metadata,
+          :association,
           :pre_processed,
           :subtype,
           :type,

data/lib/mongoid/fields.rb

@@ -411,7 +411,7 @@ module Mongoid
       def create_field_getter(name, meth, field)
         generated_methods.module_eval do
           re_define_method(meth) do
-            raw = read_attribute(name)
+            raw = read_raw_attribute(name)
             if lazy_settable?(field, raw)
               write_attribute(name, field.eval_default(self))
             else
@@ -461,7 +461,7 @@ module Mongoid
           re_define_method("#{meth}=") do |value|
             val = write_attribute(name, value)
             if field.foreign_key?
-              remove_ivar(field.metadata.name)
+              remove_ivar(field.association.name)
             end
             val
           end
@@ -480,7 +480,7 @@ module Mongoid
       def create_field_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}?") do
-            value = read_attribute(name)
+            value = read_raw_attribute(name)
             lookup_attribute_presence(name, value)
           end
         end

data/lib/mongoid/indexable.rb

@@ -28,8 +28,11 @@ module Mongoid
       # @since 1.0.0
       def create_indexes
         return unless index_specifications
+
+        default_options = {background: Config.background_indexing}
+
         index_specifications.each do |spec|
-          key, options = spec.key, spec.options
+          key, options = spec.key, default_options.merge(spec.options)
           if database = options[:database]
             with(database: database) do |klass|
               klass.collection.indexes(session: _session).create_one(key, options.except(:database))

data/lib/mongoid/interceptable.rb

@@ -160,8 +160,8 @@ module Mongoid
     #
     # @since 2.3.0
     def cascadable_children(kind, children = Set.new)
-      embedded_relations.each_pair do |name, metadata|
-        next unless metadata.cascading_callbacks?
+      embedded_relations.each_pair do |name, association|
+        next unless association.cascading_callbacks?
         without_autobuild do
           delayed_pulls = delayed_atomic_pulls[name]
           delayed_unsets = delayed_atomic_unsets[name]
@@ -170,7 +170,7 @@ module Mongoid
           relation = send(name)
           Array.wrap(relation).each do |child|
             next if children.include?(child)
-            children.add(child) if cascadable_child?(kind, child, metadata)
+            children.add(child) if cascadable_child?(kind, child, association)
             child.send(:cascadable_children, kind, children)
           end
         end
@@ -189,9 +189,9 @@ module Mongoid
     # @return [ true, false ] If the child should fire the callback.
     #
     # @since 2.3.0
-    def cascadable_child?(kind, child, metadata)
+    def cascadable_child?(kind, child, association)
       return false if kind == :initialize || kind == :find || kind == :touch
-      return false if kind == :validate && metadata.validate?
+      return false if kind == :validate && association.validate?
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end
 

data/lib/mongoid/matchable/and.rb

@@ -2,7 +2,7 @@
 module Mongoid
   module Matchable
 
-    # Defines behavior for handling $or expressions in embedded documents.
+    # Defines behavior for handling $and expressions in embedded documents.
     class And < Default
 
       # Does the supplied query match the attribute?

data/lib/mongoid/matchable/elem_match.rb

@@ -13,13 +13,19 @@ module Mongoid
       #
       # @return [ true, false ] If the values match.
       def _matches?(value)
-        if !@attribute.is_a?(Array) || !value.kind_of?(Hash) || !value["$elemMatch"].kind_of?(Hash)
+        elem_match = value["$elemMatch"] || value[:$elemMatch]
+
+        if !@attribute.is_a?(Array) || !value.kind_of?(Hash) || !elem_match.kind_of?(Hash)
           return false
         end
 
         return @attribute.any? do |sub_document|
-          value["$elemMatch"].all? do |k, v|
-            Matchable.matcher(sub_document, k, v)._matches?(v)
+          elem_match.all? do |k, v|
+            if v.try(:first).try(:[],0) == "$not".freeze || v.try(:first).try(:[],0) == :$not
+              !Matchable.matcher(sub_document, k, v.first[1])._matches?(v.first[1])
+            else
+              Matchable.matcher(sub_document, k, v)._matches?(v)
+            end
           end
         end
       end

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