mongoid 7.2.1 → 9.0.0

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

@@ -1,27 +1,47 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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
-        Rails::Application.subclasses.first.parent.to_s.underscore
+      # 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+
+          app_cls.module_parent_name
+        rescue NoMethodError
+          app_cls.parent.to_s
+        end
+        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,23 +41,25 @@ 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
 
         # 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)
@@ -80,14 +82,24 @@ development:
         # (default: 10)
         # connect_timeout: 10
 
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
+        # 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
         # 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
 
@@ -108,64 +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
-    
-    # Create indexes in background by default. (default: false)
-    # background_indexing: false
-    
-    # Mark belongs_to associations as required by default, so that saving a
-    # model with a missing belongs_to association will trigger a validation
-    # error. (default: true)
-    # 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
+<%- 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,10 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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"
@@ -16,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,13 +1,18 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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__)
@@ -18,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,7 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Rails
+
+  # Mongoid utilities for Rails
   module Mongoid
     extend self
 
@@ -14,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
@@ -35,24 +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.
-    #
-    # @since 2.0.0.rc.3
-    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,13 +33,28 @@ 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
     app_name: 'testing'
     background_indexing: false
     join_contexts: false
+  driver_options:
+    broken_view_options: false
+    # Don't set validate_update_replace here, as it is used to check if the
+    # default driver options are kept in Mongoid.
+test_nil:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+  driver_options:
+    broken_view_options:
+    validate_update_replace: false
+
 test_with_max_staleness:
   clients:
     default:

data/spec/config/mongoid_with_schema_map_uuid.yml

@@ -0,0 +1,27 @@
+test:
+  clients:
+    default:
+      database: mongoid_test
+      hosts:
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
+      options:
+        auto_encryption_options:
+          key_vault_namespace: 'admin.datakeys'
+          kms_providers:
+            local:
+              key: "z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U"
+          schema_map:
+            blog_development.comments:
+              properties:
+                message:
+                  encrypt:
+                    keyId:
+                      - !ruby/object:BSON::Binary
+                        data: !binary |-
+                          R/AgNcxASFiiJWKXqWGo5w==
+                        type: :uuid
+                    bsonType: "string"
+                    algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
+              bsonType: "object"

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