mongoid 8.1.5 → 9.0.0

data/lib/mongoid/validatable/queryable.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Validatable
+
+    # Mixin module included in Mongoid::Validatable::Uniqueness class
+    # when ensures that the persistence context is cleared when
+    # executing uniqueness queries.
+    #
+    # @todo Move this into the Mongoid::Validatable::Uniqueness class.
+    #
+    # @api private
     module Queryable
 
       # Wrap the validation inside the an execution block that alert's the

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Validatable
@@ -242,7 +243,7 @@ module Mongoid
         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)
+        criteria = criteria.read(mode: :primary).limit(2)
         add_error(document, attribute, value) if criteria.count > 1
       end
 

data/lib/mongoid/validatable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/validatable/macros"
 require "mongoid/validatable/localizable"
@@ -75,7 +76,7 @@ module Mongoid
         begin_validate
         relation = without_autobuild { send(attr) }
         exit_validate
-        relation.do_or_do_not(:in_memory) || relation
+        relation.try(:in_memory) || relation
       elsif fields[attribute].try(:localized?)
         attributes[attribute]
       else
@@ -126,7 +127,7 @@ module Mongoid
       # @example Set up validation.
       #   Person.validates_relation(association)
       #
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       def validates_relation(association)
         if association.validate?
           validates_associated(association.name)

data/lib/mongoid/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
-  VERSION = "8.1.5"
+  VERSION = "9.0.0"
 end

data/lib/mongoid/warnings.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
 
@@ -9,6 +10,13 @@ module Mongoid
   module Warnings
 
     class << self
+
+      # Define a warning message method for the given id.
+      #
+      # @param [ Symbol ] id The warning identifier.
+      # @param [ String ] message The warning message.
+      #
+      # @api private
       def warning(id, message)
         singleton_class.class_eval do
           define_method("warn_#{id}") do
@@ -22,23 +30,8 @@ module Mongoid
     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.'
+    warning :mutable_ids, 'Ignoring updates to immutable attribute `_id`. Please set Mongoid::Config.immutable_ids to true and update your code so that `_id` is never updated.'
   end
 end

data/lib/mongoid.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "forwardable"
 require "time"
 require "set"
-require "ruby2_keywords"
 
 require "active_support"
 require "active_support/core_ext"
@@ -21,27 +21,31 @@ require "mongoid/version"
 require "mongoid/deprecable"
 require "mongoid/config"
 require "mongoid/persistence_context"
+require "mongoid/loadable"
 require "mongoid/loggable"
 require "mongoid/clients"
 require "mongoid/document"
 require "mongoid/tasks/database"
-require "mongoid/query_cache"
+require "mongoid/tasks/encryption"
 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.
+# If we are using Rails then we will include the Mongoid railtie.
+# This configures initializers required to integrate Mongoid with Rails.
 if defined?(Rails)
   require "mongoid/railtie"
 end
 
-# add english load path by default
+# Add English locale config to load path by default.
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
+# Top-level module for project.
 module Mongoid
   extend Forwardable
   extend Loggable
+  extend Loadable
   extend self
+  extend Clients::Sessions::ClassMethods
 
   # A string added to the platform details of Ruby driver client handshake documents.
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
@@ -96,6 +100,16 @@ module Mongoid
     Clients.disconnect
   end
 
+  # Reconnect all active clients.
+  #
+  # @example Reconnect all active clients.
+  #   Mongoid.reconnect_clients
+  #
+  # @return [ true ] True.
+  def reconnect_clients
+    Clients.reconnect
+  end
+
   # Convenience method for getting a named client.
   #
   # @example Get a named client.
@@ -113,18 +127,37 @@ module Mongoid
   #   Mongoid.database = Mongo::Connection.new.db("test")
   def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
 
+  # Define persistence context that is used when a transaction method is called
+  # on Mongoid module.
+  #
+  # @api private
+  def persistence_context
+    PersistenceContext.get(Mongoid) || PersistenceContext.new(Mongoid)
+  end
+
+  # Define client that is used when a transaction method is called
+  # on Mongoid module. This MUST be the default client.
+  #
+  # @api private
+  def storage_options
+    { client: :default }
+  end
 
   # Module used to prepend the discriminator key assignment function to change
   # the value assigned to the discriminator key to a string.
   #
   # @api private
   module GlobalDiscriminatorKeyAssignment
+
     # This class is used for obtaining the method definition location for
     # Mongoid methods.
     class InvalidFieldHost
       include Mongoid::Document
     end
 
+    # Sets the global discriminator key name.
+    #
+    # @param [ String | Symbol ] value The new discriminator key name.
     def discriminator_key=(value)
       Mongoid::Fields::Validators::Macro.validate_field_name(InvalidFieldHost, value)
       value = value.to_s

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

@@ -1,19 +1,28 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'rails/generators/mongoid_generator'
 
 module Mongoid
   module Generators
+
+    # Generator class for Mongoid configuration files.
     class ConfigGenerator < Rails::Generators::Base
-      desc "Creates a Mongoid configuration file at config/mongoid.yml"
+      desc "Creates Mongoid configuration files"
 
       argument :database_name, type: :string, optional: true
 
+      # Returns the path to the templates directory.
+      #
+      # @return [ String ] The path.
       def self.source_root
         @_mongoid_source_root ||= File.expand_path("../templates", __FILE__)
       end
 
-      def app_name
+      # Returns the underscored name of the Rails application.
+      #
+      # @return [ String ] The app name.
+      def app_name # :nodoc:
         app_cls = Rails.application.class
         parent = begin
           # Rails 6.1+
@@ -24,10 +33,15 @@ module Mongoid
         parent.underscore
       end
 
+      # Creates a +mongoid.yml+ config file from a template.
       def create_config_file
-        template 'mongoid.yml', File.join('config', "mongoid.yml")
+        template 'mongoid.yml', File.join('config', 'mongoid.yml')
       end
 
+      # Creates a +mongoid.rb+ initializer file from a template.
+      def create_initializer_file
+        template 'mongoid.rb', File.join('config', 'initializers', 'mongoid.rb')
+      end
     end
   end
 end

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

@@ -0,0 +1,25 @@
+# rubocop:todo all
+Mongoid.configure do
+  target_version = "<%= Mongoid::VERSION[/^\d+\.\d+/] %>"
+
+  # Load Mongoid behavior defaults. This automatically sets
+  # features flags (refer to documentation)
+  config.load_defaults target_version
+
+  # It is recommended to use config/mongoid.yml for most Mongoid-related
+  # configuration, whenever possible, but if you prefer, you can set
+  # configuration values here, instead:
+  # 
+  #   config.log_level = :debug
+  #
+  # Note that the settings in config/mongoid.yml always take precedence,
+  # whatever else is set here.
+end
+ 
+# Enable Mongo driver query cache for Rack
+# Rails.application.config.middleware.use(Mongo::QueryCache::Middleware)
+ 
+# Enable Mongo driver query cache for ActiveJob
+# ActiveSupport.on_load(:active_job) do
+#   include Mongo::QueryCache::Middleware::ActiveJob
+# end

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

@@ -18,7 +18,7 @@ development:
         # Note that all options listed below are Ruby driver client options (the mongo gem).
         # Please refer to the driver documentation of the version of the mongo gem you are using
         # for the most up-to-date list of options.
-        #
+
         # Change the default write concern. (default = { w: 1 })
         # write:
         #   w: 1
@@ -41,18 +41,20 @@ development:
         # roles:
         #   - 'dbOwner'
 
-        # Change the default authentication mechanism. Valid options are: :scram,
-        # :mongodb_cr, :mongodb_x509, and :plain. Note that all authentication
-        # mechanisms require username and password, with the exception of :mongodb_x509.
-        # Default on mongoDB 3.0 is :scram, default on 2.4 and 2.6 is :plain.
+        # Change the default authentication mechanism. Valid options include:
+        # :scram, :scram256, :mongodb_cr, :mongodb_x509, :gssapi, :aws, :plain.
+        # MongoDB Server defaults to :scram, which will use "SCRAM-SHA-256" if available,
+        # otherwise fallback to "SCRAM-SHA-1" (:scram256 will always use "SCRAM-SHA-256".)
+        # This setting is handled by the MongoDB Ruby Driver. Please refer to:
+        # https://mongodb.com/docs/ruby-driver/current/reference/authentication/
         # auth_mech: :scram
 
         # The database or source to authenticate the user against.
         # (default: the database specified above or admin)
         # auth_source: admin
 
-        # Force a the driver cluster to behave in a certain manner instead of auto-
-        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
+        # Force the driver cluster to behave in a certain manner instead of auto-discovering.
+        # Can be one of: :direct, :replica_set, :sharded. Set to :direct
         # when connecting to hidden members of a replica set.
         # connect: :direct
 
@@ -93,6 +95,11 @@ development:
         # not belong to this replica set will be ignored.
         # replica_set: name
 
+        # Compressors to use for wire protocol compression. (default is to not use compression)
+        # "zstd" requires zstd-ruby gem. "snappy" requires snappy gem.
+        # Refer to: https://www.mongodb.com/docs/ruby-driver/current/reference/create-client/#compression
+        # compressors: ["zstd", "snappy", "zlib"]
+
         # Whether to connect to the servers via ssl. (default: false)
         # ssl: true
 
@@ -113,65 +120,32 @@ development:
         # 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)
+  # Configure Mongoid-specific options. (optional)
   options:
-    # 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
-
-    # Raise an error when performing a #find and the document is not found.
-    # (default: true)
-    # raise_not_found_error: true
-
-    # Raise an error when defining a scope with the same name as an
-    # existing method. (default: false)
-    # scope_overwrite_exception: false
-
-    # 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
-
-    # 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
-
-    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
-    # indexes in the background by default. (default: false)
-    # background_indexing: false
+<%- Mongoid::Config::Introspection.options.each do |opt| -%>
+    <%= opt.indented_comment(indent: 4) %>
+    # <%= opt.name %>: <%= opt.default %>
+
+<%- end -%>
+  # Configure Driver-specific options. (optional)
+  driver_options:
+    # When this flag is off, an aggregation done on a view will be executed over
+    # the documents included in that view, instead of all documents in the
+    # collection. When this flag is on, the view fiter is ignored.
+    # broken_view_aggregate: true
+
+    # When this flag is set to false, the view options will be correctly
+    # propagated to readable methods.
+    # broken_view_options: true
+
+    # When this flag is set to true, the update and replace methods will
+    # validate the paramters and raise an error if they are invalid.
+    # validate_update_replace: false
+
 
 test:
   clients:

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

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "rails/generators/mongoid_generator"
 
 module Mongoid
   module Generators
+
+    # Generator class for Mongoid model files.
     class ModelGenerator < Base
 
       desc "Creates a Mongoid model"
@@ -15,6 +18,7 @@ module Mongoid
       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"
 
+      # Creates a model file from a template.
       def create_model_file
         template "model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
       end

data/lib/rails/generators/mongoid_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "rails/generators/named_base"
 require "rails/generators/active_model"
 
 module Mongoid
   module Generators
+
+    # Base generator class for adding Mongoid to Rails applications.
     class Base < ::Rails::Generators::NamedBase
 
+      # Returns the path to the templates directory.
+      #
+      # @return [ String ] The path.
       def self.source_root
         @_mongoid_source_root ||=
           File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
@@ -17,7 +23,14 @@ end
 
 module Rails
   module Generators
+
+    # Extension to Rails' GeneratedAttribute class.
     class GeneratedAttribute
+
+      # Returns the Mongoid attribute type value for a given
+      # input class type.
+      #
+      # @return [ String ] The type value.
       def type_class
         return "Time" if type == :datetime
         return "String" if type == :text

data/lib/rails/mongoid.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Rails
+
+  # Mongoid utilities for Rails
   module Mongoid
     extend self
 
@@ -13,18 +16,7 @@ module Rails
     #
     # @param [ Application ] app The rails application.
     def load_models(app)
-      app.config.paths["app/models"].expanded.each do |path|
-        preload = ::Mongoid.preload_models
-        if preload.resizable?
-          files = preload.map { |model| "#{path}/#{model.underscore}.rb" }
-        else
-          files = Dir.glob("#{path}/**/*.rb")
-        end
-
-        files.sort.each do |file|
-          load_model(file.gsub("#{path}/" , "").gsub(".rb", ""))
-        end
-      end
+      ::Mongoid.load_models(app.config.paths["app/models"].expanded)
     end
 
     # Conditionally calls `Rails::Mongoid.load_models(app)` if the
@@ -34,22 +26,5 @@ module Rails
     def preload_models(app)
       load_models(app) if ::Mongoid.preload_models
     end
-
-    private
-
-    # I don't want to mock out kernel for unit testing purposes, so added this
-    # method as a convenience.
-    #
-    # @example Load the model.
-    #   Mongoid.load_model("/mongoid/behavior")
-    #
-    # @param [ String ] file The base filename.
-    def load_model(file)
-      begin
-        require_dependency(file)
-      rescue Exception => e
-        Logger.new(STDERR).warn(e.message)
-      end
-    end
   end
 end

data/spec/config/mongoid.yml

@@ -33,7 +33,6 @@ test:
     preload_models: false
     scope_overwrite_exception: false
     raise_not_found_error: true
-    use_activesupport_time_zone: true
     use_utc: false
     log_level: :warn
     belongs_to_required_by_default: false

data/spec/integration/active_job_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+require 'spec_helper'
+require 'active_job'
+require 'mongoid/railties/bson_object_id_serializer'
+
+describe 'ActiveJob Serialization' do
+  skip unless defined?(ActiveJob)
+
+  class TestBsonObjectIdSerializerJob < ActiveJob::Base
+    def perform(*args)
+      args
+    end
+  end
+
+  let(:band) do
+    Band.create!
+  end
+
+  before do
+    ActiveJob::Serializers.add_serializers(
+      [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+    )
+  end
+
+  it 'serializes and deserializes BSON::ObjectId' do
+    expect do
+      TestBsonObjectIdSerializerJob.perform_later(band.id)
+    end.not_to raise_error
+  end
+end