redis-semaphore 0.2.0 → 0.2.1

data/README.md

@@ -130,6 +130,8 @@ normal_sem.lock(5) # will block until the watchdog releases the previous lock af
 Advanced
 --------
 
+### Wait and Signal
+
 The methods ```wait``` and ```signal```, the traditional method names of a Semaphore, are also implemented. ```wait``` is aliased to lock, while ```signal``` puts the specified token back on the semaphore, or generates a unique new token and puts that back if none is passed:
 
 ```ruby
@@ -160,6 +162,19 @@ semaphore.signal(new_job) # Job can be any string, it will be passed unmodified
 Used in this fashion, a timeout does not make sense. Using the :stale\_client\_timeout here is not recommended.
 
 
+### Use local time
+
+When calculating the timeouts, redis-semaphore uses the Redis TIME command by default, which fetches the time on the Redis server. This is good if you're running distributed semaphores to keep all clients on the same clock, but does incur an extra round-trip for every action that requires the time.
+
+You can add the option ```:use_local_time => true``` during initialization to use the local time of the client instead of the Redis server time, which saves one extra roundtrip. This is good if e.g. you're only running one client.
+
+```ruby
+s = Redis::Semaphore.new(:local_semaphore, :redis = r, :stale_client_timeout => 5, :use_local_time => true)
+```
+
+Redis servers earlier than version 2.6 don't support the TIME command. In that case we fall back to using the local time automatically.
+
+
 Installation
 ------------
 
@@ -174,8 +189,12 @@ Testing
 Changelog
 ---------
 
+###0.2.1 August 6, 2013
+- Remove dependency on Redis 2.6+ using fallback for TIME command (thanks dubdromic!).
+- Add ```:use_local_time``` option
+
 ###0.2.0 June 2, 2013
-- Use Redis TIME command for lock timeouts (thanks dubdronic!).
+- Use Redis TIME command for lock timeouts (thanks dubdromic!).
 - Version increase because of new dependency on Redis 2.6+
 
 ###0.1.7 April 18, 2013

data/lib/redis/semaphore.rb

@@ -18,6 +18,7 @@ class Redis
       @resource_count = opts.delete(:resources) || 1
       @stale_client_timeout = opts.delete(:stale_client_timeout)
       @redis = opts.delete(:redis) || Redis.new(opts)
+      @use_local_time = opts.delete(:use_local_time)
       @tokens = []
     end
 
@@ -184,8 +185,17 @@ class Redis
     end
 
     def current_time
-      instant = @redis.time
-      Time.at(instant[0], instant[1])
+      if @use_local_time
+        Time.now
+      else
+        begin
+          instant = @redis.time
+          Time.at(instant[0], instant[1])
+        rescue
+          @use_local_time = true
+          current_time
+        end
+      end
     end
   end
 end

data/spec/semaphore_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe "redis" do
   before(:all) do
-    # use database 15 for testing so we dont accidentally step on you real data
+    # use database 15 for testing so we dont accidentally step on your real data
     @redis = Redis.new :db => 15
   end
 
@@ -149,4 +149,26 @@ describe "redis" do
       hyper_aggressive_sem.lock(1).should_not == false
     end
   end
+
+  describe "redis time" do
+    let(:semaphore) { Redis::Semaphore.new(:my_semaphore, :redis => @redis, :stale_client_timeout => 5) }
+
+    before(:all) do
+      Timecop.freeze(Time.local(1990))
+    end
+
+    it "with time support should return a different time than frozen time" do
+      semaphore.send(:current_time).should_not == Time.now
+    end
+
+    it "with use_local_time should return the same time as frozen time" do
+      semaphore = Redis::Semaphore.new(:my_semaphore, :redis => @redis, :stale_client_timeout => 5, :use_local_time => true)
+      semaphore.send(:current_time).should == Time.now
+    end
+
+    it "without time support should return the same time as frozen time" do
+      @redis.stub(:time) { raise Redis::CommandError }
+      semaphore.send(:current_time).should == Time.now
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-semaphore
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis