gregfitz23-chrono_trigger 0.0.2

data/History.txt

@@ -0,0 +1,9 @@
+== 0.0.2 2009-04-02
+
+* 1 minor enhancement:
+  * Updated to add tasks file
+
+== 0.0.1 2009-04-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/chrono_trigger.rb
+lib/chrono_trigger/cron_entry.rb
+lib/chrono_trigger/shell.rb
+lib/chrono_trigger/tasks.rb
+lib/chrono_trigger/trigger.rb
+lib/triggers/test_triggers.rb
+script/console
+script/destroy
+script/generate
+tasks/chrono_trigger.rake
+test/test_chrono_trigger.rb
+test/test_cron_entry.rb
+test/test_helper.rb
+test/test_shell.rb
+test/test_trigger.rb
+test/triggers.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+# Remember to add chrono_trigger.rake to lib/tasks in your rails project containing:
+# require 'chrono_trigger/tasks'
+

data/README.rdoc

@@ -0,0 +1,58 @@
+= chrono_trigger
+
+* http://github.com/gregfitz23/chrono_trigger/tree/master
+
+== DESCRIPTION:
+
+A cron framework for defining cron tasks using a readable DSL.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+After installation, create lib/tasks/chrono_trigger.rake containing: require 'chrono_trigger/tasks'
+
+Create trigger files (by default in the lib/triggers) directory.
+Triggers should follow the pattern:
+
+trigger "name" do
+	runs { code to execute }
+	on  :monday
+	every :minutes=>10
+	at :hour=>9, :minute=>[30,50]
+end
+
+Execute rake RAILS_ENV={env} chrono_trigger:run
+
+== REQUIREMENTS:
+
+*  ActiveSupport >= 2.0.2
+
+== INSTALL:
+
+* sudo gem install gregfitz23-chrono_trigger
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 0

data/lib/chrono_trigger.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module ChronoTrigger
+  VERSION = '0.0.2'
+end
+
+require "activesupport"
+require "chrono_trigger/shell"
+require "chrono_trigger/trigger"
+require "chrono_trigger/cron_entry"

data/lib/chrono_trigger/cron_entry.rb

@@ -0,0 +1,54 @@
+module ChronoTrigger
+  
+  class CronEntry
+   
+    def initialize(options={})
+      set_days(options[:days])
+      set_hours(options[:hours])
+      set_minutes(options[:minutes])
+    end
+
+    DAYS_CONVERSION = {
+      :sunday     => 0,
+      :monday     => 1,
+      :tuesday    => 2,
+      :wednesday  => 3,
+      :thursday   => 4,
+      :friday     => 5,
+      :saturday   => 6
+    }
+    
+    def set_hours(*args)
+      args.compact!
+      args.flatten!
+      raise ChronoTrigger::ConfigurationException.new("Hours must be less than 24") if args.any? {|hour| hour >= 24}
+      @hours = args
+    end
+    
+    def set_days(*args)
+      args.compact!
+      args.flatten!
+      args.each {|day| raise ChronoTrigger::ConfigurationException.new("Day #{day} setting is invalid") if !DAYS_CONVERSION.keys.include?(day)}
+      @days = args.map { |day| DAYS_CONVERSION[day] }
+    end
+
+    def set_minutes(*args)
+      args.compact!
+      args.flatten!
+      raise ChronoTrigger::ConfigurationException.new("Minutes must be less than 60") if args.any? {|minute| minute >= 60}      
+      @minutes = args
+    end 
+
+    def matches?(datetime)
+      if @minutes.blank? && !@days.blank?
+        raise ChronoTrigger::ConfigurationException.new("Days were specified for a CronEntry with no minutes specified") 
+      end
+      
+      return false if !@minutes.blank? && !@minutes.include?(datetime.min)
+      return false if !@hours.blank? && !@hours.include?(datetime.hour)
+      return false if !@days.blank? && !@days.include?(datetime.wday)   
+      return true
+    end
+
+  end
+end

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,92 @@
+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 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]
+        cron_entry.set_hours(hour)
+      end
+      
+      if minute = options[:minute]
+        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]
+        cron_entry.set_minutes(extract_minutes_for_every(minutes))
+      end
+      
+      if hours = options[:hours]
+        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
+      @exec_block.call
+    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
+  end
+end

data/lib/triggers/test_triggers.rb

@@ -0,0 +1,26 @@
+trigger "trigger1" do
+  runs { puts "trigger 1 runs every 1 minutes; executed at #{Time.now}"}
+  every :minutes=>1  
+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/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,136 @@
+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
+
+    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

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/chrono_trigger'
+require "shoulda"
+require "mocha"

data/test/test_shell.rb

@@ -0,0 +1,52 @@
+class TestShell < Test::Unit::TestCase
+  
+  context "A shell instance, @shell" do
+    setup do
+      @shell = ChronoTrigger::Shell.new
+    end
+    
+    should "return an empty array on call to triggers" do
+      assert_equal [], @shell.triggers
+    end
+
+    should "raise an exception unless a block is provided to #trigger" do
+      assert_raise(ChronoTrigger::ConfigurationException) { @shell.trigger("test trigger") }
+    end
+
+    context "when provided a valid block" do
+      setup do
+        @trigger = @shell.trigger("name") { runs { "x" } }
+      end
+      
+      should "create a new trigger" do
+        assert_equal 1, @shell.triggers.size
+      end
+      
+      should "create a trigger that will run x with execute" do
+        assert_equal "x", @shell.triggers.first.execute
+      end
+      
+      context "and configured to run the next time shell.execute_triggers is called" do
+        setup do
+          ChronoTrigger::CronEntry.any_instance.stubs(:matches?).returns(true)
+        end
+        
+        should "execute the code block" do
+          @trigger.expects(:execute)
+          @shell.execute_triggers
+        end
+      end #and configured to run the next time shell.execute_triggers is called
+    end #when provided a valid block
+    
+    context "calling load_context with a valid trigger file" do
+      setup do
+        @shell.load_triggers("test/triggers.rb")
+      end
+      
+      should "create 2 triggers" do
+        assert_equal 2, @shell.triggers.size
+      end
+    end #calling load_context with a valid trigger file
+  end #A shell instance, @shell
+  
+end

data/test/test_trigger.rb

@@ -0,0 +1,116 @@
+class TestTrigger < Test::Unit::TestCase
+  
+  context "A Trigger, @trigger," do
+    setup do
+      @trigger = ChronoTrigger::Trigger.new("test trigger")
+    end
+
+    context "and a block of code to run" do
+      setup do
+        @block_to_run = "hello"
+        @trigger.runs { @block_to_run }
+      end
+
+      should "assign @exec_block on call to runs" do
+        assert_equal @block_to_run, @trigger.instance_variable_get(:@exec_block).call
+      end
+      
+      should "execute @block_to_run on call to execute" do
+        assert_equal @block_to_run, @trigger.execute
+      end
+    end #and a block of code to run
+
+    context "and a call to #on with some days" do
+      setup do
+        @days = [:monday, :wednesday]
+        @expected_days = [1, 3]
+        @trigger.on(@days)
+      end
+      
+      should "set the triggers cron entry days" do
+        assert_equal @expected_days, @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@days)
+      end
+    end #and a call to on with some days
+    
+    context "and a call to #at with :hours and :minutes" do
+      setup do
+        @hours = 10
+        @minutes = 5
+        @trigger.at :hour=>@hours, :minute=>@minutes
+      end
+      
+      should "set the trigger's cron entry's hours" do
+        assert_equal [@hours], @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@hours)
+      end
+      
+      should "set the trigger's cron entry's minutes" do
+        assert_equal [@minutes], @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@minutes)
+      end
+      
+      context "that are nil" do
+        setup do
+          @hours, @minutes = nil, nil
+        end
+        
+        should "raise an exception" do
+          assert_raise ChronoTrigger::ConfigurationException do
+            @trigger.at :hours=>@hours, :minutes=>@minutes
+          end
+        end
+      end #that are nil
+    end #and a call to #at with :hours and :minutes
+    
+
+    context "on a call to #every" do
+      context "for 10 minutes" do
+        setup do
+          @minutes = 10
+        end
+      
+        context "when called" do
+          setup do          
+            @trigger.every :minutes=>@minutes
+          end
+        
+          should "set the trigger's cron entry's minutes to [0, 10,20,30,40,50]" do
+            assert_equal [0,10,20,30,40,50], @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@minutes)
+          end
+          
+          context "in addition to setting #at to hour 2" do
+            setup do
+              @hour = 2
+              @trigger.at :hour=>@hour
+            end
+            
+            should "set the trigger's cron entry's minutes to [0, 10,20,30,40,50]" do
+              assert_equal [0,10,20,30,40,50], @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@minutes)
+            end
+            
+            should "set the trigger's cron entry's hours to 2" do
+              assert_equal [2], @trigger.instance_variable_get(:@cron_entry).instance_variable_get(:@hours)              
+            end
+          end #in addition to setting #{}
+        end #when called
+      end #for 10 minutes
+      
+      context "for 11 minutes" do
+        setup do
+          @minutes = 11
+        end
+        
+        should "raise an exception" do
+          assert_raise ChronoTrigger::ConfigurationException do
+            @trigger.every :minutes=>@minutes
+          end
+        end
+      end #for 11 minutes            
+    end #on a call to #every      
+    
+    should "raise an exception on call to #every without minutes or hours" do
+      assert_raise ChronoTrigger::ConfigurationException do
+        @trigger.every()
+      end
+    end
+  end #A Trigger, @trigger,
+  
+end

data/test/triggers.rb

@@ -0,0 +1,11 @@
+trigger "test_trigger" do
+  runs  { "hello world" }
+  on    :monday
+  at    :hour=>3, :minute=>10  
+end
+
+trigger "test_trigger_2" do
+  runs  { "hello world 2" }
+  on    :tuesday
+  every :hours=>2, :minutes=>10
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: gregfitz23-chrono_trigger
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Greg Fitzgerald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: greg_fitz@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- VERSION.yml
+- lib/chrono_trigger
+- lib/chrono_trigger/cron_entry.rb
+- lib/chrono_trigger/shell.rb
+- lib/chrono_trigger/tasks.rb
+- lib/chrono_trigger/trigger.rb
+- lib/chrono_trigger.rb
+- lib/triggers
+- lib/triggers/test_triggers.rb
+- test/test_chrono_trigger.rb
+- test/test_cron_entry.rb
+- test/test_helper.rb
+- test/test_shell.rb
+- test/test_trigger.rb
+- test/triggers.rb
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: TODO
+test_files: []
+