periodic-scheduler 0.1.0 → 0.2.0

data/Gemfile

@@ -6,8 +6,10 @@ source "http://rubygems.org"
 # 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 "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "cucumber", ">= 0"
   gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.2"
+  gem "jeweler", "~> 1.8.3"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -1,28 +1,44 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    builder (3.0.0)
+    cucumber (1.1.4)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.7.1)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    gherkin (2.7.6)
+      json (>= 1.4.6)
     git (1.2.5)
-    jeweler (1.6.2)
+    jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.2)
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.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)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec-mocks (2.8.0)
+    term-ansicolor (1.0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
-  jeweler (~> 1.6.2)
+  cucumber
+  jeweler (~> 1.8.3)
   rcov
-  rspec (>= 2.3.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/Rakefile

@@ -38,7 +38,7 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/periodic-scheduler.rb

@@ -3,6 +3,7 @@ require 'set'
 
 class PeriodicScheduler
   class MissedScheduleError < RuntimeError; end
+  class EmptyScheduleError < RuntimeError; end
 
   class Event
     attr_reader :period
@@ -63,7 +64,10 @@ class PeriodicScheduler
   end
 
 
-  def initialize(quantum = 5.0, time_source = lambda {Time.now.to_f}, wait_function = lambda{|t| sleep t})
+  def initialize(quantum = 5.0, options = {})
+    time_source = (options[:time_source] or lambda {Time.now.to_f})
+    wait_function = (options[:wait_function] or lambda{|t| sleep t})
+
     @quantized_space = RealTimeToQuantizedSpaceProjection.new(
       quantum,
       lambda {|v| v.floor}
@@ -86,12 +90,22 @@ class PeriodicScheduler
     @event_groups_to_unschedule << group
   end
 
-  def wait_events
+  def run!
+    begin
+      loop do
+        run.each do |error|
+          yield error if block_given?
+        end
+      end
+    rescue EmptyScheduleError
+    end
+  end
+
+  def run
     process_unsheduled_events
 
     earliest_quant = @events.keys.sort[0]
-    # no more events left
-    return nil unless earliest_quant
+    raise EmptyScheduleError, "no events scheduled" unless earliest_quant
 
     errors = []
 
@@ -111,9 +125,9 @@ class PeriodicScheduler
 
     qnow = quantized_now
     quants = @events.keys.select{|k| k <= qnow}.sort
-    # It may happen that wait returned qucker that it should
+    # It may happen that wait returned qucker than it should
     if quants.empty?
-      return wait_events 
+      return run 
     end
 
     quants.each do |q|
@@ -132,6 +146,13 @@ class PeriodicScheduler
     errors
   end
 
+  def empty?
+    # do the cleanup - this may be causing problems!
+    process_unsheduled_events
+
+    @events.empty?
+  end
+
   private
 
   def process_unsheduled_events

data/periodic-scheduler.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "periodic-scheduler"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Pastuszek"]
+  s.date = "2012-02-03"
+  s.description = "Controls execution of periodic scheduled tasks."
+  s.email = "jpastuszek@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/periodic-scheduler.rb",
+    "lib/quantized_time_space.rb",
+    "periodic-scheduler.gemspec",
+    "spec/periodic-scheduler_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/jpastuszek/periodic-scheduler"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Scheduler for periodic tasks."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/periodic-scheduler_spec.rb

@@ -3,10 +3,12 @@ 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}"
+    @options = {
+      :time_source => lambda{@time_now},
+      :wait_function => lambda{|t| 
+        @time_now += t
+        #puts "sleeping for #{t}"
+      }
     }
 
     @got_events = []
@@ -17,7 +19,7 @@ describe PeriodicScheduler do
   end
 
   it "should execut event callbacks given time progress" do
-    s = PeriodicScheduler.new(5.0, @time, @wait)
+    s = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(11.5) do
       @got_event.call(1)
@@ -32,25 +34,21 @@ describe PeriodicScheduler do
     end
 
     @got_events.should == []
+    s.empty?.should == false
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2]
     @time_now.should == 10.0
 
-    s.wait_events
+    s.run
     @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]
+    s.empty?.should == true
   end
 
   it "should reschedule resheduable tasks" do
-    s = PeriodicScheduler.new(5.0, @time, @wait)
+    s = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(15, true) do
       @got_event.call(1)
@@ -58,21 +56,21 @@ describe PeriodicScheduler do
 
     @got_events.should == []
 
-    s.wait_events
+    s.run
     @got_events.should == [1]
     @time_now.should == 15.0
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1]
     @time_now.should == 30
 
-    s.wait_events
+    s.run
     @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)
+    s = PeriodicScheduler.new(5.0, @options)
 
     # Note that now we are using floor to quantize event
     s.schedule(12, true) do
@@ -81,41 +79,41 @@ describe PeriodicScheduler do
 
     @got_events.should == []
 
-    s.wait_events
+    s.run
     @got_events.should == [1]
     @time_now.should == 10
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1]
     @time_now.should == 20
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1]
     @time_now.should == 35
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1, 1]
     @time_now.should == 45
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1, 1, 1]
     @time_now.should == 60
 
-    s.wait_events
+    s.run
     @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| 
+    @options[:wait_function] = 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 = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(12, true) do
       @got_event.call(1)
@@ -123,38 +121,38 @@ describe PeriodicScheduler do
 
     @got_events.should == []
 
-    s.wait_events
+    s.run
     @got_events.should == [1]
     @time_now.should == 11
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1]
     @time_now.should == 20
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1]
     @time_now.should == 40
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1, 1]
     @time_now.should == 45.5
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1, 1, 1]
     @time_now.should == 60
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 1, 1, 1, 1, 1]
     @time_now.should == 70.0
 
-    s.wait_events
+    s.run
     @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| 
+    @options[:wait_function] = lambda{|t| 
       j = (rand - 0.5) * 10
       @time_now += t + j
     }
@@ -167,7 +165,7 @@ describe PeriodicScheduler do
     ev2 = []
     ev2_last = 0
 
-    s = PeriodicScheduler.new(5.0, @time, @wait) 
+    s = PeriodicScheduler.new(5.0, @options) 
 
     s.schedule(ev1_val, true) do
       ev1 << @time_now - ev1_last
@@ -179,20 +177,20 @@ describe PeriodicScheduler do
       ev2_last = @time_now
     end
 
-    10000.times{ s.wait_events }
+    10000.times{ s.run }
     
     (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 = 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, @time, @wait)
+    s = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(15, true, "g1") do
       @got_event.call(1)
@@ -208,37 +206,37 @@ describe PeriodicScheduler do
 
     @got_events.should == []
 
-    s.wait_events
+    s.run
     @got_events.should == [1]
     @time_now.should == 15
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2]
     @time_now.should == 20
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2, 3]
     @time_now.should == 25
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2, 3, 1]
     @time_now.should == 30
 
     s.unschedule_group("g1")
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2, 3, 1, 3]
     @time_now.should == 50
 
+    s.empty?.should == false
+
     s.unschedule_group("g2")
 
-    s.wait_events.should be_nil
-    @got_events.should == [1, 2, 3, 1, 3]
-    @time_now.should == 50
+    s.empty?.should == true
   end
 
   it "should support unscheduling of all events within a group from other event" do
-    s = PeriodicScheduler.new(1.0, @time, @wait)
+    s = PeriodicScheduler.new(1.0, @options)
 
     s.schedule(2, true, "g4") do
       s.unschedule_group("g2")
@@ -259,23 +257,23 @@ describe PeriodicScheduler do
 
     @got_events.should == []
 
-    s.wait_events
+    s.run
     @got_events.should == [1, 2, 3]
     @time_now.should == 1
 
     # They will get executed this time
-    s.wait_events
+    s.run
     @got_events.should == [1, 2, 3, 4, 1, 2, 3]
     @time_now.should == 2
 
     # They should be not rescheduled and gone
-    s.wait_events
+    s.run
     @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 = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(15) do
       @got_event.call(1)
@@ -289,34 +287,34 @@ describe PeriodicScheduler do
       @got_event.call(3)
     end
 
-    @wait.call(35)
+    @options[:wait_function].call(35)
 
-    s.wait_events.should
+    s.run.should
     @got_events.should == [1, 2]
 
-    s.wait_events.should
+    s.run.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 = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(15, true) do
       @got_event.call(1)
     end
 
-    @wait.call(35)
+    @options[:wait_function].call(35)
 
-    s.wait_events.should
+    s.run.should
     @got_events.should == [1]
 
-    s.wait_events.should
+    s.run.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 = PeriodicScheduler.new(5.0, @options)
 
     s.schedule(15) do
       @got_event.call(1)
@@ -326,48 +324,97 @@ describe PeriodicScheduler do
       @got_event.call(2)
     end
 
-    @wait.call(35)
+    @options[:wait_function].call(35)
 
-    errors = s.wait_events
+    errors = s.run
     errors.should_not be_empty
     errors[0].class.should == PeriodicScheduler::MissedScheduleError
     @got_events.should == [1, 2]
   end
 
-end
+  describe "run" do
+    it "should handle events call exceptions and return them" do
+      s = PeriodicScheduler.new(5.0, @options)
 
-describe PeriodicScheduler, "wait_events" do
-  before :each do
-    @time_now = 0
-    @time = lambda{@time_now}
-    @wait = lambda{|t| @time_now += t}
-  end
+      s.schedule(12, true) do
+        fail "test"
+      end
 
-  it "should handle events call exceptions and return them" do
-    s = PeriodicScheduler.new(5.0, @time, @wait)
+      errors = nil
 
-    s.schedule(12, true) do
-      fail "test"
+      lambda {
+        errors = s.run
+      }.should_not raise_exception
+
+      errors.should have(1).error
+      errors[0].should be_kind_of RuntimeError
+      errors[0].to_s.should == "test"
     end
 
-    errors = nil
+    it "should raise PeriodicScheduler::EmptyScheduleError if there are no events left to process" do
+      s = PeriodicScheduler.new(5.0, @options)
+
+      s.schedule(12) {}
 
-    lambda {
-      errors = s.wait_events
-    }.should_not raise_exception
+      lambda {
+        s.run
+      }.should_not raise_error
 
-    errors.should have(1).error
-    errors[0].should be_kind_of RuntimeError
-    errors[0].to_s.should == "test"
+      lambda {
+        s.run
+      }.should raise_error PeriodicScheduler::EmptyScheduleError
+    end
   end
 
-  it "should return nil if there are no events left to process" do
-    s = PeriodicScheduler.new(5.0, @time, @wait)
+  describe "#run!" do
+    it "should run schedule until there is no more events sheduled" do
+      s = PeriodicScheduler.new(5.0, @options)
+
+      s.schedule(5) do
+        @got_event.call(1)
+      end
+
+      s.schedule(10) do
+        @got_event.call(2)
+      end
+
+      s.schedule(15) do
+        @got_event.call(3)
+      end
+
+      s.run!
+
+      @got_events.should == [1, 2, 3]
+    end
 
-    s.schedule(12) {}
+    it "should call block on event error" do
+      s = PeriodicScheduler.new(5.0, @options)
 
-    s.wait_events.should_not be_nil
-    s.wait_events.should be_nil
+      s.schedule(5) do
+        raise "1"
+      end
+
+      s.schedule(10) do
+        @got_event.call(1)
+      end
+
+      s.schedule(15) do
+        raise "2"
+      end
+
+      s.schedule(15) do
+        @got_event.call(2)
+      end
+
+      @got_fails = []
+      s.run! do |error|
+        error.should be_kind_of RuntimeError
+        @got_fails << error.message
+      end
+
+      @got_fails.map{|m| m.to_i}.should == [1, 2]
+      @got_events.should == [1, 2]
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: periodic-scheduler
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,28 +15,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-18 00:00:00 +01:00
-default_executable: 
+date: 2012-02-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 47
         segments: 
         - 2
-        - 3
+        - 8
         - 0
-        version: 2.3.0
+        version: 2.8.0
+  prerelease: false
   name: rspec
-  requirement: *id001
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  prerelease: false
+  name: rdoc
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: cucumber
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,28 +75,28 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  prerelease: false
   name: bundler
-  requirement: *id002
-  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 49
         segments: 
         - 1
-        - 6
-        - 2
-        version: 1.6.2
+        - 8
+        - 3
+        version: 1.8.3
+  prerelease: false
   name: jeweler
-  requirement: *id003
-  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,9 +105,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: rcov
-  requirement: *id004
-  type: :development
+  version_requirements: *id006
 description: Controls execution of periodic scheduled tasks.
 email: jpastuszek@gmail.com
 executables: []
@@ -100,9 +128,9 @@ files:
 - VERSION
 - lib/periodic-scheduler.rb
 - lib/quantized_time_space.rb
+- periodic-scheduler.gemspec
 - spec/periodic-scheduler_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jpastuszek/periodic-scheduler
 licenses: 
 - MIT
@@ -132,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Scheduler for periodic tasks.