runt 0.6.0 → 0.7.0

data/lib/runt/daterange.rb

@@ -1,74 +1,74 @@
-#!/usr/bin/env ruby
-
-require 'date'
-require 'runt'
-
-
-module Runt
-  # :title:DateRange
-  # == DateRange
-  #
-  #
-  # Based the <tt>range</tt>[http://martinfowler.com/ap2/range.html] pattern by Martin Fowler.
-  #
-  #
-  #
-  # Author:: Matthew Lipper
-  class DateRange < Range
-
-    include DPrecision
-
-    attr_reader :start_expr, :end_expr
-
-    def initialize(start_expr, end_expr,exclusive=false)
-      super(start_expr, end_expr,exclusive)
-      @start_expr, @end_expr = start_expr, end_expr
-    end
-
-    def include?(obj)
-      return super(obj.min) && super(obj.max) if obj.kind_of? Range
-      return super(obj)
-    end
-
-    def overlap?(obj)
-      return true if( member?(obj) || include?(obj.min) || include?(obj.max) )
-      return true if( obj.kind_of?(Range) && obj.include?(self) )
-      false
-    end
-
-    def empty?
-      return @start_expr >= @end_expr
-    end
-
-    def gap(obj)
-
-      return EMPTY if self.overlap? obj
-
-      lower=nil
-      higher=nil
-
-      if((self<=>obj)<0)
-        lower=self
-        higher=obj
-      else
-        lower=obj
-        higher=self
-      end
-
-      return DateRange.new((lower.end_expr+1),(higher.start_expr-1))
-    end
-
-    def <=>(other)
-      return @start_expr <=> other.start_expr if(@start_expr != other.start_expr)
-      return @end_expr <=> other.end_expr
-    end
-
-    def min; @start_expr  end
-    def max; @end_expr  end
-    def to_s; @start_expr.to_s + " " + @end_expr.to_s end
-
-
-    EMPTY = DateRange.new(PDate.day(2004,2,2),PDate.day(2004,2,1))
-
-  end
-end
+#!/usr/bin/env ruby
+
+require 'date'
+require 'runt'
+
+
+module Runt
+  # :title:DateRange
+  # == DateRange
+  #
+  #
+  # Based the <tt>range</tt>[http://martinfowler.com/ap2/range.html] pattern by Martin Fowler.
+  #
+  #
+  #
+  # Author:: Matthew Lipper
+  class DateRange < Range
+
+    include DPrecision
+
+    attr_reader :start_expr, :end_expr
+
+    def initialize(start_expr, end_expr,exclusive=false)
+      super(start_expr, end_expr,exclusive)
+      @start_expr, @end_expr = start_expr, end_expr
+    end
+
+    def include?(obj)
+      return super(obj.min) && super(obj.max) if obj.kind_of? Range
+      return super(obj)
+    end
+
+    def overlap?(obj)
+      return true if( member?(obj) || include?(obj.min) || include?(obj.max) )
+      return true if( obj.kind_of?(Range) && obj.include?(self) )
+      false
+    end
+
+    def empty?
+      return @start_expr >= @end_expr
+    end
+
+    def gap(obj)
+
+      return EMPTY if self.overlap? obj
+
+      lower=nil
+      higher=nil
+
+      if((self<=>obj)<0)
+        lower=self
+        higher=obj
+      else
+        lower=obj
+        higher=self
+      end
+
+      return DateRange.new((lower.end_expr+1),(higher.start_expr-1))
+    end
+
+    def <=>(other)
+      return @start_expr <=> other.start_expr if(@start_expr != other.start_expr)
+      return @end_expr <=> other.end_expr
+    end
+
+    def min; @start_expr  end
+    def max; @end_expr  end
+    def to_s; @start_expr.to_s + " " + @end_expr.to_s end
+
+
+    EMPTY = DateRange.new(PDate.day(2004,2,2),PDate.day(2004,2,1))
+
+  end
+end

data/lib/runt/dprecision.rb

@@ -1,141 +1,150 @@
-#!/usr/bin/env ruby
-
-require 'runt'
-require 'date'
-
-module Runt
-
-  # :title:DPrecision
-  # == DPrecision
-  # Module providing automatic precisioning of Date, DateTime, and PDate classes.
-  #
-  # Inspired by a <tt>pattern</tt>[http://martinfowler.com/ap2/timePoint.html] by Martin Fowler.
-  #
-  #
-  # Author:: Matthew Lipper
-  module DPrecision
-
-    def DPrecision.to_p(date,prec=DEFAULT)
-
-      case prec
-        when MIN then PDate.min(*DPrecision.explode(date,prec))
-        when DAY then PDate.day(*DPrecision.explode(date,prec))
-        when HOUR then PDate.hour(*DPrecision.explode(date,prec))
-        when MONTH then PDate.month(*DPrecision.explode(date,prec))
-        when YEAR then PDate.year(*DPrecision.explode(date,prec))
-        when SEC then PDate.sec(*DPrecision.explode(date,prec))
-        when MILLI then date #raise "Not implemented."
-        else PDate.default(*DPrecision.explode(date,prec))
-      end
-    end
-
-    def DPrecision.explode(date,prec)
-      result = [date.year,date.month,date.day]
-        if(date.respond_to?("hour"))
-          result << date.hour << date.min << date.sec
-        else
-          result << 0 << 0 << 0
-        end
-      result
-    end
-
-    #Simple value class for keeping track of precisioned dates
-    class Precision
-      include Comparable
-
-      attr_reader :precision
-      private_class_method :new
-
-      #Some constants w/arbitrary integer values used internally for comparisions
-      YEAR_PREC = 0
-      MONTH_PREC = 1
-      DAY_PREC = 2
-      HOUR_PREC = 3
-      MIN_PREC = 4
-      SEC_PREC = 5
-      MILLI_PREC = 6
-
-      #String values for display
-      LABEL = { YEAR_PREC => "YEAR",
-        MONTH_PREC => "MONTH",
-        DAY_PREC => "DAY",
-        HOUR_PREC => "HOUR",
-        MIN_PREC => "MINUTE",
-        SEC_PREC => "SECOND",
-        MILLI_PREC => "MILLISECOND"}
-
-      #Minimun values that precisioned fields get set to
-      FIELD_MIN = { YEAR_PREC => 1,
-      MONTH_PREC => 1,
-      DAY_PREC => 1,
-      HOUR_PREC => 0,
-      MIN_PREC => 0,
-      SEC_PREC => 0,
-      MILLI_PREC => 0}
-
-      def Precision.year
-        new(YEAR_PREC)
-      end
-
-      def Precision.month
-        new(MONTH_PREC)
-      end
-
-      def Precision.day
-        new(DAY_PREC)
-      end
-
-      def Precision.hour
-        new(HOUR_PREC)
-      end
-
-      def Precision.min
-        new(MIN_PREC)
-      end
-
-      def Precision.sec
-        new(SEC_PREC)
-      end
-
-      def Precision.millisec
-        new(MILLI_PREC)
-      end
-
-      def min_value()
-        FIELD_MIN[@precision]
-      end
-
-      def initialize(prec)
-        @precision = prec
-      end
-
-      def <=>(other)
-        self.precision <=> other.precision
-      end
-
-      def ===(other)
-        self.precision == other.precision
-      end
-
-      def to_s
-        "DPrecision::#{self.label}"
-      end
-
-      def label
-	LABEL[@precision]
-      end
-  end
-
-  #Pseudo Singletons:
-  YEAR = Precision.year
-  MONTH = Precision.month
-  DAY = Precision.day
-  HOUR = Precision.hour
-  MIN = Precision.min
-  SEC = Precision.sec
-  MILLI = Precision.millisec
-  DEFAULT=MIN
-
-  end
-
-end
+#!/usr/bin/env ruby
+
+require 'runt'
+require 'date'
+
+module Runt
+
+  # :title:DPrecision
+  # == DPrecision
+  # Module providing automatic precisioning of Date, DateTime, and PDate classes.
+  #
+  # Inspired by a <tt>pattern</tt>[http://martinfowler.com/ap2/timePoint.html] by Martin Fowler.
+  #
+  #
+  # Author:: Matthew Lipper
+  module DPrecision
+
+    def DPrecision.to_p(date,prec=DEFAULT)
+
+      case prec
+        when MIN then PDate.min(*DPrecision.explode(date,prec))
+        when DAY then PDate.day(*DPrecision.explode(date,prec))
+        when HOUR then PDate.hour(*DPrecision.explode(date,prec))
+        when WEEK then PDate.week(*DPrecision.explode(date,prec))
+        when MONTH then PDate.month(*DPrecision.explode(date,prec))
+        when YEAR then PDate.year(*DPrecision.explode(date,prec))
+        when SEC then PDate.sec(*DPrecision.explode(date,prec))
+        when MILLI then date #raise "Not implemented."
+        else PDate.default(*DPrecision.explode(date,prec))
+      end
+    end
+
+    def DPrecision.explode(date,prec)
+      result = [date.year,date.month,date.day]
+        if(date.respond_to?("hour"))
+          result << date.hour << date.min << date.sec
+        else
+          result << 0 << 0 << 0
+        end
+      result
+    end
+
+    #Simple value class for keeping track of precisioned dates
+    class Precision
+      include Comparable
+
+      attr_reader :precision
+      private_class_method :new
+
+      #Some constants w/arbitrary integer values used internally for comparisions
+      YEAR_PREC = 0
+      MONTH_PREC = 1
+      WEEK_PREC = 2
+      DAY_PREC = 3
+      HOUR_PREC = 4
+      MIN_PREC = 5
+      SEC_PREC = 6
+      MILLI_PREC = 7
+
+      #String values for display
+      LABEL = { YEAR_PREC => "YEAR",
+        MONTH_PREC => "MONTH",
+        WEEK_PREC => "WEEK",
+        DAY_PREC => "DAY",
+        HOUR_PREC => "HOUR",
+        MIN_PREC => "MINUTE",
+        SEC_PREC => "SECOND",
+        MILLI_PREC => "MILLISECOND"}
+
+      #Minimun values that precisioned fields get set to
+      FIELD_MIN = { YEAR_PREC => 1,
+      MONTH_PREC => 1,
+      WEEK_PREC => 1,
+      DAY_PREC => 1,
+      HOUR_PREC => 0,
+      MIN_PREC => 0,
+      SEC_PREC => 0,
+      MILLI_PREC => 0}
+
+      def Precision.year
+        new(YEAR_PREC)
+      end
+
+      def Precision.month
+        new(MONTH_PREC)
+      end
+
+      def Precision.week
+        new(WEEK_PREC)
+      end 
+      
+      def Precision.day
+        new(DAY_PREC)
+      end
+
+      def Precision.hour
+        new(HOUR_PREC)
+      end
+
+      def Precision.min
+        new(MIN_PREC)
+      end
+
+      def Precision.sec
+        new(SEC_PREC)
+      end
+
+      def Precision.millisec
+        new(MILLI_PREC)
+      end
+
+      def min_value()
+        FIELD_MIN[@precision]
+      end
+
+      def initialize(prec)
+        @precision = prec
+      end
+
+      def <=>(other)
+        self.precision <=> other.precision
+      end
+
+      def ===(other)
+        self.precision == other.precision
+      end
+
+      def to_s
+        "DPrecision::#{self.label}"
+      end
+
+      def label
+        LABEL[@precision]
+      end
+  end
+
+  #Pseudo Singletons:
+  YEAR = Precision.year
+  MONTH = Precision.month
+  WEEK = Precision.week
+  DAY = Precision.day
+  HOUR = Precision.hour
+  MIN = Precision.min
+  SEC = Precision.sec
+  MILLI = Precision.millisec
+  DEFAULT=MIN
+
+  end
+
+end

data/lib/runt/expressionbuilder.rb

@@ -0,0 +1,65 @@
+require 'runt'
+
+# Convenience class for building temporal expressions in a more 
+# human-friendly way. Used in conjunction with shortcuts defined in the 
+# sugar.rb file, this allows one to create expressions like the following:
+#   
+#   b = ExpressionBuilder.new
+#   expr = b.define do
+#     occurs daily_8_30am_to_9_45am
+#     on tuesday
+#     possibly wednesday
+#   end
+#
+# This equivalent to:
+#
+#   expr = REDay.new(8,30,9,45) & DIWeek.new(Tuesday) | DIWeek.new(Wednesday)
+#
+# ExpressionBuilder creates expressions by evaluating a block passed to the 
+# :define method. From inside the block, methods :occurs, :on, :every, :possibly,
+# and :maybe can be called with a temporal expression which will be added to
+# a composite expression as follows:
+#
+# * <b>:on</b> - creates an "and" (&)
+# * <b>:possibly</b> - creates an "or" (|)  
+# * <b>:except</b> - creates a "not" (-)
+# * <b>:every</b> - alias for :on method
+# * <b>:occurs</b> - alias for :on method
+# * <b>:maybe</b> - alias for :possibly method 
+#  
+class ExpressionBuilder
+
+  include Runt
+
+  attr_accessor :ctx
+
+  def initialize
+    @ctx = nil
+  end
+
+  def define(&block)
+    instance_eval(&block)
+  end
+  
+  def on(expr)
+    add(expr, :&)
+  end
+
+  def add(expr, op)
+    @ctx ||= expr
+    @ctx = @ctx.send(op, expr) unless @ctx == expr
+    @ctx # explicit return, previous line may not execute
+  end
+
+  def except(expr)
+    add(expr, :-)
+  end
+  
+  def possibly(expr)
+    add(expr, :|)
+  end
+
+  alias_method :every, :on
+  alias_method :occurs, :on
+  alias_method :maybe, :possibly
+end