mongoid 9.0.11 → 9.1.1

data/lib/mongoid/extensions/module.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to Module class.
     module Module
-
       # Redefine the method. Will undef the method if it exists or simply
       # just define it.
       #
@@ -27,4 +24,4 @@ module Mongoid
   end
 end
 
-::Module.__send__(:include, Mongoid::Extensions::Module)
+Module.include Mongoid::Extensions::Module

data/lib/mongoid/extensions/nil_class.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions

data/lib/mongoid/extensions/object.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
@@ -18,7 +17,7 @@ module Mongoid
       def __evolve_object_id__
         self
       end
-      alias :__mongoize_object_id__ :__evolve_object_id__
+      alias __mongoize_object_id__ __evolve_object_id__
 
       # Convert the object to args for a find query.
       #
@@ -68,7 +67,6 @@ module Mongoid
       end
       Mongoid.deprecate(self, :__to_inc__)
 
-
       # Do or do not, there is no try. -- Yoda.
       #
       # @example Do or do not.
@@ -95,11 +93,9 @@ module Mongoid
       # @return [ Object | false ] The value or false.
       def ivar(name)
         var_name = "@_#{name}"
-        if instance_variable_defined?(var_name)
-          return instance_variable_get(var_name)
-        else
-          false
-        end
+        return instance_variable_get(var_name) if instance_variable_defined?(var_name)
+
+        false
       end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -144,11 +140,9 @@ module Mongoid
       #
       # @return [ true | false ] If the variable was defined.
       def remove_ivar(name)
-        if instance_variable_defined?("@_#{name}")
-          return remove_instance_variable("@_#{name}")
-        else
-          false
-        end
+        return remove_instance_variable("@_#{name}") if instance_variable_defined?("@_#{name}")
+
+        false
       end
 
       # Is the object's size changable? Only returns true for arrays and hashes
@@ -201,7 +195,8 @@ module Mongoid
         # @return [ Object ] The converted object.
         # @deprecated
         def __mongoize_fk__(association, object)
-          return nil if !object || object == ""
+          return nil if !object || object == ''
+
           association.convert_to_foreign_key(object)
         end
         Mongoid.deprecate(self, :__mongoize_fk__)

data/lib/mongoid/extensions/object_id.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to BSON::ObjectId.
     module ObjectId
-
       # Evolve the object id.
       #
       # @example Evolve the object id.
@@ -16,10 +13,9 @@ module Mongoid
       def __evolve_object_id__
         self
       end
-      alias :__mongoize_object_id__ :__evolve_object_id__
+      alias __mongoize_object_id__ __evolve_object_id__
 
       module ClassMethods
-
         # Evolve the object into a mongo-friendly value to query with.
         #
         # @example Evolve the object.
@@ -48,5 +44,5 @@ module Mongoid
   end
 end
 
-BSON::ObjectId.__send__(:include, Mongoid::Extensions::ObjectId)
+BSON::ObjectId.include Mongoid::Extensions::ObjectId
 BSON::ObjectId.extend(Mongoid::Extensions::ObjectId::ClassMethods)

data/lib/mongoid/extensions/range.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
@@ -53,17 +52,18 @@ module Mongoid
         # @return [ Range | nil ] The range, or nil if object cannot be represented as range.
         def demongoize(object)
           return if object.nil?
-          if object.is_a?(Hash)
-            hash = object.slice('min', 'max', 'exclude_end', :min, :max, :exclude_end)
-            unless hash.blank?
-              begin
-                ::Range.new(hash["min"] || hash[:min],
-                            hash["max"] || hash[:max],
-                            hash["exclude_end"] || hash[:exclude_end])
-              rescue ArgumentError
-                nil
-              end
-            end
+
+          return unless object.is_a?(Hash)
+
+          hash = object.slice('min', 'max', 'exclude_end', :min, :max, :exclude_end)
+          return if hash.blank?
+
+          begin
+            ::Range.new(hash['min'] || hash[:min],
+                        hash['max'] || hash[:max],
+                        hash['exclude_end'] || hash[:exclude_end])
+          rescue ArgumentError
+            nil
           end
         end
 
@@ -78,6 +78,7 @@ module Mongoid
         # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
+
           case object
           when Hash then __mongoize_hash__(object)
           when Range then __mongoize_range__(object)
@@ -98,9 +99,7 @@ module Mongoid
           hash = {}
           hash['min'] = object.begin.mongoize if object.begin
           hash['max'] = object.end.mongoize if object.end
-          if object.respond_to?(:exclude_end?) && object.exclude_end?
-            hash['exclude_end'] = true
-          end
+          hash['exclude_end'] = true if object.respond_to?(:exclude_end?) && object.exclude_end?
           hash
         end
       end

data/lib/mongoid/extensions/raw_value.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Wrapper class used when a value cannot be casted in evolve method.
 module Mongoid
-
   # Instantiates a new Mongoid::RawValue object. Used as a syntax shortcut.
   #
   # @example Create a Mongoid::RawValue object.
@@ -16,7 +14,6 @@ module Mongoid
 
   # Represents a value which cannot be type-casted between Ruby and MongoDB.
   class RawValue
-
     attr_reader :raw_value
 
     def initialize(raw_value)

data/lib/mongoid/extensions/regexp.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to Regexp class.
     module Regexp
-
       module ClassMethods
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -20,6 +16,7 @@ module Mongoid
         # @return [ Regexp | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
+
           case object
           when String then ::Regexp.new(object)
           when ::Regexp then object
@@ -28,10 +25,10 @@ module Mongoid
         rescue RegexpError
           nil
         end
-        alias :demongoize :mongoize
+        alias demongoize mongoize
       end
     end
   end
 end
 
-::Regexp.extend(Mongoid::Extensions::Regexp::ClassMethods)
+Regexp.extend(Mongoid::Extensions::Regexp::ClassMethods)

data/lib/mongoid/extensions/set.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to Set class.
     module Set
       # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -54,6 +52,7 @@ module Mongoid
         # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
+
           case object
           when ::Set then ::Array.mongoize(object.to_a).uniq
           when ::Array then ::Array.mongoize(object).uniq
@@ -64,5 +63,5 @@ module Mongoid
   end
 end
 
-::Set.__send__(:include, Mongoid::Extensions::Set)
-::Set.extend(Mongoid::Extensions::Set::ClassMethods)
+Set.include Mongoid::Extensions::Set
+Set.extend(Mongoid::Extensions::Set::ClassMethods)

data/lib/mongoid/extensions/string.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to String class.
     module String
-
       # @attribute [rw] unconvertable_to_bson If the document is unconvertable.
       # @deprecated
       attr_accessor :unconvertable_to_bson
+
       Mongoid.deprecate(self, :unconvertable_to_bson, :unconvertable_to_bson=)
 
       # Evolve the string into an object id if possible.
@@ -60,7 +58,7 @@ module Mongoid
       #
       # @return [ String ] The string in collection friendly form.
       def collectionize
-        tableize.gsub("/", "_")
+        tableize.tr('/', '_')
       end
 
       # Is the string a valid value for a Mongoid id?
@@ -95,7 +93,7 @@ module Mongoid
       #
       # @return [ String ] The string stripped of "=".
       def reader
-        delete("=").sub(/\_before\_type\_cast\z/, '')
+        delete('=').sub(/_before_type_cast\z/, '')
       end
 
       # Is this string a writer?
@@ -105,7 +103,7 @@ module Mongoid
       #
       # @return [ true | false ] If the string contains "=".
       def writer?
-        include?("=")
+        include?('=')
       end
 
       # Is this string a valid_method_name?
@@ -125,10 +123,9 @@ module Mongoid
       #
       # @return [ true | false ] If the string ends with "_before_type_cast"
       def before_type_cast?
-        ends_with?("_before_type_cast")
+        ends_with?('_before_type_cast')
       end
 
-
       # Is the object not to be converted to bson on criteria creation?
       #
       # @example Is the object unconvertable?
@@ -156,7 +153,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -169,11 +165,11 @@ module Mongoid
         def mongoize(object)
           object.try(:to_s)
         end
-        alias :demongoize :mongoize
+        alias demongoize mongoize
       end
     end
   end
 end
 
-::String.__send__(:include, Mongoid::Extensions::String)
-::String.extend(Mongoid::Extensions::String::ClassMethods)
+String.include Mongoid::Extensions::String
+String.extend(Mongoid::Extensions::String::ClassMethods)

data/lib/mongoid/extensions/symbol.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to Symbol class.
     module Symbol
-
       # Is the symbol a valid value for a Mongoid id?
       #
       # @example Is the string an id value?
@@ -20,7 +17,6 @@ module Mongoid
       Mongoid.deprecate(self, :mongoid_id?)
 
       module ClassMethods
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -33,11 +29,11 @@ module Mongoid
         def mongoize(object)
           object.try(:to_sym)
         end
-        alias :demongoize :mongoize
+        alias demongoize mongoize
       end
     end
   end
 end
 
-::Symbol.__send__(:include, Mongoid::Extensions::Symbol)
-::Symbol.extend(Mongoid::Extensions::Symbol::ClassMethods)
+Symbol.include Mongoid::Extensions::Symbol
+Symbol.extend(Mongoid::Extensions::Symbol::ClassMethods)

data/lib/mongoid/extensions/time.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to Time class.
     module Time
-
       # Mongoizes a Time into a time.
       #
       # Time always mongoize into Time instances
@@ -29,7 +26,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -40,19 +36,20 @@ module Mongoid
         # @return [ Time | nil ] The object as a time.
         def demongoize(object)
           return if object.blank?
+
           time = if object.acts_like?(:time)
-            Mongoid::Config.use_utc? ? object : object.getlocal
-          elsif object.acts_like?(:date)
-            ::Date.demongoize(object).to_time
-          elsif object.is_a?(String)
-            begin
-              object.__mongoize_time__
-            rescue ArgumentError
-              nil
-            end
-          elsif object.is_a?(BSON::Timestamp)
-            ::Time.at(object.seconds)
-          end
+                   Mongoid::Config.use_utc? ? object : object.getlocal
+                 elsif object.acts_like?(:date)
+                   ::Date.demongoize(object).to_time
+                 elsif object.is_a?(String)
+                   begin
+                     object.__mongoize_time__
+                   rescue ArgumentError
+                     nil
+                   end
+                 elsif object.is_a?(BSON::Timestamp)
+                   ::Time.at(object.seconds)
+                 end
 
           return if time.nil?
 
@@ -70,20 +67,21 @@ module Mongoid
         # @return [ Time | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.blank?
+
           begin
             time = object.respond_to?(:__mongoize_time__) ? object.__mongoize_time__ : nil
           rescue ArgumentError
             return
           end
 
-          if time.acts_like?(:time)
-            if object.respond_to?(:sec_fraction)
-              ::Time.at(time.to_i, object.sec_fraction * 10**6).utc
-            elsif time.respond_to?(:subsec)
-              ::Time.at(time.to_i, time.subsec * 10**6).utc
-            else
-              ::Time.at(time.to_i, time.usec).utc
-            end
+          return unless time.acts_like?(:time)
+
+          if object.respond_to?(:sec_fraction)
+            ::Time.at(time.to_i, object.sec_fraction * (10**6)).utc
+          elsif time.respond_to?(:subsec)
+            ::Time.at(time.to_i, time.subsec * (10**6)).utc
+          else
+            ::Time.at(time.to_i, time.usec).utc
           end
         end
       end
@@ -91,5 +89,5 @@ module Mongoid
   end
 end
 
-::Time.__send__(:include, Mongoid::Extensions::Time)
-::Time.extend(Mongoid::Extensions::Time::ClassMethods)
+Time.include Mongoid::Extensions::Time
+Time.extend(Mongoid::Extensions::Time::ClassMethods)

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
-
     # Adds type-casting behavior to ActiveSupport::TimeWithZone class.
     module TimeWithZone
-
       # Mongoizes an ActiveSupport::TimeWithZone into a time.
       #
       # TimeWithZone always mongoize into TimeWithZone instances
@@ -33,17 +30,17 @@ module Mongoid
       # See https://jira.mongodb.org/browse/MONGOID-5491.
       def _bson_to_i
         return super if defined?(super)
+
         # Workaround for JRuby's #to_i rounding negative timestamps up
         # rather than down (https://github.com/jruby/jruby/issues/6104)
         if BSON::Environment.jruby?
-          (self - usec.to_r/1000000).to_i
+          (self - (usec.to_r / 1_000_000)).to_i
         else
           to_i
         end
       end
 
       module ClassMethods
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @example Demongoize the object.
@@ -73,5 +70,5 @@ module Mongoid
   end
 end
 
-::ActiveSupport::TimeWithZone.__send__(:include, Mongoid::Extensions::TimeWithZone)
-::ActiveSupport::TimeWithZone.extend(Mongoid::Extensions::TimeWithZone::ClassMethods)
+ActiveSupport::TimeWithZone.include Mongoid::Extensions::TimeWithZone
+ActiveSupport::TimeWithZone.extend(Mongoid::Extensions::TimeWithZone::ClassMethods)

data/lib/mongoid/extensions/true_class.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Extensions
@@ -26,10 +25,9 @@ module Mongoid
       #
       # @return [ true | false ] If the other is a boolean.
       def is_a?(other)
-        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
-          return true
-        end
-        super(other)
+        return true if other == Mongoid::Boolean || other.class == Mongoid::Boolean
+
+        super
       end
     end
   end

data/lib/mongoid/extensions/vector.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Extensions
+    # Adds type-casting behavior to BSON::Vector class so that a field
+    # declared with +type: BSON::Vector+ is stored as a BSON binary of the
+    # vector subtype and read back as a BSON::Vector.
+    #
+    # Querying by an exact vector value (e.g. +where(embedding: vector)+) is
+    # not supported: BSON::Vector subclasses Array, so the criteria selector
+    # treats it as a list of elements rather than a scalar. Use Atlas Vector
+    # Search ($vectorSearch) for similarity queries on vector fields.
+    module Vector
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ BSON::Binary | nil ] The object as a vector binary.
+      def mongoize
+        BSON::Vector.mongoize(self)
+      end
+
+      module ClassMethods
+        # Mongoize an object of any type to how it's stored in the db.
+        #
+        # @example Mongoize the object.
+        #   BSON::Vector.mongoize(vector)
+        #
+        # @param [ Object ] object The object to Mongoize.
+        #
+        # @return [ BSON::Binary | nil ] A vector binary or nil.
+        def mongoize(object)
+          case object
+          when BSON::Vector then BSON::Binary.from_vector(object)
+          when BSON::Binary then object
+          end
+        end
+
+        # Convert the object from its mongo friendly ruby type back to a
+        # BSON::Vector.
+        #
+        # @example Demongoize the object.
+        #   BSON::Vector.demongoize(binary)
+        #
+        # @param [ Object ] object The object to demongoize.
+        #
+        # @return [ BSON::Vector | nil ] The vector or nil.
+        def demongoize(object)
+          case object
+          when BSON::Binary then (object.type == :vector) ? object.as_vector : nil
+          when BSON::Vector then object
+          end
+        end
+      end
+    end
+  end
+end
+
+if defined?(BSON::Vector)
+  BSON::Vector.include Mongoid::Extensions::Vector
+  BSON::Vector.extend(Mongoid::Extensions::Vector::ClassMethods)
+end

data/lib/mongoid/extensions.rb

@@ -1,28 +1,29 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/extensions/array"
-require "mongoid/extensions/big_decimal"
-require "mongoid/extensions/binary"
-require "mongoid/extensions/boolean"
-require "mongoid/extensions/date"
-require "mongoid/extensions/date_time"
-require "mongoid/extensions/decimal128"
-require "mongoid/extensions/false_class"
-require "mongoid/extensions/float"
-require "mongoid/extensions/hash"
-require "mongoid/extensions/integer"
-require "mongoid/extensions/module"
-require "mongoid/extensions/nil_class"
-require "mongoid/extensions/object"
-require "mongoid/extensions/object_id"
-require "mongoid/extensions/range"
-require "mongoid/extensions/raw_value"
-require "mongoid/extensions/regexp"
-require "mongoid/extensions/set"
-require "mongoid/extensions/string"
-require "mongoid/stringified_symbol"
-require "mongoid/extensions/symbol"
-require "mongoid/extensions/time"
-require "mongoid/extensions/time_with_zone"
-require "mongoid/extensions/true_class"
+require 'mongoid/extensions/array'
+require 'mongoid/extensions/bson_document'
+require 'mongoid/extensions/big_decimal'
+require 'mongoid/extensions/binary'
+require 'mongoid/extensions/boolean'
+require 'mongoid/extensions/date'
+require 'mongoid/extensions/date_time'
+require 'mongoid/extensions/decimal128'
+require 'mongoid/extensions/false_class'
+require 'mongoid/extensions/float'
+require 'mongoid/extensions/hash'
+require 'mongoid/extensions/integer'
+require 'mongoid/extensions/module'
+require 'mongoid/extensions/nil_class'
+require 'mongoid/extensions/object'
+require 'mongoid/extensions/object_id'
+require 'mongoid/extensions/range'
+require 'mongoid/extensions/raw_value'
+require 'mongoid/extensions/regexp'
+require 'mongoid/extensions/set'
+require 'mongoid/extensions/string'
+require 'mongoid/stringified_symbol'
+require 'mongoid/extensions/symbol'
+require 'mongoid/extensions/time'
+require 'mongoid/extensions/time_with_zone'
+require 'mongoid/extensions/true_class'
+require 'mongoid/extensions/vector'