mongoid 5.4.1 → 7.4.0

data/lib/mongoid/criteria/queryable/extensions/hash.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional hash behavior.
+        module Hash
+
+          # Add an object to a hash using the merge strategies.
+          #
+          # @example Add an object to a hash.
+          #   { field: value }.__add__({ field: other_value })
+          #
+          # @param [ Hash ] object The other hash to add.
+          #
+          # @return [ Hash ] The hash with object added.
+          def __add__(object)
+            apply_strategy(:__add__, object)
+          end
+
+          # Merge this hash into the provided array.
+          #
+          # @example Merge the hash into the array.
+          #   { field: value }.__add_from_array__([ 1, 2 ])
+          #
+          # @param [ Array ] array The array to add to.
+          #
+          # @return [ Hash ] The merged hash.
+          def __add_from_array__(array)
+            { keys.first => array.__add__(values.first) }
+          end
+
+          # Add an object to a hash using the merge strategies.
+          #
+          # @example Add an object to a hash.
+          #   { field: value }.__intersect__({ field: other_value })
+          #
+          # @param [ Hash ] object The other hash to intersect.
+          #
+          # @return [ Hash ] The hash with object intersected.
+          def __intersect__(object)
+            apply_strategy(:__intersect__, object)
+          end
+
+          # Merge this hash into the provided array.
+          #
+          # @example Merge the hash into the array.
+          #   { field: value }.__intersect_from_array__([ 1, 2 ])
+          #
+          # @param [ Array ] array The array to intersect to.
+          #
+          # @return [ Hash ] The merged hash.
+          def __intersect_from_array__(array)
+            { keys.first => array.__intersect__(values.first) }
+          end
+
+          # Merge this hash into the provided object.
+          #
+          # @example Merge the hash into the object.
+          #   { field: value }.__intersect_from_object__([ 1, 2 ])
+          #
+          # @param [ Object ] object The object to intersect to.
+          #
+          # @return [ Hash ] The merged hash.
+          def __intersect_from_object__(object)
+            { keys.first => object.__intersect__(values.first) }
+          end
+
+          # Add an object to a hash using the merge strategies.
+          #
+          # @example Add an object to a hash.
+          #   { field: value }.__union__({ field: other_value })
+          #
+          # @param [ Hash ] object The other hash to union.
+          #
+          # @return [ Hash ] The hash with object unioned.
+          def __union__(object)
+            apply_strategy(:__union__, object)
+          end
+
+          # Merge this hash into the provided object.
+          #
+          # @example Merge the hash into the object.
+          #   { field: value }.__union_from_object__([ 1, 2 ])
+          #
+          # @param [ Object ] object The object to union to.
+          #
+          # @return [ Hash ] The merged hash.
+          def __union_from_object__(object)
+            { keys.first => object.__union__(values.first) }
+          end
+
+          # Make a deep copy of this hash.
+          #
+          # @example Make a deep copy of the hash.
+          #   { field: value }.__deep_copy__
+          #
+          # @return [ Hash ] The copied hash.
+          def __deep_copy__
+            {}.tap do |copy|
+              each_pair do |key, value|
+                copy.store(key, value.__deep_copy__)
+              end
+            end
+          end
+
+          # Get the hash as a sort option.
+          #
+          # @example Get the hash as a sort option.
+          #   { field: 1 }.__sort_option__
+          #
+          # @return [ Hash ] The hash as sort option.
+          def __sort_option__
+            tap do |hash|
+              hash.each_pair do |key, value|
+                hash.store(key, value.to_direction)
+              end
+            end
+          end
+
+          # Get the object as expanded.
+          #
+          # @example Get the object expanded.
+          #   obj.__expand_complex__
+          #
+          # @return [ Hash ] The expanded hash.
+          def __expand_complex__
+            replacement = {}
+            each_pair do |key, value|
+              replacement.merge!(key.__expr_part__(value.__expand_complex__))
+            end
+            replacement
+          end
+
+          # Update all the values in the hash with the provided block.
+          #
+          # @example Update the values in place.
+          #   { field: "1" }.update_values(&:to_i)
+          #
+          # @param [ Proc ] block The block to execute on each value.
+          #
+          # @return [ Hash ] the hash.
+          def update_values(&block)
+            each_pair do |key, value|
+              store(key, block[value])
+            end
+          end
+
+          private
+
+          # Apply the provided strategy for the hash with the given object.
+          #
+          # @api private
+          #
+          # @example Apply the strategy.
+          #   { field: value }.apply_strategy(:__add__, 1)
+          #
+          # @param [ Symbol ] strategy The strategy to apply.
+          # @param [ Object ] object The object to merge.
+          #
+          # @return [ Hash ] The merged hash.
+          def apply_strategy(strategy, object)
+            tap do |hash|
+              object.each_pair do |key, value|
+                hash.store(key, hash[key].send(strategy, value))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Hash.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Hash)

data/lib/mongoid/criteria/queryable/extensions/nil_class.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional nil behavior.
+        module NilClass
+
+          # Add this object to nil.
+          #
+          # @example Add the object to a nil value.
+          #   nil.__add__([ 1, 2, 3 ])
+          #
+          # @param [ Object ] object The object to add.
+          #
+          # @return [ Object ] The provided object.
+          def __add__(object); object; end
+
+          # Add this object to nil.
+          #
+          # @example Add the object to a nil value.
+          #   nil.__expanded__([ 1, 2, 3 ])
+          #
+          # @param [ Object ] object The object to expanded.
+          #
+          # @return [ Object ] The provided object.
+          def __expanded__(object); object; end
+
+          # Evolve the nil into a date or time.
+          #
+          # @example Evolve the nil.
+          #   nil.__evolve_time__
+          #
+          # @return [ nil ] nil.
+          def __evolve_time__; self; end
+          alias :__evolve_date__ :__evolve_time__
+
+          # Add this object to nil.
+          #
+          # @example Add the object to a nil value.
+          #   nil.__intersect__([ 1, 2, 3 ])
+          #
+          # @param [ Object ] object The object to intersect.
+          #
+          # @return [ Object ] The provided object.
+          def __intersect__(object); object; end
+
+          # Add this object to nil.
+          #
+          # @example Add the object to a nil value.
+          #   nil.__override__([ 1, 2, 3 ])
+          #
+          # @param [ Object ] object The object to override.
+          #
+          # @return [ Object ] The provided object.
+          def __override__(object); object; end
+
+          # Add this object to nil.
+          #
+          # @example Add the object to a nil value.
+          #   nil.__union__([ 1, 2, 3 ])
+          #
+          # @param [ Object ] object The object to union.
+          #
+          # @return [ Object ] The provided object.
+          def __union__(object); object; end
+        end
+      end
+    end
+  end
+end
+
+::NilClass.__send__(:include, Mongoid::Criteria::Queryable::Extensions::NilClass)

data/lib/mongoid/criteria/queryable/extensions/numeric.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional numeric behavior.
+        module Numeric
+
+          # Evolve the numeric value into a mongo friendly date, aka UTC time at
+          # midnight.
+          #
+          # @example Evolve to a date.
+          #   125214512412.1123.__evolve_date__
+          #
+          # @return [ Time ] The time representation at UTC midnight.
+          def __evolve_date__
+            time = ::Time.at(self).utc
+            ::Time.utc(time.year, time.month, time.day, 0, 0, 0, 0)
+          end
+
+          # Evolve the numeric value into a mongo friendly time.
+          #
+          # @example Evolve to a time.
+          #   125214512412.1123.__evolve_time__
+          #
+          # @return [ Time ] The time representation.
+          def __evolve_time__
+            ::Time.at(self).utc
+          end
+
+          # Get the integer as a sort direction.
+          #
+          # @example Get the integer as a sort direction.
+          #   1.to_direction
+          #
+          # @return [ Integer ] self.
+          def to_direction; self; end
+
+          module ClassMethods
+
+            # Get the object as a numeric.
+            #
+            # @api private
+            #
+            # @example Get the object as numeric.
+            #   Object.__numeric__("1.442")
+            #
+            # @param [ Object ] object The object to convert.
+            #
+            # @return [ Object ] The converted number.
+            def __numeric__(object)
+              object.to_s =~ /(\A[-+]?[0-9]+\z)|(\.0+\z)|(\.\z)/ ? object.to_i : Float(object)
+            end
+
+            # Evolve the object to an integer.
+            #
+            # @example Evolve to integers.
+            #   Integer.evolve("1")
+            #
+            # @param [ Object ] object The object to evolve.
+            #
+            # @return [ Integer ] The evolved object.
+            def evolve(object)
+              __evolve__(object) do |obj|
+                __numeric__(obj) rescue obj
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Integer.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Numeric)
+::Integer.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Numeric::ClassMethods)
+
+::Float.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Numeric)
+::Float.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Numeric::ClassMethods)

data/lib/mongoid/criteria/queryable/extensions/object.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional object behavior.
+        module Object
+
+          # Combine the two objects using the add strategy.
+          #
+          # @example Add the object to the array.
+          #   [ 1, 2, 3 ].__add__(4)
+          #
+          # @param [ Object ] object The object to add.
+          #
+          # @return [ Object ] The result of the add.
+          def __add__(object)
+            (object == self) ? self : [ self, object ].flatten.uniq
+          end
+
+          # Merge this object into the provided array.
+          #
+          # @example Merge the object into the array.
+          #   4.__add_from_array__([ 1, 2 ])
+          #
+          # @param [ Array ] array The array to add to.
+          #
+          # @return [ Array ] The merged object.
+          def __add_from_array__(array)
+            array.concat(Array(self)).uniq
+          end
+
+          # Combine the two objects using the intersect strategy.
+          #
+          # @example Add the object to the array.
+          #   [ 1, 2, 3 ].__intersect__(4)
+          #
+          # @param [ Object ] object The object to intersect.
+          #
+          # @return [ Array ] The result of the intersect.
+          def __intersect__(object)
+            object.__intersect_from_object__(self)
+          end
+
+          # Merge this object into the provided array.
+          #
+          # @example Merge the object into the array.
+          #   4.__intersect_from_array__([ 1, 2 ])
+          #
+          # @param [ Array ] array The array to intersect to.
+          #
+          # @return [ Array ] The merged object.
+          def __intersect_from_array__(array)
+            array & Array(self)
+          end
+
+          # Merge this object into the provided array.
+          #
+          # @example Merge the object into the array.
+          #   4.__intersect_from_object__([ 1, 2 ])
+          #
+          # @param [ Object ] object The value to intersect to.
+          #
+          # @return [ Array ] The merged object.
+          def __intersect_from_object__(object)
+            Array(object) & Array(self)
+          end
+
+          # Combine the two objects using the union strategy.
+          #
+          # @example Add the object to the array.
+          #   [ 1, 2, 3 ].__union__(4)
+          #
+          # @param [ Object ] object The object to union.
+          #
+          # @return [ Array ] The result of the union.
+          def __union__(object)
+            object.__union_from_object__(self)
+          end
+
+          # Merge this object into the provided array.
+          #
+          # @example Merge the object into the array.
+          #   4.__union_from_object__([ 1, 2 ])
+          #
+          # @param [ Object ] object The value to union to.
+          #
+          # @return [ Array ] The merged object.
+          def __union_from_object__(object)
+            (Array(object) + Array(self)).uniq
+          end
+
+          # Deep copy the object. This is for API compatibility, but needs to be
+          # overridden.
+          #
+          # @example Deep copy the object.
+          #   1.__deep_copy__
+          #
+          # @return [ Object ] self.
+          def __deep_copy__; self; end
+
+          # Get the object as an array.
+          #
+          # @example Get the object as an array.
+          #   4.__array__
+          #
+          # @return [ Array ] The wrapped object.
+          def __array__
+            [ self ]
+          end
+
+          # Get the object as expanded.
+          #
+          # @example Get the object expanded.
+          #   obj.__expand_complex__
+          #
+          # @return [ Object ] self.
+          def __expand_complex__
+            self
+          end
+
+          # Is the object a regex.
+          #
+          # @example Is the object a regex?
+          #   obj.regexp?
+          #
+          # @return [ false ] Always false.
+          def regexp?
+            false
+          end
+
+          module ClassMethods
+
+            # Evolve the object.
+            #
+            # @note This is here for API compatibility.
+            #
+            # @example Evolve an object.
+            #   Object.evolve("test")
+            #
+            # @return [ Object ] The provided object.
+            def evolve(object)
+              object
+            end
+
+            private
+
+            # Evolve the object.
+            #
+            # @api private
+            #
+            # @todo Durran refactor out case statement.
+            #
+            # @example Evolve an object and yield.
+            #   Object.evolve("test") do |obj|
+            #     obj.to_s
+            #   end
+            #
+            # @return [ Object ] The evolved object.
+            def __evolve__(object)
+              return nil if object.nil?
+              case object
+              when ::Array
+                object.map{ |obj| evolve(obj) }
+              when ::Range
+                object.__evolve_range__
+              else
+                yield(object)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Object.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Object)
+::Object.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Object::ClassMethods)

data/lib/mongoid/criteria/queryable/extensions/range.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional range behavior.
+        module Range
+
+          # Get the range as an array.
+          #
+          # @example Get the range as an array.
+          #   1...3.__array__
+          #
+          # @return [ Array ] The range as an array.
+          def __array__
+            to_a
+          end
+
+          # Convert the range to a $gte/$lte mongo friendly query for dates.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_date__
+          #
+          # @return [ Hash ] The $gte/$lte range query with times at UTC midnight.
+          def __evolve_date__
+            __evolve_range_naive__.transform_values! {|v| v&.__evolve_date__ }
+          end
+
+          # Convert the range to a $gte/$lte mongo friendly query for times.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_date__
+          #
+          # @return [ Hash ] The $gte/$lte range query with times in UTC.
+          def __evolve_time__
+            __evolve_range_naive__.transform_values! {|v| v&.__evolve_time__ }
+          end
+
+          # Convert the range to a $gte/$lte mongo friendly query.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_range__
+          #
+          # @return [ Hash ] The $gte/$lte range query.
+          def __evolve_range__
+            __evolve_range_naive__.transform_values! do |value|
+              case value
+              when Time, DateTime then value.__evolve_time__
+              when Date then value.__evolve_date__
+              else value
+              end
+            end
+          end
+
+          private
+
+          # @note This method's return value will be mutated by the __evolve_*__
+          #   methods, therefore it must always return new objects.
+          #
+          # @api private
+          def __evolve_range_naive__
+            hash = {}
+            hash['$gte'] = self.begin if self.begin
+            hash[exclude_end? ? "$lt" : "$lte"] = self.end if self.end
+            hash
+          end
+
+          module ClassMethods
+
+            # Evolve the range. This will transform it into a $gte/$lte selection.
+            # Endless and beginning-less ranges will use only $gte or $lte respectively.
+            # End-excluded ranges (...) will use $lt selector instead of $lte.
+            #
+            # @example Evolve the range.
+            #   Range.evolve(1..3)
+            #
+            # @param [ Range ] object The range to evolve.
+            #
+            # @return [ Hash ] The range as a gte/lte criteria.
+            def evolve(object)
+              return object unless object.is_a?(::Range)
+              object.__evolve_range__
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Range.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Range)
+::Range.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Range::ClassMethods)

data/lib/mongoid/criteria/queryable/extensions/regexp.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional regex behavior.
+        module Regexp
+
+          # Is the object a regexp?
+          #
+          # @example Is the object a regex?
+          #   /\A[123]/.regexp?
+          #
+          # @return [ true ] Always true.
+          def regexp?; true; end
+
+          module ClassMethods
+
+            # Evolve the object into a regex.
+            #
+            # @example Evolve the object to a regex.
+            #   Regexp.evolve("\A[123]")
+            #
+            # @param [ Regexp, String ] object The object to evolve.
+            #
+            # @return [ Regexp ] The evolved regex.
+            def evolve(object)
+              __evolve__(object) do |obj|
+                ::Regexp.new(obj)
+              end
+            end
+          end
+
+          module Raw_
+
+            # Is the object a regexp?
+            #
+            # @example Is the object a regex?
+            #   bson_raw_regexp.regexp?
+            #
+            # @return [ true ] Always true.
+            def regexp?; true; end
+
+            module ClassMethods
+
+              # Evolve the object into a raw bson regex.
+              #
+              # @example Evolve the object to a regex.
+              #   BSON::Regexp::Raw.evolve("\\A[123]")
+              #
+              # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
+              #
+              # @return [ BSON::Regexp::Raw ] The evolved raw regex.
+              def evolve(object)
+                __evolve__(object) do |obj|
+                  obj.is_a?(String) ? BSON::Regexp::Raw.new(obj) : obj
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Regexp.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp)
+::Regexp.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::ClassMethods)
+BSON::Regexp::Raw.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp::Raw_)
+BSON::Regexp::Raw.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::Raw_::ClassMethods)