mongoid 5.4.1 → 6.0.0.beta

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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+unless defined?(Boolean)
+  class Boolean; end
+end
+
+if defined?(ActiveSupport)
+  unless defined?(ActiveSupport::TimeWithZone)
+    require "active_support/time_with_zone"
+  end
+  require "mongoid/criteria/queryable/extensions/time_with_zone"
+end
+
+require "time"
+require "mongoid/criteria/queryable/extensions/object"
+require "mongoid/criteria/queryable/extensions/array"
+require "mongoid/criteria/queryable/extensions/big_decimal"
+require "mongoid/criteria/queryable/extensions/boolean"
+require "mongoid/criteria/queryable/extensions/date"
+require "mongoid/criteria/queryable/extensions/date_time"
+require "mongoid/criteria/queryable/extensions/hash"
+require "mongoid/criteria/queryable/extensions/nil_class"
+require "mongoid/criteria/queryable/extensions/numeric"
+require "mongoid/criteria/queryable/extensions/range"
+require "mongoid/criteria/queryable/extensions/regexp"
+require "mongoid/criteria/queryable/extensions/set"
+require "mongoid/criteria/queryable/extensions/string"
+require "mongoid/criteria/queryable/extensions/symbol"
+require "mongoid/criteria/queryable/extensions/time"

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

@@ -0,0 +1,185 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # The array module adds custom behaviour for Origin onto the Array class.
+        module Array
+
+          # 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.__add_from_array__(self)
+          end
+
+          # Return the object as an array.
+          #
+          # @example Get the array.
+          #   [ 1, 2 ].__array__
+          #
+          # @return [ Array ] self
+          #
+          # @since 1.0.0
+          def __array__; self; end
+
+          # Makes a deep copy of the array, deep copying every element inside the
+          # array.
+          #
+          # @example Get a deep copy of the array.
+          #   [ 1, 2, 3 ].__deep_copy__
+          #
+          # @return [ Array ] The deep copy of the array.
+          #
+          # @since 1.0.0
+          def __deep_copy__
+            map { |value| value.__deep_copy__ }
+          end
+
+          # Evolve the array into an array of mongo friendly dates. (Times at
+          # midnight).
+          #
+          # @example Evolve the array to dates.
+          #   [ Date.new(2010, 1, 1) ].__evolve_date__
+          #
+          # @return [ Array<Time> ] The array as times at midnight UTC.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            map { |value| value.__evolve_date__ }
+          end
+
+          # Get the object as expanded.
+          #
+          # @example Get the object expanded.
+          #   obj.__expand_complex__
+          #
+          # @return [ Array ] The expanded array.
+          #
+          # @since 1.1.0
+          def __expand_complex__
+            map do |value|
+              value.__expand_complex__
+            end
+          end
+
+          # Evolve the array to an array of times.
+          #
+          # @example Evolve the array to times.
+          #   [ 1231231231 ].__evolve_time__
+          #
+          # @return [ Array<Time> ] The array as times.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            map { |value| value.__evolve_time__ }
+          end
+
+          # Combine the two objects using an intersection strategy.
+          #
+          # @example Interset with the object.
+          #   [ 1, 2 ].__intersect__(3)
+          #
+          # @param [ Object ] object The object to intersect with.
+          #
+          # @return [ Object ] The result of the intersection.
+          #
+          # @since 1.0.0
+          def __intersect__(object)
+            object.__intersect_from_array__(self)
+          end
+
+          # Gets the array as options in the proper format to pass as MongoDB sort
+          # criteria.
+          #
+          # @example Get the array as sorting options.
+          #   [ :field, 1 ].__sort_option__
+          #
+          # @return [ Hash ] The array as sort criterion.
+          #
+          # @since 1.0.0
+          def __sort_option__
+            multi.inject({}) do |options, criteria|
+              options.merge!(criteria.__sort_pair__)
+              options
+            end
+          end
+
+          # Get the array as a sort pair.
+          #
+          # @example Get the array as field/direction pair.
+          #   [ field, 1 ].__sort_pair__
+          #
+          # @return [ Hash ] The field/direction pair.
+          #
+          # @since 1.0.0
+          def __sort_pair__
+            { first => last.to_direction }
+          end
+
+          # Update all the values in the hash with the provided block.
+          #
+          # @example Update the values in place.
+          #   [ 1, 2, 3 ].update_values(&:to_s)
+          #
+          # @param [ Proc ] block The block to execute on each value.
+          #
+          # @return [ Array ] the array.
+          #
+          # @since 1.0.0
+          def update_values(&block)
+            replace(map(&block))
+          end
+
+          private
+
+          # Converts the array to a multi-dimensional array.
+          #
+          # @api private
+          #
+          # @example Convert to multi-dimensional.
+          #   [ 1, 2, 3 ].multi
+          #
+          # @return [ Array ] The multi-dimensional array.
+          #
+          # @since 1.0.0
+          def multi
+            first.is_a?(::Symbol) || first.is_a?(::String) ? [ self ] : self
+          end
+
+          module ClassMethods
+
+            # Evolve the object when the serializer is defined as an array.
+            #
+            # @example Evolve the object.
+            #   Array.evolve(1)
+            #
+            # @param [ Object ] The object to evolve.
+            #
+            # @return [ Object ] The evolved object.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              if object.is_a?(::Array)
+                object.map { |obj| obj.class.evolve(obj) }
+              else
+                object
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Array.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Array)
+::Array.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Array::ClassMethods)

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

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require "bigdecimal"
+
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # The big decimal module adds custom behaviour for Origin onto the
+        # BigDecimal class.
+        module BigDecimal
+          module ClassMethods
+
+            # Evolves the big decimal into a MongoDB friendly value - in this case
+            # a string.
+            #
+            # @example Evolve the big decimal
+            #   BigDecimal.evolve(decimal)
+            #
+            # @param [ BigDecimal ] object The object to convert.
+            #
+            # @return [ String ] The big decimal as a string.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              __evolve__(object) do |obj|
+                obj ? obj.to_s : obj
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::BigDecimal.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::BigDecimal::ClassMethods)

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains extensions for boolean selection.
+        module Boolean
+          module ClassMethods
+
+            # Evolve the value into a boolean value stored in MongoDB. Will return
+            # true for any of these values: true, t, yes, y, 1, 1.0.
+            #
+            # @example Evolve the value to a boolean.
+            #   Boolean.evolve(true)
+            #
+            # @param [ Object ] The object to evolve.
+            #
+            # @return [ true, false ] The boolean value.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              __evolve__(object) do |obj|
+                obj.to_s =~ (/(true|t|yes|y|1|1.0)$/i) ? true : false
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)

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

@@ -0,0 +1,63 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional date behaviour.
+        module Date
+
+          # Evolve the date into a mongo friendly time, UTC midnight.
+          #
+          # @example Evolve the date.
+          #   date.__evolve_date__
+          #
+          # @return [ Time ] The date as a UTC time at midnight.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            ::Time.utc(year, month, day, 0, 0, 0, 0)
+          end
+
+          # Evolve the date into a time, which is always in the local timezone.
+          #
+          # @example Evolve the date.
+          #   date.__evolve_time__
+          #
+          # @return [ Time ] The date as a local time.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            ::Time.local(year, month, day)
+          end
+
+          module ClassMethods
+
+            # Evolve the object to an date.
+            #
+            # @example Evolve dates.
+            #   Date.evolve(Date.new(1990, 1, 1))
+            #
+            # @example Evolve string dates.
+            #   Date.evolve("1990-1-1")
+            #
+            # @example Evolve date ranges.
+            #   Date.evolve(Date.new(1990, 1, 1)..Date.new(1990, 1, 4))
+            #
+            # @param [ Object ] object The object to evolve.
+            #
+            # @return [ Time ] The evolved date.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              object.__evolve_date__
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::Date.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Date)
+::Date.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Date::ClassMethods)

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

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional datetime behaviour.
+        module DateTime
+
+          # Evolve the date time into a mongo friendly UTC time.
+          #
+          # @example Evolve the date time.
+          #   date_time.__evolve_time__
+          #
+          # @return [ Time ] The converted time in UTC.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            usec = strftime("%6N").to_f
+            if utc?
+              ::Time.utc(year, month, day, hour, min, sec, usec)
+            else
+              ::Time.local(year, month, day, hour, min, sec, usec).utc
+            end
+          end
+
+          module ClassMethods
+
+            # Evolve the object to an date.
+            #
+            # @example Evolve dates.
+            #
+            # @example Evolve string dates.
+            #
+            # @example Evolve date ranges.
+            #
+            # @param [ Object ] object The object to evolve.
+            #
+            # @return [ Time ] The evolved date time.
+            #
+            # @since 1.0.0
+            def evolve(object)
+              object.__evolve_time__
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+::DateTime.__send__(:include, Mongoid::Criteria::Queryable::Extensions::DateTime)
+::DateTime.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::DateTime::ClassMethods)

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

@@ -0,0 +1,200 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional hash behaviour.
+        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.
+          #
+          # @since 1.0.0
+          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 ] value The array to add to.
+          #
+          # @return [ Hash ] The merged hash.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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 ] value The array to intersect to.
+          #
+          # @return [ Hash ] The merged hash.
+          #
+          # @since 1.0.0
+          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 ] value The object to intersect to.
+          #
+          # @return [ Hash ] The merged hash.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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 ] value The object to union to.
+          #
+          # @return [ Hash ] The merged hash.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.5
+          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.
+          #
+          # @since 1.0.0
+          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.
+          #
+          # @since 1.0.0
+          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)