periodic-scheduler 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (>= 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jakub Pastuszek
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= periodic-scheduler
+
+Description goes here.
+
+== Contributing to periodic-scheduler
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Jakub Pastuszek. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "periodic-scheduler"
+  gem.homepage = "http://github.com/jpastuszek/periodic-scheduler"
+  gem.license = "MIT"
+  gem.summary = "Scheduler for periodic tasks."
+  gem.description = "Controls execution of periodic scheduled tasks."
+  gem.email = "jpastuszek@gmail.com"
+  gem.authors = ["Jakub Pastuszek"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "periodic-scheduler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/periodic-scheduler.rb

@@ -0,0 +1,178 @@
+require 'quantized_time_space'
+require 'set'
+
+class PeriodicScheduler
+  class MissedScheduleError < RuntimeError; end
+
+  class Event
+    attr_reader :period
+    attr_reader :reschedule
+    attr_reader :group
+    attr_reader :callback
+
+    def initialize(period, reschedule, group, callback)
+      @period = period
+      @reschedule = reschedule
+      @group = group
+      @callback = callback
+    end
+
+    def call
+      @callback.call
+    end
+  end
+
+  class QuantizedEventBuilder
+    class QuantizedEvent < Event
+      attr_reader :quantum_period
+      attr_reader :quantum_error
+
+      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 initialize(quantized_space)
+      @quantized_space = quantized_space
+    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 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)
+      )
+    end
+  end
+
+
+  def initialize(quantum = 5.0, time_source = lambda {Time.now.to_f}, wait_function = lambda{|t| sleep t})
+    @quantized_space = RealTimeToQuantizedSpaceProjection.new(
+      quantum,
+      lambda {|v| v.floor}
+    )
+    @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 unschedule_group(group)
+    @event_groups_to_unschedule << group
+  end
+
+  def wait_events
+    process_unsheduled_events
+
+    earliest_quant = @events.keys.sort[0]
+    # no more events left
+    return nil unless earliest_quant
+
+    errors = []
+
+    wait_time = @quantized_space.revers_project(earliest_quant) - real_now
+    if wait_time < 0
+      # we have missed our scheduled period
+      begin
+        # we raise it so it has proper content (backtrace)
+        raise MissedScheduleError.new("missed schedule by #{-wait_time} seconds")
+      rescue StandardError => ex
+        errors << ex
+      end
+
+      wait_time = 0
+    end
+    wait(wait_time)
+
+    qnow = quantized_now
+    quants = @events.keys.select{|k| k <= qnow}.sort
+    # It may happen that wait returned qucker that it should
+    if quants.empty?
+      return wait_events 
+    end
+
+    quants.each do |q|
+      events = @events[q]
+      @events.delete(q)
+      events.each do |e|
+        begin
+          e.call
+        rescue StandardError => ex
+          errors << ex
+        end
+        reschedule_event(e, q) if e.reschedule
+      end
+    end
+    
+    errors
+  end
+
+  private
+
+  def process_unsheduled_events
+    return if @event_groups_to_unschedule.empty?
+
+    new_events = {}
+
+    @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
+
+    @events = new_events
+    @event_groups_to_unschedule = Set.new
+  end
+
+  def add_event(quantized_event, period)
+    @events[period] = [] unless @events[period]
+    @events[period] << quantized_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 wait(time)
+    fail "time must be a positive number" if time < 0
+    @wait_function.call(time)
+  end
+
+  def real_now
+    @time_source.call
+  end
+
+  def quantized_now
+    @quantized_space.project(real_now)
+  end
+end
+

data/lib/quantized_time_space.rb

@@ -0,0 +1,20 @@
+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
+

data/spec/periodic-scheduler_spec.rb

@@ -0,0 +1,373 @@
+require 'periodic-scheduler'
+
+describe PeriodicScheduler do
+  before :each do
+    @time_now = 0
+    @time = lambda{@time_now}
+    @wait = lambda{|t| 
+      @time_now += t
+      #puts "sleeping for #{t}"
+    }
+
+    @got_events = []
+    @got_event = lambda{|no|
+      #puts "event #{no} at #{@time_now}"
+      @got_events << no
+    }
+  end
+
+  it "should execut event callbacks given time progress" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(11.5) do
+      @got_event.call(1)
+    end
+
+    s.schedule(14) do
+      @got_event.call(2)
+    end
+
+    s.schedule(20) do
+      @got_event.call(3)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1, 2]
+    @time_now.should == 10.0
+
+    s.wait_events
+    @got_events.should == [1, 2, 3]
+    @time_now.should == 20.0
+
+    # They should not get resheduled by default
+    s.wait_events
+    @got_events.should == [1, 2, 3]
+
+    s.wait_events
+    @got_events.should == [1, 2, 3]
+  end
+
+  it "should reschedule resheduable tasks" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(15, true) do
+      @got_event.call(1)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1]
+    @time_now.should == 15.0
+
+    s.wait_events
+    @got_events.should == [1, 1]
+    @time_now.should == 30
+
+    s.wait_events
+    @got_events.should == [1, 1, 1]
+    @time_now.should == 45
+  end
+
+  it "should compensate for quntization error" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    # Note that now we are using floor to quantize event
+    s.schedule(12, true) do
+      @got_event.call(1)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1]
+    @time_now.should == 10
+
+    s.wait_events
+    @got_events.should == [1, 1]
+    @time_now.should == 20
+
+    s.wait_events
+    @got_events.should == [1, 1, 1]
+    @time_now.should == 35
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1]
+    @time_now.should == 45
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1, 1]
+    @time_now.should == 60
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1, 1, 1]
+    @time_now.should == 70
+  end
+
+  it "should compensate for wait function jitter" do
+    jitter = [1, 0, 5, -1, 0.5, -0.2, 0, 0, 0]
+    @wait = lambda{|t| 
+      j = jitter.shift
+      #puts "time is: #{@time_now}"
+      @time_now += t + j
+      #puts "sleeping fou #{t} + jitter #{j}: #{t + j}"
+    }
+
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(12, true) do
+      @got_event.call(1)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1]
+    @time_now.should == 11
+
+    s.wait_events
+    @got_events.should == [1, 1]
+    @time_now.should == 20
+
+    s.wait_events
+    @got_events.should == [1, 1, 1]
+    @time_now.should == 40
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1]
+    @time_now.should == 45.5
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1, 1]
+    @time_now.should == 60
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1, 1, 1]
+    @time_now.should == 70.0
+
+    s.wait_events
+    @got_events.should == [1, 1, 1, 1, 1, 1, 1]
+    @time_now.should == 80.0
+  end
+
+  it "should keep average scheduling precision over longer time" do
+    srand(100) # make rand deterministic
+    @wait = lambda{|t| 
+      j = (rand - 0.5) * 10
+      @time_now += t + j
+    }
+
+    ev1_val = Math::PI * 10
+    ev1 = []
+    ev1_last = 0
+
+    ev2_val = Math::E * 5
+    ev2 = []
+    ev2_last = 0
+
+    s = PeriodicScheduler.new(5.0, @time, @wait) 
+
+    s.schedule(ev1_val, true) do
+      ev1 << @time_now - ev1_last
+      ev1_last = @time_now
+    end
+
+    s.schedule(ev2_val, true) do
+      ev2 << @time_now - ev2_last
+      ev2_last = @time_now
+    end
+
+    10000.times{ s.wait_events }
+    
+    (ev1.inject(0){|v, s| v + s} / ev1.length).should be_within(0.001).of(ev1_val)
+    (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
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(12, true, "test group") {}
+  end
+
+  it "should support unscheduling of all events within a group" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(15, true, "g1") do
+      @got_event.call(1)
+    end
+
+    s.schedule(20, true, "g1") do
+      @got_event.call(2)
+    end
+
+    s.schedule(25, true, "g2") do
+      @got_event.call(3)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1]
+    @time_now.should == 15
+
+    s.wait_events
+    @got_events.should == [1, 2]
+    @time_now.should == 20
+
+    s.wait_events
+    @got_events.should == [1, 2, 3]
+    @time_now.should == 25
+
+    s.wait_events
+    @got_events.should == [1, 2, 3, 1]
+    @time_now.should == 30
+
+    s.unschedule_group("g1")
+
+    s.wait_events
+    @got_events.should == [1, 2, 3, 1, 3]
+    @time_now.should == 50
+
+    s.unschedule_group("g2")
+
+    s.wait_events.should be_nil
+    @got_events.should == [1, 2, 3, 1, 3]
+    @time_now.should == 50
+  end
+
+  it "should support unscheduling of all events within a group from other event" do
+    s = PeriodicScheduler.new(1.0, @time, @wait)
+
+    s.schedule(2, true, "g4") do
+      s.unschedule_group("g2")
+      @got_event.call(4)
+    end
+
+    s.schedule(1, true, "g1") do
+      @got_event.call(1)
+    end
+
+    s.schedule(1, true, "g2") do
+      @got_event.call(2)
+    end
+
+    s.schedule(1, true, "g2") do
+      @got_event.call(3)
+    end
+
+    @got_events.should == []
+
+    s.wait_events
+    @got_events.should == [1, 2, 3]
+    @time_now.should == 1
+
+    # They will get executed this time
+    s.wait_events
+    @got_events.should == [1, 2, 3, 4, 1, 2, 3]
+    @time_now.should == 2
+
+    # They should be not rescheduled and gone
+    s.wait_events
+    @got_events.should == [1, 2, 3, 4, 1, 2, 3, 1]
+    @time_now.should == 3
+  end
+
+  it "should execut all not reschedulable tasks if we miss them" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(15) do
+      @got_event.call(1)
+    end
+
+    s.schedule(30) do
+      @got_event.call(2)
+    end
+
+    s.schedule(45) do
+      @got_event.call(3)
+    end
+
+    @wait.call(35)
+
+    s.wait_events.should
+    @got_events.should == [1, 2]
+
+    s.wait_events.should
+    @got_events.should == [1, 2, 3]
+  end
+
+  it "should skpi reschedulable tasks if we miss them" do
+    #TODO: this behaviour is a bit of gary area
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(15, true) do
+      @got_event.call(1)
+    end
+
+    @wait.call(35)
+
+    s.wait_events.should
+    @got_events.should == [1]
+
+    s.wait_events.should
+    @got_events.should == [1, 1]
+  end
+
+  it "should report error if the schedule was missed" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(15) do
+      @got_event.call(1)
+    end
+
+    s.schedule(30) do
+      @got_event.call(2)
+    end
+
+    @wait.call(35)
+
+    errors = s.wait_events
+    errors.should_not be_empty
+    errors[0].class.should == PeriodicScheduler::MissedScheduleError
+    @got_events.should == [1, 2]
+  end
+
+end
+
+describe PeriodicScheduler, "wait_events" do
+  before :each do
+    @time_now = 0
+    @time = lambda{@time_now}
+    @wait = lambda{|t| @time_now += t}
+  end
+
+  it "should handle events call exceptions and return them" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(12, true) do
+      fail "test"
+    end
+
+    errors = nil
+
+    lambda {
+      errors = s.wait_events
+    }.should_not raise_exception
+
+    errors.should have(1).error
+    errors[0].should be_kind_of RuntimeError
+    errors[0].to_s.should == "test"
+  end
+
+  it "should return nil if there are no events left to process" do
+    s = PeriodicScheduler.new(5.0, @time, @wait)
+
+    s.schedule(12) {}
+
+    s.wait_events.should_not be_nil
+    s.wait_events.should be_nil
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'scheduler'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: periodic-scheduler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jakub Pastuszek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: jeweler
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  requirement: *id004
+  type: :development
+description: Controls execution of periodic scheduled tasks.
+email: jpastuszek@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/periodic-scheduler.rb
+- lib/quantized_time_space.rb
+- spec/periodic-scheduler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jpastuszek/periodic-scheduler
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Scheduler for periodic tasks.
+test_files: []
+