timers 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa56588795590f6b0772c42830b2969d4c18c31b
-  data.tar.gz: 203a266076597db814652c1b1e8d25fdca6808b2
+  metadata.gz: ff04e8dedf4d39bd0ff36650200e6c3537669cd8
+  data.tar.gz: fd2f6c05f04a626f73401ea9c06e8be89956024e
 SHA512:
-  metadata.gz: cf717b2718394941dc03bd9bd4184a790116fff7e936b07227fe64cec0d7801ff84903ba23efd5332751919d3a9acbbff95c3a1b53f8c150cd67a94c78531763
-  data.tar.gz: 26d41eddf5f924ac26860a09daba9af79203f32f0f7cefc93cafc5a46ffd95ad959f0281c6dbe619ca3ad8087c63e16c87ef1e860d297f6c30e98da3562c5be0
+  metadata.gz: 5b829c8ffc7da2676e9b32e0f16fc54135dce451825db5c669f40566d6bd8a4334dd8d6b28d06dcd191cc92cd55a27dcd3fe9476b16fcb56a80c23b335fcb2f4
+  data.tar.gz: 08314ad60709460ff1d4f55cf4c61ccb0333bf7d67186702d5e3268cfe9ac2ba9e511c936b63be0ed4f9d6532a5f3ca0235bd65ceba319b812ffa4564115f014

data/CHANGES.md

@@ -1,3 +1,8 @@
+4.0.1 (2014-09-10)
+------------------
+* Memory leak fixes
+* mathn fix for those crazy enough to use it
+
 4.0.0 (2014-07-27)
 ------------------
 * Replace Timers::Timeout with Timers::Wait

data/lib/timers/events.rb

@@ -100,7 +100,7 @@ module Timers
     # a is sorted in descending order.
     def bisect_left(a, e, l = 0, u = a.length)
       while l < u
-        m = l + (u-l)/2
+        m = l + (u-l).div(2)
         
         if a[m] > e
           l = m+1

data/lib/timers/timer.rb

@@ -1,6 +1,10 @@
 
 module Timers
-  # An individual timer set to fire a given proc at a given time
+  # An individual timer set to fire a given proc at a given time. A timer is 
+  # always connected to a Timer::Group but it would ONLY be in @group.timers
+  # if it also has a @handle specified. Otherwise it is either PAUSED or has
+  # been FIRED and is not recurring. You can manually enter this state by
+  # calling #cancel and resume normal operation by calling #reset.
   class Timer
     include Comparable
     attr_reader :interval, :offset, :recurring
@@ -8,8 +12,6 @@ module Timers
     def initialize(group, interval, recurring = false, offset = nil, &block)
       @group = group
       
-      @group.timers << self
-      
       @interval = interval
       @recurring = recurring
       @block = block
@@ -38,9 +40,9 @@ module Timers
     def resume
       return unless paused?
       
-      @group.timers.add self
       @group.paused_timers.delete self
       
+      # This will add us back to the group:
       reset
     end
 
@@ -54,27 +56,34 @@ module Timers
       
       @handle = @group.events.schedule(@offset, self)
     end
-
-    # Cancel this timer
+    
+    # Cancel this timer. Do not call while paused.
     def cancel
+      return unless @handle
+      
       @handle.cancel! if @handle
       @handle = nil
       
       # This timer is no longer valid:
-      @group.timers.delete self
-      @group = nil
+      @group.timers.delete self if @group
     end
 
-    # Reset this timer
+    # Reset this timer. Do not call while paused.
     def reset(offset = @group.current_offset)
-      @handle.cancel! if @handle
+      # This logic allows us to minimise the interaction with @group.timers.
+      # A timer with a handle is always registered with the group.
+      if @handle
+        @handle.cancel!
+      else
+        @group.timers << self
+      end
       
       @offset = Float(offset) + @interval
       
       @handle = @group.events.schedule(@offset, self)
     end
 
-    # Fire the block
+    # Fire the block.
     def fire(offset = @group.current_offset)
       if recurring == :strict
         # ... make the next interval strictly the last offset + the interval:
@@ -86,6 +95,8 @@ module Timers
       end
 
       @block.call(offset)
+      
+      cancel unless recurring
     end
 
     alias_method :call, :fire

data/lib/timers/version.rb

@@ -1,3 +1,3 @@
 module Timers
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/spec/cancel_spec.rb

@@ -0,0 +1,46 @@
+
+require 'spec_helper'
+
+RSpec.describe Timers::Group do
+  it "should be able to cancel twice" do
+    fired = false
+
+    timer = subject.after(0.1) { fired = true }
+    
+    2.times do
+      timer.cancel
+      subject.wait
+    end
+
+    expect(fired).to be false
+  end
+  
+  it "should be possble to reset after cancel" do
+    fired = false
+    
+    timer = subject.after(0.1) { fired = true }
+    timer.cancel
+    
+    subject.wait
+    
+    timer.reset
+    
+    subject.wait
+    
+    expect(fired).to be true
+  end
+  
+  it "should cancel and remove one shot timers after they fire" do
+    x = 0
+
+    Timers::Wait.for(2) do |remaining|
+      timer = subject.every(0.2) { x += 1 }
+      subject.after(0.1) { timer.cancel }
+      
+      subject.wait
+    end
+    
+    expect(subject.timers).to be_empty
+    expect(x).to be == 0
+  end
+end

data/spec/events_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Timers::Events do
       fired = true
     end
     
-    handle = subject.schedule(0.1, callback)
+    subject.schedule(0.1, callback)
     
     expect(subject.size).to be == 1
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timers
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hitimes
@@ -75,6 +75,7 @@ files:
 - lib/timers/timer.rb
 - lib/timers/version.rb
 - lib/timers/wait.rb
+- spec/cancel_spec.rb
 - spec/events_spec.rb
 - spec/every_spec.rb
 - spec/group_spec.rb
@@ -109,6 +110,7 @@ specification_version: 4
 summary: Schedule procs to run after a certain time, or at periodic intervals, using
   any API that accepts a timeout
 test_files:
+- spec/cancel_spec.rb
 - spec/events_spec.rb
 - spec/every_spec.rb
 - spec/group_spec.rb