throttler 0.3.0 → 0.3.1

data/README.md

@@ -3,20 +3,21 @@ Throttler
 
 [![travis] [1]] [2]
 
-Throttler rate-limits code execution across threads or processes on a server.
+Throttler rate-limits code execution across threads, evented blocks, or
+processes on a server.
 
 ![Mapplethorpe][3]
 
 Installation
 ------------
 
+Throttler works only on platforms that support file locking.
+
 ```ruby
-# in your Gemfile
+# Gemfile
 gem 'throttler'
 ```
 
-Throttler works only on platforms that support file locking.
-
 Usage
 -----
 
@@ -26,7 +27,6 @@ once every second per IP address.
 ```ruby
 class Scrape
   def self.perform(site, ip_address, *ids)
-    # The block is syntactic sugar.
     Throttler.limit 1.0, site, ip_address do
       spider = Spider.new site, ip_address
       spider.scrape *ids

data/lib/throttler.rb

@@ -12,12 +12,13 @@ module Throttler
 
     begin
       throttle = Throttle.new namespace
-      throttle.lock
+      throttle.strangle
       throttle.hold wait
     ensure
-      throttle.unlock
+      throttle.release
     end
 
+    # Syntactic sugar.
     yield if block_given?
   end
 end

data/lib/throttler/throttle.rb

@@ -8,15 +8,6 @@ module Throttler
 
     def initialize(namespace)
       @namespace = namespace
-      @file = File.open(path, File::RDWR|File::CREAT)
-    end
-
-    def lock
-      @file.flock(File::LOCK_EX)
-    end
-
-    def path
-      "#{self.class.tmp_dir}/.lock-#{@namespace}"
     end
 
     def hold(wait)
@@ -24,25 +15,37 @@ module Throttler
       timestamp!
     end
 
-    def unlock
-      @file.flock(File::LOCK_UN)
+    def release
+      @file.flock File::LOCK_UN
       @file.close
     end
 
+    def strangle
+      file.flock File::LOCK_EX
+    end
+
     private
 
+    def file
+      @file ||= File.open path, File::RDWR|File::CREAT
+    end
+
     def now
       Time.now.to_f
     end
 
+    def path
+      "#{self.class.tmp_dir}/.lock-#{@namespace}"
+    end
+
     def timestamp
-      @file.rewind
-      @file.gets.to_f
+      file.rewind
+      file.gets.to_f
     end
 
     def timestamp!
-      @file.rewind
-      @file.write now
+      file.rewind
+      file.write now
     end
   end
 end

data/lib/throttler/version.rb

@@ -1,4 +1,4 @@
 module Throttler
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end
 

data/test/throttler_test.rb

@@ -8,13 +8,29 @@ class Work
   end
 end
 
+class WorkAsWell
+  def self.perform
+    Throttler.limit 0.1, 'foo'
+  end
+end
+
 class ThrottlerTest < Test::Unit::TestCase
   def test_throttling
     time = Benchmark.realtime do
       11.times { Process.fork { Work.perform } }
       Process.waitall
     end
+    assert_equal 1, time.to_i
+  end
 
+  def test_namespace
+    time = Benchmark.realtime do
+      11.times do
+        Process.fork { Work.perform }
+        Process.fork { WorkAsWell.perform }
+      end
+      Process.waitall
+    end
     assert_equal 1, time.to_i
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: throttler
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70196529042720 !ruby/object:Gem::Requirement
+  requirement: &70163640755900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70196529042720
+  version_requirements: *70163640755900
 description: Throttler rate-limits code execution across threads or processes.
 email:
 - hakan.ensari@papercavalier.com