throttler 0.1.4 → 0.2.0

data/README.md

@@ -10,7 +10,7 @@ Throttle concurrency.
 
       def request
         throttle("foo#{interface}", 1.0) do
-          #noop
+          # do something
         end
       end
 
@@ -27,7 +27,7 @@ Throttle concurrency.
     end
     
     sleep 1.2
-    count.should eql 2 # 98 threads pending
+    count.should eql(2)
 
 Use case
 --------

data/lib/throttler/{throttle.rb → timer.rb}

@@ -1,26 +1,22 @@
 module Throttler
-
-  # The Throttle file
-  class Throttle
+  class Timer
     def initialize(name)
       path = "/tmp/.#{name}"
       @file = File.open(path, File::RDWR|File::CREAT)
     end
 
-    def delay(interval)
-      last = @file.gets.to_f
-      last = (Time.now.to_f - interval) if last == 0.0
-
-      sleep [last + interval - Time.now.to_f, 0.0].max
-    end
-
     def lock
       @file.flock(File::LOCK_EX)
     end
 
     def timestamp
+      @timestamp ||= @file.gets.to_f
+    end
+
+    def timestamp=(time)
       @file.rewind
-      @file.write(Time.now.to_f)
+      @file.write(time)
+      @timestamp = time
     end
 
     def unlock

data/lib/throttler.rb

@@ -1,26 +1,26 @@
-require File.dirname(__FILE__) + "/throttler/throttle"
+require File.dirname(__FILE__) + "/throttler/timer"
 
 # The Throttler module.
 #
-# Simply include this in the class where you wish to use the throttler.
+# Include this in the class where you wish to use the throttler.
 module Throttler
 
-  # Throttles execution of a block of code.
+  # Throttles the frequency in which a block is run.
   #
   # Pass name of throttler and optionally, the interval between each
-  # moment of execution. Latte defaults to one second.
+  # moment of execution. Latter defaults to one second.
   #
   #    throttle("foo") { some_code }
   #
   def throttle(name, interval=1.0)
+    timer = Timer.new(name)
+    timer.lock
     begin
-      file = Throttle.new(name)
-      file.lock
-      file.delay interval
+      sleep [timer.timestamp + interval - Time.now.to_f, 0.0].max
       yield if block_given?
-      file.timestamp
+      timer.timestamp = Time.now.to_f
     ensure
-      file.unlock
+      timer.unlock
     end
   end
 end

data/spec/integration/{scenarios_spec.rb → throttler_spec.rb}

@@ -20,7 +20,7 @@ class Bar
   def noop; end
 end
 
-describe "Simple integration tests" do
+describe "Throttler" do
   before do
     FileUtils.rm "/tmp/.bar", :force => true
     FileUtils.rm "/tmp/.baz", :force => true

data/spec/unit/throttler/timer_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+require "benchmark"
+require "fileutils"
+
+module Throttler
+  describe Timer do
+    before do
+      FileUtils.rm "/tmp/.foo", :force => true
+      @timer = Timer.new("foo")
+    end
+
+    it "creates a file" do
+      File.exists?("/tmp/.foo").should be_true
+    end
+
+    context "#lock" do
+      it "locks the file" do
+        @timer.lock
+        File.open("/tmp/.foo") { |f| f.flock(File::LOCK_EX | File::LOCK_NB).should be_false }
+      end
+    end
+
+    context "#timestamp" do
+      it "gets the timestamp" do
+        now = Time.now.to_f
+        File.open("/tmp/.foo", "w") { |f| f.write(now) }
+        @timer.timestamp.should be_close(now, 0.1)
+      end
+
+      it "returns 0.0 when file is first created" do
+        @timer.timestamp.should eql(0.0)
+      end
+    end
+  
+    context "#timestamp=" do
+      it "sets the timestamp" do
+        now = Time.now.to_f
+        @timer.timestamp= now
+
+        # We need to close the file first
+        @timer.instance_variable_get(:@file).close
+
+        File.open("/tmp/.foo") { |f| f.gets.to_f.should be_close(now, 0.1) }
+      end
+    end
+
+    context "#unlock" do
+      it "unlocks the file" do
+        @timer.lock
+        @timer.unlock
+
+        File.open("/tmp/.foo") { |f| f.flock(File::LOCK_EX | File::LOCK_NB).should_not be_false }
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-24 00:00:00 +01:00
+date: 2010-07-26 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: Throttles the frequency at which concurrently-running Ruby blocks are executed.
+description: Throttles the frequency in which asynchronously-executed Ruby blocks are run on a single server or network interface.
 email: code@papercavalier.com
 executables: []
 
@@ -31,12 +31,12 @@ extra_rdoc_files:
 files: 
 - LICENSE
 - lib/throttler.rb
-- lib/throttler/throttle.rb
+- lib/throttler/timer.rb
 - README.md
 - spec/fixtures/foo.rb
-- spec/integration/scenarios_spec.rb
+- spec/integration/throttler_spec.rb
 - spec/spec_helper.rb
-- spec/unit/throttler/throttle_spec.rb
+- spec/unit/throttler/timer_spec.rb
 - spec/unit/throttler_spec.rb
 has_rdoc: true
 homepage: http://github.com/papercavalier/throttler
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2072448878210444692
+      hash: 4404238439013896602
       segments: 
       - 0
       version: "0"
@@ -70,10 +70,10 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Throttles the frequency at which concurrently-running Ruby blocks are executed.
+summary: Throttles the frequency in which asynchronously-executed Ruby blocks are run on a single server or network interface.
 test_files: 
 - spec/fixtures/foo.rb
-- spec/integration/scenarios_spec.rb
+- spec/integration/throttler_spec.rb
 - spec/spec_helper.rb
-- spec/unit/throttler/throttle_spec.rb
+- spec/unit/throttler/timer_spec.rb
 - spec/unit/throttler_spec.rb

data/spec/unit/throttler/throttle_spec.rb

@@ -1,66 +0,0 @@
-require "spec_helper"
-require "benchmark"
-require "fileutils"
-
-module Throttler
-  describe Throttle do
-    before do
-      FileUtils.rm "/tmp/.foo", :force => true
-      @foo = Throttle.new("foo")
-    end
-
-    it "creates a file" do
-      File.exists?("/tmp/.foo").should be_true
-    end
-
-    context "#lock" do
-      it "locks the file" do
-        @foo.lock
-        File.open("/tmp/.foo") { |f| f.flock(File::LOCK_EX | File::LOCK_NB).should be_false }
-      end
-    end
-
-    context "#delay" do
-      it "throttles if file contains a timestamp" do
-        file = @foo.instance_variable_get(:@file)
-        file.stub!(:gets).and_return(Time.now.to_f)
-
-        time = Benchmark.realtime do
-          @foo.delay(1.0)
-        end
-
-        time.should be_close 1, 0.1
-      end
-
-      it "does not throttle if file is blank" do
-        file = @foo.instance_variable_get(:@file)
-        file.stub!(:gets).and_return("")
-
-        time = Benchmark.realtime do
-          @foo.delay(1.0)
-        end
-
-        time.should be_close 0, 0.1
-      end
-    end
-
-    context "#timestamp" do
-      it "timestamps file" do
-        @foo.timestamp
-        file = @foo.instance_variable_get(:@file)
-        file.close # We need to close the file first
-
-        File.open("/tmp/.foo") { |f| f.gets.to_f.should be_close Time.now.to_f, 0.1 }
-      end
-    end
-
-    context "#unlock" do
-      it "unlocks the file" do
-        @foo.lock
-        @foo.unlock
-
-        File.open("/tmp/.foo") { |f| f.flock(File::LOCK_EX | File::LOCK_NB).should_not be_false }
-      end
-    end
-  end
-end