mmb-seasonal 0.0.2

data/README

@@ -0,0 +1,34 @@
+Create a calendar of date and time events and execute code based on which
+events are currently happening.
+
+Example (print holiday greetings):
+
+require 'seasonal'
+
+holidays = Seasonal::Calendar.new
+
+holidays.push(Seasonal::Event.new(
+  'Merry Christmas', 'America/New_York', 'dec 25'))
+holidays.push(Seasonal::Event.new(
+  "April Fool's Day", 'America/New_York', 'apr 1'))
+
+holidays.going_on { |e| puts e.payload }
+
+Example (make text red between 9:00 and 10:00 am):
+
+require 'seasonal'
+
+colors = Seasonal::Calendar.new
+
+colors.push(Seasonal::Event.new(
+  '#ff0000', 'America/New_York', nil, '9:00am', nil, '10:00am'))
+
+color = '#000000'
+colors.going_on { |e| color = e.payload }
+
+puts "<p style=\"background-color : #{color}\">test</p>"
+
+Each event has an attached payload which can be any object.
+
+Uses the flexible time parsing of Time.parse to be easy to use and the
+timezone and DST handling of tzinfo.

data/lib/seasonal.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+
+require 'time'
+require 'tzinfo'
+
+module Seasonal
+
+  class Event
+    attr_accessor :payload
+    attr_accessor :zone
+    attr_accessor :start_date
+    attr_accessor :start_time
+    attr_accessor :end_date
+    attr_accessor :end_time
+
+    def initialize(payload, zone, start_date, start_time=nil, end_date=nil,
+      end_time=nil)
+      if end_time.nil?
+        if start_time.nil?
+          end_time = '23:59:59'
+        else
+          if end_date.nil?
+            end_time = start_time
+          else
+            end_time = '23:59:59'
+          end
+        end
+      end
+
+      start_time = '00:00:00' if start_time.nil?
+
+      end_date = start_date if end_date.nil?
+
+      @payload = payload
+      @zone = zone
+      @start_date = start_date
+      @end_date = end_date
+      @start_time = start_time
+      @end_time = end_time
+    end
+
+    def start
+      tz = TZInfo::Timezone.get(zone)
+      tz.local_to_utc(Time.parse("#{start_date} #{start_time}"))
+    end
+
+    def ennd
+      tz = TZInfo::Timezone.get(zone)
+      tz.local_to_utc(Time.parse("#{end_date} #{end_time}"))
+    end
+
+    def going_on?(test_time=Time.now)
+      # puts "#{start} - #{ennd}"
+      test_time >= start and test_time <= ennd
+    end
+
+  end
+
+  class Calendar < Array
+
+    def going_on(test_time=Time.now)
+      each { |event| yield event if event.going_on?(test_time) }
+    end
+
+  end
+
+end

data/seasonal.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name     = "seasonal"
+  s.version  = "0.0.2"
+  s.date     = "2008-11-07"
+  s.summary  = "create logic based on defined date and time events"
+  s.email    = "matthewm@boedicker.org"
+  s.homepage = "http://github.com/mmb/seasonal"
+  s.description = "Create a calendar of date and time events and execute code based on which events are currently happening."
+  s.has_rdoc = false
+  s.authors  = ["Matthew M. Boedicker"]
+  s.files    = [
+    "lib/seasonal.rb",
+    "README",
+    "seasonal.gemspec",
+    ]
+  s.test_files = [
+    "test/seasonal_test.rb",
+    ]
+  s.add_dependency("tzinfo", ["> 0.0.0"])
+end

data/test/seasonal_test.rb

@@ -0,0 +1,106 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'time'
+require 'seasonal'
+require 'test/unit'
+
+class SeasonalTest < Test::Unit::TestCase
+
+  def test_start_date
+    e = Seasonal::Event.new(nil, 'America/New_York', 'jan 1')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year - 1, 12, 30, 23, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 1, 1, 17, 0, 0)))
+
+    assert_equal(false, e.going_on?(Time.utc(Time.now.utc.year, 1, 2, 5, 0, 0)))
+  end
+
+  def test_start_date_end_time
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'feb 22', nil, nil, '5:00pm')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 2, 22, 4, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 2, 22, 13, 0, 0)))
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 2, 22, 22, 0, 1)))
+  end
+
+  def test_start_date_end_date
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'mar 3 2003', nil, 'mar 5 2003')
+
+    assert_equal(false, e.going_on?(Time.utc(2003, 3, 3, 4, 59, 59)))
+
+    assert(e.going_on?(Time.utc(2003, 3, 4, 0, 0, 0)))
+
+    assert_equal(false, e.going_on?(Time.utc(2003, 3, 6, 5, 0, 0)))
+  end
+
+  def test_start_date_end_date_end_time
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'apr 20', nil, 'may 1', '00:00')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 4, 20, 3, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 5, 1, 0, 0, 0)))
+
+    assert_equal(false, e.going_on?(Time.utc(Time.now.utc.year, 5, 2, 0, 0, 0)))
+  end
+
+  def test_start_date_start_time
+    e = Seasonal::Event.new(nil, 'America/New_York', 'may 10', '10:00am')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 5, 10, 13, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 5, 10, 14, 0, 0)))
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 5, 10, 14, 0, 1)))
+  end
+
+  def test_start_date_start_time_end_time
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'june 22', '10:00am', nil, '10:30am')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 6, 22, 13, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 6, 22, 14, 15, 0)))
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 6, 22, 14, 30, 1)))
+  end
+
+  def test_start_date_start_time_end_date
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'july 4', '11:00pm', 'jul 5')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 7, 5, 2, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 7, 5, 15, 0, 0)))
+
+    assert_equal(false, e.going_on?(Time.utc(Time.now.utc.year, 7, 6, 4, 0, 0)))
+  end
+
+  def test_start_date_start_time_end_date_end_time
+    e = Seasonal::Event.new(nil,
+      'America/New_York', 'aug 19', '1:00pm', 'aug 21', '2:00pm')
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 8, 19, 16, 59, 59)))
+
+    assert(e.going_on?(Time.utc(Time.now.utc.year, 8, 20, 15, 0, 0)))
+
+    assert_equal(false,
+      e.going_on?(Time.utc(Time.now.utc.year, 8, 21, 18, 0, 1)))
+  end
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: mmb-seasonal
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Matthew M. Boedicker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Create a calendar of date and time events and execute code based on which events are currently happening.
+email: matthewm@boedicker.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/seasonal.rb
+- README
+- seasonal.gemspec
+has_rdoc: false
+homepage: http://github.com/mmb/seasonal
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: create logic based on defined date and time events
+test_files: 
+- test/seasonal_test.rb