Add a variant of every and new(every:) that takes a closure with NSTimer passed in

Author: radex

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### master
 
 - Fix Carthage support for Mac (set deployment target to 10.9)
+- Add a variant of `every` and `new(every:)` that takes a closure with `NSTimer` passed in
 
 ### 1.3.1 (2016-03-02)
 

Sources/SwiftyTimer.swift

@@ -36,6 +36,7 @@ extension NSTimer {
             block()
         }
     }
+    
     /// Create a timer that will call `block` repeatedly in specified time intervals.
     ///
     /// - Note: The timer won't fire until it's scheduled on the run loop.
@@ -47,7 +48,21 @@ extension NSTimer {
             block()
         }
     }
-
+    
+    /// Create a timer that will call `block` repeatedly in specified time intervals.
+    /// (This variant also passes the timer instance to the block)
+    ///
+    /// - Note: The timer won't fire until it's scheduled on the run loop.
+    ///         Use `NSTimer.after` to create and schedule a timer in one step.
+    /// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
+    
+    @nonobjc public class func new(every interval: NSTimeInterval, _ block: NSTimer -> Void) -> NSTimer {
+        var timer: NSTimer!
+        timer = CFRunLoopTimerCreateWithHandler(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent() + interval, interval, 0, 0) { _ in
+            block(timer)
+        }
+        return timer
+    }
 
     /// Create and schedule a timer that will call `block` once after the specified time.
 
@@ -65,6 +80,15 @@ extension NSTimer {
         return timer
     }
 
+    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
+    /// (This variant also passes the timer instance to the block)
+    
+    @nonobjc public class func every(interval: NSTimeInterval, _ block: NSTimer -> Void) -> NSTimer {
+        let timer = NSTimer.new(every: interval, block)
+        timer.start()
+        return timer
+    }
+    
     /// Schedule this timer on the run loop
     ///
     /// By default, the timer is scheduled on the current run loop for the default mode.

SwiftyTimerTests/SwiftyTimerTests/main.swift

@@ -78,7 +78,34 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     }
 
     func test7() {
-        NSTimer.after(0.1.seconds, done)
+        NSTimer.after(0.1.seconds, test8)
+    }
+    
+    func test8() {
+        var fires = 0
+        let timer = NSTimer.new(every: 0.1.seconds) { (timer: NSTimer) in
+            guard fires <= 1 else { fatalError("should be invalidated") }
+            defer { fires += 1 }
+            
+            if fires == 1 {
+                timer.invalidate()
+                self.test9()
+            }
+        }
+        timer.start()
+    }
+    
+    func test9() {
+        var fires = 0
+        NSTimer.every(0.1.seconds) { (timer: NSTimer) in
+            guard fires <= 1 else { fatalError("should be invalidated") }
+            defer { fires += 1 }
+            
+            if fires == 1 {
+                timer.invalidate()
+                self.done()
+            }
+        }
     }
 
     func done() {