mongoid 7.3.5 → 7.4.0

data/lib/mongoid/indexable/specification.rb

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Indexable
 
     # Encapsulates behavior around an index specification.
-    #
-    # @since 4.0.0
     class Specification
 
       # The mappings of nice Ruby-style names to the corresponding driver
       # option name.
-      #
-      # @since 4.0.0
       MAPPINGS = {
         expire_after_seconds: :expire_after
       }
@@ -33,8 +28,6 @@ module Mongoid
       # @param [ Specification ] other The spec to compare against.
       #
       # @return [ true, false ] If the specs are equal.
-      #
-      # @since 4.0.0
       def ==(other)
         fields == other.fields && key == other.key
       end
@@ -47,8 +40,6 @@ module Mongoid
       # @param [ Class ] klass The class the index is defined on.
       # @param [ Hash ] key The hash of name/direction pairs.
       # @param [ Hash ] opts the index options.
-      #
-      # @since 4.0.0
       def initialize(klass, key, opts = nil)
         options = opts || {}
         Validators::Options.validate(klass, key, options)
@@ -64,8 +55,6 @@ module Mongoid
       #   specification.name
       #
       # @return [ String ] name The index name.
-      #
-      # @since 5.0.2
       def name
         @name ||= key.reduce([]) do |n, (k,v)|
           n << "#{k}_#{v}"
@@ -84,8 +73,6 @@ module Mongoid
       # @param [ Hash ] key The index key(s).
       #
       # @return [ Hash ] The normalized specification.
-      #
-      # @since 4.0.0
       def normalize_key(key)
         normalized = {}
         key.each_pair do |name, direction|
@@ -104,8 +91,6 @@ module Mongoid
       # @param [ Hash ] opts The index options.
       #
       # @return [ Hash ] The normalized options.
-      #
-      # @since 4.0.0
       def normalize_options(opts)
         options = {}
         opts.each_pair do |option, value|

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Indexable
@@ -53,8 +52,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate(klass, spec, options)
           validate_spec(klass, spec, options)
           validate_options(klass, spec, options)
@@ -74,8 +71,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate_options(klass, spec, options)
           options.each_pair do |name, value|
             unless VALID_OPTIONS.include?(name)
@@ -96,8 +91,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate_spec(klass, spec, options)
           raise Errors::InvalidIndex.new(klass, spec, options) if !spec.is_a?(::Hash)
           spec.each_pair do |name, value|

data/lib/mongoid/indexable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/indexable/specification"
 require "mongoid/indexable/validators/options"
@@ -8,8 +7,6 @@ require "ostruct"
 module Mongoid
 
   # Encapsulates behavior around defining indexes.
-  #
-  # @since 4.0.0
   module Indexable
     extend ActiveSupport::Concern
 
@@ -26,8 +23,6 @@ module Mongoid
       #   Person.create_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 1.0.0
       def create_indexes
         return unless index_specifications
 
@@ -52,8 +47,6 @@ module Mongoid
       #   Person.remove_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 3.0.0
       def remove_indexes
         indexed_database_names.each do |database|
           with(database: database) do |klass|
@@ -79,8 +72,6 @@ module Mongoid
       #   Person.add_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 1.0.0
       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)
@@ -97,12 +88,10 @@ module Mongoid
       #     index({ name: 1 }, { background: true })
       #   end
       #
-      # @param [ Symbol ] spec The index spec.
+      # @param [ Hash ] spec The index spec.
       # @param [ Hash ] options The index options.
       #
       # @return [ Hash ] The index options.
-      #
-      # @since 1.0.0
       def index(spec, options = nil)
         specification = Specification.new(self, spec, options)
         if !index_specifications.include?(specification)
@@ -119,8 +108,6 @@ module Mongoid
       # @param [ String ] index_name The index name.
       #
       # @return [ Specification ] The found specification.
-      #
-      # @since 4.0.0
       def index_specification(index_hash, index_name = nil)
         index = OpenStruct.new(fields: index_hash.keys, key: index_hash)
         index_specifications.detect do |spec|
@@ -139,8 +126,6 @@ module Mongoid
       #   Model.indexed_database_names
       #
       # @return [ Array<String> ] The names.
-      #
-      # @since 3.1.0
       def indexed_database_names
         index_specifications.map do |spec|
           spec.options[:database] || database_name
@@ -155,8 +140,6 @@ module Mongoid
       #   Model.index_keys
       #
       # @return [ Array<Hash> ] The specification keys.
-      #
-      # @since 4.0.0
       def index_keys
         index_specifications.map(&:key)
       end

data/lib/mongoid/inspectable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
-  # Contains the bahvior around inspecting documents via inspect.
-  #
-  # @since 4.0.0
+  # Contains the behavior around inspecting documents via inspect.
   module Inspectable
 
     # Returns the class name plus its attributes. If using dynamic fields will
@@ -15,8 +12,6 @@ module Mongoid
     #   person.inspect
     #
     # @return [ String ] A nice pretty string to look at.
-    #
-    # @since 1.0.0
     def inspect
       inspection = []
       inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
@@ -33,8 +28,6 @@ module Mongoid
     #   document.inspect_fields
     #
     # @return [ String ] An array of pretty printed field values.
-    #
-    # @since 1.0.0
     def inspect_fields
       fields.map do |name, field|
         unless name == "_id"
@@ -52,8 +45,6 @@ module Mongoid
     #   document.inspect_dynamic_fields
     #
     # @return [ String ] An array of pretty printed dynamic field values.
-    #
-    # @since 1.0.0
     def inspect_dynamic_fields
       []
     end

data/lib/mongoid/interceptable.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module contains all the callback hooks for Mongoid.
-  #
-  # @since 4.0.0
   module Interceptable
     extend ActiveSupport::Concern
 
@@ -51,8 +48,6 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback.
     #
     # @return [ true, false ] If the callback can be executed.
-    #
-    # @since 3.0.6
     def callback_executable?(kind)
       respond_to?("_#{kind}_callbacks")
     end
@@ -66,8 +61,6 @@ module Mongoid
     # @param [ Symbol ] kind The callback kind.
     #
     # @return [ true, false ] If the document is in a callback state.
-    #
-    # @since 3.1.0
     def in_callback_state?(kind)
       [ :create, :destroy ].include?(kind) || new_record? || flagged_for_destroy? || changed?
     end
@@ -83,8 +76,6 @@ module Mongoid
     # @param [ Array<Symbol> ] kinds The events that are occurring.
     #
     # @return [ Object ] The result of the chain executing.
-    #
-    # @since 3.0.0
     def run_after_callbacks(*kinds)
       kinds.each do |kind|
         run_targeted_callbacks(:after, kind)
@@ -102,8 +93,6 @@ module Mongoid
     # @param [ Array<Symbol> ] kinds The events that are occurring.
     #
     # @return [ Object ] The result of the chain executing.
-    #
-    # @since 3.0.0
     def run_before_callbacks(*kinds)
       kinds.each do |kind|
         run_targeted_callbacks(:before, kind)
@@ -123,8 +112,6 @@ module Mongoid
     # @param [ Array ] args Any options.
     #
     # @return [ Document ] The document
-    #
-    # @since 2.3.0
     ruby2_keywords def run_callbacks(kind, *args, &block)
       cascadable_children(kind).each do |child|
         if child.run_callbacks(child_callback_type(kind, child), *args) == false
@@ -149,8 +136,6 @@ module Mongoid
     #   document.before_callback_halted?
     #
     # @return [ true, false ] If a before callback was halted.
-    #
-    # @since 3.0.3
     def before_callback_halted?
       !!@before_callback_halted
     end
@@ -163,8 +148,6 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback.
     #
     # @return [ Array<Document> ] The children.
-    #
-    # @since 2.3.0
     def cascadable_children(kind, children = Set.new)
       embedded_relations.each_pair do |name, association|
         next unless association.cascading_callbacks?
@@ -193,8 +176,6 @@ module Mongoid
     # @param [ Document ] child The child document.
     #
     # @return [ true, false ] If the child should fire the callback.
-    #
-    # @since 2.3.0
     def cascadable_child?(kind, child, association)
       return false if kind == :initialize || kind == :find || kind == :touch
       return false if kind == :validate && association.validate?
@@ -213,8 +194,6 @@ module Mongoid
     # @param [ Document ] child The child document
     #
     # @return [ Symbol ] The name of the callback.
-    #
-    # @since 2.3.0
     def child_callback_type(kind, child)
       if kind == :update
         return :create if child.new_record?
@@ -236,8 +215,6 @@ module Mongoid
     # @param [ Symbol ] filter The callback that halted.
     # @param [ Symbol ] name The name of the callback that was halted
     #   (requires Rails 6.1+)
-    #
-    # @since 3.0.3
     def halted_callback_hook(filter, name = nil)
       @before_callback_halted = true
     end
@@ -252,8 +229,6 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback, :save, :create, :update.
     #
     # @return [ Object ] The result of the chain execution.
-    #
-    # @since 3.0.0
     def run_targeted_callbacks(place, kind)
       name = "_run__#{place}__#{kind}__callbacks"
       unless respond_to?(name)

data/lib/mongoid/loggable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -15,8 +14,6 @@ module Mongoid
     #   Loggable.logger
     #
     # @return [ Logger ] The logger.
-    #
-    # @since 3.0.0
     def logger
       return @logger if defined?(@logger)
       @logger = rails_logger || default_logger
@@ -30,8 +27,6 @@ module Mongoid
     # @param [ Logger ] logger The logger to set.
     #
     # @return [ Logger ] The new logger.
-    #
-    # @since 3.0.0
     def logger=(logger)
       @logger = logger
     end
@@ -46,8 +41,6 @@ module Mongoid
     #   Loggable.default_logger
     #
     # @return [ Logger ] The default logger.
-    #
-    # @since 3.0.0
     def default_logger
       logger = Logger.new(STDERR)
       logger.level = Mongoid::Config.log_level
@@ -62,8 +55,6 @@ module Mongoid
     #   Loggable.rails_logger
     #
     # @return [ Logger ] The Rails logger.
-    #
-    # @since 3.0.0
     def rails_logger
       if defined?(::Rails)
         ::Rails.logger

data/lib/mongoid/matchable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module contains all the behavior for Ruby implementations of MongoDB
   # selectors.
-  #
-  # @since 4.0.0
   module Matchable
     extend ActiveSupport::Concern
 
@@ -19,8 +16,6 @@ module Mongoid
     # @param [ Hash ] selector The MongoDB selector.
     #
     # @return [ true, false ] True if matches, false if not.
-    #
-    # @since 1.0.0
     def _matches?(selector)
       Matcher::Expression.matches?(self, selector)
     end

data/lib/mongoid/matcher/eq_impl.rb

@@ -23,10 +23,45 @@ module Mongoid
           end
 =end
         else
-          value == condition ||
-          value.is_a?(Array) && value.include?(condition)
+          # When doing a comparison with Time objects, compare using millisecond precision
+          if Mongoid.compare_time_by_ms
+            if value.kind_of?(Time) && condition.kind_of?(Time)
+              time_eq?(value, condition)
+            elsif value.is_a?(Array) && condition.kind_of?(Time)
+              value.map do |v|
+                if v.kind_of?(Time)
+                  time_rounded_to_millis(v)
+                else
+                  v
+                end
+              end.include?(time_rounded_to_millis(condition))
+            else
+              value == condition ||
+              value.is_a?(Array) && value.include?(condition)
+            end
+          else
+            value == condition ||
+            value.is_a?(Array) && value.include?(condition)
+          end
         end
       end
+
+      # Per https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/#time-instances,
+      # > Times in BSON (and MongoDB) can only have millisecond precision. When Ruby Time instances
+      # are serialized to BSON or Extended JSON, the times are floored to the nearest millisecond.
+      #
+      # > Because of this flooring, applications are strongly recommended to perform all time
+      # calculations using integer math, as inexactness of floating point calculations may produce
+      # unexpected results.
+      #
+      # As such, perform a similar operation to what the bson-ruby gem does
+      module_function def time_eq?(time_a, time_b)
+        time_rounded_to_millis(time_a) == time_rounded_to_millis(time_b)
+      end
+
+      module_function def time_rounded_to_millis(time)
+        return time._bson_to_i * 1000 + time.usec.divmod(1000).first
+      end
     end
   end
 end

data/lib/mongoid/matcher/eq_impl_with_regexp.rb

@@ -13,7 +13,12 @@ module Mongoid
         when ::BSON::Regexp::Raw
           value =~ condition.compile
         else
-          value == condition
+          if Mongoid.compare_time_by_ms &&
+            value.kind_of?(Time) && condition.kind_of?(Time)
+            EqImpl.time_eq?(value, condition)
+          else
+            value == condition
+          end
         end
       end
     end

data/lib/mongoid/persistable/creatable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Persistable
 
     # Defines behavior for persistence operations that create new documents.
-    #
-    # @since 4.0.0
     module Creatable
       extend ActiveSupport::Concern
 
@@ -19,8 +16,6 @@ module Mongoid
       # @param [ Hash ] options Options to pass to insert.
       #
       # @return [ Document ] The persisted document.
-      #
-      # @since 1.0.0
       def insert(options = {})
         prepare_insert(options) do
           if embedded?
@@ -41,8 +36,6 @@ module Mongoid
       #   document.inserts
       #
       # @return [ Hash ] The insert ops.
-      #
-      # @since 2.1.0
       def atomic_inserts
         { atomic_insert_modifier => { atomic_position => as_attributes }}
       end
@@ -55,8 +48,6 @@ module Mongoid
       #   document.insert_as_embedded
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def insert_as_embedded
         raise Errors::NoParent.new(self.class.name) unless _parent
         if _parent.new_record?
@@ -77,8 +68,6 @@ module Mongoid
       #   document.insert_as_root
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def insert_as_root
         collection.insert_one(as_attributes, session: _session)
       end
@@ -92,11 +81,9 @@ module Mongoid
       #   document.post_process_insert
       #
       # @return [ true ] true.
-      #
-      # @since 4.0.0
       def post_process_insert
         self.new_record = false
-        flag_children_persisted
+        flag_descendants_persisted
         true
       end
 
@@ -112,8 +99,6 @@ module Mongoid
       # @param [ Hash ] options The options.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def prepare_insert(options = {})
         return self if performing_validations?(options) &&
           invalid?(options[:context] || :create)
@@ -142,8 +127,6 @@ module Mongoid
         #   Array of multiple attributes for multiple documents.
         #
         # @return [ Document, Array<Document> ] The newly created document(s).
-        #
-        # @since 1.0.0
         def create(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)
@@ -171,8 +154,6 @@ module Mongoid
         #   Array of multiple attributes for multiple documents.
         #
         # @return [ Document, Array<Document> ] The newly created document(s).
-        #
-        # @since 1.0.0
         def create!(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)

data/lib/mongoid/persistable/deletable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Persistable
 
     # Defines behavior for persistence operations that delete documents.
-    #
-    # @since 4.0.0
     module Deletable
       extend ActiveSupport::Concern
 
@@ -18,8 +15,6 @@ module Mongoid
       # @param [ Hash ] options Options to pass to remove.
       #
       # @return [ TrueClass ] True.
-      #
-      # @since 1.0.0
       def delete(options = {})
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         prepare_delete do
@@ -44,8 +39,6 @@ module Mongoid
       #   document.atomic_deletes
       #
       # @return [ Hash ] The atomic deletes.
-      #
-      # @since 4.0.0
       def atomic_deletes
         { atomic_delete_modifier => { atomic_path => _index ? { "_id" => _id } : true }}
       end
@@ -60,8 +53,6 @@ module Mongoid
       # @param [ Hash ] options The deletion options.
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 4.0.0
       def delete_as_embedded(options = {})
         _parent.remove_child(self) if notifying_parent?(options)
         if _parent.persisted?
@@ -81,8 +72,6 @@ module Mongoid
       #   document.delete_as_root
       #
       # @return [ true ] If the document was removed.
-      #
-      # @since 4.0.0
       def delete_as_root
         collection.find(atomic_selector).delete_one(session: _session)
         true
@@ -98,8 +87,6 @@ module Mongoid
       # @param [ Hash ] options The delete options.
       #
       # @return [ true, false ] If the parent should be notified.
-      #
-      # @since 4.0.0
       def notifying_parent?(options = {})
         !options.delete(:suppress)
       end
@@ -114,8 +101,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 4.0.0
       def prepare_delete
         yield(self)
         freeze
@@ -137,8 +122,6 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to delete by.
         #
         # @return [ Integer ] The number of documents deleted.
-        #
-        # @since 1.0.0
         def delete_all(conditions = {})
           selector = hereditary? ? conditions.merge(discriminator_key.to_sym => discriminator_value) : conditions
           where(selector).delete

data/lib/mongoid/persistable/destroyable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Persistable
 
     # Defines behavior for persistence operations that destroy documents.
-    #
-    # @since 4.0.0
     module Destroyable
       extend ActiveSupport::Concern
 
@@ -18,8 +15,6 @@ module Mongoid
       # @param [ Hash ] options Options to pass to destroy.
       #
       # @return [ true, false ] True if successful, false if not.
-      #
-      # @since 1.0.0
       def destroy(options = nil)
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         self.flagged_for_destroy = true
@@ -53,8 +48,6 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to destroy by.
         #
         # @return [ Integer ] The number of documents destroyed.
-        #
-        # @since 1.0.0
         def destroy_all(conditions = nil)
           where(conditions || {}).destroy
         end

data/lib/mongoid/persistable/incrementable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Persistable
 
     # Defines behavior for $inc operations.
-    #
-    # @since 4.0.0
     module Incrementable
       extend ActiveSupport::Concern
 
@@ -20,8 +17,6 @@ module Mongoid
       # @param [ Hash ] increments The field/inc increment pairs.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def inc(increments)
         prepare_atomic_operation do |ops|
           process_atomic_operations(increments) do |field, value|

data/lib/mongoid/persistable/logical.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Persistable
 
     # Defines behavior for logical bitwise operations.
-    #
-    # @since 4.0.0
     module Logical
       extend ActiveSupport::Concern
 
@@ -19,8 +16,6 @@ module Mongoid
       # @param [ Hash ] operations The bitwise operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def bit(operations)
         prepare_atomic_operation do |ops|
           process_atomic_operations(operations) do |field, values|