servolux 0.5.0 → 0.6.0

data/History.txt

@@ -1,6 +1,12 @@
+== 0.6.0 / 2009-07-07
+
+* 2 Minor Enhancements
+  * Threaded objects can be set to run only a given number of times
+  * Threaded objects can now continue on error
+
 == 0.5.0 / 2009-06-30
 
-* 2 Minor Enchancements
+* 2 Minor Enhancements
   * Added tests for the Child class
   * Updating documentation in preperation for a release
 

data/lib/servolux/threaded.rb

@@ -57,17 +57,28 @@ module Servolux::Threaded
 
     before_starting if self.respond_to?(:before_starting)
     @activity_thread_running = true
+    @activity_thread_iterations = 0
     @activity_thread = Thread.new {
       begin
         loop {
-          sleep interval if running?
-          break unless running?
-          run
+          begin
+            sleep interval if running?
+            break unless running?
+            run
+            @activity_thread_iterations += 1
+            break if finished_iterations?
+          rescue SystemExit; raise
+          rescue Exception => err
+            if continue_on_error?
+              logger.error err
+            else
+              logger.fatal err
+              raise err
+            end
+          end
         }
-      rescue Exception => err
+      ensure
         @activity_thread_running = false
-        logger.fatal err unless err.is_a?(SystemExit)
-        raise err
       end
     }
     after_starting if self.respond_to?(:after_starting)
@@ -96,6 +107,20 @@ module Servolux::Threaded
     self
   end
 
+  # Wait on the activity thread.  If the thread is already stopped, this
+  # method will return without taking any action.  Otherwise, this method
+  # does not return until the activity thread has stopped, or a specific
+  # number of iterations has passed since this method was called.
+  #
+  def wait( limit = nil )
+    return self unless running?
+    start_waiting_iterations = self.iterations
+    loop {
+      break unless running?
+      break if limit and self.iterations > ( start_waiting_iterations + limit )
+    }
+  end
+
   # If the activity thread is running, the calling thread will suspend
   # execution and run the activity thread. This method does not return until
   # the activity thread is stopped or until _limit_ seconds have passed.
@@ -115,6 +140,16 @@ module Servolux::Threaded
     @activity_thread_running
   end
 
+  # Returns +true+ if the activity thread has finished its maximum
+  # number of iterations or the thread is no longer running.
+  # Returns +false+ otherwise.
+  #
+  def finished_iterations?
+    return true unless running?
+    return true if maximum_iterations and (iterations >= maximum_iterations)
+    return false
+  end
+
   # Returns the status of threaded object.
   #
   #    'sleep'    : sleeping or waiting on I/O
@@ -142,7 +177,50 @@ module Servolux::Threaded
   # threaded object's 'run' method.
   #
   def interval
-    @activity_thread_interval
+    @activity_thread_interval ||= 60
+  end
+
+  # Sets the maximum number of invocations of the threaded object's
+  # 'run' method
+  #
+  def maximum_iterations=( value )
+    raise ArgumentError, "maximum iterations must be >= 1" unless value.to_i >= 1
+    @activity_thread_maximum_iterations = value.to_i
+  end
+
+  # Returns the maximum number of invocations of the threaded
+  # object's 'run' method
+  #
+  def maximum_iterations
+    return unless defined? @activity_thread_maximum_iterations
+    @activity_thread_maximum_iterations
+  end
+
+  # Returns the number of iterations of the threaded object's 'run' method
+  # completed thus far.
+  #
+  def iterations
+    @activity_thread_iterations ||= 0
+  end
+
+  # Set to +true+ to continue running the threaded object even if an error
+  # is raised by the +run+ method. The default behavior is to stop the
+  # activity thread when an error is raised by the run method.
+  #
+  # A SystemExit will never be caught; it will always cause the Ruby
+  # interpreter to exit.
+  #
+  def continue_on_error=( value )
+    @activity_thread_continue_on_error = (value ? true : false)
+  end
+
+  # Returns +true+ if the threded object should continue running even if an
+  # error is raised by the run method. The default is to return +false+. The
+  # threaded object will stop running when an error is raised.
+  #
+  def continue_on_error?
+    return @activity_thread_continue_on_error if defined? @activity_thread_continue_on_error
+    @activity_thread_continue_on_error = false
   end
 
   # :stopdoc:

data/lib/servolux.rb

@@ -4,7 +4,7 @@ require 'logging'
 module Servolux
 
   # :stopdoc:
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/spec/threaded_spec.rb

@@ -90,6 +90,32 @@ describe Servolux::Threaded do
     lambda { obj.join }.should raise_error(RuntimeError, 'ni')
   end
 
+  it "lives if told to continue on error" do
+    klass = Class.new(base) do
+      def run()
+        @sleep ||= false
+        if @sleep then sleep
+        else
+          @sleep = true
+          raise 'ni'
+        end
+      end
+    end
+
+    obj = klass.new
+    obj.continue_on_error = true
+
+    obj.start
+    obj.pass
+
+    obj.running?.should be_true
+    @log_output.readline
+    @log_output.readline.chomp.should == "ERROR  Object : <RuntimeError> ni"
+
+    obj.stop(2)
+    obj.running?.should be_false
+  end
+
   it "complains loudly if you don't have a run method" do
     obj = base.new
     obj.start
@@ -100,6 +126,23 @@ describe Servolux::Threaded do
 
     lambda { obj.join }.should raise_error(NotImplementedError, 'The run method must be defined by the threaded object.')
   end
+
+  it "stops after a limited number of iterations" do
+    klass = Class.new( base ) do
+      def run() ; end
+    end
+    obj = klass.new
+    obj.maximum_iterations = 5
+    obj.iterations.should == 0
+    obj.start
+    obj.wait
+    obj.iterations.should == 5
+  end
+
+  it "complains loudly if you attempt to set a maximum number of iterations < 1" do
+    obj = base.new
+    lambda { obj.maximum_iterations = -1 }.should raise_error( ArgumentError, "maximum iterations must be >= 1" )
+  end
 end
 
 # EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: servolux
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-30 00:00:00 -06:00
+date: 2009-07-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency