clockwork 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb04c64391be1de07e805c05256430c06c1d0da6
-  data.tar.gz: 3804849a9e343ce52d62609390da392ccb2c6274
+  metadata.gz: fe114a0ae00c9b51086eed10fa3f2cf24cbbbda8
+  data.tar.gz: bf37628fb300af8eee5a21e64ceaf54c625c6e41
 SHA512:
-  metadata.gz: d3adf3511969f14520a4d3273dbf3555d690a8a2cb467e217825ce66f8cae9d8cae3c1431f31784ff987061c6acff1c8e081b91bebac858e96ac8013d071a67d
-  data.tar.gz: 06a2920e423ecf3f656b2b5f10ad5a8a32cf5bff46a55a12416b94f77bd484b3bf443a3cfdde7267e89a011cc282ef2580ae883191b167918f23cc6e9383c833
+  metadata.gz: 86fe430ba1581ae9fad955fc603ca72cd534cf79992fb6c7835da5a32de45065e3c1412fb748d0bae6c5fb208b4c660661ca06357a54ffa071377b5327e5bc25
+  data.tar.gz: b19a6327cc02f83a875cfcb0465eb9e0fb050741007817ec5c7085a1a00a3c184f010bd7beba8bd25188e3d1e0e225c63901af28c90319bc37e2236f2794f049

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "0.7.4"
+  s.version = "0.7.5"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'

data/lib/clockwork/manager_with_database_tasks.rb

@@ -1,5 +1,14 @@
 module Clockwork
 
+  # add equality testing to At
+  class At
+    attr_reader :min, :hour, :wday
+
+    def == other
+      @min == other.min && @hour == other.hour && @wday == other.wday
+    end
+  end
+
   module Methods
     def sync_database_tasks(options={}, &block)
       Clockwork.manager.sync_database_tasks(options, &block)
@@ -25,30 +34,34 @@ module Clockwork
       @model.all.each do |db_task|
         model_ids_that_exist << db_task.id
         
-        if !event_exists_for_task(db_task) || db_task_has_changed(db_task)
-          create_event_for_database_task(db_task)
+        if !event_exists_for_task(db_task) || task_has_changed(db_task)
+          recreate_event_for_database_task(db_task)
         end
       end
 
       remove_deleted_database_tasks(model_ids_that_exist)
     end
 
-    def events
-      @events.values
+    def clockwork_events
+      @events.values.flatten
     end
 
+    # store events by task_id in array (array is needed as there is 1 event per At)
     def add_event(e, task_id)
-      @events[task_id] = e
+      @events[task_id] ||= []
+      @events[task_id] << e
     end
 
     protected
 
-      def create_event_for_database_task(db_task)
+      def recreate_event_for_database_task(db_task)
+        @events[db_task.id] = nil
+
         options = { 
           :from_database => true, 
           :db_task_id =>  db_task.id,
           :performer => self,
-          :at => db_task.at.blank? ? nil : db_task.at.split(',')
+          :at => array_of_ats_for(db_task, :nil_if_empty => true)
         }
 
         @manager.every db_task.frequency, db_task.name, options, &@block
@@ -62,9 +75,33 @@ module Clockwork
         @events.reject!{|db_task_id, _| !model_ids_that_exist.include?(db_task_id) }
       end
 
-      def db_task_has_changed(task)
-        event = @events[task.id]
-        task.name != event.job || task.frequency != event.instance_variable_get(:@period)
+      def task_has_changed(task)
+        events = @events[task.id]
+        event = @events[task.id].first # all events will have same frequency/name, just different ats
+        ats_for_task = array_of_ats_for(task)
+        ats_from_event = array_of_ats_from_event(task.id)
+
+        name_has_changed = task.name != event.job
+        frequency_has_changed = task.frequency != event.instance_variable_get(:@period)
+
+        at_has_changed = ats_for_task.length != ats_from_event.length
+        at_has_changed ||= ats_for_task.inject(false) do |memo, at|
+          memo ||= !ats_from_event.include?(At.parse(at))
+        end
+
+        name_has_changed || frequency_has_changed || at_has_changed
+      end
+
+      def array_of_ats_from_event(task_id)
+        @events[task_id].collect{|clockwork_event| clockwork_event.instance_variable_get(:@at) }.compact
+      end
+
+      def array_of_ats_for(task, opts={})
+        if task.at.nil?
+          opts[:nil_if_empty] ? nil : []
+        else
+          task.at.split(',').map(&:strip)
+        end
       end
   end
 
@@ -93,7 +130,7 @@ module Clockwork
     private
 
     def events_from_database_as_array
-      @database_event_sync_performers.collect{|performer| performer.events}.flatten
+      @database_event_sync_performers.collect{|performer| performer.clockwork_events}.flatten
     end
 
     def events_to_run(t)

data/test/manager_with_database_tasks_test.rb

@@ -19,6 +19,20 @@ class ManagerWithDatabaseTasksTest < Test::Unit::TestCase
     @manager.handler { }
   end
 
+  def assert_will_run(t)
+    if t.is_a? String
+      t = Time.parse(t)
+    end
+    assert_equal 1, @manager.tick(t).size
+  end
+
+  def assert_wont_run(t)
+    if t.is_a? String
+      t = Time.parse(t)
+    end
+    assert_equal 0, @manager.tick(t).size
+  end
+
   def tick_at(now = Time.now, options = {})
     seconds_to_tick_for = options[:and_every_second_for] || 0
     number_of_ticks = seconds_to_tick_for + 1 # add one for right now
@@ -139,21 +153,42 @@ class ManagerWithDatabaseTasksTest < Test::Unit::TestCase
         assert_equal before, after
       end
 
-      def test_edited_tasks_switch_to_new_settings
+      def test_task_with_edited_name_switches_to_new_name
         tick_at @now, :and_every_second_for => @database_reload_frequency.seconds - 1.second
+        @tasks_run = [] # clear tasks run before change
+
         modified_task_1 = stub(:frequency => 30, :name => 'ScheduledTask:1_modified', :at => nil, :id => 1)
         ScheduledTask.stubs(:all).returns([modified_task_1])
         tick_at @now + @database_reload_frequency.seconds, :and_every_second_for => @database_reload_frequency.seconds - 1.seconds
-        assert_equal [
-          "ScheduledTask:1", 
-          "ScheduledTask:1", 
-          "ScheduledTask:1",
-          "ScheduledTask:1",
-          "ScheduledTask:1",
-          "ScheduledTask:1",
-          "ScheduledTask:1_modified",
-          "ScheduledTask:1_modified"
-          ], @tasks_run
+
+        assert_equal ["ScheduledTask:1_modified", "ScheduledTask:1_modified"], @tasks_run
+      end
+
+      def test_task_with_edited_frequency_switches_to_new_frequency
+        tick_at @now, :and_every_second_for => @database_reload_frequency.seconds - 1.second
+        @tasks_run = [] # clear tasks run before change
+
+        modified_task_1 = stub(:frequency => 30, :name => 'ScheduledTask:1', :at => nil, :id => 1)
+        ScheduledTask.stubs(:all).returns([modified_task_1])
+        tick_at @now + @database_reload_frequency.seconds, :and_every_second_for => @database_reload_frequency.seconds - 1.seconds
+
+        assert_equal 2, @tasks_run.length
+      end
+
+      def test_task_with_edited_at_runs_at_new_at
+        task_1 = stub(:frequency => 1.day, :name => 'ScheduledTask:1', :at => '10:30', :id => 1)
+        ScheduledTask.stubs(:all).returns([task_1])
+
+        assert_will_run 'jan 1 2010 10:30:00'
+        assert_wont_run 'jan 1 2010 09:30:00'
+        tick_at @now, :and_every_second_for => @database_reload_frequency.seconds - 1.second
+
+        modified_task_1 = stub(:frequency => 1.day, :name => 'ScheduledTask:1', :at => '09:30', :id => 1)
+        ScheduledTask.stubs(:all).returns([modified_task_1])
+        tick_at @now + @database_reload_frequency.seconds, :and_every_second_for => @database_reload_frequency.seconds - 1.seconds
+
+        assert_will_run 'jan 1 2010 09:30:00'
+        assert_wont_run 'jan 1 2010 10:30:00'
       end
 
       def test_daily_task_with_at_should_only_run_once
@@ -168,6 +203,21 @@ class ManagerWithDatabaseTasksTest < Test::Unit::TestCase
         assert_equal 1, @tasks_run.length
       end
 
+      def test_comma_separated_at_from_task_leads_to_multiple_event_ats
+        task = stub(:frequency => 1.day, :name => 'ScheduledTask:1', :at => '16:20, 18:10', :id => 1)
+        ScheduledTask.stubs(:all).returns([task])
+
+        tick_at @now, :and_every_second_for => @database_reload_frequency.seconds
+
+        assert_wont_run 'jan 1 2010 16:19:59'
+        assert_will_run 'jan 1 2010 16:20:00'
+        assert_wont_run 'jan 1 2010 16:20:01'
+
+        assert_wont_run 'jan 1 2010 18:09:59'
+        assert_will_run 'jan 1 2010 18:10:00'
+        assert_wont_run 'jan 1 2010 18:10:01'
+      end
+
       def test_having_multiple_sync_database_tasks_will_work
         ScheduledTask.stubs(:all).returns([@scheduled_task1])
 
@@ -204,8 +254,6 @@ class ManagerWithDatabaseTasksTest < Test::Unit::TestCase
         end
       end
 
-      # For example: if the manager updates every minute, but the task specifies 5 minutes, 
-      # the task will still run every minute.
       def test_it_only_runs_the_task_once_within_the_task_frequency_period
         tick_at(@now, :and_every_second_for => 5.minutes)
         assert_equal 1, @tasks_run.length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Adam Wiggins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo