mongoid 6.4.8 → 7.5.4

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Validatable
 
@@ -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
 
@@ -78,8 +75,6 @@ module Mongoid
       #   validator.case_sensitive?
       #
       # @return [ true, false ] If the validation is case sensitive.
-      #
-      # @since 2.3.0
       def case_sensitive?
         !(options[:case_sensitive] == false)
       end
@@ -97,11 +92,23 @@ module Mongoid
       # @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)
 
@@ -145,10 +150,8 @@ module Mongoid
       # @param [ Object ] value The value to filter.
       #
       # @return [ Object, Regexp ] The value, filtered or not.
-      #
-      # @since 2.3.0
       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)
@@ -182,8 +183,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the validation should be skipped.
-      #
-      # @since 2.3.0
       def skip_validation?(document)
         !document._parent || document.embedded_one?
       end
@@ -198,8 +197,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the scope reference has changed.
-      #
-      # @since
       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,12 +218,10 @@ 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)
-        metadata = document.relations[attribute.to_s]
-        if metadata && metadata.stores_foreign_key?
-          [ metadata.foreign_key, value && value._id ]
+        association = document.relations[attribute.to_s]
+        if association && association.stores_foreign_key?
+          [ association.foreign_key, value && value._id ]
         else
           [ attribute, value ]
         end
@@ -242,11 +237,9 @@ 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.metadata_name)
+        relation = document._parent.send(document.association_name)
         criteria = create_criteria(relation, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
         add_error(document, attribute, value) if criteria.count > 1
@@ -262,8 +255,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
 
@@ -287,8 +278,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If we need to validate.
-      #
-      # @since 2.4.4
       def validation_required?(document, attribute)
         document.new_record? ||
           document.send("attribute_changed?", attribute.to_s) ||
@@ -306,8 +295,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If the attribute is localized.
-      #
-      # @since 4.0.0
       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
@@ -48,24 +45,20 @@ module Mongoid
     # @param [ Hash ] options The options to check.
     #
     # @return [ true, false ] If we are validating.
-    #
-    # @since 4.0.0
     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.
-    #
-    # @return [ Object ] The value of the field or the relation.
+    # @param [ Symbol ] attr The name of the field or association.
     #
-    # @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)
@@ -91,8 +84,6 @@ module Mongoid
     # @param [ Symbol ] context The optional validation context.
     #
     # @return [ true, false ] True if valid, false if not.
-    #
-    # @since 2.0.0.rc.6
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -103,8 +94,6 @@ module Mongoid
     #   document.validated?
     #
     # @return [ true, false ] Has the document already been validated?
-    #
-    # @since 2.0.0.rc.2
     def validated?
       Threaded.validated?(self)
     end
@@ -115,30 +104,26 @@ module Mongoid
     #   document.validating_with_query?
     #
     # @return [ true, false ] If we are validating with a query.
-    #
-    # @since 3.0.2
     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(metadata)
-      #
-      # @param [ Metadata ] metadata The relation metadata.
+      #   Person.validates_relation(association)
       #
-      # @since 2.0.0.rc.1
-      def validates_relation(metadata)
-        if metadata.validate?
-          validates_associated(metadata.name)
+      # @param [ Association ] association The association metadata.
+      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.
@@ -149,14 +134,12 @@ module Mongoid
       # @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|
-            metadata = relations[name.to_s]
-            if metadata && metadata[:autosave] != false
-              autosave(metadata.merge!(autosave: true))
+            association = relations[name.to_s]
+            if association && association.autosave?
+              Association::Referenced::AutoSave.define_autosave!(association)
             end
           end
         end
@@ -169,8 +152,6 @@ module Mongoid
       #   Model.validating_with_query?
       #
       # @return [ true, false ] If we are validating with a query.
-      #
-      # @since 3.0.2
       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 = "6.4.8"
+  VERSION = "7.5.4"
 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

@@ -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"
@@ -13,6 +13,7 @@ require "active_support/time_with_zone"
 require "active_model"
 
 require "mongo"
+require 'mongo/active_support'
 
 require "mongoid/version"
 require "mongoid/config"
@@ -22,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.
@@ -33,12 +35,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,11 +50,14 @@ 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.
-  #
-  # @since 1.0.0
   def configure
     block_given? ? yield(Config) : Config
   end
@@ -64,8 +68,6 @@ module Mongoid
   #   Mongoid.default_client
   #
   # @return [ Mongo::Client ] The default client.
-  #
-  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -76,8 +78,6 @@ module Mongoid
   #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -88,8 +88,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 +97,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

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

@@ -3,7 +3,11 @@ development:
   clients:
     # Defines the default client. (required)
     default:
-      # Defines the name of the default database that Mongoid can connect to.
+      # Mongoid can connect to a URI accepted by the driver:
+      # uri: mongodb://user:password@mongodb.domain.com:27017/<%= database_name || app_name %>_development
+
+      # Otherwise define the parameters separately.
+      # This defines the name of the default database that Mongoid can connect to.
       # (required).
       database: <%= database_name || app_name %>_development
       # Provides the hosts the default client can connect to. Must be an array
@@ -53,7 +57,7 @@ development:
         # connect: :direct
 
         # Changes the default time in seconds the server monitors refresh their status
-        # via ismaster commands. (default: 10)
+        # via hello commands. (default: 10)
         # heartbeat_frequency: 10
 
         # The time in seconds for selecting servers for a near read preference. (default: 0.015)
@@ -73,11 +77,16 @@ development:
         # wait_queue_timeout: 5
 
         # The time to wait to establish a connection before timing out, in seconds.
-        # (default: 5)
-        # connect_timeout: 5
-
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
+        # (default: 10)
+        # connect_timeout: 10
+
+        # How long to wait for a response for each operation sent to the
+        # server. This timeout should be set to a value larger than the
+        # processing time for the longest operation that will be executed
+        # by the application. Note that this is a client-side timeout;
+        # the server may continue executing an operation after the client
+        # aborts it with the SocketTimeout exception.
+        # (default: nil, meaning no timeout)
         # socket_timeout: 5
 
         # The name of the replica set to connect to. Servers provided as seeds that do
@@ -98,22 +107,46 @@ development:
         # A passphrase for the private key.
         # ssl_key_pass_phrase: password
 
-        # Whether or not to do peer certification validation. (default: true)
+        # Whether to do peer certification validation. (default: true)
         # ssl_verify: true
 
-        # The file containing a set of concatenated certification authority certifications
+        # The file containing concatenated certificate authority certificates
         # used to validate certs passed from the other end of the connection.
         # ssl_ca_cert: /path/to/ca.cert
-
+        
+        # Whether to truncate long log lines. (default: true)
+        # truncate_logs: true
 
   # Configure Mongoid specific options. (optional)
   options:
-    # Includes the root model name in json serialization. (default: false)
+    # Application name that is printed to the mongodb logs upon establishing
+    # a connection in server versions >= 3.4. Note that the name cannot
+    # exceed 128 bytes. It is also used as the database name if the
+    # database name is not explicitly defined. (default: nil)
+    # app_name: MyApplicationName
+    
+    # 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)
+    # belongs_to_required_by_default: true
+    
+    # Raise an exception when a field is redefined. (default: false)
+    # duplicate_fields_exception: false
+    
+    # Include the root model name in json serialization. (default: false)
     # include_root_in_json: false
 
     # Include the _type field in serialization. (default: false)
     # include_type_for_serialization: false
 
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default. (default: false)
+    # join_contexts: false
+
+    # Set the Mongoid and Ruby driver log levels when Mongoid is not using
+    # Ruby on Rails logger instance. (default: :info)
+    # log_level: :info
+    
     # Preload all models in development, needed when models use
     # inheritance. (default: false)
     # preload_models: false
@@ -126,29 +159,20 @@ development:
     # existing method. (default: false)
     # scope_overwrite_exception: false
 
-    # Raise an error when defining a field with the same name as an
-    # existing method. (default: false)
-    # duplicate_fields_exception: false
-
-    # Use Active Support's time zone in conversions. (default: true)
+    # Use ActiveSupport's time zone in time operations instead of
+    # the Ruby default time zone. See the time zone section below for
+    # further information. (default: true)
     # use_activesupport_time_zone: true
 
-    # Ensure all times are UTC in the app side. (default: false)
+    # Return stored times as UTC. See the time zone section below for
+    # further information. Most applications should not use this option.
+    # (default: false)
     # use_utc: false
 
-    # Set the Mongoid and Ruby driver log levels when not in a Rails
-    # environment. The Mongoid logger will be set to the Rails logger
-    # otherwise.(default: :info)
-    # log_level: :info
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    # background_indexing: false
 
-    # Control whether `belongs_to` association is required. By default
-    # `belongs_to` will trigger a validation error if the association
-    # is not present. (default: true)
-    # belongs_to_required_by_default: true
-
-    # Application name that is printed to the mongodb logs upon establishing a
-    # connection in server versions >= 3.4. Note that the name cannot exceed 128 bytes.
-    # app_name: MyApplicationName
 test:
   clients:
     default:

data/lib/rails/generators/mongoid/model/model_generator.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails/generators/mongoid_generator"
 
 module Mongoid
@@ -10,7 +11,7 @@ module Mongoid
 
       check_class_collision
 
-      class_option :timestamps, type: :boolean
+      class_option :timestamps, type: :boolean, default: true
       class_option :parent,     type: :string, desc: "The parent class for the generated model"
       class_option :collection, type: :string, desc: "The collection for storing model's documents"
 

data/lib/rails/generators/mongoid/model/templates/model.rb.tt

@@ -13,7 +13,7 @@ class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent]
   field :<%= attribute.name %>, type: <%= attribute.type_class %>
 <% end -%>
 <% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
-  embedded_in :<%= attribute.name%>
+  belongs_to :<%= attribute.name%>
 <% end -%>
 end
 <% end -%>

data/lib/rails/generators/mongoid_generator.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails/generators/named_base"
 require "rails/generators/active_model"
 

data/lib/rails/mongoid.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Rails
   module Mongoid
     extend self
@@ -40,16 +41,14 @@ module Rails
     # method as a convenience.
     #
     # @example Load the model.
-    #   Mongoid.load_model("/mongoid/behaviour")
+    #   Mongoid.load_model("/mongoid/behavior")
     #
     # @param [ String ] file The base filename.
-    #
-    # @since 2.0.0.rc.3
     def load_model(file)
       begin
         require_dependency(file)
       rescue Exception => e
-        Logger.new($stdout).warn(e.message)
+        Logger.new(STDERR).warn(e.message)
       end
     end
   end