periodic-scheduler 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/periodic-scheduler.rb

@@ -1,68 +1,78 @@
-require 'quantized_time_space'
-require 'set'
-
 class PeriodicScheduler
   class MissedScheduleError < RuntimeError; end
   class EmptyScheduleError < RuntimeError; end
 
+	class RealTimeToQuantizedSpaceProjection
+		def initialize(quantum_size, quantization_rule)
+			@quantum_size = quantum_size
+			@quantization_rule = quantization_rule
+		end
+
+		def project(value)
+			@quantization_rule.call(value / @quantum_size)
+		end
+
+		def revers_project(value)
+			value * @quantum_size
+		end
+
+		def projection_error(value)
+			value - revers_project(project(value))
+		end
+	end
+
   class Event
+		attr_reader :quantum_period
     attr_reader :period
-    attr_reader :reschedule
-    attr_reader :group
+    attr_reader :keep
     attr_reader :callback
 
-    def initialize(period, reschedule, group, callback)
+    def initialize(quantized_space, period, keep, &callback)
+			@quantized_space = quantized_space
       @period = period
-      @reschedule = reschedule
-      @group = group
+      @keep = keep
       @callback = callback
+			quantatize(period)
     end
 
-    def call
-      @callback.call
-    end
-  end
+		def reschedule
+			quantatize(@period + @quantum_error)
+			@reschedule_hook.call(self) if @reschedule_hook
+		end
 
-  class QuantizedEventBuilder
-    class QuantizedEvent < Event
-      attr_reader :quantum_period
-      attr_reader :quantum_error
+		def reschedule_hook(&callback)
+			@reschedule_hook = callback
+		end
 
-      def initialize(period, reschedule, group, callback, quantum_period, quantum_error)
-        super(period, reschedule, group, callback)
-        @quantum_period = quantum_period
-        @quantum_error = quantum_error
-      end
-    end
+		def keep?
+			@keep
+		end
 
-    def initialize(quantized_space)
-      @quantized_space = quantized_space
-    end
+		def stop
+			return if @stopped
+			@stopped = true
+			@stop_hook.call(self) if @reschedule_hook
+		end
 
-    def from_event(event)
-      QuantizedEvent.new(
-        event.period,
-        event.reschedule,
-        event.group,
-        event.callback,
-        @quantized_space.project(event.period),
-        @quantized_space.projection_error(event.period)
-      )
-    end
+		def stopped?
+			@stopped
+		end
+
+		def stop_hook(&callback)
+			@stop_hook = callback
+		end
 
-    def reschedule(quantized_event)
-      accumulated_period = quantized_event.period + quantized_event.quantum_error
-      QuantizedEvent.new(
-        quantized_event.period,
-        quantized_event.reschedule,
-        quantized_event.group,
-        quantized_event.callback,
-        @quantized_space.project(accumulated_period),
-        @quantized_space.projection_error(accumulated_period)
-      )
+    def call
+      @callback.call
     end
-  end
 
+		private
+
+		def quantatize(period)
+			@quantum_period = @quantized_space.project(period)
+			@quantum_error = @quantized_space.projection_error(period)
+		end
+  end
 
   def initialize(quantum = 5.0, options = {})
     time_source = (options[:time_source] or lambda {Time.now.to_f})
@@ -70,25 +80,21 @@ class PeriodicScheduler
 
     @quantized_space = RealTimeToQuantizedSpaceProjection.new(
       quantum,
-      lambda {|v| v.floor}
+      lambda {|v| v.ceil} # behave like sleep - never execute too early
     )
-    @quantized_event_builder = QuantizedEventBuilder.new(@quantized_space)
     @time_source = time_source
     @wait_function = wait_function
 
     @events = {}
-    @event_groups_to_unschedule = Set.new
   end
 
-  def schedule(period, reschedule = false, group = nil, &callback)
-    event = @quantized_event_builder.from_event(Event.new(period, reschedule, group, callback))
-    period = quantized_now + event.quantum_period
-    add_event(event, period)
-  end
+	def after(period, &callback)
+		schedule_event Event.new(@quantized_space, period, false, &callback)
+	end
 
-  def unschedule_group(group)
-    @event_groups_to_unschedule << group
-  end
+	def every(period, &callback)
+		schedule_event Event.new(@quantized_space, period, true, &callback)
+	end
 
   def run!(&block)
     begin
@@ -100,12 +106,8 @@ class PeriodicScheduler
   end
 
   def run
-    process_unsheduled_events
-
-    earliest_quant = @events.keys.sort[0]
-    raise EmptyScheduleError, "no events scheduled" unless earliest_quant
-
-    errors = []
+		earliest_quant = @events.keys.sort.first
+		raise EmptyScheduleError, "no events scheduled" unless earliest_quant
 
     wait_time = @quantized_space.revers_project(earliest_quant) - real_now
     if wait_time < 0
@@ -113,10 +115,9 @@ class PeriodicScheduler
       begin
         # we raise it so it has proper content (backtrace)
         raise MissedScheduleError.new("missed schedule by #{-wait_time} seconds")
-      rescue StandardError => ex
-        errors << ex
+      rescue StandardError => error
+				yield error if block_given?
       end
-
       wait_time = 0
     end
     wait(wait_time)
@@ -124,75 +125,55 @@ class PeriodicScheduler
 		objects = []
 
     qnow = quantized_now
-    quants = @events.keys.select{|k| k <= qnow}.sort
 
-    # It may happen that wait returned qucker than it should
-		# In this case just return no data
-    if quants.empty?
-      return objects
-    end
+		# move quants to be run away to separate array
+    quants = @events.keys.select{|k| k <= qnow}.sort.map{|q| @events.delete(q)}
 
 		# Call callback for every quant and reschedule if needed
-    quants.each do |q|
-      events = @events[q]
-      @events.delete(q)
+    quants.each do |events|
+			# get all events for quantum that are not stopped
       events.each do |e|
         begin
           objects << e.call
-        rescue StandardError => ex
-          errors << ex
+        rescue StandardError => error
+					# Yield errors to block
+					yield error if block_given?
         end
-        reschedule_event(e, q) if e.reschedule
+        e.reschedule if e.keep? and not e.stopped?
       end
     end
-    
-		# Yield errors to block
-		if block_given?
-			errors.each do |error|
-				yield error
-			end
-		end
 
 		# return collected callabck return objects
 		objects
   end
 
   def empty?
-    # do the cleanup - this may be causing problems!
-    process_unsheduled_events
-
-    @events.empty?
+		@events.empty?
   end
 
   private
 
-  def process_unsheduled_events
-    return if @event_groups_to_unschedule.empty?
-
-    new_events = {}
+	def schedule_event(event, from = quantized_now)
+		quant = from + event.quantum_period
+		(@events[quant] ||= []) << event
 
-    @events.each_pair do |quant, events|
-      evs = events.select do |event|
-        not @event_groups_to_unschedule.member?(event.group)
-      end
-
-      new_events[quant] = evs unless evs.empty?
-    end
+		event.reschedule_hook do |event|
+			unschedule_event(event, quant)
+			schedule_event(event, quant)
+		end
 
-    @events = new_events
-    @event_groups_to_unschedule = Set.new
-  end
+		event.stop_hook do |event|
+			unschedule_event(event, quant)
+		end
 
-  def add_event(quantized_event, period)
-    @events[period] = [] unless @events[period]
-    @events[period] << quantized_event
-  end
+		event
+	end
 
-  def reschedule_event(quantized_event, previous_run_quant)
-    event = @quantized_event_builder.reschedule(quantized_event)
-    period = previous_run_quant + event.quantum_period
-    add_event(event, period)
-  end
+	def unschedule_event(event, quant)
+		return unless @events[quant]
+		@events[quant].delete(event)
+		@events.delete(quant) if @events[quant].empty?
+	end
 
   def wait(time)
     fail "time must be a positive number" if time < 0

data/periodic-scheduler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "periodic-scheduler"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2012-10-22"
+  s.date = "2012-11-03"
   s.description = "Controls execution of periodic scheduled tasks."
   s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [
@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/periodic-scheduler.rb",
-    "lib/quantized_time_space.rb",
     "periodic-scheduler.gemspec",
     "spec/periodic-scheduler_spec.rb",
     "spec/spec_helper.rb"

data/spec/periodic-scheduler_spec.rb

@@ -21,15 +21,15 @@ describe PeriodicScheduler do
   it "should execut event callbacks given time progress" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(11.5) do
+    s.after(9.5) do
       @got_event.call(1)
     end
 
-    s.schedule(14) do
+    s.after(14) do
       @got_event.call(2)
     end
 
-    s.schedule(20) do
+    s.after(20) do
       @got_event.call(3)
     end
 
@@ -37,12 +37,16 @@ describe PeriodicScheduler do
     s.empty?.should == false
 
     s.run
-    @got_events.should == [1, 2]
+    @got_events.should == [1]
     @time_now.should == 10.0
 
     s.run
-    @got_events.should == [1, 2, 3]
-    @time_now.should == 20.0
+    @got_events.should == [1, 2]
+    @time_now.should == 15.0
+
+		s.run
+		@got_events.should == [1, 2, 3]
+		@time_now.should == 20.0
 
     s.empty?.should == true
   end
@@ -50,7 +54,7 @@ describe PeriodicScheduler do
   it "should reschedule resheduable tasks" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(15, true) do
+    s.every(15) do
       @got_event.call(1)
     end
 
@@ -72,8 +76,7 @@ describe PeriodicScheduler do
   it "should compensate for quntization error" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    # Note that now we are using floor to quantize event
-    s.schedule(12, true) do
+    s.every(12) do
       @got_event.call(1)
     end
 
@@ -81,19 +84,19 @@ describe PeriodicScheduler do
 
     s.run
     @got_events.should == [1]
-    @time_now.should == 10
+    @time_now.should == 15
 
     s.run
     @got_events.should == [1, 1]
-    @time_now.should == 20
+    @time_now.should == 25
 
     s.run
     @got_events.should == [1, 1, 1]
-    @time_now.should == 35
+    @time_now.should == 40
 
     s.run
     @got_events.should == [1, 1, 1, 1]
-    @time_now.should == 45
+    @time_now.should == 50
 
     s.run
     @got_events.should == [1, 1, 1, 1, 1]
@@ -101,11 +104,11 @@ describe PeriodicScheduler do
 
     s.run
     @got_events.should == [1, 1, 1, 1, 1, 1]
-    @time_now.should == 70
+    @time_now.should == 75
   end
 
   it "should compensate for wait function jitter" do
-    jitter = [1, 0, 5, -1, 0.5, -0.2, 0, 0, 0]
+    jitter = [1, 0, 5, -5, 0.5, -0.2, 0, 0, 0]
     @options[:wait_function] = lambda{|t| 
       j = jitter.shift
       #puts "time is: #{@time_now}"
@@ -115,44 +118,44 @@ describe PeriodicScheduler do
 
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(12, true) do
+    s.every(12) do
       @got_event.call(1)
     end
 
     @got_events.should == []
 
     s.run.should_not be_empty
-		@time_now.should == 11
+		@time_now.should == 16
     @got_events.should == [1]
 
     s.run.should_not be_empty
-		@time_now.should == 20
+		@time_now.should == 25
     @got_events.should == [1, 1]
 
     s.run.should_not be_empty
-		@time_now.should == 40
+		@time_now.should == 45
     @got_events.should == [1, 1, 1]
 
 		# if timer returns too quickly the run will be empty
     s.run.should be_empty
-		@time_now.should == 44
+		@time_now.should == 45
 		@got_events.should == [1, 1, 1]
 		
 		s.run.should_not be_empty
-		@time_now.should == 45.5
+		@time_now.should == 50.5
     @got_events.should == [1, 1, 1, 1]
 
-		s.run.should be_empty
+		# now the jitter is too small to not progress the quant
     s.run.should_not be_empty
-		@time_now.should == 60
+		@time_now.should == 59.8
     @got_events.should == [1, 1, 1, 1, 1]
 
     s.run.should_not be_empty
-		@time_now.should == 70.0
+		@time_now.should == 75.0
     @got_events.should == [1, 1, 1, 1, 1, 1]
 
     s.run.should_not be_empty
-		@time_now.should == 80.0
+		@time_now.should == 85.0
     @got_events.should == [1, 1, 1, 1, 1, 1, 1]
   end
 
@@ -173,12 +176,12 @@ describe PeriodicScheduler do
 
     s = PeriodicScheduler.new(5.0, @options) 
 
-    s.schedule(ev1_val, true) do
+    s.every(ev1_val) do
       ev1 << @time_now - ev1_last
       ev1_last = @time_now
     end
 
-    s.schedule(ev2_val, true) do
+    s.every(ev2_val) do
       ev2 << @time_now - ev2_last
       ev2_last = @time_now
     end
@@ -189,24 +192,18 @@ describe PeriodicScheduler do
     (ev2.inject(0){|v, s| v + s} / ev2.length).should be_within(0.001).of(ev2_val)
   end
 
-  it "should support grouping of events" do
+  it "should support unscheduling of events" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(12, true, "test group") {}
-  end
-
-  it "should support unscheduling of all events within a group" do
-    s = PeriodicScheduler.new(5.0, @options)
-
-    s.schedule(15, true, "g1") do
+    e1 = s.every(15) do
       @got_event.call(1)
     end
 
-    s.schedule(20, true, "g1") do
+    e2 = s.every(20) do
       @got_event.call(2)
     end
 
-    s.schedule(25, true, "g2") do
+    e3 = s.every(25) do
       @got_event.call(3)
     end
 
@@ -228,68 +225,68 @@ describe PeriodicScheduler do
     @got_events.should == [1, 2, 3, 1]
     @time_now.should == 30
 
-    s.unschedule_group("g1")
+		e1.stop
+		e2.stop
 
     s.run
     @got_events.should == [1, 2, 3, 1, 3]
-    @time_now.should == 50
+		@time_now.should == 50
 
     s.empty?.should == false
 
-    s.unschedule_group("g2")
-
+		e3.stop
     s.empty?.should == true
   end
 
-  it "should support unscheduling of all events within a group from other event" do
+  it "should support unscheduling of events from other event" do
     s = PeriodicScheduler.new(1.0, @options)
 
-    s.schedule(2, true, "g4") do
-      s.unschedule_group("g2")
-      @got_event.call(4)
-    end
-
-    s.schedule(1, true, "g1") do
+    e1 = s.every(1) do
       @got_event.call(1)
     end
 
-    s.schedule(1, true, "g2") do
+    e2 = s.every(1) do
       @got_event.call(2)
     end
 
-    s.schedule(1, true, "g2") do
+    e3 = s.every(1) do
       @got_event.call(3)
     end
 
+		e4 = s.every(2) do
+			e1.stop
+			@got_event.call(4)
+		end
+
     @got_events.should == []
 
     s.run
     @got_events.should == [1, 2, 3]
     @time_now.should == 1
 
-    # They will get executed this time
+    # Will get executed this time
     s.run
     @got_events.should == [1, 2, 3, 4, 1, 2, 3]
     @time_now.should == 2
 
-    # They should be not rescheduled and gone
+    # Should be not rescheduled
     s.run
-    @got_events.should == [1, 2, 3, 4, 1, 2, 3, 1]
+    @got_events.should == [1, 2, 3, 4, 1, 2, 3, 2, 3]
     @time_now.should == 3
   end
 
   it "should execut all not reschedulable tasks if we miss them" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(15) do
+    s.after(15) do
       @got_event.call(1)
     end
 
-    s.schedule(30) do
+    s.after(30) do
       @got_event.call(2)
     end
 
-    s.schedule(45) do
+    s.after(45) do
       @got_event.call(3)
     end
 
@@ -306,7 +303,7 @@ describe PeriodicScheduler do
     #TODO: this behaviour is a bit of gary area
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(15, true) do
+    s.every(15) do
       @got_event.call(1)
     end
 
@@ -322,11 +319,11 @@ describe PeriodicScheduler do
   it "should report error if the schedule was missed" do
     s = PeriodicScheduler.new(5.0, @options)
 
-    s.schedule(15) do
+    s.after(15) do
       @got_event.call(1)
     end
 
-    s.schedule(30) do
+    s.after(30) do
       @got_event.call(2)
     end
 
@@ -346,7 +343,7 @@ describe PeriodicScheduler do
     it "should handle events call exceptions and return them" do
       s = PeriodicScheduler.new(5.0, @options)
 
-      s.schedule(12, true) do
+      s.every(12) do
         fail "test"
       end
 
@@ -366,7 +363,7 @@ describe PeriodicScheduler do
     it "should raise PeriodicScheduler::EmptyScheduleError if there are no events left to process" do
       s = PeriodicScheduler.new(5.0, @options)
 
-      s.schedule(12) {}
+      s.after(12) {}
 
       lambda {
         s.run
@@ -382,11 +379,11 @@ describe PeriodicScheduler do
 
 			test = 0
 
-			s.schedule(11, true) do
+			s.every(11) do
 				test += 1
 			end
 
-			s.schedule(12) do
+			s.after(12) do
 				test += 1
 			end
 
@@ -399,15 +396,15 @@ describe PeriodicScheduler do
     it "should run schedule until there is no more events sheduled" do
       s = PeriodicScheduler.new(5.0, @options)
 
-      s.schedule(5) do
+      s.after(5) do
         @got_event.call(1)
       end
 
-      s.schedule(10) do
+      s.after(10) do
         @got_event.call(2)
       end
 
-      s.schedule(15) do
+      s.after(15) do
         @got_event.call(3)
       end
 
@@ -419,19 +416,19 @@ describe PeriodicScheduler do
     it "should call block on event error" do
       s = PeriodicScheduler.new(5.0, @options)
 
-      s.schedule(5) do
+      s.after(5) do
         raise "1"
       end
 
-      s.schedule(10) do
+      s.after(10) do
         @got_event.call(1)
       end
 
-      s.schedule(15) do
+      s.after(15) do
         raise "2"
       end
 
-      s.schedule(15) do
+      s.after(15) do
         @got_event.call(2)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodic-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70209526649300 !ruby/object:Gem::Requirement
+  requirement: &70289045852440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70209526649300
+  version_requirements: *70289045852440
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70209526648820 !ruby/object:Gem::Requirement
+  requirement: &70289045851420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70209526648820
+  version_requirements: *70289045851420
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70209526648340 !ruby/object:Gem::Requirement
+  requirement: &70289045850520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70209526648340
+  version_requirements: *70289045850520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70209526647840 !ruby/object:Gem::Requirement
+  requirement: &70289045849460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70209526647840
+  version_requirements: *70289045849460
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70209526647360 !ruby/object:Gem::Requirement
+  requirement: &70289045848140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70209526647360
+  version_requirements: *70289045848140
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70209526646820 !ruby/object:Gem::Requirement
+  requirement: &70289045847660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70209526646820
+  version_requirements: *70289045847660
 description: Controls execution of periodic scheduled tasks.
 email: jpastuszek@gmail.com
 executables: []
@@ -94,7 +94,6 @@ files:
 - Rakefile
 - VERSION
 - lib/periodic-scheduler.rb
-- lib/quantized_time_space.rb
 - periodic-scheduler.gemspec
 - spec/periodic-scheduler_spec.rb
 - spec/spec_helper.rb
@@ -113,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2525595850660518537
+      hash: -3007109713831198216
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/quantized_time_space.rb

@@ -1,20 +0,0 @@
-class RealTimeToQuantizedSpaceProjection
-  def initialize(quantum_size, quantization_rule)
-    @quantum_size = quantum_size
-    @quantization_rule = quantization_rule
-  end
-
-  def project(value)
-    @quantization_rule.call(value / @quantum_size)
-  end
-
-  def revers_project(value)
-    value * @quantum_size
-  end
-
-  def projection_error(value)
-    new_value = project(value)
-    value - revers_project(new_value)
-  end
-end
-