ActionTimer 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,5 +1,9 @@
 = CHANGELOG
 
+== 0.1.1
+* fix for float calculations 
+* downcased gem name
+
 == 0.1.0
 * remove excess exceptions
 * use logger directly

data/README.rdoc

@@ -2,41 +2,110 @@
 
 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
+    gem install actiontimer
 
 === install (less easy):
 
     git clone http://github.com/spox/actiontimer.git
-    cd actiontimer
-    gem build actiontimer.gemspec
-    gem install ./
+    cd actiontimer && gem build *.gemspec && gem install ./
 
-=== Simple example of using the timer:
+=== install (less easy that's a little easier)
 
-    require 'actiontimer'
+{rip}[http://hellorip.com/about.html] makes it easy to install directly from a github repository.
 
-    timer = ActionTimer::Timer.new
+=== Using the timer:
 
-    timer.add(10){puts "#{Time.now}: This is timed every 10 seconds"}
-    timer.add(15){puts "#{Time.now}: This is timed every 15 seconds"}
+==== 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 that sleeps for 5 seconds"
-        sleep(5)
+        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.mass_add(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
 
-==== Output:
-
-    2009-04-13 17:41:39 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:41:44 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:41:49 -0700: This is timed every 10 seconds
-    2009-04-13 17:41:49 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:41:54 -0700: This is timed every 15 seconds
-    2009-04-13 17:41:54 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:41:59 -0700: This is timed every 10 seconds
-    2009-04-13 17:41:59 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:42:04 -0700: Main loop that sleeps for 5 seconds
-    2009-04-13 17:42:09 -0700: This is timed every 10 seconds
-    2009-04-13 17:42:09 -0700: This is timed every 15 seconds
-    2009-04-13 17:42:09 -0700: Main loop that sleeps for 5 seconds
+    ActionPool is licensed under the LGPLv3
+    Copyright (c) 2009 spox <spox@modspox.com>

data/actiontimer.gemspec

@@ -2,7 +2,7 @@ spec = Gem::Specification.new do |s|
     s.name              = 'ActionTimer'
     s.author            = 'spox'
     s.email             = 'spox@modspox.com'
-    s.version           = '0.1.0'
+    s.version           = '0.1.1'
     s.summary           = 'Simple timer for a complex world'
     s.platform          = Gem::Platform::RUBY
     s.has_rdoc          = true
@@ -14,4 +14,4 @@ spec = Gem::Specification.new do |s|
     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
+end

data/lib/actiontimer/Timer.rb

@@ -81,6 +81,7 @@ module ActionTimer
                         else
                             actual_sleep = 0
                         end
+                        actual_sleep = to_sleep if actual_sleep <= 0
                         tick(actual_sleep)
                         add_waiting_actions
                     end

data/test

@@ -0,0 +1,11 @@
+    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.mass_add(actions)
+    sleep(0.41)
+    p result
+

data/tests/run_tests.rb

@@ -1,3 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path("#{__FILE__}/../../lib"))
+
 require 'test/unit'
 require 'actiontimer'
 
@@ -25,6 +27,15 @@ class TimerTests < Test::Unit::TestCase
         @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
@@ -44,7 +55,7 @@ class TimerTests < Test::Unit::TestCase
         @timer.pause
         sleep(2)
         @timer.start
-        sleep(2.1)
+        sleep(2)
         assert_equal(5, result)
     end
 
@@ -131,4 +142,4 @@ class TimerTests < Test::Unit::TestCase
         sleep(3.1)
         assert_equal(result, 3)
     end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ActionTimer
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 -08:00
+date: 2010-01-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,15 +33,16 @@ extra_rdoc_files:
 - LICENSE
 - CHANGELOG
 files: 
-- actiontimer.gemspec
-- tests/run_tests.rb
-- lib/actiontimer.rb
+- lib/actiontimer/Exceptions.rb
 - lib/actiontimer/Timer.rb
 - lib/actiontimer/Action.rb
-- lib/actiontimer/Exceptions.rb
+- lib/actiontimer.rb
+- test
+- tests/run_tests.rb
 - CHANGELOG
 - LICENSE
 - README.rdoc
+- actiontimer.gemspec
 has_rdoc: true
 homepage: http://github.com/spox/actiontimer
 licenses: []