Adding Function#periodical

dist/classified.js

@@ -458,11 +458,26 @@ classify(Function, function() {
     return this.delay.apply(this, [ 0.01 ].concat(slice.call(arguments)));
   });
 
+  // Schedules the function to run in the specified intervals of time, passing
+  // any arguments given.
+  // 
+  // Behaves much like `window.setInterval`, but the interval is in seconds
+  // rather than milliseconds. Returns an integer ID that can be used to
+  // clear the interval with `window.clearInterval` before it runs.
+  def('periodical', function(interval) {
+    var method = this,
+        args   = slice.call(arguments, 1);
+
+    return this.__intervalID__ = setInterval(function() {
+      return method.apply(null, args);
+    }, interval * 1000);
+  });
+
   // If a #delay, #defer, or #periodical call has been made, calling #stop
   // will stop the function call from being made.
   def('stop', function() {
     clearTimeout(this.__timeoutID__);
-    // clearInterval(this.__intervalID__);
+    clearInterval(this.__intervalID__);
   });
 });
 

spec/classified/functionSpec.js

@@ -96,6 +96,40 @@ describe('Function', function() {
     });
   });
 
+  describe('#periodical', function() {
+    it('runs a function periodically', function() {
+      var count = 0;
+      var method = function() {
+        count++;
+      };
+
+      var id = method.periodical(0.05);
+      expect(count).toBe(0);
+
+      waits(150);
+      runs(function() {
+        clearInterval(id);
+        expect(count).toBe(2);
+      });
+    });
+
+    it('passes arguments to the deferred function', function() {
+      var args;
+      var method = function() {
+        args = Array.prototype.slice.call(arguments);
+      };
+
+      var id = method.periodical(0.05, 1, 2, 3);
+      expect(args).toBeUndefined();
+
+      waits(100);
+      runs(function() {
+        clearInterval(id);
+        expect(args).toEqual([ 1, 2, 3 ]);
+      });
+    });
+  });
+
   describe('#stop', function() {
     it('stops delayed calls', function() {
       var delayed = false;
@@ -126,5 +160,22 @@ describe('Function', function() {
         expect(defered).toBe(false);
       });
     });
+
+    it('stops periodical calls', function() {
+      var count = 0;
+      var method = function() {
+        count++;
+      };
+
+      method.periodical(0.05);
+      waits(125);
+      runs(function() {
+        method.stop();
+      })
+      waits(50);
+      runs(function() {
+        expect(count).toBe(2);
+      });
+    });
   });
 });

src/extensions/function.js

@@ -55,10 +55,25 @@ classify(Function, function() {
     return this.delay.apply(this, [ 0.01 ].concat(slice.call(arguments)));
   });
 
+  // Schedules the function to run in the specified intervals of time, passing
+  // any arguments given.
+  // 
+  // Behaves much like `window.setInterval`, but the interval is in seconds
+  // rather than milliseconds. Returns an integer ID that can be used to
+  // clear the interval with `window.clearInterval` before it runs.
+  def('periodical', function(interval) {
+    var method = this,
+        args   = slice.call(arguments, 1);
+
+    return this.__intervalID__ = setInterval(function() {
+      return method.apply(null, args);
+    }, interval * 1000);
+  });
+
   // If a #delay, #defer, or #periodical call has been made, calling #stop
   // will stop the function call from being made.
   def('stop', function() {
     clearTimeout(this.__timeoutID__);
-    // clearInterval(this.__intervalID__);
+    clearInterval(this.__intervalID__);
   });
 });