origin 0.0.0.alpha → 1.0.0.alpha

data/lib/origin/extensions/set.rb

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

data/lib/origin/extensions/string.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+module Origin
+  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 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".specify(value)
+      #
+      # @param [ Object ] value The value of the criteria.
+      #
+      # @return [ Hash ] The selection.
+      #
+      # @since 1.0.0
+      def specify(value)
+        { self => value }
+      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
+
+        # 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
+
+::String.__send__(:include, Origin::Extensions::String)
+::String.__send__(:extend, Origin::Extensions::String::ClassMethods)

data/lib/origin/extensions/symbol.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module Origin
+  module Extensions
+
+    # This module contains additional symbol behaviour.
+    module Symbol
+
+      # Get the symbol as a specification.
+      #
+      # @example Get the symbol as a criteria.
+      #   :field.specify(value)
+      #
+      # @param [ Object ] value The value of the criteria.
+      #
+      # @return [ Hash ] The selection.
+      #
+      # @since 1.0.0
+      def specify(value)
+        { self => value }
+      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
+
+::Symbol.__send__(:include, Origin::Extensions::Symbol)
+::Symbol.__send__(:extend, Origin::Extensions::Symbol::ClassMethods)

data/lib/origin/extensions/time.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Origin
+  module Extensions
+
+    # This module contains additional time behaviour.
+    module Time
+
+      # 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
+
+::Time.__send__(:include, Origin::Extensions::Time)
+::Time.__send__(:extend, Origin::Extensions::Time::ClassMethods)

data/lib/origin/extensions/time_with_zone.rb

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

data/lib/origin/forwardable.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+module Origin
+
+  # Allows for easy delegation of origin queryable instance methods to a
+  # specific method.
+  module Forwardable
+
+    # Tells origin with method on the class to delegate to when calling an
+    # original selectable or optional method on the class.
+    #
+    # @example Tell origin where to select from.
+    #   class Band
+    #     extend Origin::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
+          delegate :#{name}, to: :#{receiver}
+        SEL
+      else
+        (class << self; self; end).class_eval <<-SEL
+          delegate :#{name}, to: :#{receiver}
+        SEL
+      end
+    end
+  end
+end

data/lib/origin/key.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module Origin
+
+  # The key is a representation of a field in a queryable, that can be
+  # expanded to special MongoDB selectors.
+  class Key
+
+    # @attribute [r] name The name of the field.
+    # @attribute [r] block The optional block to transform values.
+    # @attribute [r] operator The MongoDB query operator.
+    # @attribute [r] expanded The MongoDB expanded query operator.
+    # @attribute [r] strategy The name of the merge strategy.
+    attr_reader :block, :name, :operator, :expanded, :strategy
+
+    # Does the key equal another object?
+    #
+    # @example Is the key equal to another?
+    #   key == other
+    #
+    # @param [ Object ] other The object to compare to.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 1.0.0
+    def ==(other)
+      return false unless other.is_a?(Key)
+      name == other.name && operator == other.operator && expanded == other.expanded
+    end
+
+    # Instantiate the new key.
+    #
+    # @example Instantiate the key.
+    #   Key.new("age", "$gt")
+    #
+    # @param [ String, Symbol ] name The field name.
+    # @param [ Symbol ] strategy The name of the merge strategy.
+    # @param [ String ] operator The Mongo operator.
+    # @param [ String ] expanded The Mongo expanded operator.
+    #
+    # @since 1.0.0
+    def initialize(name, strategy, operator, expanded = nil, &block)
+      @name, @strategy, @operator, @expanded, @block =
+        name, strategy, operator, expanded, block
+    end
+
+    # Gets the raw selector that would be passed to Mongo from this key.
+    #
+    # @example Specify the raw selector.
+    #   key.specify(50)
+    #
+    # @param [ Object ] object The value to be included.
+    #
+    # @return [ Hash ] The raw MongoDB selector.
+    #
+    # @since 1.0.0
+    def specify(object)
+      value = block ? block[object] : object
+      { name.to_s => { operator => expanded ? { expanded => value } : value }}
+    end
+
+    # Get the key as raw Mongo sorting options.
+    #
+    # @example Get the key as a sort.
+    #   key.__sort_option__
+    #
+    # @return [ Hash ] The field/direction pair.
+    #
+    # @since 1.0.0
+    def __sort_option__
+      { name => operator }
+    end
+    alias :__sort_pair__ :__sort_option__
+  end
+end

data/lib/origin/macroable.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Origin
+
+  # Adds macro behaviour for adding symbol methods.
+  module Macroable
+
+    # Adds a method on Symbol for convenience in where queries for the
+    # provided operators.
+    #
+    # @example Add a symbol key.
+    #   key :all, "$all
+    #
+    # @param [ Symbol ] name The name of the method.
+    # @param [ Symbol ] strategy The merge strategy.
+    # @param [ String ] operator The MongoDB operator.
+    # @param [ String ] additional The additional MongoDB operator.
+    #
+    # @since 1.0.0
+    def key(name, strategy, operator, additional = nil, &block)
+      ::Symbol.add_key(name, strategy, operator, additional, &block)
+    end
+  end
+end