chrono_trigger 0.1.7

data/lib/chrono_trigger/shell.rb

@@ -0,0 +1,36 @@
+module ChronoTrigger
+  
+  class ConfigurationException < Exception; end
+  
+  class Shell
+    
+    DEFAULT_TRIGGERS = "lib/triggers/*.rb"
+    #Load triggers defined in the trigger files by evaluating them in the context of this Shell instance.
+    def load_triggers(files = Dir.glob("#{DEFAULT_TRIGGERS}"))
+      files.each { |file| self.instance_eval(File.read(file), file) }
+    end
+    
+    #Instantiate a trigger and evaluate the passed in block in the context of the trigger.
+    #This is the initial method call when setting up a configuration using the DSL. 
+    def trigger(name, &block)
+      raise ConfigurationException.new("No configuration specified for trigger #{name}") unless block_given?
+      
+      trigger = Trigger.new(name)
+      trigger.instance_eval(&block)
+      
+      triggers << trigger
+      trigger
+    end
+    
+    #Run execute on any trigger who's cron entry matches the current time.
+    def execute_triggers
+      now = Time.now
+      triggers.map {|trigger| trigger.execute_on_match(now)}
+    end
+    
+    def triggers
+      @triggers ||= []
+    end
+    
+  end
+end

data/lib/chrono_trigger/tasks.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '*.rake')].each do |f|
+  load f
+end

data/lib/chrono_trigger/trigger.rb

@@ -0,0 +1,127 @@
+module ChronoTrigger
+  class Trigger
+    
+    attr_accessor :name
+    
+    def initialize(name)
+      self.name = name
+    end
+    
+    #Define the code to be run when the cron job is ready to be executed.
+    def runs(&block)
+      @exec_block = block
+    end
+    
+    #Specify what days the task should run on.
+    #Values are :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday
+    def on(*days)
+      cron_entry.set_days(days)
+    end
+    
+    #Specify what calendar day the task should run on; think monthly jobs.
+    #Values are 1-31
+    def monthly_on(*calendar_day)
+      cron_entry.set_calendar_days(calendar_day)
+    end
+    
+    #Specify what hours and minutes the task should run at 
+    #(e.g. :minute=>10, :hour=>3 or :minute=>[10,20,30], :hour=>[1,2,3])
+    def at(options={})
+      validate_hours_or_minutes!(options)
+      
+      if hour = (options[:hour] || options[:hours])
+        cron_entry.set_hours(hour)
+      end
+      
+      if minute = (options[:minute] || options[:minutes])
+        cron_entry.set_minutes(minute)
+      end
+    end
+    
+    #Specify a repeating interval of hours and minutes to run.
+    #Specifying minutes not divisible by 60 result in an exception, use #at instead.
+    def every(options={})
+      validate_hours_or_minutes!(options)
+      if minutes = (options[:minutes] || options[:minute])
+        cron_entry.set_minutes(extract_minutes_for_every(minutes))
+      end
+      
+      if hours = (options[:hours] || options[:hour])
+        cron_entry.set_hours(extract_hours_for_every(hours))
+      end
+    end
+    
+    def dates
+      @dates ||= []
+    end
+
+    #Execute this Trigger's code block if the datetime param matches this Trigger's cron entry.
+    def execute_on_match(datetime)
+      self.execute if cron_entry.matches?(datetime)
+    end
+    
+    def execute
+      defined?(ActiveRecord) ? execute_with_active_record : execute_without_active_record
+    end
+  
+  
+    private
+    def cron_entry
+      @cron_entry ||= CronEntry.new
+    end
+    
+    #Raise an exception unless minutes and hours are set.
+    def validate_hours_or_minutes!(options={})
+      unless (options[:hours] || options[:hour]) || (options[:minutes] || options[:minute])      
+        raise ChronoTrigger::ConfigurationException.new("Hours or minutes not specified in call to 'at' or 'every' method.") 
+      end
+    end
+    
+    def extract_minutes_for_every(minutes)
+      extract_for_every(minutes, 60)
+    end
+    
+    def extract_hours_for_every(hours)
+      extract_for_every(hours, 24)
+    end
+    
+    #Extract an array of integers representing the minutes or hours a task should be run at.
+    #Raise an exception if time_value is not evenly divisible by base.
+    def extract_for_every(time_value, base)
+      unless (base % time_value == 0)
+        raise ChronoTrigger::ConfigurationException.new("#{time_value} is not evenly divisible by #{base}.  Consider using #at instead.")
+      end
+      
+      (0...base).select {|num| num % time_value == 0}      
+    end
+    
+    # When ActiveRecord is defined, attempt to rescue ConnectionNotEstablished errors once,
+    # and reestablish the connection to the database.  If this fails, normal exception logging will take place.
+    # 
+    def execute_with_active_record
+      begin
+        @exec_block.call
+      rescue ActiveRecord::ConnectionNotEstablished, ActiveRecord::StatementInvalid
+        ActiveRecord::Base.connection.reconnect!
+        execute_without_active_record
+      rescue Exception
+        log_exception
+      end      
+    end
+    
+    # Execute the execution block and log all exceptions.
+    #
+    def execute_without_active_record
+      begin
+        @exec_block.call
+      rescue Exception
+        log_exception
+      end            
+    end
+    
+    def log_exception
+      STDERR.puts "Exception #{$!.inspect} caught in Trigger##{self.name}.  Backtrace:"
+      STDERR.puts $!.backtrace      
+    end
+  end
+end

data/lib/tasks/chrono_trigger.rake

@@ -0,0 +1,14 @@
+namespace :chrono_trigger do
+  
+  run_task_name = defined?(RAILS_ROOT) ? {:run => :environment} : :run
+  desc "Execute all triggers in loop, sleeping 1 minute between checks."
+  task run_task_name do
+    shell = ChronoTrigger::Shell.new
+    shell.load_triggers
+    loop do
+      shell.execute_triggers
+      sleep 1.minute.to_i
+    end
+    
+  end
+end

data/lib/triggers/test_triggers.rb

@@ -0,0 +1,31 @@
+trigger "trigger1" do
+  runs { puts "trigger 1 runs every 1 minutes; executed at #{Time.now}" }
+  every :minutes=>1  
+end
+
+trigger "exception trigger" do
+  runs { raise Exception.new("test exception")}
+  every :minutes=>2
+end
+
+trigger "trigger2" do
+  runs { puts "trigger 2 runs every 5 minutes; executed at #{Time.now}"}
+  every :minutes=>5
+end
+
+trigger "trigger3" do 
+  runs  { puts "trigger 3 runs at 9:48; executed at #{Time.now}"}
+  at    :hour=>9, :minute=>48
+end
+
+trigger "trigger4" do
+  runs { puts "trigger 4 runs on monday at 9:53 and 9:56; executed at #{Time.now}"}
+  on    :monday
+  at    :hour=>9, :minute=>[53, 56]
+end
+
+trigger "trigger5" do
+  runs  { puts "trigger 5 runs on thursday at 9:58/59; executed at #{Time.now}"}
+  on    :thursday
+  at    :hour=>9, :minute=>[58, 59]
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/chrono_trigger.rb'}"
+puts "Loading chrono_trigger gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_chrono_trigger.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestChronoTrigger < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_cron_entry.rb

@@ -0,0 +1,198 @@
+class TestCronEntry < Test::Unit::TestCase
+
+  class << self
+    
+    def should_match(options={})
+      context "and a datetime of #{options.inspect}" do
+        setup do
+          @datetime = time_from_options(options)
+        end
+        
+        should "return true on a call to matches?" do
+          assert @cron.matches?(@datetime)
+        end
+      end #and a datetime of options[]
+    end
+    
+    def should_not_match(options={})
+      context "and a datetime of #{options.inspect}" do
+        setup do
+          @datetime = time_from_options(options)
+        end
+        
+        should "return false on a call to matches?" do
+          assert !@cron.matches?(@datetime)
+        end
+      end #and a datetime of options[]      
+    end
+
+  end
+
+  context "A CronEntry, @cron," do
+    setup do
+      @cron = ChronoTrigger::CronEntry.new
+    end
+    
+    context "with a minutes entry of 10 minutes" do
+      setup do
+        @cron.set_minutes(10)
+      end
+      
+      should_match(:minutes=>10)
+
+      should_not_match(:minutes=>11)
+      
+      context "and 25 minutes" do
+        setup do
+          @cron.set_minutes(10, 25)
+        end
+
+        should_match(:minutes=>25)
+        
+        should_match(:minutes=>10)
+        
+        should_not_match(:minutes=>12)
+
+        context "and a day entry of monday" do
+          setup do
+            @cron.set_days(:monday)
+          end
+
+          should_match(:minutes=>10, :wday=>1)
+          
+          should_not_match(:minutes=>10, :wday=>2)
+          
+          context "and wednesday" do
+            setup do
+              @cron.set_days(:monday, :wednesday)
+            end
+
+            should_match(:minutes=>10, :wday=>1)
+            
+            should_match(:minutes=>10, :wday=>3)
+            
+            should_not_match(:minutes=>25, :wday=>5)
+            
+            should_not_match(:minutes=>11, :wday=>3)
+            
+            context "and an hour entry of 2" do
+              setup do
+                @cron.set_hours(5)
+              end
+
+              should_match(:minutes=>25, :wday=>3, :hour=>5)
+              
+              should_not_match(:minutes=>25, :wday=>3, :hour=>6)
+            end #and an hour entry of 2
+          end #and wednesday
+        end #and a day entry of monday
+      end #and 25 minutes
+    end #with a minutes entry of 10 minutes
+    
+    context "with a day entry of monday" do
+      setup do
+        @cron.set_days(:monday)
+      end
+
+      context "and no minutes_entry" do
+        setup do
+          @cron.set_minutes(nil)
+        end
+        
+        should "raise a ChronoTrigger::CronEntry:ConfigException exception on matches?" do
+          assert_raise ChronoTrigger::ConfigurationException do
+            @cron.matches?(time_from_options)
+          end
+        end
+      end #and no minutes_entry
+    end #with a day entry
+    
+    context "with a calendar_day entry of 25" do
+      setup do
+        @cron.set_calendar_days(25)
+      end
+      
+      should "raise an exception when setting a calendar_day and no hour and minutes" do
+        assert_raise ChronoTrigger::ConfigurationException do
+           @cron.matches?(time_from_options(:day => 25))
+        end
+      end
+      
+      context "with a hour entry of 10" do
+        setup do
+          @cron.set_hours(10)
+        end
+        
+        should "raise an exception when setting a calendar_day and hour but no minutes" do
+          assert_raise ChronoTrigger::ConfigurationException do
+             @cron.matches?(time_from_options(:hour=> 10, :day => 25))
+          end
+        end
+      
+        context "with a minutes entry of 5" do
+          setup do
+            @cron.set_minutes(5)
+          end
+          
+          should_match(:minutes => 5, :hour => 10, :day => 25)
+          should_not_match(:minutes => 4, :hour => 10, :day => 25)
+          should_not_match(:minutes => 5, :hour => 11, :day => 25)
+          should_not_match(:minutes => 5, :hour => 10, :day => 26)
+          
+          context "with an additional calendar_day entry of 26" do
+            setup do
+              @cron.set_calendar_days([25, 26])
+            end
+            
+            should_match(:minutes => 5, :hour => 10, :day => 25)
+            should_match(:minutes => 5, :hour => 10, :day => 26)
+            
+            should "raise an exception when setting a calendar_day is outside the acceptable range" do
+              assert_raise ChronoTrigger::ConfigurationException do
+                @cron.set_calendar_days(-1)
+              end
+            end
+          end
+          
+          context "with a day entry of tuesday" do
+            setup do
+              @cron.set_days(:wednesday)
+            end
+            
+            should "raise an exception when setting a calendar_day with a day" do
+              assert_raise ChronoTrigger::ConfigurationException do
+                @cron.matches?(time_from_options(:minutes => 5, :hour => 10, :day => 25, :wday => 3))
+              end
+            end
+          end
+        end
+      end
+    end
+        
+    should "raise an exception when setting an hour entry greater than 25" do
+      assert_raise ChronoTrigger::ConfigurationException do
+        @cron.set_hours(25)
+      end
+    end
+  end #A CronEntry, @cron,
+
+
+  private 
+  def time_from_options(options={})
+    datetime = Time.utc(options[:year] || 2000,
+             options[:month] || "jan",
+             options[:day]||1,
+             options[:hour]||0,
+             options[:minutes]||0,
+             options[:second]||0)
+             
+    if wday = options[:wday]
+      while datetime.wday != wday
+        datetime += 1.day
+      end
+    end
+    
+    datetime
+  end
+
+end