redis-queue 0.0.2 → 0.0.3

data/README.md

@@ -43,6 +43,17 @@ end
   YourTask.new(message).perform.succeed?
 end
 
+# Process messages with timeout (starting from version 0.0.3)
+# Wait for 15 seconds for new messages, then exit
+queue.process(false, 15) do |message|
+  puts "'#{message}'" 
+end
+
+# Process messages in a non blocking-way
+# A soon as the queue is empty, the block will exit
+queue.process(true) do |message|
+  puts "'#{message}'" 
+end
 ```
 Contributing to redis-queue
 ----------------

data/example/blocking.rb

@@ -0,0 +1,25 @@
+require "redis-queue"
+require "thread"
+
+redis = Redis.new
+#Create a queue that will listen for a new element for 10 seconds
+queue = Redis::Queue.new('__test', 'bp__test', :redis => redis, :timeout => 10)
+queue.clear true 
+
+100.times { queue << rand(100) }
+
+# Simulate a delayed insert
+t = Thread.new do
+  sleep 3
+   # We should use a second connection here since the first one is busy 
+   # on a blocking call
+  _redis = Redis.new
+  _queue = Redis::Queue.new('__test', 'bp__test', :redis => _redis)
+  100.times { _queue << "e_#{rand(100)}" }
+end
+
+#When all elements are dequeud, process method will wait for 10 secods before exit
+queue.process do |message|
+  puts "'#{message}'" 
+end
+t.join

data/example/non-blocking.rb

@@ -0,0 +1,10 @@
+require "redis-queue"
+
+redis = Redis.new
+
+queue = Redis::Queue.new('__test', 'bp__test', :redis => redis)
+queue.clear true
+
+100.times { queue << rand(100) }
+
+queue.process(true) {|m| puts m}

data/lib/redis/queue.rb

@@ -1,7 +1,7 @@
 class Redis
   class Queue
 
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
 
     def self.version
       "redis-queue version #{VERSION}"
@@ -16,6 +16,7 @@ class Redis
       @queue_name = queue_name
       @process_queue_name = process_queue_name
       @last_message = nil
+      @timeout = options[:timeout] ||= 0
     end
 
     def length
@@ -39,7 +40,7 @@ class Redis
       if non_block
         @last_message = @redis.rpoplpush(@queue_name,@process_queue_name)
       else
-        @last_message = @redis.brpoplpush(@queue_name,@process_queue_name)
+        @last_message = @redis.brpoplpush(@queue_name,@process_queue_name, @timeout)
       end
       @last_message
     end
@@ -48,11 +49,15 @@ class Redis
       @redis.lrem(@process_queue_name, 0, @last_message)
     end
 
-    def process(non_block=false)
-      while message=pop(non_block)
+    def process(non_block=false, timeout = nil)
+      @timeout = timeout unless timeout.nil?
+      loop do
+        message = pop(non_block)
         ret = yield message if block_given?
         commit if ret
+        break if message.nil? || (non_block && empty?)
       end
+
     end
 
     def refill

data/spec/redis_queue_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require "timeout"
 
 describe Redis::Queue do
   before(:all) do
@@ -83,4 +84,38 @@ describe Redis::Queue do
     @redis.llen('bp__test').should be == 0
   end
 
+  it 'should work with the timeout parameters' do
+    @queue.clear(true)
+    100.times { @queue << rand(100) }
+    is_ok = true
+    begin
+      Timeout::timeout(3) {
+        @queue.process(false, 2) {|m| true}
+      }
+    rescue Timeout::Error => e
+      is_ok = false
+    end
+    
+    is_ok.should be_true
+
+  end
+
+  it 'should honor the timeout param in the initializer' do
+    redis = Redis.new
+    queue = Redis::Queue.new('__test_tm', 'bp__test_tm', :redis => redis, :timeout => 2)
+    queue.clear true
+
+    is_ok = true
+    begin
+      Timeout::timeout(4) {
+        queue.pop
+      }
+    rescue Timeout::Error => e
+      puts "#{e}"
+      is_ok = false
+    end
+    queue.clear
+    is_ok.should be_true
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-queue
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -74,6 +74,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/blocking.rb
+- example/non-blocking.rb
 - lib/redis-queue.rb
 - lib/redis/queue.rb
 - redis-queue.gemspec