ActionTimer 0.0.2 → 0.1.0

data/CHANGELOG

@@ -1,5 +1,10 @@
 = CHANGELOG
 
+== 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

data/README.rdoc

@@ -2,20 +2,16 @@
 
 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.
 
-==== useful links
-* {trac site}[http://dev.modspox.com/trac/actiontimer]
-* {RDocs}[http://dev.modspox.com/~sine/ActionTimer]
-
 === install (easy):
 
-    gem install --include-dependencies ActionTimer
+    gem install ActionTimer
 
 === install (less easy):
 
     git clone http://github.com/spox/actiontimer.git
     cd actiontimer
     gem build actiontimer.gemspec
-    gem install ActionTimer-x.x.x.gem
+    gem install ./
 
 === Simple example of using the timer:
 

data/actiontimer.gemspec

@@ -1,9 +1,9 @@
 spec = Gem::Specification.new do |s|
     s.name              = 'ActionTimer'
-    s.author            = %q(spox)
-    s.email             = %q(spox@modspox.com)
-    s.version           = '0.0.2'
-    s.summary           = %q(Simple timer for a complex world)
+    s.author            = 'spox'
+    s.email             = 'spox@modspox.com'
+    s.version           = '0.1.0'
+    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)
@@ -12,14 +12,6 @@ spec = Gem::Specification.new do |s|
     s.require_paths     = %w(lib)
     s.add_dependency 'ActionPool'
     s.required_ruby_version = '>= 1.8.6'
-    s.homepage          = %q(http://dev.modspox.com/trac/ActionTimer)
-    description         = []
-    File.open("README.rdoc") do |file|
-        file.each do |line|
-            line.chomp!
-            break if line.empty?
-            description << "#{line.gsub(/\[\d\]/, '')}"
-        end
-    end
-    s.description = description[1..-1].join(" ")
+    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/Action.rb

@@ -67,7 +67,7 @@ module ActionTimer
         
         # Run the action
         def run
-            @data.nil? ? @block.call : @block.call(@data)
+            @data.nil? ? @block.call : @block.call(*@data)
         end
     end
 end

data/lib/actiontimer/Exceptions.rb

@@ -5,17 +5,4 @@ module ActionTimer
     
     class NotRunning < Exception
     end
-    
-    class InvalidType < Exception
-        attr_reader :given
-        attr_reader :expected
-        def initialize(g,e)
-            @given = given
-            @expected = e
-        end
-
-        def to_s
-            "Given type: #{g} Expected type: #{e}"
-        end
-    end
 end

data/lib/actiontimer/Timer.rb

@@ -1,5 +1,5 @@
 require 'actionpool'
-['Action', 'Exceptions', 'LogHelper'].each{|f| require "actiontimer/#{f}"}
+['Action', 'Exceptions'].each{|f| require "actiontimer/#{f}"}
 
 module ActionTimer
     class Timer
@@ -10,11 +10,11 @@ module ActionTimer
             auto_start = true
             if(args.is_a?(Hash))
                 @pool = args[:pool] ? args[:pool] : ActionPool::Pool.new
-                @logger = LogHelper.new(args[:logger])
+                @logger = args[:logger] && args[:logger].is_a?(Logger) ? args[:logger] : Logger.new(nil)
                 auto_start = args.has_key?(:auto_start) ? args[:auto_start] : true
             else
                 @pool = args.is_a?(ActionPool::Pool) ? args : ActionPool::Pool.new
-                @logger = LogHelper.new(extra)
+                @logger = extra && extra.is_a?(Logger) ? extra : Logger.new(nil)
             end
             @actions = []
             @new_actions = []
@@ -50,9 +50,9 @@ module ActionTimer
         # actions:: Array of actions
         # Add multiple Actions to the timer at once
         def mass_add(actions)
-            raise InvalidType.new(Array, actions.class) unless actions.is_a?(Array)
+            raise ArgumentError.new('Expecting an array') unless actions.is_a?(Array)
             actions.each do |action|
-                raise InvalidType.new(ActionTimer::Action, action.class) unless action.is_a?(Action)
+                raise ArgumentError.new('Expecting an Action') unless action.is_a?(Action)
             end
             @add_lock.synchronize{ @new_actions = @new_actions + actions }
             wakeup if running?
@@ -61,7 +61,7 @@ module ActionTimer
         # action:: Action to remove from timer
         # Remove given action from timer
         def remove(action)
-            raise InvalidType.new(ActionTimer::Action, action.class) unless action.is_a?(Action)
+            raise ArgumentError.new('Expecting an action') unless action.is_a?(Action)
             @actions.delete(action)
             wakeup if running?
         end
@@ -159,7 +159,7 @@ module ActionTimer
                     @pool.process do
                         begin
                             action.run
-                        rescue Object => boom
+                        rescue StandardError => boom
                             @logger.error("Timer caught an error while running action: #{boom}\n#{boom.backtrace.join("\n")}")
                         end
                     end

data/tests/run_tests.rb

@@ -55,6 +55,11 @@ class TimerTests < Test::Unit::TestCase
         @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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ActionTimer
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-20 00:00:00 -07:00
+date: 2009-12-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: ""
+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: []
 
@@ -33,21 +33,19 @@ extra_rdoc_files:
 - LICENSE
 - CHANGELOG
 files: 
-- tests
-- tests/run_tests.rb
 - actiontimer.gemspec
-- README.rdoc
-- lib
-- lib/actiontimer
+- tests/run_tests.rb
+- lib/actiontimer.rb
+- lib/actiontimer/Timer.rb
 - lib/actiontimer/Action.rb
-- lib/actiontimer/LogHelper.rb
 - lib/actiontimer/Exceptions.rb
-- lib/actiontimer/Timer.rb
-- lib/actiontimer.rb
-- LICENSE
 - CHANGELOG
+- LICENSE
+- README.rdoc
 has_rdoc: true
-homepage: http://dev.modspox.com/trac/ActionTimer
+homepage: http://github.com/spox/actiontimer
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -73,9 +71,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Simple timer for a complex world
 test_files: []
 

data/lib/actiontimer/LogHelper.rb

@@ -1,28 +0,0 @@
-require 'logger'
-
-module ActionTimer
-
-    class LogHelper
-    
-        def initialize(logger=nil)
-            @logger = logger
-        end
-
-        def info(m)
-            @logger.info(m) unless @logger.nil?
-        end
-
-        def warn(m)
-            @logger.warn(m) unless @logger.nil?
-        end
-
-        def fatal(m)
-            @logger.fatal(m) unless @logger.nil?
-        end
-
-        def error(m)
-            @logger.error(m) unless @logger.nil?
-        end
-    end
-
-end