mmb-seasonal 0.0.3 → 0.0.4

data/{README → README.textile}

@@ -3,19 +3,25 @@ events are currently happening.
 
 Example (print holiday greetings):
 
+<pre>
+<code>
 require 'seasonal'
 
 holidays = Seasonal::Calendar.new
 
 holidays.push(Seasonal::Event.new('Merry Christmas', 'America/New_York',
-  :start => 'dec 25 00:00', :end => 'dec 25 23:59:59'))
+  :on => 'dec 25'))
 holidays.push(Seasonal::Event.new("April Fool's Day", 'America/New_York',
-  :start => 'apr 1 00:00', :end => 'apr 1 23:59:59'))
+  :on => 'apr 1'))
 
-holidays.going_on { |e| puts e.payload }
+holidays.going_on { |e| puts e }
+</code>
+</pre>
 
 Example (make text red between 9:00 and 10:00 am):
 
+<pre>
+<code>
 require 'seasonal'
 
 colors = Seasonal::Calendar.new
@@ -23,13 +29,15 @@ colors = Seasonal::Calendar.new
 colors.push(Seasonal::Event.new('#ff0000', 'America/New_York',
   :start => '9:00am', :end => '10:00am'))
 
-color = '#000000'
-colors.going_on { |e| color = e.payload }
-
+color = colors.going_on(:or_if_none => '#000000')
 puts "<p style=\"background-color : #{color}\">test</p>"
+</code>
+</pre>
 
 Example (sale ends Jul 10):
 
+<pre>
+<code>
 require 'seasonal'
 
 sales = Seasonal::Calendar.new
@@ -37,7 +45,9 @@ sales = Seasonal::Calendar.new
 sales.push(Seasonal::Event.new('Everything on sale', 'America/New_York',
   :end => 'jul 10 2009'))
 
-sales.going_on { |e| puts e.payload }
+sales.going_on { |e| puts e }
+</code>
+</pre>
 
 Each event has an attached payload which can be any object.
 

data/lib/seasonal.rb

@@ -14,8 +14,13 @@ module Seasonal
     def initialize(payload, zone, options={})
       @payload = payload
       @zone = zone
-      @start = options[:start]
-      @ennd = options[:end]
+      if options[:on]
+        @start = "#{options[:on]} 00:00:00"
+        @ennd = "#{options[:on]} 23:59:59"
+      else
+        @start = options[:start]
+        @ennd = options[:end]
+      end
     end
 
     def start_utc
@@ -54,8 +59,26 @@ module Seasonal
 
   class Calendar < Array
 
-    def going_on(test_time=Time.now)
-      each { |event| yield event if event.going_on?(test_time) }
+    def going_on(options={})
+      options = { :at => Time.now, :payloads => true }.merge(options)
+      if block_given?
+        if options[:payloads]
+          each { |event| yield event.payload if event.going_on?(options[:at]) }
+        else
+          each { |event| yield event if event.going_on?(options[:at]) }
+        end
+      else
+        result = reject { |event| !event.going_on?(options[:at]) }
+        if options[:payloads]
+          if result.empty? and !options[:or_if_none].nil?
+            result.push(options[:or_if_none])
+          else
+            result.collect { |e| e.payload }
+          end
+        else
+          result
+        end
+      end
     end
 
   end

data/seasonal.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "seasonal"
-  s.version  = "0.0.3"
+  s.version  = "0.0.4"
   s.date     = "2008-11-10"
   s.summary  = "create logic based on defined date and time events"
   s.email    = "matthewm@boedicker.org"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.authors  = ["Matthew M. Boedicker"]
   s.files    = [
     "lib/seasonal.rb",
-    "README",
+    "README.textile",
     "seasonal.gemspec",
     ]
   s.test_files = [

data/test/seasonal_test.rb

@@ -6,13 +6,24 @@ require 'test/unit'
 
 class SeasonalTest < Test::Unit::TestCase
 
-  def test_none
+  def test_event_none
     e = Seasonal::Event.new(nil, 'America/New_York')
 
     assert_equal(false, e.going_on?)
   end
 
-  def test_end
+  def test_event_start
+    ss = 'jan 2'
+    start = Time.parse(ss).utc
+
+    e = Seasonal::Event.new(nil, 'America/New_York', :start => ss)
+
+    assert_equal(false, e.going_on?(start - 1))
+    assert(e.going_on?(start))
+    assert(e.going_on?(start + 1))
+  end
+
+  def test_event_end
     es = 'mar 17'
     ennd = Time.parse(es).utc
 
@@ -23,36 +34,103 @@ class SeasonalTest < Test::Unit::TestCase
     assert_equal(false, e.going_on?(ennd + 1))
   end
 
-  def test_start
-    ss = 'jan 2'
+  def test_event_start_end
+    ss = 'aug 29'
+    es = 'sep 1'
     start = Time.parse(ss).utc
+    ennd = Time.parse(es).utc
 
-    e = Seasonal::Event.new(nil, 'America/New_York', :start => ss)
+    e = Seasonal::Event.new(nil, 'America/New_York', :start => ss, :end => es)
 
     assert_equal(false, e.going_on?(start - 1))
     assert(e.going_on?(start))
-    assert(e.going_on?(start + 1))
+    assert(e.going_on?(ennd))
+    assert_equal(false, e.going_on?(ennd + 1))
   end
 
-  def test_start_end
-    ss = 'aug 29'
-    es = 'sep 1'
-    start = Time.parse(ss).utc
-    ennd = Time.parse(es).utc
+  def test_calendar_going_on
+    calendar = Seasonal::Calendar.new
+    calendar.push(Seasonal::Event.new(nil, 'America/New_York',
+      :start => 'June 22, 1978 10:00pm', :end => 'June 28, 1978 10:00am'))
+    assert_equal(1, calendar.going_on(
+      :at => Time.utc(1978, 6, 23, 2, 0, 0)).size)
+  end
 
-    e = Seasonal::Event.new(nil, 'America/New_York', :start => ss, :end => es)
+  def test_calendar_going_on_or_if_none_some
+    calendar = Seasonal::Calendar.new
+    calendar.push(Seasonal::Event.new(nil, 'America/New_York',
+      :start => 'Sep 14, 1999 1:10pm', :end => 'Sep 15, 1999 12:00am'))
+    assert_equal(1, calendar.going_on(
+      :at => Time.utc(1999, 9, 14, 18, 11, 1)).size)
+  end
 
-    assert_equal(false, e.going_on?(start - 1))
+  def test_calendar_going_on_or_if_none_none
+    calendar = Seasonal::Calendar.new
+    calendar.push(Seasonal::Event.new(nil, 'America/New_York',
+      :start => '05/01/2007', :end => '05/03/2007'))
+    or_if_none = 'default'
+    assert_equal(1, calendar.going_on(:at => Time.utc(2007, 5, 5, 0, 0, 0),
+      :or_if_none => or_if_none).size)
+    assert_equal(or_if_none, calendar.going_on(
+      :at => Time.utc(2007, 5, 5, 0, 0, 0), :or_if_none => or_if_none).first)
+  end
 
-    if start <= ennd
-      assert(e.going_on?(start))
-      assert(e.going_on?(ennd))
-    else
-      assert_equal(false, e.going_on?(start))
-      assert_equal(false, e.going_on?(ennd))
+  def test_calendar_going_on_block
+    calendar = Seasonal::Calendar.new
+    payload = 'test'
+    calendar.push(Seasonal::Event.new(payload, 'America/New_York',
+      :start => 'apr 11', :end => 'may 5'))
+    result = false
+    calendar.going_on(:at => Time.utc(Time.now.utc.year, 4, 16, 1, 2, 3)) do |e|
+      assert(payload, e)
+      result = true
     end
+    assert(result)
+  end
 
-    assert_equal(false, e.going_on?(ennd + 1))
+  def test_calendar_going_on_block_whole_event
+    calendar = Seasonal::Calendar.new
+    payload = 'test'
+    calendar.push(Seasonal::Event.new(payload, 'America/New_York',
+      :start => 'apr 11', :end => 'may 5'))
+    result = false
+    calendar.going_on(:at => Time.utc(Time.now.utc.year, 4, 16, 1, 2, 3),
+      :payloads => false) do |e|
+      assert(payload, e.payload)
+      result = true
+    end
+    assert(result)
+  end
+
+  def test_calendar_on
+    calendar = Seasonal::Calendar.new
+    on = Time.now
+    calendar.push(Seasonal::Event.new(nil, 'America/New_York',
+      :on => on.strftime('%b %d')))
+    assert_equal(1, calendar.going_on(:at => on).size)
+  end
+
+  def test_calendar_payload
+    calendar = Seasonal::Calendar.new
+    payload = 'test'
+    on = Time.now
+    calendar.push(Seasonal::Event.new(payload, 'America/New_York',
+      :on => on.strftime('%b %d')))
+    assert_equal(1, calendar.going_on(:at => on).size)
+    assert_equal(payload, calendar.going_on(:at => on).first)
+  end
+
+  def test_calendar_whole_event
+    calendar = Seasonal::Calendar.new
+    payload = 'test'
+    on = Time.now
+    calendar.push(Seasonal::Event.new(payload, 'America/New_York',
+      :on => on.strftime('%b %d')))
+    assert_equal(1, calendar.going_on(:at => on, :payloads => false).size)
+    assert_kind_of(Seasonal::Event, calendar.going_on(:at => on,
+      :payloads => false).first)
+    assert_equal(payload, calendar.going_on(:at => on,
+      :payloads => false).first.payload)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mmb-seasonal
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Matthew M. Boedicker
@@ -31,7 +31,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/seasonal.rb
-- README
+- README.textile
 - seasonal.gemspec
 has_rdoc: false
 homepage: http://github.com/mmb/seasonal