mongoid 7.3.5 → 7.4.0

data/lib/mongoid/errors/unsaved_document.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
 
     # Raised when attempting to call create or create! through a
     # references_many when the parent document has not been saved. This
-    # prevents the child from getting presisted and immediately being orphaned.
+    # prevents the child from getting persisted and immediately being orphaned.
     class UnsavedDocument < MongoidError
       def initialize(base, document)
         super(

data/lib/mongoid/errors/unsupported_javascript.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #
       # @param [ Class ] klass The embedded document class.
       # @param [ String ] javascript The javascript expression.
-      #
-      # @since 3.0.0
       def initialize(klass, javascript)
         super(
           compose_message(

data/lib/mongoid/errors/validations.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors

data/lib/mongoid/errors.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/errors/mongoid_error"
 require "mongoid/errors/ambiguous_relationship"

data/lib/mongoid/evolvable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -12,8 +11,6 @@ module Mongoid
     #   document.__evolve_object_id__
     #
     # @return [ Object ] The document's id.
-    #
-    # @since 3.0.0
     def __evolve_object_id__
       _id
     end

data/lib/mongoid/extensions/array.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   [ id ].__evolve_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         map!(&:__evolve_object_id__)
         self
@@ -24,8 +21,6 @@ module Mongoid
       #   [ 1, 2, 3 ].__find_args__
       #
       # @return [ Array ] The array of args.
-      #
-      # @since 3.0.0
       def __find_args__
         flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s }
       end
@@ -36,8 +31,6 @@ module Mongoid
       #   [ id ].__mongoize_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         map!(&:__mongoize_object_id__).compact!
         self
@@ -54,8 +47,6 @@ module Mongoid
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to date/time components
       #   in this array.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         ::Time.configured.local(*self)
       end
@@ -75,8 +66,6 @@ module Mongoid
       # for backwards compatibility only. It always returns false.
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.1.0
       # @deprecated
       def blank_criteria?
         false
@@ -88,8 +77,6 @@ module Mongoid
       #   [ 1, 2, 3 ].multi_arged?
       #
       # @return [ true, false ] If the array is multi args.
-      #
-      # @since 3.0.0
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
@@ -101,16 +88,13 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Array ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         ::Array.mongoize(self)
       end
 
       # Delete the first object in the array that is equal to the supplied
       # object and return it. This is much faster than performing a standard
-      # delete for large arrays ince it attempt to delete multiple in the
-      # other.
+      # delete for large arrays since it does not perform multiple deletes.
       #
       # @example Delete the first object.
       #   [ "1", "2", "1" ].delete_one("1")
@@ -118,21 +102,17 @@ module Mongoid
       # @param [ Object ] object The object to delete.
       #
       # @return [ Object ] The deleted object.
-      #
-      # @since 2.1.0
       def delete_one(object)
         position = index(object)
         position ? delete_at(position) : nil
       end
 
-      # Is the object's size changable?
+      # Returns whether the object's size can be changed.
       #
       # @example Is the object resizable?
       #   object.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -148,8 +128,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
-        #
-        # @since 3.0.0
         def __mongoize_fk__(association, object)
           if object.resizable?
             object.blank? ? object : association.convert_to_foreign_key(object)
@@ -167,8 +145,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           if object.is_a?(::Array)
             evolve(object).collect{ |obj| obj.class.mongoize(obj) }
@@ -177,14 +153,12 @@ module Mongoid
           end
         end
 
-        # Is the object's size changable?
+        # Returns whether the object's size can be changed.
         #
         # @example Is the object resizable?
         #   Array.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end

data/lib/mongoid/extensions/big_decimal.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   bd.__to_inc__
       #
       # @return [ Float ] The big decimal as a float.
-      #
-      # @since 3.0.3
       def __to_inc__
         to_f
       end
@@ -24,8 +21,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         to_s
       end
@@ -36,8 +31,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 6.0.0
       def numeric?
         true
       end
@@ -52,8 +45,6 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ BigDecimal, nil ] A BigDecimal derived from the object or nil.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object && object.numeric? ? BigDecimal(object.to_s) : nil
         end
@@ -66,8 +57,6 @@ module Mongoid
         # @param [ Object ] object The object to Mongoize
         #
         # @return [ String, nil ] A String representing the object or nil.
-        #
-        # @since 3.0.7
         def mongoize(object)
           object && object.numeric? ? object.to_s : nil
         end

data/lib/mongoid/extensions/boolean.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Boolean
@@ -13,8 +12,6 @@ module Mongoid
       #   Boolean.mongoize("123.11")
       #
       # @return [ String ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize(object)
         evolve(object)
       end

data/lib/mongoid/extensions/date.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -20,8 +19,6 @@ module Mongoid
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to local midnight of
       #   this date.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         ::Time.configured.local(year, month, day)
       end
@@ -33,8 +30,6 @@ module Mongoid
       #   date.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Date.mongoize(self)
       end
@@ -49,8 +44,6 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ Date ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Date.new(object.year, object.month, object.day) if object
         end
@@ -64,8 +57,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             begin

data/lib/mongoid/extensions/date_time.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   date_time.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         if Mongoid.use_activesupport_time_zone?
           in_time_zone(::Time.zone)
@@ -29,8 +26,6 @@ module Mongoid
       #   date_time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::DateTime.mongoize(self)
       end
@@ -45,8 +40,6 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ DateTime ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Time.demongoize(object).try(:to_datetime)
         end
@@ -60,8 +53,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           ::Time.mongoize(object)
         end

data/lib/mongoid/extensions/decimal128.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   decimal128.__evolve_decimal128__
       #
       # @return [ BSON::Decimal128 ] self.
-      #
-      # @since 6.1.0
       def __evolve_decimal128__
         self
       end
@@ -27,8 +24,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::Decimal128 ] The decimal128.
-        #
-        # @since 6.1.0
         def evolve(object)
           object.__evolve_decimal128__
         end

data/lib/mongoid/extensions/false_class.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
     module FalseClass
 
-      # Get the value of the object as a mongo friendy sort value.
+      # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 0.
-      #
-      # @since 3.0.0
       def __sortable__
         0
       end
@@ -25,8 +22,6 @@ module Mongoid
       # @param [ Class ] other The class to check.
       #
       # @return [ true, false ] If the other is a boolean.
-      #
-      # @since 1.0.0
       def is_a?(other)
         if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true

data/lib/mongoid/extensions/float.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   1335532685.117847.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         ::Time.configured.at(self)
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -40,8 +35,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             __numeric__(object).to_f rescue 0.0

data/lib/mongoid/extensions/hash.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   { field: id }.__evolve_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         update_values(&:__evolve_object_id__)
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   { field: id }.__mongoize_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         if id = self['$oid']
           BSON::ObjectId.from_string(id)
@@ -39,8 +34,6 @@ module Mongoid
       #   { name: "Placebo" }.__consolidate__
       #
       # @return [ Hash ] A new consolidated hash.
-      #
-      # @since 3.0.0
       def __consolidate__(klass)
         consolidated = {}
         each_pair do |key, value|
@@ -103,8 +96,6 @@ module Mongoid
       #
       # @return [ true | false ] Whether hash contains known unsatisfiable
       #   conditions.
-      #
-      # @since 3.1.0
       # @deprecated
       alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
 
@@ -114,8 +105,6 @@ module Mongoid
       #   {}.delete_id
       #
       # @return [ Object ] The deleted value, or nil.
-      #
-      # @since 3.0.2
       def delete_id
         delete("_id") || delete(:_id) || delete("id") || delete(:id)
       end
@@ -127,8 +116,6 @@ module Mongoid
       #   { :_id => 1 }.extract_id
       #
       # @return [ Object ] The value of the id.
-      #
-      # @since 2.3.2
       def extract_id
         self["_id"] || self[:_id] || self["id"] || self[:id]
       end
@@ -141,8 +128,6 @@ module Mongoid
       # @param [ String ] string the dot syntax string.
       #
       # @return [ Object ] The matching value.
-      #
-      # @since 3.0.15
       def __nested__(string)
         keys = string.split(".")
         value = self
@@ -164,8 +149,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Hash ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -176,8 +159,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -190,8 +171,6 @@ module Mongoid
       #   { klass: Band, where: { name: "Depeche Mode" }.to_criteria
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.7
       def to_criteria
         criteria = Criteria.new(delete(:klass) || delete("klass"))
         each_pair do |method, args|
@@ -215,8 +194,6 @@ module Mongoid
       # @param [ Object ] value The value to mongoize.
       #
       # @return [ Object ] The mongoized value.
-      #
-      # @since 3.1.0
       def mongoize_for(operator, klass, key, value)
         field = klass.fields[key.to_s]
         if field
@@ -241,8 +218,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           return if object.nil?
           evolve(object.dup).update_values { |value| value.mongoize }
@@ -254,8 +229,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end

data/lib/mongoid/extensions/integer.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   1335532685.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         ::Time.configured.at(self)
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -35,8 +30,6 @@ module Mongoid
       #   object.unconvertable_to_bson?
       #
       # @return [ true ] If the object is unconvertable.
-      #
-      # @since 2.2.1
       def unconvertable_to_bson?
         true
       end
@@ -50,8 +43,6 @@ module Mongoid
         #   BigDecimal.mongoize("123.11")
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             __numeric__(object).to_i rescue 0

data/lib/mongoid/extensions/module.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -17,8 +16,6 @@ module Mongoid
       # @param [ Proc ] block The method body.
       #
       # @return [ Method ] The new method.
-      #
-      # @since 3.0.0
       def re_define_method(name, &block)
         undef_method(name) if method_defined?(name)
         define_method(name, &block)

data/lib/mongoid/extensions/nil_class.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 3.1.0
       def __setter__
         self
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   nil.collectionize
       #
       # @return [ String ] A blank string.
-      #
-      # @since 1.0.0
       def collectionize
         to_s.collectionize
       end