actiontimer 0.2.1

data/CHANGELOG

@@ -0,0 +1,29 @@
+= CHANGELOG
+
+== 0.2.1
+* Use simple monitor
+* Add support for rounding sleep time within a delta
+* Raise unexpected exception to creator thread after shutting down
+* Fix arity checks for < 1.9 versions
+
+== 0.2.0
+* hashed arguments for Timer#add and Action#new
+* Timer#mass_add replaced with Timer#register for single and arrays of Actions
+* Timer#registered? added to see if an Action is registered with the timer
+* Timer#actions to see Actions registered with the timer
+* Action#timer= to allow Actions to be moved
+
+== 0.1.1
+* fix for float calculations 
+* downcased gem name
+
+== 0.1.0
+* remove excess exceptions
+* use logger directly
+* add a splat for data passage
+
+== 0.0.2
+* added new Timer::running? method
+* added new Timer::pause method
+* fixed single iteration action bug
+* added unit tests for proper checks

data/LICENSE

@@ -0,0 +1,165 @@
+           GNU LESSER GENERAL PUBLIC LICENSE
+                Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,120 @@
+== ActionTimer: Simple timing for a complex world
+
+ActionTimer is a helper for timed events. It allows for single and recurring actions to be executed in an efficient manner. It makes use of a single thread to keep time on registered actions and uses an ActionPool to execute actions. Simple and effective.
+
+
+=== install (easy):
+
+    gem install actiontimer
+
+=== install (less easy):
+
+    git clone http://github.com/spox/actiontimer.git
+    cd actiontimer && gem build *.gemspec && gem install ./
+
+=== install (less easy that's a little easier)
+
+{rip}[http://hellorip.com/about.html] makes it easy to install directly from a github repository.
+
+=== Testing
+
+ActionTimer is currently tested on:
+
+* Ruby 1.8.6-p383
+* Ruby 1.8.7-p248
+* Ruby 1.9.1-p376
+* JRuby 1.4.0
+
+=== Using the timer:
+
+==== Simple example:
+
+    require 'actiontimer'
+    timer = ActionTimer::Timer.new
+    timer.add(1){ puts "#{Time.now}: This is timed every 1 second." }
+    timer.add(2){ puts "#{Time.now}: This is timed every 2 seconds." }
+    loop do
+        puts "#{Time.now}: Main loop sleeps for 3 seconds."
+        sleep(3)
+    end
+    
+    =>
+    2010-01-05 17:52:46 -0800: Main loop sleeps for 3 seconds.
+    2010-01-05 17:52:47 -0800: This is timed every 1 second.
+    2010-01-05 17:52:48 -0800: This is timed every 1 second.
+    2010-01-05 17:52:48 -0800: This is timed every 2 seconds.
+    2010-01-05 17:52:49 -0800: Main loop sleeps for 3 seconds.
+    2010-01-05 17:52:49 -0800: This is timed every 1 second.
+    2010-01-05 17:52:50 -0800: This is timed every 1 second.
+    2010-01-05 17:52:50 -0800: This is timed every 2 seconds.
+    2010-01-05 17:52:51 -0800: This is timed every 1 second.
+    2010-01-05 17:52:52 -0800: Main loop sleeps for 3 seconds.
+
+==== Other examples:
+
+What if you want to sleep for less than a second? Well, sure we can do that:
+
+    require 'actiontimer'
+    result = 0
+    timer = ActionTimer::Timer.new
+    timer.add(0.1){ result += 1 }
+    sleep(1.01)
+    p result
+    
+    => 10
+    
+How about passing data to your block:
+
+    require 'actiontimer'
+    data = :foobar
+    timer = ActionTimer::Timer.new
+    timer.add(0.01, false, data){|x| puts "Data: #{x}" }
+    data = :fubar
+    p data
+    sleep(0.011)
+    p data
+    
+    =>
+        :fubar
+        Data: foobar
+        :fubar
+
+Or maybe you don't want the timer to start right away:
+
+    require 'actiontimer'
+    timer = ActionTimer::Timer.new(:auto_start => false)
+    output = 0
+    timer.add(0.1){ output += 1 }
+    sleep(1)
+    p output
+    timer.start
+    sleep(1.01)
+    p output
+    
+    => 
+        0
+        10
+        
+What if you want to add multiple actions at one time? We can do this:
+    
+    require 'actiontimer'
+    timer = ActionTimer::Timer.new
+    result = 0
+    actions = []
+    actions << ActionTimer::Action.new(timer, 0.1){ result += 1}
+    actions << ActionTimer::Action.new(timer, 0.2){ result += 1}
+    actions << ActionTimer::Action.new(timer, 0.3){ result += 1}
+    timer.register(actions)
+    sleep(0.41)
+    p result
+    
+    => 7
+    
+== Last remarks
+
+If you find any bugs, please report them through {github}[http://github.com/spox/actiontimer/issues]. If you are in need of any help, you can generally find me on DALnet and Freenode.
+
+== License
+
+    ActionPool is licensed under the LGPLv3
+    Copyright (c) 2009 spox <spox@modspox.com>

data/actiontimer.gemspec

@@ -0,0 +1,18 @@
+spec = Gem::Specification.new do |s|
+    s.name              = 'actiontimer'
+    s.author            = 'spox'
+    s.email             = 'spox@modspox.com'
+    s.version           = '0.2.1'
+    s.summary           = 'Simple timer for a complex world'
+    s.platform          = Gem::Platform::RUBY
+    s.has_rdoc          = true
+    s.rdoc_options      = %w(--title ActionTimer --main README.rdoc --line-numbers --inline-source)
+    s.extra_rdoc_files  = %w(README.rdoc LICENSE CHANGELOG)
+    s.files             = Dir['**/*']
+    s.require_paths     = %w(lib)
+    s.add_dependency 'actionpool', '~> 0.2.3'
+    s.add_dependency 'splib', '~> 1.4'
+    s.required_ruby_version = '>= 1.8.6'
+    s.homepage          = 'http://github.com/spox/actiontimer'
+    s.description       = 'ActionTimer is a simple timer for recurring actions. It supports single and recurring actions with an easy to use API.'
+end

data/lib/actiontimer.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'actiontimer/Timer.rb'
+require 'splib'
+Splib.load :Array, :Float, :Monitor

data/lib/actiontimer/Action.rb

@@ -0,0 +1,91 @@
+module ActionTimer
+    class Action
+    
+        attr_accessor :owner
+        attr_accessor :timer
+    
+        # timer:: Timer this action resides within
+        # period:: amount of time between runs
+        # once:: only run this action once
+        # data:: data to pass to block
+        # block:: block to be executed
+        def initialize(hash, &block)
+            raise ArgumentError.new('Period must be supplied') unless hash[:period]
+            raise ArgumentError.new('Block must be provided') unless block_given?
+            raise ArgumentError.new('Block must accept data value') if hash[:data] && block.arity == 0
+            if((block.arity > 0 || block.arity < -1) && (!hash.has_key?(:data) || hash[:data].nil?))
+                raise ArgumentError.new('Data must be supplied for block')
+            end
+            args = {:once => false, :data => nil, :owner => nil}.merge(hash)
+            @period = args[:period].to_f
+            @block = block
+            @data = args[:data]
+            @once = args[:once]
+            @timer = args[:timer]
+            @completed = false
+            @wait_remaining = @period
+            @owner = args[:owner]
+        end
+
+        # t:: ActionTimer::Timer
+        # Set timer for action to be associated with
+        def timer=(t)
+            raise ArgumentError.new('Expecting an ActionTimer::Timer') unless t.is_a?(ActionTimer::Timer)
+            @timer = t
+        end
+        
+        # o:: Object that added this action
+        # Adds an owner for this action. Useful
+        # for clearing all actions for a given
+        # object from the timer
+        def owner=(o)
+            @owner = o
+        end
+        
+        # amount:: amount of time that has passed
+        # Decrement remaining wait time by given amount
+        def tick(amount)
+            amount = amount.to_f
+            amount = 0 if amount < 0
+            @wait_remaining = @wait_remaining - amount if @wait_remaining > 0
+            @wait_remaining = 0 if @wait_remaining < 0
+            @completed = true if @once && @wait_remaining <= 0
+        end
+        
+        # Time remaning before Action is due
+        def remaining
+            @wait_remaining <= 0 ? 0 : @wait_remaining
+        end
+        
+        # new_time:: new period
+        # Resets the wait period between runs
+        def reset_period(new_time)
+            @period = new_time.to_f
+            @wait_remaining = @period
+            @completed = false
+            @timer.wakeup unless @timer.nil?
+        end
+        
+        # Action is ready to be destroyed
+        def is_complete?
+            @completed
+        end
+        
+        # Used for scheduling with Timer. Resets the interval
+        # and returns itself
+        def schedule
+            @wait_remaining = @period
+            return self
+        end
+
+        # Is action due for execution
+        def due?
+            @wait_remaining <= 0
+        end
+        
+        # Run the action
+        def run
+            @data.nil? ? @block.call : @block.call(*@data)
+        end
+    end
+end

data/lib/actiontimer/Exceptions.rb

@@ -0,0 +1,8 @@
+module ActionTimer
+
+    class AlreadyRunning < Exception
+    end
+    
+    class NotRunning < Exception
+    end
+end

data/lib/actiontimer/Timer.rb

@@ -0,0 +1,203 @@
+require 'actionpool'
+['Action', 'Exceptions'].each{|f| require "actiontimer/#{f}"}
+
+module ActionTimer
+    class Timer
+        # pool:: ActionPool for processing actions
+        # Creates a new timer
+        # Argument hash: {:pool, :logger, :auto_start}
+        def initialize(args={}, extra=nil)
+            auto_start = true
+            @delta = nil
+            if(args.is_a?(Hash))
+                @pool = args[:pool] ? args[:pool] : ActionPool::Pool.new
+                @logger = args[:logger] && args[:logger].is_a?(Logger) ? args[:logger] : Logger.new(nil)
+                auto_start = args.has_key?(:auto_start) ? args[:auto_start] : true
+                @delta = args[:delta] ? args[:delta].to_f : nil
+            else
+                @pool = args.is_a?(ActionPool::Pool) ? args : ActionPool::Pool.new
+                @logger = extra && extra.is_a?(Logger) ? extra : Logger.new(nil)
+            end
+            @actions = []
+            @new_actions = []
+            @timer_thread = nil
+            @stop_timer = false
+            @add_lock = Splib::Monitor.new
+            @awake_lock = Splib::Monitor.new
+            @sleeper = Splib::Monitor.new
+            @respond_to = Thread.current
+            start if auto_start
+        end
+        
+        # Forcibly wakes the timer early
+        def wakeup
+            raise NotRunning.new unless running?
+            if(@sleeper.waiters > 0)
+                @sleeper.signal
+            else
+                @timer_thread.wakeup if @timer_thread.alive? && @timer_thread.stop?
+            end
+        end
+        
+        # period:: amount of time between runs
+        # once:: only run this action once
+        # data:: data to pass to block
+        # owner:: owner of Action
+        # func:: block to be executed
+        # Add a new action to block
+        def add(hash, &func)
+            raise ArgumentError.new('Expecting hash of arguments') unless hash.is_a?(Hash)
+            raise ArgumentError.new('A period must be provided for timed action') unless hash[:period]
+            raise ArgumentError.new('Block must be provided') unless block_given?
+            raise ArgumentError.new('Block must accept data value') if hash[:data] && func.arity == 0
+            args = {:once => false, :data => nil, :owner => nil}.merge(hash)
+            action = Action.new(args.merge(:timer => self), &func)
+            @add_lock.synchronize{ @new_actions << action }
+            wakeup if running?
+            action
+        end
+        
+        # actions:: Array of actions or single ActionTimer::Action
+        # Add single or multiple Actions to the timer at once
+        def register(action)
+            if(action.is_a?(Array))
+                if(action.find{|x|x.is_a?(Action)}.nil?)
+                    raise ArgumentError.new('Array contains non ActionTimer::Action objects')
+                end
+            else
+                raise ArgumentError.new('Expecting an ActionTimer::Action object') unless action.is_a?(Action)
+                action = [action]
+            end
+            @add_lock.synchronize{ @new_actions = @new_actions + action }
+            wakeup if running?
+        end
+        
+        # action:: Action to remove from timer
+        # Remove given action from timer
+        def remove(action)
+            raise ArgumentError.new('Expecting an action') unless action.is_a?(Action)
+            @actions.delete(action)
+            wakeup if running?
+        end
+        
+        # Start the timer
+        def start
+            raise AlreadyRunning.new unless @timer_thread.nil?
+            @stop_timer = false
+            @timer_thread = Thread.new do
+                begin
+                    until @stop_timer do
+                        to_sleep = get_min_sleep
+                        if((to_sleep.nil? || to_sleep > 0) && @new_actions.empty?)
+                            @awake_lock.unlock if @awake_lock.locked?
+                            start = Time.now.to_f
+                            to_sleep.nil? ? @sleeper.wait : sleep(to_sleep)
+                            actual_sleep = Time.now.to_f - start
+                            if(@delta && to_sleep && actual_sleep.within_delta?(:expected => to_sleep, :delta => @delta))
+                                actual_sleep = to_sleep
+                            end
+                            @awake_lock.lock
+                        else
+                            actual_sleep = 0
+                        end
+                        tick(actual_sleep)
+                        add_waiting_actions
+                    end
+                rescue Object => boom
+                    @timer_thread = nil
+                    clean_actions
+                    @logger.fatal("Timer encountered an unexpected error and is shutting down: #{boom}\n#{boom.backtrace.join("\n")}")
+                    @respond_to.raise boom
+                end
+            end
+        end
+        
+        # Pause the timer in its current state.
+        def pause
+            @stop_timer = true
+            if(running?)
+                wakeup
+                @timer_thread.join
+            end
+            @timer_thread = nil
+        end
+
+        # Stop the timer. Unlike pause, this will completely
+        # stop the timer and remove all actions from the timer
+        def stop
+            @stop_timer = true
+            if(running?)
+                wakeup
+                clean_actions
+                @timer_thread.join
+            end
+            @timer_thread = nil
+        end
+        
+        # owner:: owner actions to remove
+        # Clears timer of actions. If an owner is supplied
+        # only actions owned by owner will be removed
+        def clear(owner=nil)
+            if(owner.nil?)
+                @actions.clear
+                @new_actions.clear
+            else
+                @actions.each{|a| @actions.delete(a) if a.owner == owner}
+            end
+            wakeup if running?
+        end
+        
+        # Is timer currently running?
+        def running?
+            !@timer_thread.nil?
+        end
+
+        # action:: ActionTimer::Action
+        # Is action currently in timer
+        def registered?(action)
+            @actions.include?(action)
+        end
+
+        # Actions registered with the timer
+        def actions
+            @actions.dup
+        end
+        
+        private
+        
+        def get_min_sleep
+            min = @actions.min{|a,b|a.remaining <=> b.remaining}
+            min.remaining if min
+        end
+        
+        def add_waiting_actions
+            @add_lock.synchronize do
+                @actions = @actions + @new_actions
+                @new_actions.clear
+            end
+        end
+        
+        def tick(time_passed)
+            @actions.each do |action|
+                action.tick(time_passed)
+                if(action.due?)
+                    @actions.delete(action) if action.is_complete?
+                    action = action.schedule
+                    @pool.process do
+                        begin
+                            action.run
+                        rescue StandardError => boom
+                            @logger.error("Timer caught an error while running action: #{boom}\n#{boom.backtrace.join("\n")}")
+                        end
+                    end
+                end
+            end
+        end
+        
+        def clean_actions
+            @actions.clear
+            @new_actions.clear
+        end
+        
+    end
+end

data/tests/cases/action.rb

@@ -0,0 +1,128 @@
+require 'test/unit'
+require 'actiontimer'
+
+class ActionTests < Test::Unit::TestCase
+    def setup
+        @timer = ActionTimer::Timer.new
+    end
+    def teardown
+    end
+
+    def test_create
+        assert_raise(ArgumentError) do
+            action = ActionTimer::Action.new(:timer => @timer){true}
+        end
+        assert_raise(ArgumentError) do
+            action = ActionTimer::Action.new(:timer => @timer, :period => 1){|x|true}
+        end
+        assert_raise(ArgumentError) do
+            action = ActionTimer::Action.new(:timer => @timer, :period => 1, :data => 1)
+        end
+        if(RUBY_VERSION > "1.9.0")
+            assert_raise(ArgumentError) do
+                action = ActionTimer::Action.new(:timer => @timer, :period => 1, :data => 1){true}
+            end
+        end
+        assert_kind_of(ActionTimer::Action, ActionTimer::Action.new(:timer => @timer, :period => 1){true})
+        assert_kind_of(ActionTimer::Action, ActionTimer::Action.new(:timer => @timer, :period => 1, :once => true){true})
+        assert_kind_of(ActionTimer::Action, ActionTimer::Action.new(:timer => @timer, :period => 1, :once => false){true})
+    end
+
+    def test_timer
+        mytimer = ActionTimer::Timer.new
+        action = ActionTimer::Action.new(:timer => @timer, :period => 1){true}
+        assert_equal(@timer, action.timer)
+        action.timer = mytimer
+        assert_equal(mytimer, action.timer)
+    end
+    
+    def test_owner
+        object = Object.new
+        action = ActionTimer::Action.new(:timer => @timer, :period => 1, :owner => object){true}
+        assert_equal(object, action.owner)
+        other_object = Object.new
+        action.owner = other_object
+        assert_equal(other_object, action.owner)
+        action.owner = object
+        assert_equal(object, action.owner)
+    end
+
+    def test_tick
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2){true}
+        action.tick(1)
+        assert_equal(1, action.remaining)
+        action.tick(0.1)
+        assert_equal(0.9, action.remaining)
+        action.tick(0.11)
+        assert_equal(0.79, action.remaining)
+    end
+
+    def test_reset_period
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2){true}
+        action.tick(1)
+        assert_equal(1, action.remaining)
+        action.reset_period(3)
+        assert_equal(3, action.remaining)
+        action.tick(3)
+        assert_equal(0, action.remaining)
+        assert(!action.is_complete?)
+    end
+
+    def test_complete
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2, :once => true){true}
+        action.tick(2)
+        assert_equal(0, action.remaining)
+        assert(action.is_complete?)
+    end
+
+    def test_schedule
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2){true}
+        action.tick(1)
+        assert_equal(1, action.remaining)
+        assert_equal(action, action.schedule)
+        assert_equal(2, action.remaining)
+    end
+
+    def test_due
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2){true}
+        assert(!action.due?)
+        action.tick(2)
+        assert(action.due?)
+    end
+
+    def test_run_noargs
+        a = false
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2){ a = true }
+        assert(!a)
+        action.run
+        assert(a)
+    end
+
+    def test_run_args
+        a = []
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2, :data => [1,2,[3]]) do |b,c,d|
+            a << b
+            a << c
+            a << d
+        end
+        action.run
+        assert_kind_of(Array, a.pop)
+        assert_equal(2, a.pop)
+        assert_equal(1, a.pop)
+        assert(a.empty?)
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2, :data => [1,2,[3]]) do |*b|
+            a = b
+        end
+        action.run
+        assert_kind_of(Array, a)
+        assert_kind_of(Array, a.pop)
+        assert_equal(2, a.pop)
+        assert_equal(1, a.pop)
+        assert(a.empty?)        
+        action = ActionTimer::Action.new(:timer => @timer, :period => 2, :data => :foo) do |b|
+            a = b
+        end
+        action.run
+        assert_equal(:foo, a)
+    end
+end

data/tests/cases/timer.rb

@@ -0,0 +1,85 @@
+require 'test/unit'
+require 'actiontimer'
+
+class TimerTests < Test::Unit::TestCase
+    def setup
+        @timer = ActionTimer::Timer.new
+    end
+    
+    def teardown
+    end
+
+    def test_add_bad
+        assert_raise(ArgumentError) do
+            @timer.add{true}
+        end
+        assert_raise(ArgumentError) do
+            @timer.add(1){true}
+        end
+        assert_raise(ArgumentError) do
+            @timer.add(:period => 1)
+        end
+        if(RUBY_VERSION > "1.9.0")
+            assert_raise(ArgumentError) do
+                @timer.add(:period => 1, :data => 2){true}
+            end
+        end
+    end
+
+    def test_add
+        output = []
+        action = @timer.add(:period => 0.1){true}
+        assert_kind_of(ActionTimer::Action, action)
+        sleep(0.01)
+        assert_equal(1, @timer.actions.size)
+        assert(@timer.registered?(action))
+        @timer.add(:period => 0.1, :once => true, :data => :foo){|x| output << x }
+        sleep(0.01)
+        assert_equal(2, @timer.actions.size)
+        sleep(0.14)
+        assert_equal(:foo, output.pop)
+        assert_equal(1, @timer.actions.size)
+    end
+
+    def test_register
+        output = []
+        action = ActionTimer::Action.new(:period => 0.01){output << :action}
+        @timer.register(action)
+        sleep(0.113)
+        @timer.pause
+        assert_equal(10, output.size)
+        assert_equal(1, @timer.actions.size)
+        assert(@timer.registered?(action))
+        @timer.clear
+        assert(@timer.actions.empty?)
+        @timer.start
+        output.clear
+        actions = [action]
+        actions << ActionTimer::Action.new(:period => 0.02){output << :fubar}
+        @timer.register(actions)
+        sleep(0.051)
+        @timer.pause
+        assert_equal(7, output.size)
+        assert(output.include?(:fubar))
+        assert_equal(2, @timer.actions.size)
+        actions.each{|x| assert(@timer.registered?(x)) }
+    end
+
+    def test_remove
+        output = []
+        action = ActionTimer::Action.new(:period => 0.01){output << :action}
+        @timer.register(action)
+        sleep(0.029)
+        @timer.remove(action)
+        assert_equal(2, output.size)
+        assert(@timer.actions.empty?)
+        output.clear
+        assert(output.empty?)
+        action = @timer.add(:period => 0.01){output << :action}
+        sleep(0.021)
+        @timer.remove(action)
+        assert(!@timer.registered?(action))
+        assert(2, output.size)
+    end
+
+end

data/tests/run_tests.rb

@@ -0,0 +1,150 @@
+$LOAD_PATH.unshift(File.expand_path("#{__FILE__}/../../lib"))
+
+require 'test/unit'
+require 'actiontimer'
+
+Dir.new("#{File.dirname(__FILE__)}/cases").each{|f|
+    require "#{File.dirname(__FILE__)}/cases/#{f}" if f[-2..f.size] == 'rb'
+}
+# 
+# 
+# class TimerTests < Test::Unit::TestCase
+#     def setup
+#         @timer = ActionTimer::Timer.new
+#     end
+# 
+#     # Simple test of basic repetitive action
+#     def test_basic
+#         result = 0
+#         @timer.add(2){ result += 1 }
+#         sleep(5)
+#         assert_equal(2, result)
+#     end
+# 
+#     # Check the the running? method properly reports
+#     def test_running
+#         @timer.add(1){ 1 + 1}
+#         assert(@timer.running?)
+#         @timer.pause
+#         assert(!@timer.running?)
+#         @timer.start
+#         assert(@timer.running?)
+#         @timer.stop
+#         assert(!@timer.running?)
+#     end
+#     
+#     # Check that a value 0 < t < 1 works
+#     # as expected
+#     def test_float
+#         result = 0
+#         @timer.add(0.1){ result += 1 }
+#         sleep(1.01)
+#         assert_equal(10, result)
+#     end
+# 
+#     # Check that a single iterative action is only
+#     # completed once
+#     def test_once
+#         result = 0
+#         @timer.add(1, true){ result += 1 }
+#         sleep(3)
+#         assert_equal(1, result)
+#     end
+# 
+#     # Check that timer can be paused and restarted
+#     # without registered actions being effected
+#     def test_pause
+#         result = 0
+#         @timer.add(1){ result += 1 }
+#         sleep(3.1)
+#         @timer.pause
+#         sleep(2)
+#         @timer.start
+#         sleep(2)
+#         assert_equal(5, result)
+#     end
+# 
+#     # Check that data can be passed to the block
+#     # properly when created
+#     def test_data
+#         result = 0
+#         @timer.add(1, true, 3){|a| result = a}
+#         sleep(2)
+#         assert_equal(3, result)
+#         @timer.add(1, true, [3,4,['foobar']]){|a,b,c| result = [b,a,c]}
+#         sleep(2)
+#         assert_equal(4, result[0])
+#         assert_equal(3, result[1])
+#         assert(result[2].is_a?(Array))
+#     end
+# 
+#     # Check that the timer's auto starting mechanism
+#     # can be disabled
+#     def test_auto_start
+#         timer = ActionTimer::Timer.new(:auto_start => false)
+#         timer.add(1){ 1+1 }
+#         assert(!timer.running?)
+#         timer.start
+#         assert(timer.running?)
+#     end
+# 
+#     # Check that the actions can be cleared out of the
+#     # timer and the timer is still left in a "running"
+#     # state.
+#     def test_clear
+#         result = 0
+#         @timer.add(1){ result += 1 }
+#         sleep(3)
+#         @timer.clear
+#         sleep(2)
+#         assert_equal(2, result)
+#         assert(@timer.running?)
+#     end
+# 
+#     # Check that the timer throws an exception when it
+#     # is instructed to wakeup while not running
+#     def test_wakeup
+#         @timer.stop
+#         assert_raise(ActionTimer::NotRunning){ @timer.wakeup }
+#     end
+# 
+#     # Check that the timer throws an exception when it
+#     # is instructed to start but is already running
+#     def test_start
+#         assert_raise(ActionTimer::AlreadyRunning){ @timer.start }
+#     end
+# 
+#     # Check that multiple actions can be added at once
+#     def test_mass_add
+#         result = 0
+#         actions = []
+#         actions << ActionTimer::Action.new(@timer, 1){ result += 1}
+#         actions << ActionTimer::Action.new(@timer, 3){ result += 1}
+#         actions << ActionTimer::Action.new(@timer, 5){ result += 1}
+#         @timer.mass_add(actions)
+#         sleep(5.3)
+#         assert_equal(7, result)
+#     end
+# 
+#     # Check that an action can be properly removed from
+#     # the timer
+#     def test_remove
+#         result = 0
+#         action = @timer.add(1){result += 1}
+#         sleep(2.1)
+#         @timer.remove(action)
+#         sleep(2)
+#         assert_equal(2, result)
+#     end
+# 
+#     # Check that an action's period can be dynamically
+#     # reset
+#     def test_action_reset
+#         result = 0
+#         action = @timer.add(1){ result += 1}
+#         sleep(2.1)
+#         action.reset_period(3)
+#         sleep(3.1)
+#         assert_equal(result, 3)
+#     end
+# end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: actiontimer
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- spox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpool
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: splib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+    version: 
+description: ActionTimer is a simple timer for recurring actions. It supports single and recurring actions with an easy to use API.
+email: spox@modspox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- CHANGELOG
+files: 
+- actiontimer.gemspec
+- tests/cases/timer.rb
+- tests/cases/action.rb
+- tests/run_tests.rb
+- lib/actiontimer.rb
+- lib/actiontimer/Timer.rb
+- lib/actiontimer/Action.rb
+- lib/actiontimer/Exceptions.rb
+- CHANGELOG
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/spox/actiontimer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- ActionTimer
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple timer for a complex world
+test_files: []
+