mongoid 7.0.2 → 8.1.1

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Validatable
 
@@ -15,7 +16,7 @@ module Mongoid
     #   end
     #
     # It is also possible to limit the uniqueness constraint to a set of
-    # records matching certain conditions:
+    # documents matching certain conditions:
     #   class Person
     #     include Mongoid::Document
     #     field :title
@@ -36,8 +37,6 @@ module Mongoid
       # @param [ Object ] value The value of the field.
       #
       # @return [ Errors ] The errors.
-      #
-      # @since 1.0.0
       def validate_each(document, attribute, value)
         with_query(document) do
           attrib, val = to_validate(document, attribute, value)
@@ -62,11 +61,9 @@ module Mongoid
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The name of the attribute.
       # @param [ Object ] value The value of the object.
-      #
-      # @since 2.4.10
       def add_error(document, attribute, value)
         document.errors.add(
-          attribute, :taken, options.except(:case_sensitive, :scope).merge(value: value)
+          attribute, :taken, **options.except(:case_sensitive, :scope).merge(value: value)
         )
       end
 
@@ -77,9 +74,7 @@ module Mongoid
       # @example Is the validation case sensitive?
       #   validator.case_sensitive?
       #
-      # @return [ true, false ] If the validation is case sensitive.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the validation is case sensitive.
       def case_sensitive?
         !(options[:case_sensitive] == false)
       end
@@ -91,17 +86,29 @@ module Mongoid
       # @example Create the criteria.
       #   validator.create_criteria(User, user, :name, "syd")
       #
-      # @param [ Class, Proxy ] base The base to execute the criteria from.
+      # @param [ Class | Proxy ] base The base to execute the criteria from.
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The name of the attribute.
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 2.4.10
       def create_criteria(base, document, attribute, value)
         criteria = scope(base.unscoped, document, attribute)
-        criteria.selector.update(criterion(document, attribute, value.mongoize))
+        field = document.fields[document.database_field_name(attribute)]
+
+        # In the past, we were calling value.mongoize in all cases, which
+        # would call Object's mongoize method. This is a problem for StringifiedSymbol,
+        # because a Symbol should mongoize to a String, but calling .mongoize
+        # on a Symbol mongoizes it to a Symbol.
+        # Therefore, we call the field's mongoize in all cases except when the
+        # field is localized, because by the time we arrive at this code, the
+        # value is already in the form of { lang => translation } and calling
+        # the field's mongoize will nest that further into { lang =>
+        # "\{ lang => translation \}"} (assuming the field type is a string).
+        # Therefore, we call Object's mongoize method so it returns the hash as
+        # it is.
+        mongoized = field.try(:localized?) ? value.mongoize : field.mongoize(value)
+        criteria.selector.update(criterion(document, attribute, mongoized))
         criteria
       end
 
@@ -117,8 +124,6 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The uniqueness criteria.
-      #
-      # @since 2.3.0
       def criterion(document, attribute, value)
         field = document.database_field_name(attribute)
 
@@ -144,11 +149,9 @@ module Mongoid
       #
       # @param [ Object ] value The value to filter.
       #
-      # @return [ Object, Regexp ] The value, filtered or not.
-      #
-      # @since 2.3.0
+      # @return [ Object | Regexp ] The value, filtered or not.
       def filter(value)
-        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}$/i : value
+        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
 
       # Scope the criteria to the scope options provided.
@@ -162,8 +165,6 @@ module Mongoid
       # @param [ Document ] document The document being validated.
       #
       # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 2.3.0
       def scope(criteria, document, _attribute)
         Array.wrap(options[:scope]).each do |item|
           name = document.database_field_name(item)
@@ -181,9 +182,7 @@ module Mongoid
       #
       # @param [ Document ] document The embedded document.
       #
-      # @return [ true, false ] If the validation should be skipped.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the validation should be skipped.
       def skip_validation?(document)
         !document._parent || document.embedded_one?
       end
@@ -197,9 +196,7 @@ module Mongoid
       #
       # @param [ Document ] document The embedded document.
       #
-      # @return [ true, false ] If the scope reference has changed.
-      #
-      # @since
+      # @return [ true | false ] If the scope reference has changed.
       def scope_value_changed?(document)
         Array.wrap(options[:scope]).any? do |item|
           document.send("attribute_changed?", item.to_s)
@@ -207,8 +204,8 @@ module Mongoid
       end
 
       # Get the name of the field and the value to validate. This is for the
-      # case when we validate a relation via the relation name and not the key,
-      # we need to send the key name and value to the db, not the relation
+      # case when we validate an association via the association name and not the key,
+      # we need to send the key name and value to the db, not the association
       # object.
       #
       # @api private
@@ -221,8 +218,6 @@ module Mongoid
       # @param [ Object ] value The value of the attribute.
       #
       # @return [ Array<Object, Object> ] The field and value.
-      #
-      # @since 2.4.4
       def to_validate(document, attribute, value)
         association = document.relations[attribute.to_s]
         if association && association.stores_foreign_key?
@@ -242,13 +237,12 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_embedded(document, attribute, value)
         return if skip_validation?(document)
         relation = document._parent.send(document.association_name)
         criteria = create_criteria(relation, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
+        criteria = criteria.limit(2)
         add_error(document, attribute, value) if criteria.count > 1
       end
 
@@ -262,8 +256,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_root(document, attribute, value)
         klass = document.class
 
@@ -286,9 +278,7 @@ module Mongoid
       # @param [ Document ] document The document getting validated.
       # @param [ Symbol ] attribute The attribute to validate.
       #
-      # @return [ true, false ] If we need to validate.
-      #
-      # @since 2.4.4
+      # @return [ true | false ] If we need to validate.
       def validation_required?(document, attribute)
         document.new_record? ||
           document.send("attribute_changed?", attribute.to_s) ||
@@ -305,9 +295,7 @@ module Mongoid
       # @param [ Document ] document The document getting validated.
       # @param [ Symbol ] attribute The attribute to validate.
       #
-      # @return [ true, false ] If the attribute is localized.
-      #
-      # @since 4.0.0
+      # @return [ true | false ] If the attribute is localized.
       def localized?(document, attribute)
         document.fields[document.database_field_name(attribute)].try(:localized?)
       end

data/lib/mongoid/validatable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/validatable/macros"
 require "mongoid/validatable/localizable"
 require "mongoid/validatable/associated"
@@ -24,8 +25,6 @@ module Mongoid
     #
     # @example Begin validation.
     #   document.begin_validate
-    #
-    # @since 2.1.9
     def begin_validate
       Threaded.begin_validate(self)
     end
@@ -34,8 +33,6 @@ module Mongoid
     #
     # @example Exit validation.
     #   document.exit_validate
-    #
-    # @since 2.1.9
     def exit_validate
       Threaded.exit_validate(self)
     end
@@ -47,25 +44,23 @@ module Mongoid
     #
     # @param [ Hash ] options The options to check.
     #
-    # @return [ true, false ] If we are validating.
+    # @option options [ true | false ] :validate Whether or not to validate.
     #
-    # @since 4.0.0
+    # @return [ true | false ] If we are validating.
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
     end
 
-    # Overrides the default ActiveModel behaviour since we need to handle
-    # validations of relations slightly different than just calling the
+    # Overrides the default ActiveModel behavior since we need to handle
+    # validations of associations slightly different than just calling the
     # getter.
     #
     # @example Read the value.
     #   person.read_attribute_for_validation(:addresses)
     #
-    # @param [ Symbol ] attr The name of the field or relation.
+    # @param [ Symbol ] attr The name of the field or association.
     #
-    # @return [ Object ] The value of the field or the relation.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ Object ] The value of the field or the association.
     def read_attribute_for_validation(attr)
       attribute = database_field_name(attr)
       if relations.key?(attribute)
@@ -90,9 +85,7 @@ module Mongoid
     #
     # @param [ Symbol ] context The optional validation context.
     #
-    # @return [ true, false ] True if valid, false if not.
-    #
-    # @since 2.0.0.rc.6
+    # @return [ true | false ] True if valid, false if not.
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -102,9 +95,7 @@ module Mongoid
     # @example Is the document validated?
     #   document.validated?
     #
-    # @return [ true, false ] Has the document already been validated?
-    #
-    # @since 2.0.0.rc.2
+    # @return [ true | false ] Has the document already been validated?
     def validated?
       Threaded.validated?(self)
     end
@@ -114,43 +105,38 @@ module Mongoid
     # @example Are we validating with a query?
     #   document.validating_with_query?
     #
-    # @return [ true, false ] If we are validating with a query.
-    #
-    # @since 3.0.2
+    # @return [ true | false ] If we are validating with a query.
     def validating_with_query?
       self.class.validating_with_query?
     end
 
     module ClassMethods
 
-      # Adds an associated validator for the relation if the validate option
+      # Adds an associated validator for the association if the validate option
       # was not provided or set to true.
       #
       # @example Set up validation.
       #   Person.validates_relation(association)
       #
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def validates_relation(association)
         if association.validate?
           validates_associated(association.name)
         end
       end
 
-      # Add validation with the supplied validators forthe provided fields
+      # Add validation with the supplied validators for the provided fields
       # with options.
       #
       # @example Validate with a specific validator.
       #   validates_with MyValidator, on: :create
       #
-      # @param [ Class<Array>, Hash ] args The validator classes and options.
+      # @param [ ActiveModel::Validator..., Hash ] *args The validator classes
+      #   and options hash.
       #
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is
       #   added.
-      #
-      # @since 3.0.0
       def validates_with(*args, &block)
         if args.first == PresenceValidator
           args.last[:attributes].each do |name|
@@ -168,9 +154,7 @@ module Mongoid
       # @example Are we validating with a query?
       #   Model.validating_with_query?
       #
-      # @return [ true, false ] If we are validating with a query.
-      #
-      # @since 3.0.2
+      # @return [ true | false ] If we are validating with a query.
       def validating_with_query?
         Threaded.executing?("#{name}-validate-with-query")
       end

data/lib/mongoid/version.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
-  VERSION = "7.0.2"
+  VERSION = "8.1.1"
 end

data/lib/mongoid/warnings.rb

@@ -0,0 +1,44 @@
+# 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 :geo_haystack_deprecated, 'The geoHaystack type is deprecated.'
+    warning :as_json_compact_deprecated, '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
+    warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
+    warning :legacy_readonly, 'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
+    warning :use_activesupport_time_zone_deprecated, 'Config option :use_activesupport_time_zone is deprecated and should be removed from your config. It will always be true beginning in Mongoid 9.0.'
+    warning :broken_aggregables_deprecated, 'Config option :broken_aggregables is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_alias_handling_deprecated, 'Config option :broken_alias_handling is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_and_deprecated, 'Config option :broken_and is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_scoping_deprecated, 'Config option :broken_scoping is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :broken_updates_deprecated, 'Config option :broken_updates is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :compare_time_by_ms_deprecated, 'Config option :compare_time_by_ms is deprecated. It will always be true beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_attributes_deprecated, 'Config option :legacy_attributes is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_pluck_distinct_deprecated, 'Config option :legacy_pluck_distinct is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :legacy_triple_equals_deprecated, 'Config option :legacy_triple_equals is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :object_id_as_json_oid_deprecated, 'Config option :object_id_as_json_oid is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :overwrite_chained_operators_deprecated, 'Config option :overwrite_chained_operators is deprecated. It will always be false beginning in Mongoid 9.0. Please use load_defaults for Mongoid 8.0 or later, then remove it from your config.'
+    warning :mutable_ids, 'In Mongoid 9.0 the _id field will be immutable. In earlier versions of 8.x, mutating the _id field was supported inconsistently. Prepare your code for 9.0 by setting Mongoid::Config.immutable_ids to true.'
+    warning :mongoid_query_cache, 'In Mongoid 9.0, Mongoid::QueryCache will be removed. Please replace it with Mongo::QueryCache.'
+    warning :mongoid_query_cache_clear, 'In Mongoid 9.0, Mongoid::QueryCache#clear_cache should be replaced it with Mongo::QueryCache#clear.'
+  end
+end

data/lib/mongoid.rb

@@ -1,9 +1,9 @@
-# encoding: utf-8
-require "support/ruby_version"
+# frozen_string_literal: true
 
-require "delegate"
+require "forwardable"
 require "time"
 require "set"
+require "ruby2_keywords"
 
 require "active_support"
 require "active_support/core_ext"
@@ -12,9 +12,13 @@ require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
 
+require 'concurrent-ruby'
+
 require "mongo"
+require "mongo/active_support"
 
 require "mongoid/version"
+require "mongoid/deprecable"
 require "mongoid/config"
 require "mongoid/persistence_context"
 require "mongoid/loggable"
@@ -22,6 +26,8 @@ require "mongoid/clients"
 require "mongoid/document"
 require "mongoid/tasks/database"
 require "mongoid/query_cache"
+require "mongoid/warnings"
+require "mongoid/utils"
 
 # If we are using Rails then we will include the Mongoid railtie. This has all
 # the nifty initializers that Mongoid needs.
@@ -33,12 +39,11 @@ end
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid
+  extend Forwardable
   extend Loggable
   extend self
 
   # A string added to the platform details of Ruby driver client handshake documents.
-  #
-  # @since 6.1.0
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
@@ -49,13 +54,26 @@ module Mongoid
   # @example Set up configuration options.
   #   Mongoid.configure do |config|
   #     config.connect_to("mongoid_test")
+  #
+  #     config.clients.default = {
+  #       hosts: ["localhost:27017"],
+  #       database: "mongoid_test",
+  #     }
   #   end
   #
-  # @return [ Config ] The configuration object.
+  # @example Using a block without an argument. Use `config` inside
+  #   the block to perform variable assignment.
+  #
+  #   Mongoid.configure do
+  #     connect_to("mongoid_test")
   #
-  # @since 1.0.0
-  def configure
-    block_given? ? yield(Config) : Config
+  #     config.preload_models = true
+  #
+  # @return [ Config ] The configuration object.
+  def configure(&block)
+    return Config unless block_given?
+
+    block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
   end
 
   # Convenience method for getting the default client.
@@ -64,8 +82,6 @@ module Mongoid
   #   Mongoid.default_client
   #
   # @return [ Mongo::Client ] The default client.
-  #
-  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -76,8 +92,6 @@ module Mongoid
   #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -88,8 +102,6 @@ module Mongoid
   #   Mongoid.client(:default)
   #
   # @return [ Mongo::Client ] The named client.
-  #
-  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end
@@ -99,7 +111,28 @@ module Mongoid
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
+  def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
+
+
+  # Module used to prepend the discriminator key assignment function to change
+  # the value assigned to the discriminator key to a string.
   #
-  # @since 1.0.0
-  delegate(*(Config.public_instance_methods(false) - [ :logger=, :logger ] << { to: Config }))
+  # @api private
+  module GlobalDiscriminatorKeyAssignment
+    # This class is used for obtaining the method definition location for
+    # Mongoid methods.
+    class InvalidFieldHost
+      include Mongoid::Document
+    end
+
+    def discriminator_key=(value)
+      Mongoid::Fields::Validators::Macro.validate_field_name(InvalidFieldHost, value)
+      value = value.to_s
+      super
+    end
+  end
+
+  class << self
+    prepend GlobalDiscriminatorKeyAssignment
+  end
 end

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'rails/generators/mongoid_generator'
 
 module Mongoid
@@ -13,7 +14,14 @@ module Mongoid
       end
 
       def app_name
-        Rails::Application.subclasses.first.parent.to_s.underscore
+        app_cls = Rails.application.class
+        parent = begin
+          # Rails 6.1+
+          app_cls.module_parent_name
+        rescue NoMethodError
+          app_cls.parent.to_s
+        end
+        parent.underscore
       end
 
       def create_config_file