redis-semaphore 0.2.4 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjdjZjZhZWZiNmZiYTY1YWJkMWQ0ZDUyYmJjZGY2NGViMzQzZDhmMA==
-  data.tar.gz: !binary |-
-    MjI5YzlmMzBhOWE2ZmUwZTQyNjQ0Y2JjM2ZkMzZhOWEzMTc0YWZkOA==
+SHA1:
+  metadata.gz: 309187f46b275cd806075cad1bbe6957dac9b81d
+  data.tar.gz: 290e95937ffc62ca1026be42ad33d2b9017be559
 SHA512:
-  metadata.gz: !binary |-
-    YzZjOTA0ZWQ2OWUzMzk2YTYyODA1ZWIzYjBiZmU1MTc5Yjg4MTk0MDZjYWYz
-    YjZiZTZlZTBmYzQ0MWFlNjFlNzFiODVjOTc4YjAyOWRiODUwYWY4MjNiNmYy
-    ZDAyZDEwOTZjZjk3ODVmMWIyNmJkNWZiYmEyMzM4ZDNjYmU2MTI=
-  data.tar.gz: !binary |-
-    MTdhN2RjYTRjMDIxMGJhNTM4YWM0YTViYzNjM2FjYmJmMjBmYjgwZGZjMDE0
-    MGNiZmM3YjI3OTJiNmU5OTAyZTZhNWVmOGFlNzQyZjMxNTYwZmIzMDY2NGU3
-    NTA4NTBkMGNiZjRhNmQzZjEyNjM4ZjMwNzFjYTI4YzgxZWFiYzg=
+  metadata.gz: bc1eefa40196e5e95f8c4f74258b8136eb8179262a784bff743c5729a17631de3fbbd7b13b888eaffd43b7b63de8fa3209ea226d3009d66de9a18467742be594
+  data.tar.gz: 8c69c42bfb18035f63fb15d94cbd92593344a2e08dee9883ddde9598e534dcef0227a6d51542496cea6582ac9c1751d7fe830965e5134e62502c5a7c886c0ca7

data/README.md

@@ -10,6 +10,23 @@ The mutex and semaphore is blocking, not polling, and has a fair queue serving p
 
 For more info see [Wikipedia](http://en.wikipedia.org/wiki/Semaphore_(programming)).
 
+Changes for 0.3.0
+=================
+
+If you've been using `redis-semaphore` before version `0.3.0` you should be aware that the interface for `lock` has changed slightly. Before `0.3` calling `semaphore.lock(0)` (with `0` as the timeout) would block the semaphore indefinitely, just like a redis `blpop` command would.
+
+This has changed in `0.3` to mean *do not block at all*. You can still omit the argument entirely, or pass in `nil` to get the old functionality back. Examples:
+
+```ruby
+# These block indefinitely until a resource becomes available:
+semaphore.lock
+semaphore.lock(nil)
+
+# This does not block at all and rather returns immediately if there's no
+# resource available:
+semaphore.lock(0)
+```
+
 Usage
 -----
 
@@ -200,9 +217,15 @@ Testing
 Changelog
 ---------
 
+###0.3.0 January 24, 2016
+- Change API to include non-blocking option for `#lock` (thanks tomclose!).
+- Fix unwanted persisting of `available_key` (thanks dany1468!).
+- Fix `available_count` returning 0 for nonexisting semaphores (thanks mikeryz!).
+
 ###0.2.4 January 11, 2015
 - Fix bug with TIME and redis-namespace (thanks sos4nt!).
 - Add expiration option (thanks jcalvert!).
+- Update API version logic.
 
 ###0.2.3 September 7, 2014
 - Block-based locking return the value of the block (thanks frobcode!).
@@ -266,4 +289,5 @@ Thanks to these awesome people for their contributions:
 - [Petteri Räty](https://github.com/betelgeuse)
 - [Stefan Schüßler](https://github.com/sos4nt)
 - [Jonathan Calvert](https://github.com/jcalvert)
-
+- [mikeryz](https://github.com/mikeryz)
+- [tomclose](https://github.com/tomclose)

data/lib/redis/semaphore.rb

@@ -37,13 +37,16 @@ class Redis
           @redis.set(version_key, API_VERSION)
         end
 
-        set_expiration_if_necessary
         true
       end
     end
 
     def available_count
-      @redis.llen(available_key)
+      if exists?
+        @redis.llen(available_key)
+      else
+        @resource_count
+      end
     end
 
     def delete!
@@ -53,11 +56,17 @@ class Redis
       @redis.del(version_key)
     end
 
-    def lock(timeout = 0)
+    def lock(timeout = nil)
       exists_or_create!
       release_stale_locks! if check_staleness?
 
-      token_pair = @redis.blpop(available_key, timeout)
+      if timeout.nil? || timeout > 0
+        # passing timeout 0 to blpop causes it to block
+        token_pair = @redis.blpop(available_key, timeout || 0)
+      else
+        token_pair = @redis.lpop(available_key)
+      end
+
       return false if token_pair.nil?
 
       current_token = token_pair[1]
@@ -100,6 +109,8 @@ class Redis
       @redis.multi do
         @redis.hdel grabbed_key, token
         @redis.lpush available_key, token
+
+        set_expiration_if_necessary
       end
     end
 

data/spec/semaphore_spec.rb

@@ -22,6 +22,10 @@ describe "redis" do
       expect(semaphore.available_count).to eq(1)
     end
 
+    it "has the correct amount of available resources before locking" do
+      expect(semaphore.available_count).to eq(1)
+    end
+
     it "should not exist from the start" do
       expect(semaphore.exists?).to eq(false)
       semaphore.lock
@@ -89,9 +93,9 @@ describe "redis" do
     it "should not leave the semaphore locked after raising an exception" do
       expect {
         semaphore.lock(1) do
-          raise Exception
+          raise Exception, "redis semaphore exception"
         end
-      }.to raise_error
+      }.to raise_error(Exception, "redis semaphore exception")
 
       expect(semaphore.locked?).to eq(false)
     end
@@ -121,6 +125,18 @@ describe "redis" do
 
       expect(@redis.keys.count).to eq(original_key_size)
     end
+
+    it "should not block when the timeout is zero" do
+      did_we_get_in = false
+
+      semaphore.lock do
+        semaphore.lock(0) do
+          did_we_get_in = true
+        end
+      end
+
+      expect(did_we_get_in).to be false
+    end
   end
 
   describe "semaphore with expiration" do
@@ -135,6 +151,15 @@ describe "redis" do
       sleep 3.0
       expect(@redis.keys.count).to eq(original_key_size)
     end
+
+    it "expires keys after unlocking" do
+      original_key_size = @redis.keys.count
+      semaphore.lock do
+        # noop
+      end
+      sleep 3.0
+      expect(@redis.keys.count).to eq(original_key_size)
+    end
   end
 
   describe "semaphore without staleness checking" do

metadata

@@ -1,98 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: redis-semaphore
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - David Verhasselt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Implements a distributed semaphore or mutex using Redis.
-
-'
+description: |
+  Implements a distributed semaphore or mutex using Redis.
 email: david@crowdway.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
-- LICENSE
-- lib/redis/semaphore.rb
 - lib/redis-semaphore.rb
+- lib/redis/semaphore.rb
 - spec/semaphore_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/dv/redis-semaphore
@@ -105,19 +104,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Implements a distributed semaphore or mutex using Redis.
 test_files: []
-has_rdoc: