mongoid 5.4.1 → 6.0.0.beta

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

@@ -0,0 +1,45 @@
+# 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
+        end
+      end
+    end
+  end
+end
+
+::Regexp.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp)
+::Regexp.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::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)

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

@@ -0,0 +1,60 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional time behaviour.
+        module Time
+
+          # Evolve the time as a date, UTC midnight.
+          #
+          # @example Evolve the time to a date query format.
+          #   time.__evolve_date__
+          #
+          # @return [ Time ] The date at midnight UTC.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            ::Time.utc(year, month, day, 0, 0, 0, 0)
+          end
+
+          # Evolve the time into a utc time.
+          #
+          # @example Evolve the time.
+          #   time.__evolve_time__
+          #
+          # @return [ Time ] The time in UTC.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            utc
+          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
+
+::Time.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Time)
+::Time.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Time::ClassMethods)

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

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+      module Extensions
+
+        # This module contains additional time with zone behaviour.
+        module TimeWithZone
+
+          # Evolve the time into a utc time.
+          #
+          # @example Evolve the time.
+          #   time.__evolve_time__
+          #
+          # @return [ Time ] The time in UTC.
+          #
+          # @since 1.0.0
+          def __evolve_time__
+            utc
+          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
+
+::ActiveSupport::TimeWithZone.__send__(
+  :include,
+  Mongoid::Criteria::Queryable::Extensions::TimeWithZone
+)
+::ActiveSupport::TimeWithZone.__send__(
+  :extend,
+  Mongoid::Criteria::Queryable::Extensions::TimeWithZone::ClassMethods
+)

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

@@ -0,0 +1,65 @@
+# encoding: utf-8
+module Mongoid
+  class Criteria
+    module Queryable
+
+      # Allows for easy delegation of queryable queryable instance methods to a
+      # specific method.
+      module Forwardable
+
+        # Tells queryable with method on the class to delegate to when calling an
+        # original selectable or optional method on the class.
+        #
+        # @example Tell queryable where to select from.
+        #   class Band
+        #     extend Queryable::Forwardable
+        #     select_with :criteria
+        #
+        #     def self.criteria
+        #       Query.new
+        #     end
+        #   end
+        #
+        # @param [ Symbol ] receiver The name of the receiver method.
+        #
+        # @return [ Array<Symbol> ] The names of the forwarded methods.
+        #
+        # @since 1.0.0
+        def select_with(receiver)
+          (Selectable.forwardables + Optional.forwardables).each do |name|
+            __forward__(name, receiver)
+          end
+        end
+
+        private
+
+        # Forwards the method name to the provided receiver method.
+        #
+        # @api private
+        #
+        # @example Define the forwarding.
+        #   Model.__forward__(:exists, :criteria)
+        #
+        # @param [ Symbol ] name The name of the method.
+        # @param [ Symbol ] receiver The name of the receiver method.
+        #
+        # @since 1.0.0
+        def __forward__(name, receiver)
+          if self.class == Module
+            module_eval <<-SEL
+              def #{name}(*args, &block)
+                #{receiver}.__send__(:#{name}, *args, &block)
+              end
+            SEL
+          else
+            (class << self; self; end).class_eval <<-SEL
+              def #{name}(*args, &block)
+                #{receiver}.__send__(:#{name}, *args, &block)
+              end
+            SEL
+          end
+        end
+      end
+    end
+  end
+end