mongoid 7.4.0 → 8.0.3

data/lib/mongoid/criteria/queryable/extensions/time_with_zone.rb

@@ -42,7 +42,12 @@ module Mongoid
             #
             # @return [ Time ] The evolved date time.
             def evolve(object)
-              object.__evolve_time__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -82,7 +82,7 @@ module Mongoid
         #
         # @param [ Object ] other The object to compare to.
         #
-        # @return [ true, false ] If the objects are equal.
+        # @return [ true | false ] If the objects are equal.
         def ==(other)
           return false unless other.is_a?(Key)
           name == other.name && operator == other.operator && expanded == other.expanded
@@ -104,7 +104,7 @@ module Mongoid
         # @example Instantiate a key for sorting.
         #   Key.new(:field, :__override__, 1)
         #
-        # @param [ String, Symbol ] name The field name.
+        # @param [ String | Symbol ] name The field name.
         # @param [ Symbol ] strategy The name of the merge strategy.
         # @param [ String | Integer ] operator The MongoDB operator,
         #   or sort direction (1 or -1).
@@ -124,7 +124,7 @@ module Mongoid
         #   key.__expr_part__(50)
         #
         # @param [ Object ] object The value to be included.
-        # @param [ true, false ] negating If the selection should be negated.
+        # @param [ true | false ] negating If the selection should be negated.
         #
         # @return [ Hash ] The raw MongoDB selector.
         def __expr_part__(object, negating = false)

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

@@ -52,6 +52,27 @@ module Mongoid
           self
         end
 
+        # Merge criteria with operators using the and operator.
+        #
+        # @param [ Hash ] criterion The criterion to add to the criteria.
+        # @param [ String ] operator The MongoDB operator.
+        #
+        # @return [ Criteria ] The resulting criteria.
+        def and_with_operator(criterion, operator)
+          crit = self
+          if criterion
+            criterion.each_pair do |field, value|
+              val = prepare(field, operator, value)
+              # The prepare method already takes the negation into account. We
+              # set negating to false here so that ``and`` doesn't also apply
+              # negation and we have a double negative.
+              crit.negating = false
+              crit = crit.and(field => val)
+            end
+          end
+          crit
+        end
+
         private
 
         # Adds the criterion to the existing selection.

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

@@ -163,7 +163,7 @@ module Mongoid
         # @example Add sorting options via a string.
         #   optional.order_by("name ASC, dob DESC")
         #
-        # @param [ Array, Hash, String ] spec The sorting specification.
+        # @param [ Array | Hash | String ] spec The sorting specification.
         #
         # @return [ Optional ] The cloned optional.
         def order_by(*spec)
@@ -184,7 +184,7 @@ module Mongoid
         # @example Replace the ordering.
         #   optional.reorder(name: :asc)
         #
-        # @param [ Array, Hash, String ] spec The sorting specification.
+        # @param [ Array | Hash | String ] spec The sorting specification.
         #
         # @return [ Optional ] The cloned optional.
         def reorder(*spec)
@@ -318,15 +318,9 @@ module Mongoid
         #
         # @return [ Optional ] The cloned optional.
         def add_sort_option(options, field, direction)
-          if driver == :mongo1x
-            sorting = (options[:sort] || []).dup
-            sorting.push([ field, direction ])
-            options.store(:sort, sorting)
-          else
-            sorting = (options[:sort] || {}).dup
-            sorting[field] = direction
-            options.store(:sort, sorting)
-          end
+          sorting = (options[:sort] || {}).dup
+          sorting[field] = direction
+          options.store(:sort, sorting)
         end
 
         # Take the provided criterion and store it as an option in the query

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

@@ -54,7 +54,7 @@ module Mongoid
         # @example Store a value in the options.
         #   options.store(:key, "testing")
         #
-        # @param [ String, Symbol ] key The name of the attribute.
+        # @param [ String | Symbol ] key The name of the attribute.
         # @param [ Object ] value The value to add.
         #
         # @return [ Object ] The stored object.
@@ -84,7 +84,7 @@ module Mongoid
         #
         # @return [ Options ] The copied options.
         def __deep_copy__
-          self.class.new(aliases, serializers) do |copy|
+          self.class.new(aliases, serializers, associations, aliased_associations) do |copy|
             each_pair do |key, value|
               copy.merge!(key => value.__deep_copy__)
             end

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

@@ -67,7 +67,7 @@ module Mongoid
         #   pipeline.unwind(:field)
         #   pipeline.unwind(document)
         #
-        # @param [ String, Symbol, Hash ] field_or_doc A field name or a
+        # @param [ String | Symbol | Hash ] field_or_doc A field name or a
         #   document.
         #
         # @return [ Pipeline ] The pipeline.

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

@@ -154,7 +154,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :elem_match
           end
 
-          __override__(criterion, "$elemMatch")
+          and_or_override(criterion, "$elemMatch")
         end
         key :elem_match, :override, "$elemMatch"
 
@@ -227,19 +227,6 @@ module Mongoid
           __merge__(criterion)
         end
 
-        # Alias for +geo_spatial+.
-        #
-        # @deprecated
-        def geo_spacial(criterion)
-          # Duplicate method body so that we can raise this exception with
-          # geo_spacial as the indicated operator rather than geo_spatial.
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :geo_spacial
-          end
-
-          __merge__(criterion)
-        end
-
         key :intersects_line, :override, "$geoIntersects", "$geometry" do |value|
           { "type" => LINE_STRING, "coordinates" => value }
         end
@@ -270,7 +257,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :eq
           end
 
-          __override__(criterion, "$eq")
+          and_or_override(criterion, "$eq")
         end
         key :eq, :override, "$eq"
 
@@ -290,7 +277,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gt
           end
 
-          __override__(criterion, "$gt")
+          and_or_override(criterion, "$gt")
         end
         key :gt, :override, "$gt"
 
@@ -310,7 +297,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gte
           end
 
-          __override__(criterion, "$gte")
+          and_or_override(criterion, "$gte")
         end
         key :gte, :override, "$gte"
 
@@ -366,7 +353,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lt
           end
 
-          __override__(criterion, "$lt")
+          and_or_override(criterion, "$lt")
         end
         key :lt, :override, "$lt"
 
@@ -386,7 +373,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lte
           end
 
-          __override__(criterion, "$lte")
+          and_or_override(criterion, "$lte")
         end
         key :lte, :override, "$lte"
 
@@ -423,7 +410,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :mod
           end
 
-          __override__(criterion, "$mod")
+          and_or_override(criterion, "$mod")
         end
         key :mod, :override, "$mod"
 
@@ -443,7 +430,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :ne
           end
 
-          __override__(criterion, "$ne")
+          and_or_override(criterion, "$ne")
         end
         alias :excludes :ne
         key :ne, :override, "$ne"
@@ -464,7 +451,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near
           end
 
-          __override__(criterion, "$near")
+          and_or_override(criterion, "$near")
         end
         key :near, :override, "$near"
 
@@ -484,7 +471,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near_sphere
           end
 
-          __override__(criterion, "$nearSphere")
+          and_or_override(criterion, "$nearSphere")
         end
         key :near_sphere, :override, "$nearSphere"
 
@@ -542,7 +529,7 @@ module Mongoid
         # @example Is the selectable negating?
         #   selectable.negating?
         #
-        # @return [ true, false ] If the selectable is negating.
+        # @return [ true | false ] If the selectable is negating.
         def negating?
           !!negating
         end
@@ -679,16 +666,7 @@ module Mongoid
                 end]
               end
             end
-            # Should be able to do:
-            #where('$or' => exprs)
-            # But since that is broken do instead:
-            clone.tap do |query|
-              if query.selector['$or']
-                query.selector.store('$or', query.selector['$or'] + exprs)
-              else
-                query.selector.store('$or', exprs)
-              end
-            end
+            self.and('$or' => exprs)
           end
         end
 
@@ -758,7 +736,7 @@ module Mongoid
         #   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
+        # @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
         #   for options.
@@ -796,7 +774,7 @@ module Mongoid
         # @example Add a javascript selection.
         #   selectable.where("this.name == 'syd'")
         #
-        # @param [ String, Hash ] criterion The javascript or standard selection.
+        # @param [ String | Hash ] criterion The javascript or standard selection.
         #
         # @return [ Selectable ] The cloned selectable.
         def where(*criteria)
@@ -874,7 +852,7 @@ module Mongoid
         # @param [ Hash ] criterion The criterion.
         def typed_override(criterion, operator)
           if criterion
-            criterion.update_values do |value|
+            criterion.transform_values! do |value|
               yield(value)
             end
           end
@@ -924,6 +902,22 @@ module Mongoid
           end
         end
 
+        # Combine operator expessions onto a Criteria using either
+        # an override or ands depending on the status of the
+        # Mongoid.overwrite_chained_operators feature flag.
+        #
+        # @param [ Hash ] The criterion to add to the criteria.
+        # @param [ String ] operator The MongoDB operator.
+        #
+        # @return [ Criteria ] The resulting criteria.
+        def and_or_override(criterion, operator)
+          if Mongoid.overwrite_chained_operators
+            __override__(criterion, operator)
+          else
+            and_with_operator(criterion, operator)
+          end
+        end
+
         class << self
 
           # Get the methods on the selectable that can be forwarded to from a model.

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

@@ -13,7 +13,7 @@ module Mongoid
         # @example Merge in another selector.
         #   selector.merge!(name: "test")
         #
-        # @param [ Hash, Selector ] other The object to merge in.
+        # @param [ Hash | Selector ] other The object to merge in.
         #
         # @return [ Selector ] The selector.
         def merge!(other)
@@ -43,7 +43,7 @@ module Mongoid
         # @example Store a value in the selector.
         #   selector.store(:key, "testing")
         #
-        # @param [ String, Symbol ] key The name of the attribute.
+        # @param [ String | Symbol ] key The name of the attribute.
         # @param [ Object ] value The value to add.
         #
         # @return [ Object ] The stored object.
@@ -53,8 +53,7 @@ module Mongoid
             store_name = name
             store_value = evolve_multi(value)
           else
-            store_name = localized_key(name, serializer)
-            store_value = evolve(serializer, value)
+            store_name, store_value = store_creds(name, serializer, value)
           end
           super(store_name, store_value)
         end
@@ -74,6 +73,24 @@ module Mongoid
 
         private
 
+        # Get the store name and store value. If the value is of type range,
+        # we need may need to change the store_name as well as the store_value,
+        # therefore, we cannot just use the evole method.
+        #
+        # @param [ String ] name The name of the field.
+        # @param [ Object ] serializer The optional serializer for the field.
+        # @param [ Object ] value The value to serialize.
+        #
+        # @return [ Array<String, String> ] The store name and store value.
+        def store_creds(name, serializer, value)
+          store_name = localized_key(name, serializer)
+          if Range === value
+            evolve_range(store_name, serializer, value)
+          else
+            [ store_name, evolve(serializer, value) ]
+          end
+        end
+
         # Evolves a multi-list selection, like an $and or $or criterion, and
         # performs the necessary serialization.
         #
@@ -103,11 +120,10 @@ module Mongoid
               # some reason, although per its documentation Smash supposedly
               # owns both.
               name, serializer = storage_pair(key)
-              final_key = localized_key(name, serializer)
               # This performs type conversions on the value and transformations
               # that depend on the type of the field that the value is stored
               # in, but not transformations that have to do with query shape.
-              evolved_value = evolve(serializer, value)
+              final_key, evolved_value = store_creds(name, serializer, value)
 
               # This builds a query shape around the value, when the query
               # involves complex keys. For example, {:foo.lt => 5} produces
@@ -139,6 +155,8 @@ module Mongoid
             evolve_hash(serializer, value)
           when Array
             evolve_array(serializer, value)
+          when Range
+            value.__evolve_range__(serializer: serializer)
           else
             (serializer || value.class).evolve(value)
           end
@@ -182,6 +200,73 @@ module Mongoid
           end
         end
 
+        # Evolve a single key selection with range values. This method traverses
+        # the association tree to build a query for the given value and
+        # serializer. There are three parts to the query here:
+        #
+        # (1) "klass.child.gchild" => {
+        #       "$elemMatch" => {
+        #     (2) "ggchild.field" => (3) { "$gte" => 6, "$lte" => 10 }
+        #       }
+        #     }
+        # (1) The first n fields are dotted together until the last
+        #     embeds_many or field of type array. In the above case, gchild
+        #     would be an embeds_many or Array, and ggchild would be an
+        #     embeds_one or a hash.
+        # (2) The last fields are used inside the $elemMatch. This one is
+        #     actually optional, and will be ignored if the last field is an
+        #     array or embeds_many. If the last field is an array (1), (2) and
+        #     (3) will look like:
+        #
+        #       "klass.child.gchild.ggchild.field" => {
+        #         { "$elemMatch" => { "$gte" => 6, "$lte" => 10 } }
+        #       }
+        #
+        # (3) This is calculated by:
+        #
+        #       value.__evolve_range__(serializer: serializer).
+        #
+        # @api private
+        #
+        # @param [ String ] key The to store the range for.
+        # @param [ Object ] serializer The optional serializer for the field.
+        # @param [ Range ] value The Range to serialize.
+        #
+        # @return [ Array<String, Hash> ] The store name and serialized Range.
+        def evolve_range(key, serializer, value)
+          v = value.__evolve_range__(serializer: serializer)
+          assocs = []
+          Fields.traverse_association_tree(key, serializers, associations, aliased_associations) do |meth, obj, is_field|
+            assocs.push([meth, obj, is_field])
+          end
+
+          # Iterate backwards until you get a field with type
+          # Array or an embeds_many association.
+          inner_key = ""
+          loop do
+            # If there are no arrays or embeds_many associations, just return
+            # the key and value without $elemMatch.
+            return [ key, v ] if assocs.empty?
+
+            meth, obj, is_field = assocs.last
+            break if (is_field && obj.type == Array) || (!is_field && obj.is_a?(Association::Embedded::EmbedsMany))
+
+            assocs.pop
+            inner_key = "#{meth}.#{inner_key}"
+          end
+
+          # If the last array or embeds_many association is the last field,
+          # the inner key (2) is ignored, and the outer key (1) is the original
+          # key.
+          if inner_key.blank?
+            [ key, { "$elemMatch" => v }]
+          else
+            store_key = assocs.map(&:first).join('.')
+            store_value = { "$elemMatch" => { inner_key.chop => v } }
+            [ store_key,  store_value ]
+          end
+        end
+
         # Determines if the selection is a multi-select, like an $and or $or or $nor
         # selection.
         #
@@ -192,7 +277,7 @@ module Mongoid
         #
         # @param [ String ] key The key to check.
         #
-        # @return [ true, false ] If the key is for a multi-select.
+        # @return [ true | false ] If the key is for a multi-select.
         def multi_selection?(key)
           %w($and $or $nor).include?(key)
         end

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

@@ -8,8 +8,16 @@ module Mongoid
       class Smash < Hash
 
         # @attribute [r] aliases The aliases.
+        attr_reader :aliases
+
         # @attribute [r] serializers The serializers.
-        attr_reader :aliases, :serializers
+        attr_reader :serializers
+
+        # @attribute [r] associations The associations.
+        attr_reader :associations
+
+        # @attribute [r] aliased_associations The aliased_associations.
+        attr_reader :aliased_associations
 
         # Perform a deep copy of the smash.
         #
@@ -18,7 +26,7 @@ module Mongoid
         #
         # @return [ Smash ] The copied hash.
         def __deep_copy__
-          self.class.new(aliases, serializers) do |copy|
+          self.class.new(aliases, serializers, associations, aliased_associations) do |copy|
             each_pair do |key, value|
               copy.store(key, value.__deep_copy__)
             end
@@ -36,8 +44,15 @@ module Mongoid
         #   responsible for serializing values. The keys of the hash must be
         #   strings that match the field name, and the values must respond to
         #   #localized? and #evolve(object).
-        def initialize(aliases = {}, serializers = {})
-          @aliases, @serializers = aliases, serializers
+        # @param [ Hash ] associations An optional hash of names to association
+        #   objects.
+        # @param [ Hash ] aliased_associations An optional hash of mappings from
+        #   aliases for associations to their actual field names in the database.
+        def initialize(aliases = {}, serializers = {}, associations = {}, aliased_associations = {})
+          @aliases = aliases
+          @serializers = serializers
+          @associations = associations
+          @aliased_associations = aliased_associations
           yield(self) if block_given?
         end
 
@@ -80,14 +95,32 @@ module Mongoid
         # @example Get the name and serializer.
         #   smash.storage_pair("id")
         #
-        # @param [ Symbol, String ] key The key provided to the selection.
+        # @param [ Symbol | String ] key The key provided to the selection.
         #
         # @return [ Array<String, Object> ] The name of the db field and
         #   serializer.
         def storage_pair(key)
           field = key.to_s
-          name = aliases[field] || field
-          [ name, serializers[name] ]
+          name = Fields.database_field_name(field, associations, aliases, aliased_associations)
+          [ name, get_serializer(name) ]
+        end
+
+        private
+
+        # Retrieves the serializer for the given name. If the name exists in
+        # the serializers hash then return that immediately, otherwise
+        # recursively look through the associations and find the appropriate
+        # field.
+        #
+        # @param [ String ] name The name of the db field.
+        #
+        # @return [ Object ] The serializer.
+        def get_serializer(name)
+          if s = serializers[name]
+            s
+          else
+            Fields.traverse_association_tree(name, serializers, associations, aliased_associations)
+          end
         end
       end
     end

data/lib/mongoid/criteria/queryable.rb

@@ -33,9 +33,10 @@ module Mongoid
       include Optional
 
       # @attribute [r] aliases The aliases.
-      # @attribute [r] driver The Mongo driver being used.
+      attr_reader :aliases
+
       # @attribute [r] serializers The serializers.
-      attr_reader :aliases, :driver, :serializers
+      attr_reader :serializers
 
       # Is this queryable equal to another object? Is true if the selector and
       # options are equal.
@@ -45,7 +46,7 @@ module Mongoid
       #
       # @param [ Object ] other The object to compare against.
       #
-      # @return [ true, false ] If the objects are equal.
+      # @return [ true | false ] If the objects are equal.
       def ==(other)
         return false unless other.is_a?(Queryable)
         selector == other.selector && options == other.options
@@ -59,11 +60,15 @@ module Mongoid
       #
       # @param [ Hash ] aliases The optional field aliases.
       # @param [ Hash ] serializers The optional field serializers.
+      # @param [ Hash ] associations The optional associations.
+      # @param [ Hash ] aliased_associations The optional aliased associations.
       # @param [ Symbol ] driver The driver being used.
-      def initialize(aliases = {}, serializers = {}, driver = :mongo)
-        @aliases, @driver, @serializers = aliases, driver.to_sym, serializers
-        @options = Options.new(aliases, serializers)
-        @selector = Selector.new(aliases, serializers)
+      #
+      # @api private
+      def initialize(aliases = {}, serializers = {}, associations = {}, aliased_associations = {})
+        @aliases, @serializers = aliases, serializers
+        @options = Options.new(aliases, serializers, associations, aliased_associations)
+        @selector = Selector.new(aliases, serializers, associations, aliased_associations)
         @pipeline = Pipeline.new(aliases)
         @aggregating = nil
         yield(self) if block_given?

data/lib/mongoid/criteria/scopable.rb

@@ -83,7 +83,7 @@ module Mongoid
       # @example Is the default scope applied?
       #   criteria.scoped?
       #
-      # @return [ true, false ] If the default scope is applied.
+      # @return [ true | false ] If the default scope is applied.
       def scoped?
         !!(defined?(@scoped) ? @scoped : nil)
       end
@@ -108,7 +108,7 @@ module Mongoid
       # @example Is the criteria unscoped?
       #   criteria.unscoped?
       #
-      # @return [ true, false ] If the criteria is force unscoped.
+      # @return [ true | false ] If the criteria is force unscoped.
       def unscoped?
         !!(defined?(@unscoped) ? @unscoped : nil)
       end