mongoid 9.0.11 → 9.1.0

data/lib/mongoid/railtie.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "rails"
-require "rails/mongoid"
+require 'rails'
+require 'rails/mongoid'
 
 module Rails
   module Mongoid
-
     # Hooks Mongoid into Rails 3 and higher.
     class Railtie < Rails::Railtie
-
       console do |app|
         if app.sandbox?
-          require "mongoid/railties/console_sandbox"
+          require 'mongoid/railties/console_sandbox'
           start_sandbox
         end
       end
@@ -25,19 +22,17 @@ module Rails
       # @ return [Hash] rescued responses
       def self.rescue_responses
         {
-          "Mongoid::Errors::DocumentNotFound" => :not_found,
-          "Mongoid::Errors::Validations" => 422
+          'Mongoid::Errors::DocumentNotFound' => :not_found,
+          'Mongoid::Errors::Validations' => 422
         }
       end
 
       config.app_generators.orm :mongoid, migration: false
 
-      if config.action_dispatch.rescue_responses
-        config.action_dispatch.rescue_responses.merge!(rescue_responses)
-      end
+      config.action_dispatch.rescue_responses.merge!(rescue_responses) if config.action_dispatch.rescue_responses
 
       rake_tasks do
-        load "mongoid/railties/database.rake"
+        load 'mongoid/railties/database.rake'
       end
 
       # Exposes Mongoid's configuration to the Rails application configuration.
@@ -56,8 +51,8 @@ module Rails
       # It runs after all config/initializers have loaded, so that the YAML
       # options can override options specified in
       # (e.g.) config/initializers/mongoid.rb.
-      initializer "mongoid.load-config", after: :load_config_initializers do
-        config_file = Rails.root.join("config", "mongoid.yml")
+      initializer 'mongoid.load-config', after: :load_config_initializers do
+        config_file = Rails.root.join('config', 'mongoid.yml')
         if config_file.file?
           begin
             ::Mongoid.load!(config_file)
@@ -87,18 +82,18 @@ module Rails
       #
       # This will happen for every request in development, once in other
       # environments.
-      initializer "mongoid.preload-models" do |app|
+      initializer 'mongoid.preload-models' do |app|
         config.to_prepare do
           ::Rails::Mongoid.preload_models(app)
         end
       end
 
       # Rails runs all initializers first before getting into any generator
-      # code, so we have no way in the intitializer to know if we are
+      # code, so we have no way in the initializer to know if we are
       # generating a mongoid.yml. So instead of failing, we catch all the
       # errors and print them out.
       def handle_configuration_error(e)
-        puts "There is a configuration error with the current mongoid.yml."
+        puts 'There is a configuration error with the current mongoid.yml.'
         puts e.message
       end
 
@@ -107,15 +102,15 @@ module Rails
       # instrumentation event `process_action.action_controller`.
       #
       # The measurement is made via internal Mongo monitoring subscription
-      initializer "mongoid.runtime-metric" do
-        require "mongoid/railties/controller_runtime"
+      initializer 'mongoid.runtime-metric' do
+        require 'mongoid/railties/controller_runtime'
 
         ActiveSupport.on_load :action_controller do
           include ::Mongoid::Railties::ControllerRuntime::ControllerExtension
         end
 
         Mongo::Monitoring::Global.subscribe Mongo::Monitoring::COMMAND,
-            ::Mongoid::Railties::ControllerRuntime::Collector.new
+                                            ::Mongoid::Railties::ControllerRuntime::Collector.new
       end
 
       # Add custom serializers for BSON::ObjectId
@@ -124,11 +119,10 @@ module Rails
           require 'mongoid/railties/bson_object_id_serializer'
 
           ActiveJob::Serializers.add_serializers(
-            [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+            [ ::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer ]
           )
         end
       end
-
     end
   end
 end

data/lib/mongoid/railties/console_sandbox.rb

@@ -1,6 +1,5 @@
-# rubocop:todo all
-require "mongoid/threaded"
-require "mongoid/errors/transactions_not_supported"
+require 'mongoid/threaded'
+require 'mongoid/errors/transactions_not_supported'
 
 # This method raises an error if the cluster the client is connected to
 # does not support transactions in any case. At the moment this is the case
@@ -14,9 +13,9 @@ require "mongoid/errors/transactions_not_supported"
 # @raise [ Mongoid::Errors::TransactionsNotSupported ] If the cluster
 #   definitely does not support transactions.
 def check_if_transactions_might_be_available!(client)
-  if client.cluster.single?
-    raise Mongoid::Errors::TransactionsNotSupported
-  end
+  return unless client.cluster.single?
+
+  raise Mongoid::Errors::TransactionsNotSupported
 end
 
 # Starts a transaction that should include all the operations inside
@@ -27,7 +26,7 @@ end
 # @param [ Mongo::Client ] client Client to start the transaction.
 def start_sandbox_transaction(client)
   session = client.start_session
-  ::Mongoid::Threaded.set_session(session, client: client)
+  Mongoid::Threaded.set_session(session, client: client)
   session.start_transaction
 end
 
@@ -39,4 +38,3 @@ def start_sandbox
     start_sandbox_transaction(client)
   end
 end
-

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Railties
     module ControllerRuntime
-
       # This extension mimics the Rails' internal method to
       # measure ActiveRecord runtime during request processing.
       # It appends MongoDB runtime value (`mongoid_runtime`) into payload
@@ -38,13 +36,12 @@ module Mongoid
         end
 
         module ClassMethods
-
           # Append MongoDB runtime information to ActionController runtime
           # log message.
           def log_process_action(payload)
             messages = super
             mongoid_runtime = payload[:mongoid_runtime]
-            messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
+            messages << format('MongoDB: %.1fms', mongoid_runtime.to_f) if mongoid_runtime
             messages
           end
         end
@@ -55,24 +52,23 @@ module Mongoid
       # variable to provide correct accounting when an application issues
       # MongoDB operations from background threads.
       class Collector
-
-        VARIABLE_NAME = "Mongoid.controller_runtime".freeze
+        VARIABLE_NAME = 'Mongoid.controller_runtime'
 
         # Call when event started. Does nothing.
         #
         # @return [ nil ] Nil.
-        def started _; end
+        def started(_); end
 
         # Call when event completed. Updates the runtime value.
         #
         # @param [ Mongo::Event::Base ] e The monitoring event.
         #
         # @return [ Integer ] The current runtime value.
-        def _completed e
+        def _completed(e)
           Collector.runtime += e.duration * 1000
         end
-        alias :succeeded :_completed
-        alias :failed :_completed
+        alias succeeded _completed
+        alias failed _completed
 
         # Get the runtime value on the current thread.
         #
@@ -86,7 +82,7 @@ module Mongoid
         # @param [ Integer ] value The runtime value.
         #
         # @return [ Integer ] The runtime value.
-        def self.runtime= value
+        def self.runtime=(value)
           Threaded.set(VARIABLE_NAME, value)
         end
 

data/lib/mongoid/railties/database.rake

@@ -1,53 +1,51 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 load 'mongoid/tasks/database.rake'
-load "mongoid/tasks/encryption.rake"
+load 'mongoid/tasks/encryption.rake'
 
 namespace :db do
-
-  unless Rake::Task.task_defined?("db:drop")
-    desc "Drops all the collections for the database for the current Rails.env"
-    task :drop => "mongoid:drop"
+  unless Rake::Task.task_defined?('db:drop')
+    desc 'Drops all the collections for the database for the current Rails.env'
+    task drop: 'mongoid:drop'
   end
 
-  unless Rake::Task.task_defined?("db:purge")
-    desc "Drop all collections except the system collections"
-    task :purge => "mongoid:purge"
+  unless Rake::Task.task_defined?('db:purge')
+    desc 'Drop all collections except the system collections'
+    task purge: 'mongoid:purge'
   end
 
-  unless Rake::Task.task_defined?("db:seed")
+  unless Rake::Task.task_defined?('db:seed')
     # if another ORM has defined db:seed, don"t run it twice.
-    desc "Load the seed data from db/seeds.rb"
-    task :seed => :environment do
-      seed_file = File.join(Rails.root, "db", "seeds.rb")
+    desc 'Load the seed data from db/seeds.rb'
+    task seed: :environment do
+      seed_file = File.join(Rails.root, 'db', 'seeds.rb')
       load(seed_file) if File.exist?(seed_file)
     end
   end
 
-  unless Rake::Task.task_defined?("db:setup")
-    desc "Create the database, and initialize with the seed data"
-    task :setup => [ "db:create", "mongoid:create_collections", "mongoid:create_indexes", "db:seed" ]
+  unless Rake::Task.task_defined?('db:setup')
+    desc 'Create the database, and initialize with the seed data'
+    task setup: [ 'db:create', 'mongoid:create_collections', 'mongoid:create_indexes', 'db:seed' ]
   end
 
-  unless Rake::Task.task_defined?("db:reset")
-    desc "Delete data and loads the seeds"
-    task :reset => [ "db:drop", "db:seed" ]
+  unless Rake::Task.task_defined?('db:reset')
+    desc 'Delete data and loads the seeds'
+    task reset: [ 'db:drop', 'db:seed' ]
   end
 
-  unless Rake::Task.task_defined?("db:create")
-    task :create => :environment do
+  unless Rake::Task.task_defined?('db:create')
+    task create: :environment do
       # noop
     end
   end
 
-  unless Rake::Task.task_defined?("db:migrate")
-    task :migrate => :environment do
+  unless Rake::Task.task_defined?('db:migrate')
+    task migrate: :environment do
       # noop
     end
   end
 
-  unless Rake::Task.task_defined?("db:schema:load")
+  unless Rake::Task.task_defined?('db:schema:load')
     namespace :schema do
       task :load do
         # noop
@@ -55,45 +53,45 @@ namespace :db do
     end
   end
 
-  unless Rake::Task.task_defined?("db:test:prepare")
+  unless Rake::Task.task_defined?('db:test:prepare')
     namespace :test do
-      task :prepare => ["mongoid:create_collections", "mongoid:create_indexes"]
+      task prepare: [ 'mongoid:create_collections', 'mongoid:create_indexes' ]
     end
   end
 
-  unless Rake::Task.task_defined?("db:create_collections")
-    desc "Create collections specified in Mongoid models"
-    task :create_collections => "mongoid:create_collections"
+  unless Rake::Task.task_defined?('db:create_collections')
+    desc 'Create collections specified in Mongoid models'
+    task create_collections: 'mongoid:create_collections'
   end
 
-  unless Rake::Task.task_defined?("db:create_indexes")
-    desc "Create indexes specified in Mongoid models"
-    task :create_indexes => "mongoid:create_indexes"
+  unless Rake::Task.task_defined?('db:create_indexes')
+    desc 'Create indexes specified in Mongoid models'
+    task create_indexes: 'mongoid:create_indexes'
   end
 
-  unless Rake::Task.task_defined?("db:create_search_indexes")
-    desc "Create search indexes specified in Mongoid models"
-    task :create_search_indexes => "mongoid:create_search_indexes"
+  unless Rake::Task.task_defined?('db:create_search_indexes')
+    desc 'Create search indexes specified in Mongoid models'
+    task create_search_indexes: 'mongoid:create_search_indexes'
   end
 
-  unless Rake::Task.task_defined?("db:remove_indexes")
-    desc "Remove indexes specified in Mongoid models"
-    task :remove_indexes => "mongoid:remove_indexes"
+  unless Rake::Task.task_defined?('db:remove_indexes')
+    desc 'Remove indexes specified in Mongoid models'
+    task remove_indexes: 'mongoid:remove_indexes'
   end
 
-  unless Rake::Task.task_defined?("db:shard_collections")
-    desc "Shard collections with shard keys specified in Mongoid models"
-    task :shard_collections => "mongoid:shard_collections"
+  unless Rake::Task.task_defined?('db:shard_collections')
+    desc 'Shard collections with shard keys specified in Mongoid models'
+    task shard_collections: 'mongoid:shard_collections'
   end
 
   namespace :encryption do
-    desc "Create encryption key"
-    task :create_data_key =>  "mongoid:encryption:create_data_key"
+    desc 'Create encryption key'
+    task create_data_key: 'mongoid:encryption:create_data_key'
   end
 
   namespace :mongoid do
     task :load_models do
-      ::Rails.application.eager_load! if defined?(::Rails)
+      Rails.application.eager_load! if defined?(Rails)
     end
   end
 end

data/lib/mongoid/scopable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # This module contains behavior for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
   module Scopable
@@ -26,15 +24,14 @@ module Mongoid
     #
     # @return [ true | false ] If default scoping was applied.
     def apply_default_scoping
-      if default_scoping
-        default_scoping.call.selector.each do |field, value|
-          attributes[field] = value unless value.respond_to?(:each)
-        end
+      return unless default_scoping
+
+      default_scoping.call.selector.each do |field, value|
+        attributes[field] = value unless value.respond_to?(:each)
       end
     end
 
     module ClassMethods
-
       # Returns a hash of all the scopes defined for this class, including
       # scopes defined on ancestor classes.
       #
@@ -50,10 +47,8 @@ module Mongoid
       # @return [ Hash ] The scopes defined for this class
       def scopes
         defined_scopes = {}
-        ancestors.reverse.each do |klass|
-          if klass.respond_to?(:_declared_scopes)
-            defined_scopes.merge!(klass._declared_scopes)
-          end
+        ancestors.reverse_each do |klass|
+          defined_scopes.merge!(klass._declared_scopes) if klass.respond_to?(:_declared_scopes)
         end
         defined_scopes.freeze
       end
@@ -80,8 +75,8 @@ module Mongoid
       # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
       #
       # @return [ Proc ] The default scope.
-      def default_scope(value = nil)
-        value = Proc.new { yield } if block_given?
+      def default_scope(value = nil, &block)
+        value = proc(&block) if block_given?
         check_scope_validity(value)
         self.default_scoping = process_default_scope(value)
       end
@@ -106,7 +101,7 @@ module Mongoid
       # @return [ Criteria ] The queryable.
       def queryable
         crit = Threaded.current_scope(self) || Criteria.new(self)
-        crit.embedded = true if (crit.klass.embedded? && !crit.klass.cyclic?)
+        crit.embedded = true if crit.klass.embedded? && !crit.klass.cyclic?
         crit
       end
 
@@ -195,7 +190,7 @@ module Mongoid
       def with_default_scope
         queryable.with_default_scope
       end
-      alias :criteria :with_default_scope
+      alias criteria with_default_scope
 
       # Pushes the provided criteria onto the scope stack, and removes it after the
       # provided block is yielded.
@@ -245,18 +240,15 @@ module Mongoid
       # @raise [ Errors::ScopeOverwrite ] If the name exists and configured to
       #   raise the error.
       def check_scope_name(name)
-        if _declared_scopes[name] || respond_to?(name, true)
-          if Mongoid.scope_overwrite_exception
-            raise Errors::ScopeOverwrite.new(self.name, name)
-          else
-            Mongoid.logger.warn(
-              "Creating scope :#{name} which conflicts with #{self.name}.#{name}. " +
-              "Calls to `Mongoid::Criteria##{name}` will delegate to " +
-              "`Mongoid::Criteria##{name}` for criteria with klass #{self.name} " +
-              "and will ignore the declared scope."
-            )
-          end
-        end
+        return unless _declared_scopes[name] || respond_to?(name, true)
+        raise Errors::ScopeOverwrite.new(self.name, name) if Mongoid.scope_overwrite_exception
+
+        Mongoid.logger.warn(
+          "Creating scope :#{name} which conflicts with #{self.name}.#{name}. " +
+          "Calls to `Mongoid::Criteria##{name}` will delegate to " +
+          "`Mongoid::Criteria##{name}` for criteria with klass #{self.name} " +
+          'and will ignore the declared scope.'
+        )
       end
 
       # Checks if the intended scope is a valid object, either a criteria or
@@ -271,9 +263,9 @@ module Mongoid
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a valid object.
       def check_scope_validity(value)
-        unless value.respond_to?(:call)
-          raise Errors::InvalidScope.new(self, value)
-        end
+        return if value.respond_to?(:call)
+
+        raise Errors::InvalidScope.new(self, value)
       end
 
       # Defines the actual class method that will execute the scope when
@@ -318,7 +310,7 @@ module Mongoid
       # @param [ Criteria | Proc ] value The default scope value.
       def process_default_scope(value)
         if existing = default_scoping
-          ->{ existing.call.merge(value.to_proc.call) }
+          -> { existing.call.merge(value.to_proc.call) }
         else
           value.to_proc
         end