origin 0.0.0.alpha → 1.0.0.alpha

data/lib/origin/extensions/nil_class.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+module Origin
+  module Extensions
+
+    # This module contains additional nil behaviour.
+    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.
+      #
+      # @since 1.0.0
+      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.
+      #
+      # @since 1.0.0
+      def __expanded__(object); object; end
+
+      # Evolve the nil into a date or time.
+      #
+      # @example Evolve the nil.
+      #   nil.__evolve_time__
+      #
+      # @return [ nil ] nil.
+      #
+      # @since 1.0.0
+      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.
+      #
+      # @since 1.0.0
+      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.
+      #
+      # @since 1.0.0
+      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.
+      #
+      # @since 1.0.0
+      def __union__(object); object; end
+    end
+  end
+end
+
+::NilClass.__send__(:include, Origin::Extensions::NilClass)

data/lib/origin/extensions/numeric.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+module Origin
+  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)
+        ::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
+
+::Integer.__send__(:include, Origin::Extensions::Numeric)
+::Integer.__send__(:extend, Origin::Extensions::Numeric::ClassMethods)
+
+::Float.__send__(:include, Origin::Extensions::Numeric)
+::Float.__send__(:extend, Origin::Extensions::Numeric::ClassMethods)

data/lib/origin/extensions/object.rb

@@ -0,0 +1,182 @@
+# encoding: utf-8
+module Origin
+  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 ] value 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 ] value 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 ] value 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 ] value 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
+
+      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
+
+::Object.__send__(:include, Origin::Extensions::Object)
+::Object.__send__(:extend, Origin::Extensions::Object::ClassMethods)

data/lib/origin/extensions/range.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Origin
+  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
+
+::Range.__send__(:include, Origin::Extensions::Range)
+::Range.__send__(:extend, Origin::Extensions::Range::ClassMethods)

data/lib/origin/extensions/regexp.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Origin
+  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
+
+::Regexp.__send__(:include, Origin::Extensions::Regexp)
+::Regexp.__send__(:extend, Origin::Extensions::Regexp::ClassMethods)