runt 0.6.0 → 0.7.0

data/examples/payment_report.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+
+require 'runt'
+
+class Report
+  
+  attr_reader :schedule
+
+  def initialize(schedule)
+    @schedule = schedule
+  end
+  def list(range)
+    result = {}
+    range.each do |dt|
+      events = @schedule.events(dt)
+      result[dt]=events unless events.empty?
+    end
+    result
+  end
+end
+
+class Payment < Runt::Event
+  attr_accessor :amount
+  def initialize(id, amount)
+    super(id)
+    @amount = amount
+  end
+end
+
+
+if __FILE__ == $0
+
+  include Runt
+
+  schedule = Schedule.new
+
+  # Gas payment on the first Wednesday of every month
+  gas_payment = Payment.new("Gas", 234)
+  gas_expr = DIMonth.new(First, Wednesday)
+  schedule.add(gas_payment, gas_expr)
+
+  # Insurance payment every year on January 7th
+  insurance_payment = Payment.new("Insurance", 345)
+  insurance_expr = REYear.new(1, 7, 1, 7)
+  schedule.add(insurance_payment, insurance_expr)
+  
+  # Run a report
+  report = Report.new(schedule)
+  result = report.list(PDate.day(2008, 1, 1)..PDate.day(2008,1,31))
+  result.keys.sort.each do |dt|
+    unless result[dt].empty? then
+      print "#{dt.ctime} - "
+      result[dt].each do |event|
+	puts "#{event.id}, $#{event.amount}"
+      end
+    end
+  end
+
+end

data/examples/payment_reporttest.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby
+
+require 'test/unit'
+require 'runt'
+require 'payment_report'
+
+class ReportTest < Test::Unit::TestCase
+
+  include Runt
+
+  def setup
+    @schedule = Schedule.new
+
+    # Gas payment on the first Wednesday of every month
+    @gas_payment = Payment.new("Gas", 234)
+    @gas_expr = DIMonth.new(First, Wednesday)
+    @schedule.add(@gas_payment, @gas_expr)
+
+    # Insurance payment every year on January 7th
+    @insurance_payment = Payment.new("Insurance", 345)
+    @insurance_expr = REYear.new(1, 7, 1, 7)
+    @schedule.add(@insurance_payment, @insurance_expr)
+    @report = Report.new(@schedule)
+  end
+  def test_initialize
+    assert_equal @schedule, @report.schedule
+  end
+  def test_list
+    range = PDate.day(2008, 1, 1)..PDate.day(2008,1,31)
+    result = @report.list(range) 
+    assert_equal(2, result.size)
+    assert_equal(@gas_payment, result[PDate.day(2008, 1, 2)][0])
+    assert_equal(@insurance_payment, result[PDate.day(2008, 1, 7)][0])
+  end
+end
+
+class PaymentTest < Test::Unit::TestCase
+
+  include Runt
+
+  def test_initialize
+    p = Payment.new "Foo", 12
+    assert_equal "Foo", p.id
+    assert_equal 12, p.amount
+  end
+
+end
+
+

data/examples/reminder.rb

@@ -1,63 +1,63 @@
-#!/usr/bin/ruby
-
-# NOTE this is slightly broken; it is in the process of being fixed
-base = File.basename(Dir.pwd)
-if base == "examples" || base =~ /runt/
-  Dir.chdir("..") if base == "examples"
-  $LOAD_PATH.unshift(Dir.pwd + '/lib')
-  Dir.chdir("examples") if base =~ /runt/
-end
-
-
-
-
-require 'runt'
-
-class Reminder
-  include Runt
-
-  def initialize(schedule)
-    @schedule=schedule
-  end
-
-  def next_times(event,end_point,now=Time.now)
-    @schedule.dates(event,DateRange.new(now,end_point))
-  end
-end 
-
-# start of range whose occurrences we want to list
-# TODO fix Runt so this can be done with Time instead 
-#      e.g., now=Time.now
-#now=Time.parse("13:00")
-#now.date_precision=Runt::DPrecision::MIN
-now=Runt::PDate.min(2006,12,8,13,00)
-
-# end of range
-soon=(now + 10.minutes)
-
-# Sanity check
-print "start: #{now.to_s} (#{now.date_precision}) end: #{soon.to_s} (#{soon.date_precision})\n"
-
-#
-# Schedule used to house TemporalExpression describing the recurrence from 
-# which we'd list to generate a list of dates. In this example, some Event
-# occuring every 5 minutes.
-# 
-schedule=Runt::Schedule.new
-
-# Some event whose schedule we're interested in
-event=Runt::Event.new("whatever")
-
-# Add the event to the schedule (
-# NOTE: any Object that is a sensible Hash key can be used
-schedule.add(event,Runt::EveryTE.new(now,5.minutes))
-
-# Example domain Object using Runt 
-reminder=Reminder.new(schedule)
-
-# Call our domain Object with the start and end times and the event
-# in which we're interested
-#puts "times (inclusive) = #{reminder.next_times(event,soon,now).join('\n')}"
-
-puts "times (inclusive):"
-reminder.next_times(event,soon,now).each{|t| puts t}
+#!/usr/bin/ruby
+
+# NOTE this is slightly broken; it is in the process of being fixed
+base = File.basename(Dir.pwd)
+if base == "examples" || base =~ /runt/
+  Dir.chdir("..") if base == "examples"
+  $LOAD_PATH.unshift(Dir.pwd + '/lib')
+  Dir.chdir("examples") if base =~ /runt/
+end
+
+
+
+
+require 'runt'
+
+class Reminder
+  include Runt
+
+  def initialize(schedule)
+    @schedule=schedule
+  end
+
+  def next_times(event,end_point,now=Time.now)
+    @schedule.dates(event,DateRange.new(now,end_point))
+  end
+end 
+
+# start of range whose occurrences we want to list
+# TODO fix Runt so this can be done with Time instead 
+#      e.g., now=Time.now
+#now=Time.parse("13:00")
+#now.date_precision=Runt::DPrecision::MIN
+now=Runt::PDate.min(2006,12,8,13,00)
+
+# end of range
+soon=(now + 10.minutes)
+
+# Sanity check
+print "start: #{now.to_s} (#{now.date_precision}) end: #{soon.to_s} (#{soon.date_precision})\n"
+
+#
+# Schedule used to house TemporalExpression describing the recurrence from 
+# which we'd list to generate a list of dates. In this example, some Event
+# occuring every 5 minutes.
+# 
+schedule=Runt::Schedule.new
+
+# Some event whose schedule we're interested in
+event=Runt::Event.new("whatever")
+
+# Add the event to the schedule (
+# NOTE: any Object that is a sensible Hash key can be used
+schedule.add(event,Runt::EveryTE.new(now,5.minutes))
+
+# Example domain Object using Runt 
+reminder=Reminder.new(schedule)
+
+# Call our domain Object with the start and end times and the event
+# in which we're interested
+#puts "times (inclusive) = #{reminder.next_times(event,soon,now).join('\n')}"
+
+puts "times (inclusive):"
+reminder.next_times(event,soon,now).each{|t| puts t}

data/lib/runt.rb

@@ -1,219 +1,237 @@
-#!/usr/bin/env ruby
-
-# :title:Runt -- Ruby Temporal Expressions
-#
-# == Runt -- Ruby Temporal Expressions
-#
-# The usage and design patterns expressed in this library are mostly...*uhm*..
-# <em>entirely</em>..*cough*...based on a series of
-# <tt>articles</tt>[http://www.martinfowler.com] by Martin Fowler.
-#
-# It highly recommended that anyone using Runt (or writing
-# object-oriented software :) take a moment to peruse the wealth of useful info
-# that Fowler has made publicly available:
-#
-# * An excellent introductory summation of temporal <tt>patterns</tt>[http://martinfowler.com/ap2/timeNarrative.html]
-# * Recurring event <tt>pattern</tt>[http://martinfowler.com/apsupp/recurring.pdf]
-#
-# Also, for those of you (like me, for example) still chained in your cubicle and forced
-# to write <tt>Java</tt>[http://java.sun.com] code, check out the original version of
-# project called <tt>ChronicJ</tt>[http://chronicj.org].
-#
-# ---
-# Author::    Matthew Lipper (mailto:mlipper@gmail.com)
-# Copyright:: Copyright (c) 2004 Digital Clash, LLC
-# License::   See LICENSE.txt
-#
-# = Warranty
-#
-# This software is provided "as is" and without any express or
-# implied warranties, including, without limitation, the implied
-# warranties of merchantibility and fitness for a particular
-# purpose.
-
-require 'time'
-require 'date'
-require 'date/format'
-require "runt/dprecision"
-require "runt/pdate"
-require "runt/temporalexpression"
-require "runt/schedule"
-require "runt/daterange"
-
-#
-# The Runt module is the main namespace for all Runt modules and classes. Using
-# require statements, it makes the entire Runt library available.It also
-# defines some new constants and exposes some already defined in the standard
-# library classes <tt>Date</tt> and <tt>DateTime</tt>.
-#
-# <b>See also</b> date.rb
-#
-module Runt
-  
-  class << self
-    
-    def day_name(number)
-      Date::DAYNAMES[number]
-    end
-    
-    def month_name(number)
-      Date::MONTHNAMES[number]
-    end
-
-    def format_time(date)
-      date.strftime('%I:%M%p')
-    end
-
-    def format_date(date)
-      date.ctime
-    end
-    
-    #
-    # Cut and pasted from activesupport-1.2.5/lib/inflector.rb
-    #
-    def ordinalize(number)
-      if (number.to_i==-1)
-	'last'
-      elsif (number.to_i==-2)
-	'second to last'  
-      elsif (11..13).include?(number.to_i % 100)
-	"#{number}th"
-      else
-	case number.to_i % 10
-	  when 1: "#{number}st"
-	  when 2: "#{number}nd"
-	  when 3: "#{number}rd"
-	  else    "#{number}th"
-	end
-      end
-    end
-
-  end
-
-  #Yes it's true, I'm a big idiot!
-  Sunday = Date::DAYNAMES.index("Sunday")
-  Monday = Date::DAYNAMES.index("Monday")
-  Tuesday = Date::DAYNAMES.index("Tuesday")
-  Wednesday = Date::DAYNAMES.index("Wednesday")
-  Thursday = Date::DAYNAMES.index("Thursday")
-  Friday = Date::DAYNAMES.index("Friday")
-  Saturday = Date::DAYNAMES.index("Saturday")
-  Sun = Date::ABBR_DAYNAMES.index("Sun")
-  Mon = Date::ABBR_DAYNAMES.index("Mon")
-  Tue = Date::ABBR_DAYNAMES.index("Tue")
-  Wed = Date::ABBR_DAYNAMES.index("Wed")
-  Thu = Date::ABBR_DAYNAMES.index("Thu")
-  Fri = Date::ABBR_DAYNAMES.index("Fri")
-  Sat = Date::ABBR_DAYNAMES.index("Sat")
-  First = 1
-  Second = 2
-  Third = 3
-  Fourth = 4
-  Fifth = 5
-  Sixth = 6
-  Seventh = 7
-  Eigth = 8
-  Ninth = 9
-  Tenth = 10
-
-  private
-  class ApplyLast #:nodoc:
-    def initialize
-      @negate=Proc.new{|n| n*-1}
-    end
-    def [](arg)
-      @negate.call(arg)
-    end
-  end
-  LastProc = ApplyLast.new
-
-  public
-  Last = LastProc[First]
-  Last_of = LastProc[First]
-  Second_to_last = LastProc[Second]
-
-end
-
-#
-# Add precision +Runt::DPrecision+ to standard library classes Date and DateTime 
-# (which is a subclass of Date). Also, add an inlcude? method for interoperability
-# with +Runt::TExpr+ classes
-#
-class Date
-
-  include Runt
-
-  attr_accessor :date_precision
-
-  def include?(expr)
-    eql?(expr)
-  end
-
-  def date_precision
-    return @date_precision unless @date_precision.nil? 
-    return Runt::DPrecision::DEFAULT 
-  end 	  
-end
-
-#
-# Add the ability to use Time class 
-#
-# Contributed by Paul Wright
-#
-class Time
-  
-  include Runt
-
-  attr_accessor :date_precision
-  alias_method :old_initialize, :initialize
-  def initialize(*args)
-    if(args[0].instance_of?(Runt::DPrecision::Precision))
-      @precision=args.shift
-    else
-      @precision=Runt::DPrecision::DEFAULT
-    end
-    old_initialize(*args)
-  end
-
-  class << self
-    alias_method :old_parse, :parse
-    def parse(*args)
-      precision=Runt::DPrecision::DEFAULT
-      if(args[0].instance_of?(Runt::DPrecision::Precision))
-        precision=args.shift
-      end
-      _parse=old_parse(*args)
-      _parse.date_precision=precision
-      _parse
-    end
-  end
-
-  def date_precision
-    return @date_precision unless @date_precision.nil?
-    return Runt::DPrecision::DEFAULT
-  end
-end
-
-#
-# Useful shortcuts!
-#
-# Contributed by Ara T. Howard who is pretty sure he got the idea from 
-# somewhere else. :-)
-#
-class Numeric #:nodoc:
-  def microseconds() Float(self  * (10 ** -6)) end
-  def milliseconds() Float(self  * (10 ** -3)) end
-  def seconds() self end
-  def minutes() 60 * seconds end
-  def hours() 60 * minutes end
-  def days() 24 * hours end
-  def weeks() 7 * days end
-  def months() 30 * days end
-  def years() 365 * days end
-  def decades() 10 * years end
-  # This causes RDoc to hurl:  
-  %w[
-  microseconds milliseconds seconds minutes hours days weeks months years decades
-  ].each{|m| alias_method m.chop, m}
-end
-
+#!/usr/bin/env ruby
+
+# :title:Runt -- Ruby Temporal Expressions
+#
+# == Runt -- Ruby Temporal Expressions
+#
+# The usage and design patterns expressed in this library are mostly...*uhm*..
+# <em>entirely</em>..*cough*...based on a series of
+# <tt>articles</tt>[http://www.martinfowler.com] by Martin Fowler.
+#
+# It highly recommended that anyone using Runt (or writing
+# object-oriented software :) take a moment to peruse the wealth of useful info
+# that Fowler has made publicly available:
+#
+# * An excellent introductory summation of temporal <tt>patterns</tt>[http://martinfowler.com/ap2/timeNarrative.html]
+# * Recurring event <tt>pattern</tt>[http://martinfowler.com/apsupp/recurring.pdf]
+#
+# Also, for those of you (like me, for example) still chained in your cubicle and forced
+# to write <tt>Java</tt>[http://java.sun.com] code, check out the original version of
+# project called <tt>ChronicJ</tt>[http://chronicj.org].
+#
+# ---
+# Author::    Matthew Lipper (mailto:mlipper@gmail.com)
+# Copyright:: Copyright (c) 2004 Digital Clash, LLC
+# License::   See LICENSE.txt
+#
+# = Warranty
+#
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantibility and fitness for a particular
+# purpose.
+
+require 'time'
+require 'date'
+require 'date/format'
+require "runt/dprecision"
+require "runt/pdate"
+require "runt/temporalexpression"
+require "runt/schedule"
+require "runt/daterange"
+require "runt/sugar"
+require "runt/expressionbuilder"
+
+#
+# The Runt module is the main namespace for all Runt modules and classes. Using
+# require statements, it makes the entire Runt library available.It also
+# defines some new constants and exposes some already defined in the standard
+# library classes <tt>Date</tt> and <tt>DateTime</tt>.
+#
+# <b>See also</b> runt/sugar_rb which re-opens this module and adds 
+# some additional functionality
+#
+# <b>See also</b> date.rb
+#
+module Runt
+  
+  class << self
+    
+    def day_name(number)
+      Date::DAYNAMES[number]
+    end
+    
+    def month_name(number)
+      Date::MONTHNAMES[number]
+    end
+
+    def format_time(date)
+      date.strftime('%I:%M%p')
+    end
+
+    def format_date(date)
+      date.ctime
+    end
+    
+    #
+    # Cut and pasted from activesupport-1.2.5/lib/inflector.rb
+    #
+    def ordinalize(number)
+      if (number.to_i==-1)
+	'last'
+      elsif (number.to_i==-2)
+	'second to last'  
+      elsif (11..13).include?(number.to_i % 100)
+	"#{number}th"
+      else
+	case number.to_i % 10
+	  when 1: "#{number}st"
+	  when 2: "#{number}nd"
+	  when 3: "#{number}rd"
+	  else    "#{number}th"
+	end
+      end
+    end
+
+  end
+
+  #Yes it's true, I'm a big idiot!
+  Sunday = Date::DAYNAMES.index("Sunday")
+  Monday = Date::DAYNAMES.index("Monday")
+  Tuesday = Date::DAYNAMES.index("Tuesday")
+  Wednesday = Date::DAYNAMES.index("Wednesday")
+  Thursday = Date::DAYNAMES.index("Thursday")
+  Friday = Date::DAYNAMES.index("Friday")
+  Saturday = Date::DAYNAMES.index("Saturday")
+  Sun = Date::ABBR_DAYNAMES.index("Sun")
+  Mon = Date::ABBR_DAYNAMES.index("Mon")
+  Tue = Date::ABBR_DAYNAMES.index("Tue")
+  Wed = Date::ABBR_DAYNAMES.index("Wed")
+  Thu = Date::ABBR_DAYNAMES.index("Thu")
+  Fri = Date::ABBR_DAYNAMES.index("Fri")
+  Sat = Date::ABBR_DAYNAMES.index("Sat")
+  January = Date::MONTHNAMES.index("January")
+  February = Date::MONTHNAMES.index("February")
+  March = Date::MONTHNAMES.index("March")
+  April = Date::MONTHNAMES.index("April")
+  May = Date::MONTHNAMES.index("May")
+  June = Date::MONTHNAMES.index("June")
+  July = Date::MONTHNAMES.index("July")
+  August = Date::MONTHNAMES.index("August")
+  September = Date::MONTHNAMES.index("September")
+  October = Date::MONTHNAMES.index("October")
+  November = Date::MONTHNAMES.index("November")
+  December = Date::MONTHNAMES.index("December")
+  First = 1
+  Second = 2
+  Third = 3
+  Fourth = 4
+  Fifth = 5
+  Sixth = 6
+  Seventh = 7
+  Eighth = 8
+  Eigth = 8  # Will be removed in v0.9.0
+  Ninth = 9
+  Tenth = 10
+
+  private
+  class ApplyLast #:nodoc:
+    def initialize
+      @negate=Proc.new{|n| n*-1}
+    end
+    def [](arg)
+      @negate.call(arg)
+    end
+  end
+  LastProc = ApplyLast.new
+
+  public
+  Last = LastProc[First]
+  Last_of = LastProc[First]
+  Second_to_last = LastProc[Second]
+
+end
+
+#
+# Add precision +Runt::DPrecision+ to standard library classes Date and DateTime 
+# (which is a subclass of Date). Also, add an inlcude? method for interoperability
+# with +Runt::TExpr+ classes
+#
+class Date
+
+  include Runt
+
+  attr_accessor :date_precision
+
+  def include?(expr)
+    eql?(expr)
+  end
+
+  def date_precision
+    return @date_precision unless @date_precision.nil? 
+    return Runt::DPrecision::DEFAULT 
+  end 	  
+end
+
+#
+# Add the ability to use Time class 
+#
+# Contributed by Paul Wright
+#
+class Time
+  
+  include Runt
+
+  attr_accessor :date_precision
+  alias_method :old_initialize, :initialize
+  def initialize(*args)
+    if(args[0].instance_of?(Runt::DPrecision::Precision))
+      @precision=args.shift
+    else
+      @precision=Runt::DPrecision::DEFAULT
+    end
+    old_initialize(*args)
+  end
+
+  class << self
+    alias_method :old_parse, :parse
+    def parse(*args)
+      precision=Runt::DPrecision::DEFAULT
+      if(args[0].instance_of?(Runt::DPrecision::Precision))
+        precision=args.shift
+      end
+      _parse=old_parse(*args)
+      _parse.date_precision=precision
+      _parse
+    end
+  end
+
+  def date_precision
+    return @date_precision unless @date_precision.nil?
+    return Runt::DPrecision::DEFAULT
+  end
+end
+
+#
+# Useful shortcuts!
+#
+# Contributed by Ara T. Howard who is pretty sure he got the idea from 
+# somewhere else. :-)
+#
+class Numeric #:nodoc:
+  def microseconds() Float(self  * (10 ** -6)) end
+  def milliseconds() Float(self  * (10 ** -3)) end
+  def seconds() self end
+  def minutes() 60 * seconds end
+  def hours() 60 * minutes end
+  def days() 24 * hours end
+  def weeks() 7 * days end
+  def months() 30 * days end
+  def years() 365 * days end
+  def decades() 10 * years end
+  # This causes RDoc to hurl:  
+  %w[
+  microseconds milliseconds seconds minutes hours days weeks months years decades
+  ].each{|m| alias_method m.chop, m}
+end
+