mongoid 5.4.0 → 6.4.8

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

@@ -0,0 +1,90 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional numeric behaviour.
+        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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+            #
+            # @since 1.0.0
+            def __numeric__(object)
+              object.to_s =~ /(^[-+]?[0-9]+$)|(\.0+$)|(\.$)/ ? 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.
+            #
+            # @since 1.0.0
+            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,206 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional object behaviour.
+        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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          def __array__
+            [ self ]
+          end
+
+          # Get the object as expanded.
+          #
+          # @example Get the object expanded.
+          #   obj.__expand_complex__
+          #
+          # @return [ Object ] self.
+          #
+          # @since 1.0.5
+          def __expand_complex__
+            self
+          end
+
+          # Is the object a regex.
+          #
+          # @example Is the object a regex?
+          #   obj.regexp?
+          #
+          # @return [ false ] Always false.
+          #
+          # @since 1.0.4
+          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.
+            #
+            # @since 1.0.0
+            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.
+            #
+            # @since 1.0.0
+            def __evolve__(object)
+              return nil if object.nil?
+              case object
+              when ::Array
+                object.map{ |obj| evolve(obj) }
+              when ::Range
+                { "$gte" => evolve(object.min), "$lte" => evolve(object.max) }
+              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,70 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional range behaviour.
+        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.
+          #
+          # @since 1.0.0
+          def __array__
+            to_a
+          end
+
+          # Convert the range to a min/max mongo friendly query for dates.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_date__
+          #
+          # @return [ Hash ] The min/max range query with times at midnight.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            { "$gte" => min.__evolve_date__, "$lte" => max.__evolve_date__ }
+          end
+
+          # Convert the range to a min/max mongo friendly query for times.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_date__
+          #
+          # @return [ Hash ] The min/max range query with times.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            { "$gte" => min.__evolve_time__, "$lte" => max.__evolve_time__ }
+          end
+
+          module ClassMethods
+
+            # Evolve the range. This will transform it into a $gte/$lte selection.
+            #
+            # @example Evolve the range.
+            #   Range.evolve(1..3)
+            #
+            # @param [ Range ] object The range to evolve.
+            #
+            # @return [ Hash ] The range as a gte/lte criteria.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              return object unless object.is_a?(::Range)
+              { "$gte" => object.min, "$lte" => object.max }
+            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,79 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional regex behaviour.
+        module Regexp
+
+          # Is the object a regexp?
+          #
+          # @example Is the object a regex?
+          #   /^[123]/.regexp?
+          #
+          # @return [ true ] Always true.
+          #
+          # @since 1.0.0
+          def regexp?; true; end
+
+          module ClassMethods
+
+            # Evolve the object into a regex.
+            #
+            # @example Evolve the object to a regex.
+            #   Regexp.evolve("^[123]")
+            #
+            # @param [ Regexp, String ] object The object to evolve.
+            #
+            # @return [ Regexp ] The evolved regex.
+            #
+            # @since 1.0.0
+            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.
+            #
+            # @since 5.2.1
+            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("^[123]")
+              #
+              # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
+              #
+              # @return [ BSON::Regexp::Raw ] The evolved raw regex.
+              #
+              # @since 5.2.1
+              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)

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require "set"
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional object behaviour.
+        module Set
+          module ClassMethods
+
+            # Evolve the set, casting all its elements.
+            #
+            # @example Evolve the set.
+            #   Set.evolve(set)
+            #
+            # @param [ Set, Object ] object The object to evolve.
+            #
+            # @return [ Array ] The evolved set.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              return object if !object || !object.respond_to?(:map)
+              object.map{ |obj| obj.class.evolve(obj) }
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Set.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Set::ClassMethods)

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

@@ -0,0 +1,137 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional object behaviour.
+        module String
+
+          # Evolve the string into a mongodb friendly date.
+          #
+          # @example Evolve the string.
+          #   "2012-1-1".__evolve_date__
+          #
+          # @return [ Time ] The time at UTC midnight.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            time = ::Time.parse(self)
+            ::Time.utc(time.year, time.month, time.day, 0, 0, 0, 0)
+          end
+
+          # Evolve the string into a mongodb friendly time.
+          #
+          # @example Evolve the string.
+          #   "2012-1-1".__evolve_time__
+          #
+          # @return [ Time ] The string as a time.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            ::Time.parse(self).utc
+          end
+
+          # Get the string as a mongo expression, adding $ to the front.
+          #
+          # @example Get the string as an expression.
+          #   "test".__mongo_expression__
+          #
+          # @return [ String ] The string with $ at the front.
+          #
+          # @since 2.0.0
+          def __mongo_expression__
+            start_with?("$") ? self : "$#{self}"
+          end
+
+          # Get the string as a sort option.
+          #
+          # @example Get the string as a sort option.
+          #   "field ASC".__sort_option__
+          #
+          # @return [ Hash ] The string as a sort option hash.
+          #
+          # @since 1.0.0
+          def __sort_option__
+            split(/,/).inject({}) do |hash, spec|
+              hash.tap do |_hash|
+                field, direction = spec.strip.split(/\s/)
+                _hash[field.to_sym] = direction.to_direction
+              end
+            end
+          end
+
+          # Get the string as a specification.
+          #
+          # @example Get the string as a criteria.
+          #   "field".__expr_part__(value)
+          #
+          # @param [ Object ] value The value of the criteria.
+          # @param [ true, false ] negating If the selection should be negated.
+          #
+          # @return [ Hash ] The selection.
+          #
+          # @since 1.0.0
+          def __expr_part__(value, negating = false)
+            ::String.__expr_part__(self, value, negating)
+          end
+
+          # Get the string as a sort direction.
+          #
+          # @example Get the string as a sort direction.
+          #   "1".to_direction
+          #
+          # @return [ Integer ] The direction.
+          #
+          # @since 1.0.0
+          def to_direction
+            self =~ /desc/i ? -1 : 1
+          end
+
+          module ClassMethods
+
+            # Get the value as a expression.
+            #
+            # @example Get the value as an expression.
+            #   String.__expr_part__("field", value)
+            #
+            # @param [ String, Symbol ] key The field key.
+            # @param [ Object ] value The value of the criteria.
+            # @param [ true, false ] negating If the selection should be negated.
+            #
+            # @return [ Hash ] The selection.
+            #
+            # @since 2.0.0
+            def __expr_part__(key, value, negating = false)
+              if negating
+                { key => { "$#{value.regexp? ? "not" : "ne"}" => value }}
+              else
+                { key => value }
+              end
+            end
+
+            # Evolves the string into a MongoDB friendly value - in this case
+            # a string.
+            #
+            # @example Evolve the string
+            #   String.evolve(1)
+            #
+            # @param [ Object ] object The object to convert.
+            #
+            # @return [ String ] The value as a string.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              __evolve__(object) do |obj|
+                obj.regexp? ? obj : obj.to_s
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::String.__send__(:include, Mongoid::Criteria::Queryable::Extensions::String)
+::String.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::String::ClassMethods)

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

@@ -0,0 +1,79 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional symbol behaviour.
+        module Symbol
+
+          # Get the symbol as a specification.
+          #
+          # @example Get the symbol as a criteria.
+          #   :field.__expr_part__(value)
+          #
+          # @param [ Object ] value The value of the criteria.
+          # @param [ true, false ] negating If the selection should be negated.
+          #
+          # @return [ Hash ] The selection.
+          #
+          # @since 1.0.0
+          def __expr_part__(value, negating = false)
+            ::String.__expr_part__(self, value, negating)
+          end
+
+          # Get the symbol as a sort direction.
+          #
+          # @example Get the symbol as a sort direction.
+          #   "1".to_direction
+          #
+          # @return [ Integer ] The direction.
+          #
+          # @since 1.0.0
+          def to_direction
+            to_s.to_direction
+          end
+
+          module ClassMethods
+
+            # Adds a method on symbol as a convenience for the MongoDB operator.
+            #
+            # @example Add the $in method.
+            #   Symbol.add_key(:in, "$in")
+            #
+            # @param [ Symbol ] name The name of the method.
+            # @param [ Symbol ] strategy The name of the merge strategy.
+            # @param [ String ] operator The MongoDB operator.
+            # @param [ String ] additional The additional MongoDB operator.
+            #
+            # @since 1.0.0
+            def add_key(name, strategy, operator, additional = nil, &block)
+              define_method(name) do
+                method = "__#{strategy}__".to_sym
+                Key.new(self, method, operator, additional, &block)
+              end
+            end
+
+            # Evolves the symbol into a MongoDB friendly value - in this case
+            # a symbol.
+            #
+            # @example Evolve the symbol
+            #   Symbol.evolve("test")
+            #
+            # @param [ Object ] object The object to convert.
+            #
+            # @return [ Symbol ] The value as a symbol.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              __evolve__(object) { |obj| obj.to_sym }
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Symbol.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Symbol)
+::Symbol.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Symbol::ClassMethods)