mongoid 9.0.11 → 9.1.1

data/lib/mongoid/criteria.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
-# rubocop:todo all
-
-require "mongoid/criteria/findable"
-require "mongoid/criteria/includable"
-require "mongoid/criteria/inspectable"
-require "mongoid/criteria/marshalable"
-require "mongoid/criteria/modifiable"
-require "mongoid/criteria/queryable"
-require "mongoid/criteria/scopable"
-require "mongoid/criteria/options"
-require "mongoid/criteria/translator"
 
-module Mongoid
+require 'mongoid/criteria/findable'
+require 'mongoid/criteria/includable'
+require 'mongoid/criteria/inspectable'
+require 'mongoid/criteria/marshalable'
+require 'mongoid/criteria/modifiable'
+require 'mongoid/criteria/queryable'
+require 'mongoid/criteria/scopable'
+require 'mongoid/criteria/options'
+require 'mongoid/criteria/translator'
 
+module Mongoid
   # The +Criteria+ class is the core object needed in Mongoid to retrieve
   # objects from the database. It is a DSL that essentially sets up the
   # selector and options arguments that get passed on to a Mongo::Collection
@@ -23,14 +21,14 @@ module Mongoid
     include Enumerable
 
     # @api private
-    alias :_enumerable_find :find
+    alias _enumerable_find find
 
     include Contextual
     include Queryable
     include Findable
 
     # @api private
-    alias :_findable_find :find
+    alias _findable_find find
 
     include Inspectable
     include Includable
@@ -87,6 +85,7 @@ module Mongoid
           unless ALLOWED_FROM_HASH_METHODS.include?(method_sym)
             raise ArgumentError, "Method '#{method}' is not allowed in from_hash"
           end
+
           criteria = criteria.public_send(method_sym, args)
         end
         criteria
@@ -110,6 +109,7 @@ module Mongoid
     # @return [ true | false ] If the objects are equal.
     def ==(other)
       return super if other.respond_to?(:selector)
+
       entries == other
     end
 
@@ -121,7 +121,7 @@ module Mongoid
     # and finds one or many documents for the provided _id values.
     #
     # If this method is given a block, it delegates to +Enumerable#find+ and
-    # returns the first document of those found by the current Crieria object
+    # returns the first document of those found by the current Criteria object
     # for which the block returns a truthy value.
     #
     # Note that the "default proc" argument of Enumerable is not specially
@@ -132,7 +132,7 @@ module Mongoid
     #   a nested array. Each array will be flattened.
     #
     # @example Finds a document by its _id, invokes Findable#find.
-    #   critera.find("1234")
+    #   criteria.find("1234")
     #
     # @example Finds the first matching document using a block, invokes Enumerable#find.
     #   criteria.find { |item| item.name == "Depeche Mode" }
@@ -191,9 +191,7 @@ module Mongoid
     # @param [ Array<Document> ] docs The embedded documents.
     #
     # @return [ Array<Document> ] The embedded documents.
-    def documents=(docs)
-      @documents = docs
-    end
+    attr_writer :documents
 
     # Is the criteria for embedded documents?
     #
@@ -205,6 +203,65 @@ module Mongoid
       !!@embedded
     end
 
+    # Produce a clone of the current criteria object with it's "raw"
+    # setting set to the given value. A criteria set to "raw" will return
+    # all results as raw hashes. If `typed` is true, the values in the hashes
+    # will be typecast according to the fields that they correspond to.
+    #
+    # When "raw" is not set (or if `raw_results` is false), the criteria will
+    # return all results as instantiated Document instances.
+    #
+    # @example Return query results as raw hashes:
+    #   Person.where(city: 'Boston').raw
+    #
+    # @param [ true | false ] raw_results Whether the new criteria should be
+    #   placed in "raw" mode or not.
+    # @param [ true | false ] typed Whether the raw results should be typecast
+    #   before being returned. Default is true if raw_results is false, and
+    #   false otherwise.
+    #
+    # @return [ Criteria ] the cloned criteria object.
+    def raw(raw_results = true, typed: nil)
+      # default for typed is true when raw_results is false, and false when
+      # raw_results is true.
+      typed = !raw_results if typed.nil?
+
+      raise ArgumentError, 'instantiated results must be typecast' if !typed && !raw_results
+
+      clone.tap do |criteria|
+        criteria._raw_results = { raw: raw_results, typed: typed }
+      end
+    end
+
+    # An internal helper for getting/setting the "raw" flag on a given criteria
+    # object.
+    #
+    # @return [ nil | Hash ] If set, it is a hash with two keys, :raw and :typed,
+    #   that describe whether raw results should be returned, and whether they
+    #   ought to be typecast.
+    #
+    # @api private
+    attr_accessor :_raw_results
+
+    # Predicate that answers the question: is this criteria object currently
+    # in raw mode? (See #raw for a description of raw mode.)
+    #
+    # @return [ true | false ] whether the criteria is in raw mode or not.
+    def raw_results?
+      _raw_results && _raw_results[:raw]
+    end
+
+    # Predicate that answers the question: should the results returned by
+    # this criteria object be typecast? (See #raw for a description of this.)
+    # The answer is meaningless unless #raw_results? is true, since if
+    # instantiated document objects are returned they will always be typecast.
+    #
+    # @return [ true | false ] whether the criteria should return typecast
+    #   results.
+    def typecast_results?
+      _raw_results && _raw_results[:typed]
+    end
+
     # Extract a single id from the provided criteria. Could be in an $and
     # query or a straight _id query.
     #
@@ -239,7 +296,7 @@ module Mongoid
     # @return [ Array<String> ] The fields.
     def field_list
       if options[:fields]
-        options[:fields].keys.reject{ |key| key == klass.discriminator_key }
+        options[:fields].keys.reject { |key| key == klass.discriminator_key }
       else
         []
       end
@@ -312,6 +369,8 @@ module Mongoid
       self.documents = other.documents.dup unless other.documents.empty?
       self.scoping_options = other.scoping_options
       self.inclusions = (inclusions + other.inclusions).uniq
+      self._raw_results = _raw_results || other._raw_results
+      @use_lookup ||= other.use_lookup?
       self
     end
 
@@ -336,7 +395,7 @@ module Mongoid
       !!@none
     end
 
-    # Overriden to include _type in the fields.
+    # Overridden to include _type in the fields.
     #
     # @example Limit the fields returned from the database.
     #   Band.only(:name)
@@ -347,13 +406,10 @@ module Mongoid
     def only(*args)
       args = args.flatten
       return clone if args.empty?
-      if (args & Fields::IDS).empty?
-        args.unshift(:_id)
-      end
-      if klass.hereditary?
-        args.push(klass.discriminator_key.to_sym)
-      end
-      super(*args)
+
+      args.unshift(:_id) if (args & Fields::IDS).empty?
+      args.push(klass.discriminator_key.to_sym) if klass.hereditary?
+      super
     end
 
     # Set the read preference for the criteria.
@@ -370,7 +426,7 @@ module Mongoid
       end
     end
 
-    # Overriden to exclude _id from the fields.
+    # Overridden to exclude _id from the fields.
     #
     # @example Exclude fields returned from the database.
     #   Band.without(:name)
@@ -380,13 +436,13 @@ module Mongoid
     # @return [ Criteria ] The cloned criteria.
     def without(*args)
       args -= id_fields
-      super(*args)
+      super
     end
 
     # Returns true if criteria responds to the given method.
     #
     # @example Does the criteria respond to the method?
-    #   crtiteria.respond_to?(:each)
+    #   criteria.respond_to?(:each)
     #
     # @param [ Symbol ] name The name of the class method on the +Document+.
     # @param [ true | false ] include_private Whether to include privates.
@@ -396,7 +452,7 @@ module Mongoid
       super || klass.respond_to?(name) || CHECK.respond_to?(name, include_private)
     end
 
-    alias :to_ary :to_a
+    alias to_ary to_a
 
     # Convenience for objects that want to be merged into a criteria.
     #
@@ -417,7 +473,7 @@ module Mongoid
     #
     # @return [ Proc ] The wrapped criteria.
     def to_proc
-      ->{ self }
+      -> { self }
     end
 
     # Adds a criterion to the +Criteria+ that specifies a type or an Array of
@@ -431,7 +487,7 @@ module Mongoid
     #
     # @return [ Criteria ] The cloned criteria.
     def type(types)
-      any_in(self.discriminator_key.to_sym => Array(types))
+      any_in(discriminator_key.to_sym => Array(types))
     end
 
     # This is the general entry point for most MongoDB queries. This either
@@ -455,18 +511,15 @@ module Mongoid
       # Historically this method required exactly one argument.
       # As of https://jira.mongodb.org/browse/MONGOID-4804 it also accepts
       # zero arguments.
-      # The underlying where implemetation that super invokes supports
-      # any number of arguments, but we don't presently allow mutiple
+      # The underlying where implementation that super invokes supports
+      # any number of arguments, but we don't presently allow multiple
       # arguments through this method. This API can be reconsidered in the
       # future.
-      if args.length > 1
-        raise ArgumentError, "Criteria#where requires zero or one arguments (given #{args.length})"
-      end
+      raise ArgumentError, "Criteria#where requires zero or one arguments (given #{args.length})" if args.length > 1
+
       if args.length == 1
         expression = args.first
-        if expression.is_a?(::String) && embedded?
-          raise Errors::UnsupportedJavascript.new(klass, expression)
-        end
+        raise Errors::UnsupportedJavascript.new(klass, expression) if expression.is_a?(::String) && embedded?
       end
       super
     end
@@ -499,11 +552,11 @@ module Mongoid
     # @deprecated
     def for_js(javascript, scope = {})
       code = if scope.empty?
-        # CodeWithScope is not supported for $where as of MongoDB 4.4
-        BSON::Code.new(javascript)
-      else
-        BSON::CodeWithScope.new(javascript, scope)
-      end
+               # CodeWithScope is not supported for $where as of MongoDB 4.4
+               BSON::Code.new(javascript)
+             else
+               BSON::CodeWithScope.new(javascript, scope)
+             end
       js_query(code)
     end
     Mongoid.deprecate(self, :for_js)
@@ -524,9 +577,9 @@ module Mongoid
     # @raise [ Errors::DocumentNotFound ] If none are found and raising an
     #   error.
     def check_for_missing_documents!(result, ids)
-      if (result.size < ids.size) && Mongoid.raise_not_found_error
-        raise Errors::DocumentNotFound.new(klass, ids, ids - result.map(&:_id))
-      end
+      return unless (result.size < ids.size) && Mongoid.raise_not_found_error
+
+      raise Errors::DocumentNotFound.new(klass, ids, ids - result.map(&:_id))
     end
 
     # Clone or dup the current +Criteria+. This will return a new criteria with
@@ -547,7 +600,9 @@ module Mongoid
       @inclusions = other.inclusions.dup
       @scoping_options = other.scoping_options
       @documents = other.documents.dup
+      self._raw_results = other._raw_results
       @context = nil
+      @use_lookup = other.use_lookup?
       super
     end
 
@@ -567,7 +622,7 @@ module Mongoid
           klass.send(name, *args, &block)
         end
       elsif CHECK.respond_to?(name)
-        return entries.send(name, *args, &block)
+        entries.send(name, *args, &block)
       else
         super
       end
@@ -594,8 +649,8 @@ module Mongoid
     # @return [ true | false ] If type selection should be added.
     def type_selectable?
       klass.hereditary? &&
-        !selector.keys.include?(self.discriminator_key) &&
-        !selector.keys.include?(self.discriminator_key.to_sym)
+        !selector.keys.include?(discriminator_key) &&
+        !selector.keys.include?(discriminator_key.to_sym)
     end
 
     # Get the selector for type selection.
@@ -609,7 +664,7 @@ module Mongoid
     def type_selection
       klasses = klass._types
       if klasses.size > 1
-        { klass.discriminator_key.to_sym => { "$in" => klass._types }}
+        { klass.discriminator_key.to_sym => { '$in' => klass._types } }
       else
         { klass.discriminator_key.to_sym => klass._types[0] }
       end

data/lib/mongoid/deprecable.rb

@@ -1,14 +1,34 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/deprecation"
+require 'mongoid/deprecation'
 
 module Mongoid
-
   # Adds ability to declare Mongoid-specific deprecations.
   #
   # @api private
   module Deprecable
+    # A Mongoid::Deprecation instance to use for reporting deprecations
+    def deprecator
+      @deprecator ||= Mongoid::Deprecation.new
+    end
+
+    # Resets all deprecation warnings. For use in tests.
+    def reset_deprecation_warnings!
+      DEPRECATION_WARNING_MUTEX.synchronize { @deprecation_warnings = {} }
+    end
+
+    # Emits a warning using the current deprecator. If the given warning (as
+    # identified by `id`) has already been issued previously, this is a no-op.
+    #
+    # @param [ Symbol ] id The unique identifier for this warning.
+    # @param [ String ] warning The warning message to emit.
+    # @param [ Array<Thread::Backtrace::Location> | nil ] callstack The backtrace at the call site.
+    def deprecation_warning(id, warning, callstack = nil)
+      site = callstack&.first
+      deprecation_warning_guard(id, site ? "#{site.path}:#{site.lineno}" : nil) do
+        deprecator.warn(warning, callstack)
+      end
+    end
 
     # Declares method(s) as deprecated.
     #
@@ -28,8 +48,28 @@ module Mongoid
     # @param [ [ Symbol | Hash<Symbol, [ Symbol | String ]> ]... ] *method_descriptors
     #   The methods to deprecate, with optional replacement instructions.
     def deprecate(target_module, *method_descriptors)
-      @_deprecator ||= Mongoid::Deprecation.new
-      @_deprecator.deprecate_methods(target_module, *method_descriptors)
+      deprecator.deprecate_methods(target_module, *method_descriptors)
+    end
+
+    private
+
+    # The Mutex instance used to guard the deprecation warning flags.
+    DEPRECATION_WARNING_MUTEX = Mutex.new
+
+    # Wraps access to the warnings Hash in a synchronize block. If the given
+    # id+callsite has not been warned already, the method will yield to a block and then
+    # flag the id. Otherwise, it returns immediately.
+    def deprecation_warning_guard(id, callsite)
+      DEPRECATION_WARNING_MUTEX.synchronize do
+        @deprecation_warnings ||= {}
+
+        key = "#{id}:#{callsite}"
+        return if @deprecation_warnings.key?(key)
+
+        yield
+
+        @deprecation_warnings[key] = true
+      end
     end
   end
 end

data/lib/mongoid/deprecation.rb

@@ -1,25 +1,21 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Utility class for logging deprecation warnings.
   class Deprecation < ::ActiveSupport::Deprecation
-
     def initialize
       # Per change policy, deprecations will be removed in the next major version.
-      deprecation_horizon = "#{Mongoid::VERSION.split('.').first.to_i + 1}.0".freeze
+      deprecation_horizon = "#{Mongoid::VERSION.split('.').first.to_i + 1}.0"
       gem_name = 'Mongoid'
       super(deprecation_horizon, gem_name)
     end
 
-
     # Overrides default ActiveSupport::Deprecation behavior
     # to use Mongoid's logger.
     #
     # @return [ Array<Proc> ] The deprecation behavior.
     def behavior
-      @behavior ||= Array(->(*args) {
+      @behavior ||= Array(lambda { |*args|
         logger = Mongoid.logger
         logger.warn(args[0])
         logger.debug(args[1].join("\n  ")) if debug

data/lib/mongoid/document.rb

@@ -409,7 +409,7 @@ module Mongoid
       # @api private
       def instantiate_document(attrs = nil, selected_fields = nil, options = {}, &block)
         execute_callbacks = options.fetch(:execute_callbacks, Threaded.execute_callbacks?)
-        attributes = attrs&.to_h || {}
+        attributes = attrs.to_h
 
         doc = allocate
         doc.__selected_fields = selected_fields

data/lib/mongoid/encryptable.rb

@@ -1,4 +1,3 @@
-# rubocop:todo all
 module Mongoid
   # This module is used to extend Mongoid::Document
   # to add encryption functionality.
@@ -37,6 +36,52 @@ module Mongoid
         !encrypt_metadata.empty? || fields.any? { |_, field| field.is_a?(Mongoid::Fields::Encrypted) }
       end
 
+      # Whether an encryption schema has to be generated for this model.
+      #
+      # True when the model declares encryption itself, and also when any model
+      # reachable through its embeds_one relations does. A model in the second
+      # group has no encrypted field of its own, but its collection still needs
+      # a schema, otherwise the embedded fields are written in plaintext.
+      #
+      # The answer is memoized, since this runs on the persistence path.
+      # Declaring encryption on a model after it has already been persisted is
+      # not supported.
+      #
+      # @return [ true | false ] Whether the model needs an encryption schema.
+      #
+      # @api private
+      def requires_encryption_schema?
+        return @requires_encryption_schema if defined?(@requires_encryption_schema)
+
+        @requires_encryption_schema = encrypted? || embeds_encrypted?([ self ])
+      end
+
+      # Whether any model reachable through this model's embeds_one relations
+      # declares encryption.
+      #
+      # embeds_many is not considered: libmongocrypt cannot express per-field
+      # encryption under array items, so those fields are never mapped.
+      #
+      # @param [ Array<Class> ] path The models the walk is already inside of.
+      #   A model embedding itself terminates here.
+      #
+      # @return [ true | false ] Whether an embedded model is encrypted.
+      #
+      # @api private
+      def embeds_encrypted?(path)
+        relations.each_value.any? do |relation|
+          next false unless relation.is_a?(Association::Embedded::EmbedsOne)
+
+          klass = relation.try_relation_class
+          # An association target does not have to be a Mongoid document, and
+          # the class it names does not have to exist.
+          next false unless klass.respond_to?(:encrypted?)
+          next false if path.include?(klass)
+
+          klass.encrypted? || klass.embeds_encrypted?(path + [ klass ])
+        end
+      end
+
       # Override the key_id for the model.
       #
       # This method is solely for testing purposes and should not be used in
@@ -46,7 +91,7 @@ module Mongoid
       #
       # @api private
       def set_key_id(key_id)
-        self.encrypt_metadata[:key_id] = key_id
+        encrypt_metadata[:key_id] = key_id
       end
     end
   end

data/lib/mongoid/equality.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # This module contains the behavior of Mongoid's clone/dup of documents.
   module Equality
     # Leave the current contents of this module outside of InstanceMethods
@@ -19,7 +17,8 @@ module Mongoid
     # @return [ Integer ] -1, 0, 1.
     def <=>(other)
       return super unless other.is_a?(Mongoid::Equality)
-      attributes["_id"].to_s <=> other.attributes["_id"].to_s
+
+      attributes['_id'].to_s <=> other.attributes['_id'].to_s
     end
 
     # Performs equality checking on the document ids. For more robust
@@ -33,7 +32,7 @@ module Mongoid
     # @return [ true | false ] True if the ids are equal, false if not.
     def ==(other)
       self.class == other.class &&
-          attributes["_id"] == other.attributes["_id"]
+        attributes['_id'] == other.attributes['_id']
     end
 
     # Delegates to ==. Used when needing checks in hashes.
@@ -45,7 +44,7 @@ module Mongoid
     #
     # @return [ true | false ] True if equal, false if not.
     def eql?(other)
-      self == (other)
+      self == other
     end
 
     module ClassMethods

data/lib/mongoid/errors/ambiguous_relationship.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Errors
-
     # This error is raised in case of an ambiguous association.
     #
     # @example An ambiguous association.
@@ -21,7 +19,6 @@ module Mongoid
     #     belongs_to :referred_by, class_name: "Person"
     #   end
     class AmbiguousRelationship < MongoidError
-
       # Create the new error.
       #
       # @example Create the error.
@@ -36,12 +33,12 @@ module Mongoid
       def initialize(klass, inverse, name, candidates)
         super(
           compose_message(
-            "ambiguous_relationship",
+            'ambiguous_relationship',
             {
               klass: klass,
               inverse: inverse,
               name: name.inspect,
-              candidates: candidates.map(&:inspect).join(", ")
+              candidates: candidates.map(&:inspect).join(', ')
             }
           )
         )

data/lib/mongoid/errors/attribute_not_loaded.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Errors
-
     # Raised when attempting to read or write an attribute which has
     # not been loaded. This can occur when using `.only` or `.without`
     # query projection methods.
@@ -16,7 +14,6 @@ module Mongoid
     #   Band.without(:label).first.label = 'Sub Pop Records'
     #   #=> raises Mongoid::Errors::AttributeNotLoaded
     class AttributeNotLoaded < MongoidError
-
       # Create the new error.
       #
       # @example Instantiate the error.
@@ -26,7 +23,7 @@ module Mongoid
       # @param [ String | Symbol ] name The name of the attribute.
       def initialize(klass, name)
         super(
-          compose_message("attribute_not_loaded", { klass: klass.name, name: name })
+          compose_message('attribute_not_loaded', { klass: klass.name, name: name })
         )
       end
     end

data/lib/mongoid/errors/callback.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Errors
-
     # This error is raised when calling #save! or .create! on a model when one
     # of the callbacks returns false.
     class Callback < MongoidError
-
       # Create the new callbacks error.
       #
       # @example Create the new callbacks error.
@@ -17,7 +14,7 @@ module Mongoid
       # @param [ Symbol ] method The name of the method.
       def initialize(klass, method)
         super(
-          compose_message("callbacks", { klass: klass, method: method })
+          compose_message('callbacks', { klass: klass, method: method })
         )
       end
     end

data/lib/mongoid/errors/config_redactor.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+    # Redacts credentials from a client configuration hash before it is
+    # interpolated into an exception message.
+    module ConfigRedactor
+      extend self
+
+      REDACTED = '[REDACTED]'
+
+      # Top-level keys whose values should be replaced wholesale.
+      SENSITIVE_KEYS = %w[password auto_encryption_options].freeze
+
+      # Match the userinfo portion of a MongoDB connection string.
+      URI_USERINFO = %r{\A(mongodb(?:\+srv)?://)[^@/]+@}.freeze
+
+      # Return a copy of the given config hash with sensitive values redacted.
+      # Recurses into nested hashes so that, e.g., `:options =>
+      # { :auto_encryption_options => ... }` is also covered. Non-hash inputs
+      # are returned unchanged.
+      def redact(config)
+        return config unless config.is_a?(Hash)
+
+        config.each_with_object({}) do |(key, value), result|
+          result[key] = redact_value(key, value)
+        end
+      end
+
+      def redact_value(key, value)
+        if SENSITIVE_KEYS.include?(key.to_s)
+          REDACTED
+        elsif key.to_s == 'uri' && value.is_a?(String)
+          value.sub(URI_USERINFO, "\\1#{REDACTED}@")
+        elsif value.is_a?(Hash)
+          redact(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end