mongoid 9.0.11 → 9.1.0

data/lib/mongoid/indexable/validators/options.rb

@@ -1,46 +1,44 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Indexable
     module Validators
-
       # Validates the options passed to the index macro.
       module Options
         extend self
 
-        VALID_OPTIONS = [
-          :background,
-          :database,
-          :default_language,
-          :language_override,
-          :name,
-          :sparse,
-          :unique,
-          :max,
-          :min,
-          :bits,
-          :bucket_size,
-          :expire_after_seconds,
-          :weights,
-          :storage_engine,
-          :key,
-          :sphere_version,
-          :text_version,
-          :version,
-          :partial_filter_expression,
-          :collation,
-          :wildcard_projection,
+        VALID_OPTIONS = %i[
+          background
+          database
+          default_language
+          language_override
+          name
+          sparse
+          unique
+          max
+          min
+          bits
+          bucket_size
+          expire_after_seconds
+          weights
+          storage_engine
+          key
+          sphere_version
+          text_version
+          version
+          partial_filter_expression
+          collation
+          wildcard_projection
         ]
 
         VALID_TYPES = [
           1,
           -1,
-          "2d",
-          "2dsphere",
-          "geoHaystack",
-          "text",
-          "hashed"
+          '2d',
+          '2dsphere',
+          'geoHaystack',
+          'text',
+          'hashed'
         ]
 
         # Validate the index specification.
@@ -73,10 +71,8 @@ module Mongoid
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
         def validate_options(klass, spec, options)
-          options.each_pair do |name, value|
-            unless VALID_OPTIONS.include?(name)
-              raise Errors::InvalidIndex.new(klass, spec, options)
-            end
+          options.each_pair do |name, _value|
+            raise Errors::InvalidIndex.new(klass, spec, options) unless VALID_OPTIONS.include?(name)
           end
         end
 
@@ -93,16 +89,13 @@ module Mongoid
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
         def validate_spec(klass, spec, options)
-          raise Errors::InvalidIndex.new(klass, spec, options) if !spec.is_a?(::Hash)
+          raise Errors::InvalidIndex.new(klass, spec, options) unless spec.is_a?(::Hash)
+
           spec.each_pair do |name, value|
             next if name == :options
-            unless VALID_TYPES.include?(value)
-              raise Errors::InvalidIndex.new(klass, spec, options)
-            end
+            raise Errors::InvalidIndex.new(klass, spec, options) unless VALID_TYPES.include?(value)
 
-            if value == "geoHaystack"
-              Mongoid::Warnings.warn_geo_haystack_deprecated
-            end
+            Mongoid::Warnings.warn_geo_haystack_deprecated if value == 'geoHaystack'
           end
         end
       end

data/lib/mongoid/indexable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/indexable/specification"
-require "mongoid/indexable/validators/options"
-require "ostruct"
+require 'mongoid/indexable/specification'
+require 'mongoid/indexable/validators/options'
+require 'ostruct'
 
 module Mongoid
-
   # Encapsulates behavior around defining indexes.
   module Indexable
     extend ActiveSupport::Concern
@@ -17,7 +15,6 @@ module Mongoid
     end
 
     module ClassMethods
-
       # Send the actual index creation comments to the MongoDB driver
       #
       # @example Create the indexes for the class.
@@ -27,7 +24,7 @@ module Mongoid
       def create_indexes
         return unless index_specifications
 
-        default_options = {background: Config.background_indexing}
+        default_options = { background: Config.background_indexing }
 
         index_specifications.each do |spec|
           key, options = spec.key, default_options.merge(spec.options)
@@ -51,17 +48,16 @@ module Mongoid
       def remove_indexes
         indexed_database_names.each do |database|
           with(database: database) do |klass|
-            begin
-              klass.collection.indexes(session: _session).each do |spec|
-                unless spec["name"] == "_id_"
-                  klass.collection.indexes(session: _session).drop_one(spec["key"])
-                  logger.info(
-                    "MONGOID: Removed index '#{spec["name"]}' on collection " +
-                    "'#{klass.collection.name}' in database '#{database}'."
-                  )
-                end
-              end
-            rescue Mongo::Error::OperationFailure; end
+            klass.collection.indexes(session: _session).each do |spec|
+              next if spec['name'] == '_id_'
+
+              klass.collection.indexes(session: _session).drop_one(spec['key'])
+              logger.info(
+                "MONGOID: Removed index '#{spec['name']}' on collection " +
+                "'#{klass.collection.name}' in database '#{database}'."
+              )
+            end
+          rescue Mongo::Error::OperationFailure
           end
         end and true
       end
@@ -74,8 +70,8 @@ module Mongoid
       #
       # @return [ true ] If the operation succeeded.
       def add_indexes
-        if hereditary? && !index_keys.include?(self.discriminator_key.to_sym => 1)
-          index({ self.discriminator_key.to_sym => 1 }, unique: false, background: true)
+        if hereditary? && !index_keys.include?(discriminator_key.to_sym => 1)
+          index({ discriminator_key.to_sym => 1 }, unique: false, background: true)
         end
         true
       end
@@ -95,9 +91,15 @@ module Mongoid
       # @return [ Hash ] The index options.
       def index(spec, options = nil)
         specification = Specification.new(self, spec, options)
-        if !index_specifications.include?(specification)
-          index_specifications.push(specification)
-        end
+
+        # the equality test for Indexable::Specification instances does not
+        # consider any options, which means names are not compared. This means
+        # that an index with different options from another, and a different
+        # name, will be silently ignored unless duplicate index declarations
+        # are allowed.
+        return unless Mongoid.allow_duplicate_index_declarations || !index_specifications.include?(specification)
+
+        index_specifications.push(specification)
       end
 
       # Get an index specification for the provided key.
@@ -110,9 +112,8 @@ module Mongoid
       #
       # @return [ Specification ] The found specification.
       def index_specification(index_hash, index_name = nil)
-        index = OpenStruct.new(fields: index_hash.keys, key: index_hash)
         index_specifications.detect do |spec|
-          spec == index || (index_name && index_name == spec.name)
+          spec.superficial_match?(key: index_hash, name: index_name)
         end
       end
 

data/lib/mongoid/inspectable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Contains the behavior around inspecting documents via inspect.
   module Inspectable
-
     # Returns the class name plus its attributes. If using dynamic fields will
     # include those as well.
     #
@@ -31,7 +28,7 @@ module Mongoid
     def pretty_print(pretty_printer)
       keys = fields.keys | attributes.keys
       pretty_printer.group(1, "#<#{self.class.name}", '>') do
-        sep = lambda { pretty_printer.text(',') }
+        sep = -> { pretty_printer.text(',') }
         pretty_printer.seplist(keys, sep) do |key|
           pretty_printer.breakable
           field = fields[key]
@@ -40,7 +37,7 @@ module Mongoid
           pretty_printer.text(':')
           pretty_printer.group(1) do
             pretty_printer.breakable
-            if key == "_id"
+            if key == '_id'
               pretty_printer.text(_id.to_s)
             else
               pretty_printer.pp(@attributes[key])
@@ -62,9 +59,9 @@ module Mongoid
     # @return [ String ] An array of pretty printed field values.
     def inspect_fields
       fields.map do |name, field|
-        unless name == "_id"
+        unless name == '_id'
           as = field.options[:as]
-          "#{name}#{as ? "(#{as})" : nil}: #{@attributes[name].inspect}"
+          "#{name}#{"(#{as})" if as}: #{@attributes[name].inspect}"
         end
       end.compact
     end

data/lib/mongoid/interceptable.rb

@@ -1,34 +1,32 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # This module contains all the callback hooks for Mongoid.
   module Interceptable
     extend ActiveSupport::Concern
 
-    CALLBACKS = [
-      :after_build,
-      :after_create,
-      :after_destroy,
-      :after_find,
-      :after_initialize,
-      :after_save,
-      :after_touch,
-      :after_update,
-      :after_upsert,
-      :after_validation,
-      :around_create,
-      :around_destroy,
-      :around_save,
-      :around_update,
-      :around_upsert,
-      :before_create,
-      :before_destroy,
-      :before_save,
-      :before_update,
-      :before_upsert,
-      :before_validation,
+    CALLBACKS = %i[
+      after_build
+      after_create
+      after_destroy
+      after_find
+      after_initialize
+      after_save
+      after_touch
+      after_update
+      after_upsert
+      after_validation
+      around_create
+      around_destroy
+      around_save
+      around_update
+      around_upsert
+      before_create
+      before_destroy
+      before_save
+      before_update
+      before_upsert
+      before_validation
     ].freeze
 
     included do
@@ -46,7 +44,7 @@ module Mongoid
 
       define_callbacks :commit, :rollback,
                        only: :after,
-                       scope: [:kind, :name]
+                       scope: %i[kind name]
 
       attr_accessor :before_callback_halted
     end
@@ -73,7 +71,7 @@ module Mongoid
     #
     # @return [ true | false ] If the document is in a callback state.
     def in_callback_state?(kind)
-      [ :create, :destroy ].include?(kind) || new_record? || flagged_for_destroy? || changed?
+      %i[create destroy].include?(kind) || new_record? || flagged_for_destroy? || changed?
     end
 
     # Run only the after callbacks for the specific event.
@@ -125,14 +123,11 @@ module Mongoid
     # @param [ Proc | nil ] skip_if If this proc returns true, the callbacks
     #   will not be triggered, while the given block will be still called.
     def run_callbacks(kind, with_children: true, skip_if: nil, &block)
-      if skip_if&.call
-        return block&.call
-      end
+      return block&.call if skip_if&.call
+
       if with_children
         cascadable_children(kind).each do |child|
-          if child.run_callbacks(child_callback_type(kind, child), with_children: with_children) == false
-            return false
-          end
+          return false if child.run_callbacks(child_callback_type(kind, child), with_children: with_children) == false
         end
       end
       if callback_executable?(kind)
@@ -172,7 +167,7 @@ module Mongoid
     #
     #  @api private
     def _mongoid_run_child_callbacks_with_around(kind, children: nil, &block)
-      children = (children || cascadable_children(kind))
+      children ||= cascadable_children(kind)
       with_children = !Mongoid::Config.prevent_multiple_calls_of_embedded_callbacks
 
       return block&.call if children.empty?
@@ -205,9 +200,10 @@ module Mongoid
     #
     # @api private
     def _mongoid_run_child_callbacks_without_around(kind, children: nil, &block)
-      children = (children || cascadable_children(kind))
+      children ||= cascadable_children(kind)
       callback_list = _mongoid_run_child_before_callbacks(kind, children: children)
       return false if callback_list == false
+
       value = block&.call
       callback_list.each do |_next_sequence, env|
         env.value &&= value
@@ -233,12 +229,13 @@ module Mongoid
         next_sequence = compile_callbacks(chain)
         unless next_sequence.final?
           Mongoid.logger.warn("Around callbacks are disabled for embedded documents. Skipping around callbacks for #{child.class.name}.")
-          Mongoid.logger.warn("To enable around callbacks for embedded documents, set Mongoid::Config.around_callbacks_for_embeds to true.")
+          Mongoid.logger.warn('To enable around callbacks for embedded documents, set Mongoid::Config.around_callbacks_for_embeds to true.')
         end
         next_sequence.invoke_before(env)
         return false if env.halted
+
         env.value = !env.halted
-        callback_list << [next_sequence, env]
+        callback_list << [ next_sequence, env ]
       end
       callback_list
     end
@@ -284,10 +281,10 @@ module Mongoid
     # @api private
     def run_pending_callbacks
       pending_callbacks.each do |cb|
-        if [:apply_defaults, :apply_post_processed_defaults].include?(cb)
+        if %i[apply_defaults apply_post_processed_defaults].include?(cb)
           send(cb)
         else
-          self.run_callbacks(cb, with_children: false)
+          run_callbacks(cb, with_children: false)
         end
       end
       pending_callbacks.clear
@@ -319,6 +316,7 @@ module Mongoid
     def cascadable_children(kind, children = Set.new)
       embedded_relations.each_pair do |name, association|
         next unless association.cascading_callbacks?
+
         without_autobuild do
           delayed_pulls = delayed_atomic_pulls[name]
           delayed_unsets = delayed_atomic_unsets[name]
@@ -327,6 +325,7 @@ module Mongoid
           relation = send(name)
           Array.wrap(relation).each do |child|
             next if children.include?(child)
+
             children.add(child) if cascadable_child?(kind, child, association)
             child.send(:cascadable_children, kind, children)
           end
@@ -345,8 +344,9 @@ module Mongoid
     #
     # @return [ true | false ] If the child should fire the callback.
     def cascadable_child?(kind, child, association)
-      return false if kind == :initialize || kind == :find || kind == :touch
+      return false if %i[initialize find touch].include?(kind)
       return false if kind == :validate && association.validate?
+
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end
 
@@ -366,6 +366,7 @@ module Mongoid
       if kind == :update
         return :create if child.new_record?
         return :destroy if child.flagged_for_destroy?
+
         kind
       else
         kind
@@ -383,7 +384,7 @@ module Mongoid
     # @param [ Symbol ] filter The callback that halted.
     # @param [ Symbol ] name The name of the callback that was halted
     #   (requires Rails 6.1+)
-    def halted_callback_hook(filter, name = nil)
+    def halted_callback_hook(_filter, _name = nil)
       @before_callback_halted = true
     end
 

data/lib/mongoid/loadable.rb

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Defines how Mongoid can autoload all defined models.
   module Loadable
     # The default list of paths where model classes should be looked for. If
     # Rails is present, the "app/models" paths will be used instead.
     # (See #model_paths.)
-    DEFAULT_MODEL_PATHS = %w( ./app/models ./lib/models ).freeze
+    DEFAULT_MODEL_PATHS = %w[ ./app/models ./lib/models ].freeze
 
     # The default list of glob patterns that match paths to ignore when loading
     # models. Defaults to '*/models/concerns/*', which Rails uses for extensions
     # to models (and which cause errors when loaded out of order).
     #
     # See #ignore_patterns.
-    DEFAULT_IGNORE_PATTERNS = %w( */models/concerns/* ).freeze
+    DEFAULT_IGNORE_PATTERNS = %w[ */models/concerns/* ].freeze
 
     # Search a list of model paths to get every model and require it, so
     # that indexing and inheritance work in both development and production
@@ -62,16 +60,16 @@ module Mongoid
     #   via `require_dependency` or `require`.
     def files_under_path(path)
       files = if preload_models.resizable?
-          preload_models.
-            map { |model| "#{path}/#{model.underscore}.rb" }.
-            select { |file_name| File.exists?(file_name) }
-        else
-          Dir.glob("#{path}/**/*.rb").
-            reject { |file_name| ignored?(file_name) }
-        end
+                preload_models
+                  .map { |model| "#{path}/#{model.underscore}.rb" }
+                  .select { |file_name| File.exist?(file_name) }
+              else
+                Dir.glob("#{path}/**/*.rb")
+                   .reject { |file_name| ignored?(file_name) }
+              end
 
       # strip the path and the suffix from each entry
-      files.map { |file| file.gsub(/^#{path}\// , "").gsub(/\.rb$/, "") }
+      files.map { |file| file.gsub(%r{^#{path}/}, '').gsub(/\.rb$/, '') }
     end
 
     # A convenience method for loading a model's file. If Rails'
@@ -94,8 +92,8 @@ module Mongoid
 
     # Returns the array of paths where the application's model definitions
     # are located. If Rails is loaded, this defaults to the configured
-    # "app/models" paths (e.g. `config.paths["app/models"]`); otherwise, it
-    # defaults to `%w(./app/models ./lib/models)`.
+    # "app/models" paths (e.g. +config.paths["app/models"]+); otherwise, it
+    # defaults to '%w(./app/models ./lib/models)'.
     #
     # Note that these paths are the *roots* of the directory hierarchies where
     # the models are located; it is not necessary to indicate every subdirectory,
@@ -103,9 +101,11 @@ module Mongoid
     #
     # @return [ Array<String> ] the array of model paths
     def model_paths
-      @model_paths ||= defined?(Rails) ?
-        Rails.application.config.paths["app/models"].expanded :
-        DEFAULT_MODEL_PATHS
+      @model_paths ||= if defined?(Rails)
+                         Rails.application.config.paths['app/models'].expanded
+                       else
+                         DEFAULT_MODEL_PATHS
+                       end
     end
 
     # Returns the array of glob patterns that determine whether a given
@@ -143,5 +143,4 @@ module Mongoid
       ignore_patterns.any? { |pattern| File.fnmatch?(pattern, file_path) }
     end
   end
-
 end

data/lib/mongoid/loggable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Contains logging behavior.
   module Loggable
-
     # Get the logger.
     #
     # @note Will try to grab Rails' logger first before creating a new logger
@@ -17,6 +14,7 @@ module Mongoid
     # @return [ Logger ] The logger.
     def logger
       return @logger if defined?(@logger)
+
       @logger = rails_logger || default_logger
     end
 
@@ -57,11 +55,9 @@ module Mongoid
     #
     # @return [ Logger ] The Rails logger.
     def rails_logger
-      if defined?(::Rails)
-        ::Rails.logger
-      else
-        nil
-      end
+      return unless defined?(::Rails)
+
+      ::Rails.logger
     end
   end
 end

data/lib/mongoid/matchable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # This module contains all the behavior for Ruby implementations of MongoDB
   # selectors.
   module Matchable

data/lib/mongoid/matcher/all.rb

@@ -1,14 +1,11 @@
-# rubocop:todo all
 module Mongoid
   module Matcher
-
     # In-memory matcher for $all expression.
     #
     # @see https://www.mongodb.com/docs/manual/reference/operator/query/all/
     #
     # @api private
     module All
-
       # Returns whether a value satisfies an $all expression.
       #
       # @param [ true | false ] exists Not used.
@@ -18,8 +15,8 @@ module Mongoid
       # @return [ true | false ] Whether the value matches.
       #
       # @api private
-      module_function def matches?(exists, value, condition)
-        unless Array === condition
+      module_function def matches?(_exists, value, condition)
+        unless condition.is_a?(Array)
           raise Errors::InvalidQuery, "$all argument must be an array: #{Errors::InvalidQuery.truncate_expr(condition)}"
         end
 

data/lib/mongoid/matcher/and.rb

@@ -1,14 +1,11 @@
-# rubocop:todo all
 module Mongoid
   module Matcher
-
     # In-memory matcher for $and expression.
     #
     # @see https://www.mongodb.com/docs/manual/reference/operator/query/and/
     #
     # @api private
     module And
-
       # Returns whether a document satisfies an $and expression.
       #
       # @param [ Mongoid::Document ] document The document.

data/lib/mongoid/matcher/bits.rb

@@ -1,12 +1,9 @@
-# rubocop:todo all
 module Mongoid
   module Matcher
-
     # Mixin module included in bitwise expression matchers.
     #
     # @api private
     module Bits
-
       # Returns whether a value satisfies a bitwise expression.
       #
       # @param [ true | false ] exists Not used.
@@ -17,7 +14,7 @@ module Mongoid
       # @return [ true | false ] Whether the value matches.
       #
       # @api private
-      def matches?(exists, value, condition)
+      def matches?(_exists, value, condition)
         case value
         when BSON::Binary
           value = value.data.split('').map { |n| '%02x' % n.ord }.join.to_i(16)
@@ -30,17 +27,25 @@ module Mongoid
           int_matches?(value, int_cond)
         when Integer
           if condition < 0
-            raise Errors::InvalidQuery, "Invalid value for $#{operator_name} argument: negative integers are not allowed: #{condition}"
+            raise Errors::InvalidQuery,
+                  "Invalid value for $#{operator_name} argument: negative integers are not allowed: #{condition}"
           end
+
           int_matches?(value, condition)
         when Float
-          if (int_cond = condition.to_i).to_f == condition
+          # Allow floats that are whole numbers (e.g. 50.0), but reject those
+          # with a fractional part (e.g. 50.1) since bitwise ops require integers.
+          int_cond = condition.to_i
+          if int_cond == condition
             if int_cond < 0
-              raise Errors::InvalidQuery, "Invalid value for $#{operator_name} argument: negative numbers are not allowed: #{condition}"
+              raise Errors::InvalidQuery,
+                    "Invalid value for $#{operator_name} argument: negative numbers are not allowed: #{condition}"
             end
+
             int_matches?(value, int_cond)
           else
-            raise Errors::InvalidQuery, "Invalid type for $#{operator_name} argument: not representable as an integer: #{condition}"
+            raise Errors::InvalidQuery,
+                  "Invalid type for $#{operator_name} argument: not representable as an integer: #{condition}"
           end
         else
           raise Errors::InvalidQuery, "Invalid type for $#{operator_name} argument: #{condition}"

data/lib/mongoid/matcher/bits_all_clear.rb

@@ -1,7 +1,5 @@
-# rubocop:todo all
 module Mongoid
   module Matcher
-
     # In-memory matcher for $bitsAllClear expression.
     #
     # @see https://www.mongodb.com/docs/manual/reference/operator/query/bitsAllClear/
@@ -21,7 +19,7 @@ module Mongoid
       # @api private
       def array_matches?(value, condition)
         condition.all? do |c|
-          value & (1<<c) == 0
+          value & (1 << c) == 0
         end
       end