bkoski-interval_exec 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.5.0 2009-01-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/interval_exec/interval_exec.rb
+lib/interval_exec.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_interval_exec.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+You've successfully installed interval_exec!

data/README.rdoc

@@ -0,0 +1,48 @@
+= interval_exec
+
+== DESCRIPTION:
+
+Library to execute code at defined intervals -- useful in command-line scripts or daemons when a resource must be polled periodically.
+
+== SYNOPSIS:
+
+IntervalExec.run wraps a block of code to be executed at a given interval.  For example,
+
+  IntervalExec.run(10, :immediate) do
+    puts "Hello, world!"
+  end
+
+will put "Hello, world!" to STDOUT every 10 seconds.  See IntervalExec docs for more detail; options provide a post-interval callback hook and change handling for blocks that run longer than the interval
+
+== Author:
+
+Ben Koski, http://benkoski.com
+
+== INSTALL:
+
+  sudo gem install bkoski-interval_exec --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Ben Koski
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/interval_exec'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('interval_exec', IntervalExecGem::VERSION) do |p|
+  p.developer('Ben Koski', 'ben@benkoski.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/interval_exec/interval_exec.rb

@@ -0,0 +1,50 @@
+class IntervalExec
+  
+  # Loops a block of code, handling execution interval as specified by _duration_ and _params_.
+  #
+  # *Params*:
+  # [+duration+] Execution interval in seconds
+  # [+overrun_handler+] Defines what should happen when the block execution exceeds duration
+  #
+  # <b>Possible overrun_handler values:</b>
+  # [<tt>:immediate</tt>] If execution exceeds duration, next interval begins immediately after long cycle completes.
+  # [<tt>:fixed</tt>] Next interval begins exactly _duration_ seconds after execution completes.
+  # [<tt>:next</tt>] Execution skips a cycle, and picks up at next scheduled interval.  For example, if cycle is 10s and code
+  #                  execution takes 15s, IntervalExec will sleep for 5s so execution begins at 20s mark.
+  #
+  # *Options*:
+  # [<tt>:interval_end_proc</tt>] A proc to be called at the end of every interval with one parameter:
+  #                               +actual_duration+, block execution time in seconds
+  #
+  # <b>Notes:</b>
+  # * If code execution ends early, code sleeps until _duration_ is reached.
+  # * Code runs inside a standard +loop+, so +break+ and +next+ keywords can be used to stop execution and skip to next interval
+  # * IntervalExec doesn't do any exception handling
+  def self.run(duration, overrun_handler, opts = {}, &block)
+    interval_end_proc = opts[:interval_end_proc]
+    
+    loop do
+      start_time = Time.now
+      
+      yield
+      
+      end_time = Time.now
+      actual_duration = end_time - start_time
+      
+      if actual_duration < duration
+        Kernel.sleep(duration - actual_duration)
+      else
+        case overrun_handler
+        when :fixed
+          Kernel.sleep(duration)
+        when :next
+          overrun = actual_duration % duration
+          Kernel.sleep(duration - overrun)
+        end
+      end
+      
+      interval_end_proc.call(actual_duration) unless interval_end_proc.nil?
+    end
+  end
+  
+end

data/lib/interval_exec.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require File.dirname(__FILE__) + '/interval_exec/interval_exec'
+
+module IntervalExecGem
+  VERSION = '0.5.0'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/interval_exec.rb'}"
+puts "Loading interval_exec gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'stringio'
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'timecop'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/interval_exec'

data/test/test_interval_exec.rb

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+module Kernel  
+  # cattr_accessor to store expected sleep value
+  @@expected_sleep = nil
+  def self.expected_sleep= val
+    @@expected_sleep = val
+  end
+     
+  def expected_sleep
+    @@expected_sleep
+  end
+  
+  # Stubbed sleep raises exception if request isn't approx equal to expected_sleep
+  def self.sleep requested_sec
+    raise "No sleep expectation defined" if self.expected_sleep.nil?
+    sleep_delta = self.expected_sleep - requested_sec
+    
+    tolerance = 1
+    if sleep_delta > tolerance || sleep_delta < (-1 * tolerance)
+      raise "Sleep request (#{requested_sec}) was #{sleep_delta} different from expectation (#{self.expected_sleep})!" 
+    end
+  end
+end
+
+
+class TestIntervalExec < Test::Unit::TestCase
+
+  def teardown
+    Time.unmock!
+  end
+  
+  def run_interval duration, overflow_handler, block_execution_time, opts={}
+    first_cycle = true
+    IntervalExec.run(duration, overflow_handler, opts) do
+      break if !first_cycle
+      
+      first_cycle = false
+      Time.freeze_time(Time.now + block_execution_time)
+    end
+  end
+
+  context "code completes within interval" do
+    
+    should "call sleep when overrun_handler=:immediate" do
+      Kernel.expects(:sleep)      
+      run_interval(10, :immediate, 6)
+    end
+    
+    should "sleep until interval expires when overrun_handler=:immediate" do
+      Kernel.expected_sleep = 4
+      assert_nothing_raised { run_interval(10, :immediate, 6) }
+    end
+    
+    should "sleep until interval expires when overrun_handler=:fixed" do
+      Kernel.expected_sleep = 6      
+      assert_nothing_raised { run_interval(12, :fixed, 6) }
+    end
+    
+    should "sleep until interval expires when overrun_handler=:next" do
+      Kernel.expected_sleep = 8     
+      assert_nothing_raised { run_interval(14, :fixed, 6) }
+    end
+  end
+  
+  context "code runs past interval" do
+    should "not sleep at all when overrun_handler=:immediate" do
+      Kernel.expects(:sleep).never
+      run_interval(14, :immediate, 20)
+    end
+    
+    should "sleep when overrun_handler=:fixed" do
+      Kernel.expects(:sleep)
+      assert_nothing_raised { run_interval(14, :fixed, 20) }
+    end
+    
+    should "sleep for duration when overrun_handler=:fixed" do
+      Kernel.expected_sleep = 14
+      assert_nothing_raised { run_interval(14, :fixed, 20) }
+    end
+    
+    should "sleep when overrun_handler=:next" do
+      Kernel.expects(:sleep)
+      assert_nothing_raised { run_interval(15, :next, 20) }
+    end
+    
+    should "sleep until interval would expire when overrun_handler=:next" do
+      Kernel.expected_sleep = 10
+      assert_nothing_raised { run_interval(15, :next, 20) }
+    end
+    
+    should "sleep until interval would expire when overrun_handler=:next and execution exceeds several intervals" do
+      Kernel.expected_sleep = 10
+      assert_nothing_raised { run_interval(15, :next, 35) }
+    end
+  end
+  
+  should "call interval_end_proc when specified" do
+    Kernel.stubs(:sleep)
+    test_proc = Proc.new {}
+    test_proc.expects(:call)
+    run_interval(10, :immediate, 5, :interval_end_proc => test_proc)
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: bkoski-interval_exec
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Ben Koski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Library to execute code at defined intervals -- useful in command-line scripts or daemons when a resource must be polled periodically.
+email: 
+- ben@benkoski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/interval_exec/interval_exec.rb
+- lib/interval_exec.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_interval_exec.rb
+has_rdoc: true
+homepage: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: interval_exec
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Library to execute code at defined intervals -- useful in command-line scripts or daemons when a resource must be polled periodically.
+test_files: 
+- test/test_helper.rb
+- test/test_interval_exec.rb