mongoid 7.4.3 → 7.5.0

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

@@ -142,6 +142,8 @@ module Mongoid
           # @param [ Proc ] block The block to execute on each value.
           #
           # @return [ Hash ] the hash.
+          #
+          # @deprecated
           def update_values(&block)
             each_pair do |key, value|
               store(key, block[value])

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/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"
 
@@ -270,7 +270,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :eq
           end
 
-          __override__(criterion, "$eq")
+          and_or_override(criterion, "$eq")
         end
         key :eq, :override, "$eq"
 
@@ -290,7 +290,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gt
           end
 
-          __override__(criterion, "$gt")
+          and_or_override(criterion, "$gt")
         end
         key :gt, :override, "$gt"
 
@@ -310,7 +310,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gte
           end
 
-          __override__(criterion, "$gte")
+          and_or_override(criterion, "$gte")
         end
         key :gte, :override, "$gte"
 
@@ -366,7 +366,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lt
           end
 
-          __override__(criterion, "$lt")
+          and_or_override(criterion, "$lt")
         end
         key :lt, :override, "$lt"
 
@@ -386,7 +386,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lte
           end
 
-          __override__(criterion, "$lte")
+          and_or_override(criterion, "$lte")
         end
         key :lte, :override, "$lte"
 
@@ -423,7 +423,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :mod
           end
 
-          __override__(criterion, "$mod")
+          and_or_override(criterion, "$mod")
         end
         key :mod, :override, "$mod"
 
@@ -443,7 +443,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 +464,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near
           end
 
-          __override__(criterion, "$near")
+          and_or_override(criterion, "$near")
         end
         key :near, :override, "$near"
 
@@ -484,7 +484,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near_sphere
           end
 
-          __override__(criterion, "$nearSphere")
+          and_or_override(criterion, "$nearSphere")
         end
         key :near_sphere, :override, "$nearSphere"
 
@@ -924,6 +924,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.rb

@@ -122,6 +122,7 @@ module Mongoid
     #
     # @return [ Criteria ] The cloned criteria.
     def cache
+      Mongoid::Warnings.warn_criteria_cache_deprecated
       crit = clone
       crit.options.merge!(cache: true)
       crit
@@ -134,6 +135,7 @@ module Mongoid
     #
     # @return [ true, false ] If the criteria is flagged as cached.
     def cached?
+      Mongoid::Warnings.warn_criteria_cache_deprecated
       options[:cache] == true
     end
 

data/lib/mongoid/document.rb

@@ -143,6 +143,8 @@ module Mongoid
     #   document.to_a
     #
     # @return [ Array<Document> ] An array with the document as its only item.
+    #
+    # @deprecated
     def to_a
       [ self ]
     end

data/lib/mongoid/equality.rb

@@ -44,9 +44,9 @@ module Mongoid
     # @return [ true, false ] True if the classes are equal, false if not.
     def ===(other)
       if Mongoid.legacy_triple_equals
-        other.class == Class ? self.class === other : self == other
-      else
         super
+      else
+        other.class == Class ? self.class === other : self == other
       end
     end
 
@@ -73,9 +73,9 @@ module Mongoid
       # @return [ true, false ] True if the classes are equal, false if not.
       def ===(other)
         if Mongoid.legacy_triple_equals
-          other.class == Class ? self <= other : other.is_a?(self)
-        else
           other.is_a?(self)
+        else
+          other.class == Class ? self <= other : other.is_a?(self)
         end
       end
     end

data/lib/mongoid/errors/document_not_found.rb

@@ -23,13 +23,13 @@ module Mongoid
       # @param [ Array ] unmatched The unmatched ids, if appropriate
       def initialize(klass, params, unmatched = nil)
         if !unmatched && !params.is_a?(Hash)
-          unmatched = Array(params)
+          unmatched = Array(params) if params
         end
 
         @klass, @params = klass, params
         super(
           compose_message(
-            message_key(params),
+            message_key(params, unmatched),
             {
               klass: klass.name,
               searched: searched(params),
@@ -93,10 +93,27 @@ module Mongoid
       #   error.problem
       #
       # @return [ String ] The problem.
-      def message_key(params)
-        case params
-          when Hash then "document_with_attributes_not_found"
-          else "document_not_found"
+      def message_key(params, unmatched)
+        if !params && !unmatched
+          "no_documents_found"
+        elsif Hash === params
+          "document_with_attributes_not_found"
+        elsif Hash === unmatched && unmatched.size >= 2
+          "document_with_shard_key_not_found"
+        else
+          "document_not_found"
+        end
+      end
+
+      # Get the shard key from the unmatched hash.
+      #
+      # @return [ String ] the shard key and value.
+      def shard_key(unmatched)
+        if Hash === unmatched
+          h = unmatched.dup
+          h.delete("_id")
+          h.delete(:_id)
+          h.map{|k,v| "#{k}: #{v}" }.join(", ")
         end
       end
     end

data/lib/mongoid/fields.rb

@@ -270,21 +270,64 @@ module Mongoid
       def options
         @options ||= {}
       end
-    end
-
-    module ClassMethods
 
-      # Returns an array of names for the attributes available on this object.
+      # Traverse down the association tree and search for the field for the
+      # given key. To do this, split the key by '.' and for each part (meth) of
+      # the key:
       #
-      # Provides the field names in an ORM-agnostic way. Rails v3.1+ uses this
-      # method to automatically wrap params in JSON requests.
+      # - If the meth is a field, yield the meth, field, and is_field as true.
+      # - If the meth is an association, update the klass to the association's
+      #   klass, and yield the meth, klass, and is_field as false.
       #
-      # @example Get the field names
-      #   Model.attribute_names
+      # The next iteration will use klass's fields and associations to continue
+      # traversing the tree.
       #
-      # @return [ Array<String> ] The field names
-      def attribute_names
-        fields.keys
+      # @param [ String ] key The key used to search the association tree.
+      # @param [ Hash ] fields The fields to begin the search with.
+      # @param [ Hash ] associations The associations to begin the search with.
+      # @param [ Hash ] aliased_associations The alaised associations to begin
+      #   the search with.
+      # @param [ Proc ] block The block takes in three paramaters, the current
+      #   meth, the field or the relation, and whether the second parameter is a
+      #   field or not.
+      #
+      # @return [ Field ] The field found for the given key at the end of the
+      #   search. This will return nil if the last thing found is an association
+      #   or no field was found for the given key.
+      #
+      # @api private
+      def traverse_association_tree(key, fields, associations, aliased_associations)
+        klass = nil
+        field = nil
+        key.split('.').each_with_index do |meth, i|
+          fs = i == 0 ? fields : klass&.fields
+          rs = i == 0 ? associations : klass&.relations
+          as = i == 0 ? aliased_associations : klass&.aliased_associations
+
+          # Associations can possibly have two "keys", their name and their alias.
+          # The fields name is what is used to store it in the klass's relations
+          # and field hashes, and the alias is what's used to store that field
+          # in the database. The key inputted to this function is the aliased
+          # key. We can convert them back to their names by looking in the
+          # aliased_associations hash.
+          aliased = meth
+          if as && a = as.fetch(meth, nil)
+            aliased = a.to_s
+          end
+
+          field = nil
+          klass = nil
+          if fs && f = fs[aliased]
+            field = f
+            yield(meth, f, true) if block_given?
+          elsif rs && rel = rs[aliased]
+            klass = rel.klass
+            yield(meth, rel, false) if block_given?
+          else
+            yield(meth, nil, false) if block_given?
+          end
+        end
+        field
       end
 
       # Get the name of the provided field as it is stored in the database.
@@ -292,16 +335,43 @@ module Mongoid
       # finds aliases for embedded documents and fields, delimited with
       # period "." character.
       #
-      # @example Get the database field name of a field.
-      #   Model.database_field_name(:authorization)
+      # Note that this method returns the name of associations as they're
+      # stored in the database, whereas the `relations` hash uses their in-code
+      # aliases. In order to check for membership in the relations hash, you
+      # would first have to look up the string returned from this method in
+      # the aliased_associations hash.
+      #
+      # This method will not expand the alias of a belongs_to association that
+      # is not the last item. For example, if we had a School that has_many
+      # Students, and the field name passed was (from the Student's perspective):
+      #
+      #   school._id
+      #
+      # The alias for a belongs_to association is that association's _id field.
+      # Therefore, expanding out this association would yield:
+      #
+      #   school_id._id
       #
-      # @example Get the database field name of an embedded field.
-      #   Model.database_field_name('customers.addresses.city')
+      # This is not the correct field name, because the intention here was not
+      # to get a property of the _id field. The intention was to get a property
+      # of the referenced document. Therefore, if a part of the name passed is
+      # a belongs_to association that is not the last part of the name, we
+      # won't expand its alias, and return:
+      #
+      #   school._id
+      #
+      # If the belongs_to association is the last part of the name, we will
+      # pass back the _id field.
       #
       # @param [ String, Symbol ] name The name to get.
+      # @param [ Hash ] relations The associations.
+      # @param [ Hash ] alaiased_fields The aliased fields.
+      # @param [ Hash ] alaiased_associations The aliased associations.
       #
       # @return [ String ] The name of the field as stored in the database.
-      def database_field_name(name)
+      #
+      # @api private
+      def database_field_name(name, relations, aliased_fields, aliased_associations)
         if Mongoid.broken_alias_handling
           return nil unless name
           normalized = name.to_s
@@ -310,31 +380,68 @@ module Mongoid
           return nil unless name.present?
           key = name.to_s
           segment, remaining = key.split('.', 2)
-          segment = aliased_fields[segment]&.dup || segment
+
+          # Don't get the alias for the field when a belongs_to association
+          # is not the last item. Therefore, get the alias when one of the
+          # following is true:
+          # 1. This is the last item, i.e. there is no remaining.
+          # 2. It is not an association.
+          # 3. It is not a belongs association
+          if !remaining || !relations.key?(segment) || !relations[segment].is_a?(Association::Referenced::BelongsTo)
+            segment = aliased_fields[segment]&.dup || segment
+          end
+
           return segment unless remaining
 
           relation = relations[aliased_associations[segment] || segment]
           if relation
-            "#{segment}.#{relation.klass.database_field_name(remaining)}"
+            k = relation.klass
+            "#{segment}.#{database_field_name(remaining, k.relations, k.aliased_fields, k.aliased_associations)}"
           else
             "#{segment}.#{remaining}"
           end
         end
       end
+    end
+
+    module ClassMethods
+
+      # Returns an array of names for the attributes available on this object.
+      #
+      # Provides the field names in an ORM-agnostic way. Rails v3.1+ uses this
+      # method to automatically wrap params in JSON requests.
+      #
+      # @example Get the field names
+      #   Model.attribute_names
+      #
+      # @return [ Array<String> ] The field names
+      def attribute_names
+        fields.keys
+      end
+
+      # Get the name of the provided field as it is stored in the database.
+      # Used in determining if the field is aliased or not.
+      #
+      # @param [ String, Symbol ] name The name to get.
+      #
+      # @return [ String ] The name of the field as it's stored in the db.
+      def database_field_name(name)
+        Fields.database_field_name(name, relations, aliased_fields, aliased_associations)
+      end
 
       # Defines all the fields that are accessible on the Document
       # For each field that is defined, a getter and setter will be
       # added as an instance method to the Document.
       #
       # @example Define a field.
-      #   field :score, :type => Integer, :default => 0
+      #   field :score, type: Integer, default: 0
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The options to pass to the field.
       #
-      # @option options [ Class ] :type The type of the field.
+      # @option options [ Class | Symbol | String ] :type The type of the field.
       # @option options [ String ] :label The label for the field.
-      # @option options [ Object, Proc ] :default The field's default
+      # @option options [ Object | Proc ] :default The field's default.
       #
       # @return [ Field ] The generated field
       def field(name, options = {})
@@ -372,6 +479,23 @@ module Mongoid
         fields["_id"].object_id_field?
       end
 
+      # Traverse down the association tree and search for the field for the
+      # given key.
+      #
+      # @param [ String ] key The key used to search the association tree.
+      # @param [ Proc ] block The block takes in three paramaters, the current
+      #   meth, the field or the relation, and whether the second parameter is a
+      #   field or not.
+      #
+      # @return [ Field ] The field found for the given key at the end of the
+      #   search. This will return nil if the last thing found is an association
+      #   or no field was found for the given key.
+      #
+      # @api private
+      def traverse_association_tree(key, &block)
+        Fields.traverse_association_tree(key, fields, relations, aliased_associations, &block)
+      end
+
       protected
 
       # Add the defaults to the model. This breaks them up between ones that

data/lib/mongoid/findable.rb

@@ -41,9 +41,12 @@ module Mongoid
       :pluck,
       :read,
       :sum,
+      :take,
+      :take!,
+      :tally,
       :text_search,
       :update,
-      :update_all
+      :update_all,
 
     # Returns a count of records in the database.
     # If you want to specify conditions use where.
@@ -179,9 +182,15 @@ module Mongoid
     # @example Find the first document.
     #   Person.first
     #
+    # @param [ Integer | Hash ] limit_or_opts The number of documents to
+    #   return, or a hash of options.
+    #
+    # @option limit_or_opts [ :none ] :id_sort This option is deprecated.
+    #   Don't apply a sort on _id if no other sort is defined on the criteria.
+    #
     # @return [ Document ] The first matching document.
-    def first
-      with_default_scope.first
+    def first(limit_or_opts = nil)
+      with_default_scope.first(limit_or_opts)
     end
     alias :one :first
 
@@ -190,9 +199,15 @@ module Mongoid
     # @example Find the last document.
     #   Person.last
     #
+    # @param [ Integer | Hash ] limit_or_opts The number of documents to
+    #   return, or a hash of options.
+    #
+    # @option limit_or_opts [ :none ] :id_sort This option is deprecated.
+    #   Don't apply a sort on _id if no other sort is defined on the criteria.
+    #
     # @return [ Document ] The last matching document.
-    def last
-      with_default_scope.last
+    def last(limit_or_opts = nil)
+      with_default_scope.last(limit_or_opts)
     end
   end
 end

data/lib/mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mongoid
-  VERSION = "7.4.3"
+  VERSION = "7.5.0"
 end

data/lib/mongoid/warnings.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # Encapsulates behavior around logging and caching warnings so they are only
+  # logged once.
+  #
+  # @api private
+  module Warnings
+
+    class << self
+      def warning(id, message)
+        singleton_class.class_eval do
+          define_method("warn_#{id}") do
+            unless instance_variable_get("@#{id}")
+              Mongoid.logger.warn(message)
+              instance_variable_set("@#{id}", true)
+            end
+          end
+        end
+      end
+    end
+
+    warning :id_sort_deprecated, 'The :id_sort option has been deprecated. Use Mongo#take to get a document without a sort on _id.'
+    warning :criteria_cache_deprecated, 'The criteria cache has been deprecated and will be removed in Mongoid 8. Please enable the Mongoid QueryCache to have caching functionality.'
+    warning :map_field_deprecated, 'The field argument to the Mongo#map method has been deprecated, please pass in a block instead. Support will be dropped in Mongoid 8.'
+  end
+end
+

data/lib/mongoid.rb

@@ -23,6 +23,7 @@ require "mongoid/clients"
 require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
+require "mongoid/warnings"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -125,9 +125,6 @@ development:
     # database name is not explicitly defined. (default: nil)
     # app_name: MyApplicationName
     
-    # Create indexes in background by default. (default: false)
-    # background_indexing: false
-    
     # Mark belongs_to associations as required by default, so that saving a
     # model with a missing belongs_to association will trigger a validation
     # error. (default: true)
@@ -172,6 +169,10 @@ development:
     # (default: false)
     # use_utc: false
 
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    # background_indexing: false
+
 test:
   clients:
     default:

data/spec/integration/i18n_fallbacks_spec.rb

@@ -23,6 +23,10 @@ describe 'i18n fallbacks' do
       I18n.fallbacks[:de] = [ :en ]
     end
 
+    after do
+      I18n.locale = :en
+    end
+
     context 'when translation is present in active locale' do
       it 'uses active locale' do
         product = Product.new
@@ -36,6 +40,9 @@ describe 'i18n fallbacks' do
     end
 
     context 'when translation is missing in active locale and present in fallback locale' do
+      after do
+        I18n.locale = :en
+      end
 
       it 'falls back on default locale' do
         product = Product.new
@@ -57,6 +64,10 @@ describe 'i18n fallbacks' do
           end
         end
 
+        after do
+          I18n.locale = :en
+        end
+
         it 'returns nil' do
           product = Product.new
           I18n.locale = :en
@@ -75,6 +86,10 @@ describe 'i18n fallbacks' do
           end
         end
 
+        after do
+          I18n.locale = :en
+        end
+
         it 'falls back on default locale' do
           product = Product.new
           I18n.locale = :en
@@ -82,7 +97,6 @@ describe 'i18n fallbacks' do
           I18n.locale = :ru
           product.description.should == 'Marvelous!'
         end
-
       end
     end
   end

data/spec/mongoid/association/embedded/embeds_many/proxy_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require_relative '../embeds_many_models.rb'
 
 describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
 
@@ -4650,24 +4649,4 @@ describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
       end
     end
   end
-
-  context "when using assign_attributes with an already populated array" do
-    let(:post) { EmmPost.create! }
-
-    before do
-      post.assign_attributes(company_tags: [{id: BSON::ObjectId.new, title: 'a'}],
-        user_tags: [{id: BSON::ObjectId.new, title: 'b'}])
-      post.save!
-      post.reload
-      post.assign_attributes(company_tags: [{id: BSON::ObjectId.new, title: 'c'}],
-        user_tags: [])
-      post.save!
-      post.reload
-    end
-
-    it "has the correct embedded documents" do
-      expect(post.company_tags.length).to eq(1)
-      expect(post.company_tags.first.title).to eq("c")
-    end
-  end
 end