timeout_queue 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59b969678d331842aae14d22898b8ec774048d64387b9edcadad821870c5e4e8
-  data.tar.gz: 1b0e23ffb8727cddafb4dc52a0bfc448d620ec634cfb40d98f9568056b7c4ef0
+  metadata.gz: 29d93c187aaecf84b0dcfb32c5a05ae16bc6aa4b82636ffa43438ac731fd3ca7
+  data.tar.gz: c24440e09eab0ac50c295123b5faf95a9bf06757c2740ca633bb234a9e994c4d
 SHA512:
-  metadata.gz: f6007cde65568613756d2469236ec5dd78a1b5cdd7a8551300aaac55a68fa892b49f1e14a187d8b330a7d6d199993b4e6f3ec267fe837887bfbef2ca406f416c
-  data.tar.gz: 64b1bb7f09a1942d8309306739b7e12c10b36ec9bcf05bc64489216c149b3d414018bf9af6963200ac52b290e40f7ff27c576df0882dfb89e2f16a73ed1e33ca
+  metadata.gz: 41127cc7cd3cfc8e4b6fecd6d9b10a1e8c7023f95b1251450a29aacdc52902a22a541bd8128d1ede25550d864798cdbea93110c29b3aa4f37eb98f896f899bb0
+  data.tar.gz: 591f454b9cdfd8f9f882339f1c0711cd3f460df334da756af30b65343eb10d7f3b20e3b46965e70fff00f5728c25bfbe931e1581e447e5c9f1f2aea80efd1666

data/lib/timeout_queue.rb

@@ -5,6 +5,8 @@ class TimeoutQueue
     @queue = []
     @mutex = Mutex.new
     @received = ConditionVariable.new
+    @closed = false
+    @waiting = []
       
   end
   
@@ -14,7 +16,7 @@ class TimeoutQueue
   # @return object
   #
   def push(object, **opt)
-    __push do 
+    __push(object) do 
       @queue.send(__method__, object)
     end  
   end
@@ -25,7 +27,7 @@ class TimeoutQueue
   # @return object
   #
   def unshift(object)
-    __push do 
+    __push(object) do 
       @queue.send(__method__, object)
     end
   end
@@ -58,15 +60,15 @@ class TimeoutQueue
   
     timeout = opts[:timeout]
   
-    if timeout
-                
-      end_time = Time.now + timeout.to_f
-    
-    end
-      
     with_mutex do
+
+      @waiting << Thread.current
+    
+      if timeout              
+        end_time = Time.now + timeout.to_f    
+      end
     
-      while @queue.empty? and not(non_block)
+      while @queue.empty? and not(non_block) and not(@closed)
       
         if timeout
         
@@ -82,13 +84,45 @@ class TimeoutQueue
       
       end 
       
-      raise ThreadError unless not @queue.empty?
+      @waiting.delete(Thread.current)
+      
+      if @queue.empty?
+      
+        if @closed
+          raise ClosedQueueError          
+        else
+          raise ThreadError
+        end
+        
+      else
                              
-      @queue.shift
+        @queue.shift
+      
+      end
             
     end
   
   end
+  
+  def num_waiting
+    with_mutex do
+      @waiting.size
+    end
+  end
+  
+  def closed?
+    @closed
+  end
+
+  def close
+    with_mutex do
+      if not @closed
+        @closed = true
+        @waiting.each(&:wakeup)
+      end
+    end
+    self
+  end
 
   def empty?
     @queue.send __method__
@@ -112,7 +146,8 @@ class TimeoutQueue
   end
   
   def __push(object)
-    with_mutex do          
+    with_mutex do   
+      raise ClosedQueueError if closed?      
       yield
       @received.signal                
     end    

data/lib/timeout_queue/version.rb

@@ -1,5 +1,5 @@
 class TimeoutQueue
 
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
 end

data/test/close.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+require 'timeout_queue'
+
+describe "close a queue" do
+
+  let(:q){ TimeoutQueue.new }
+  
+  it "is not closed to start" do
+  
+    refute q.closed?
+  
+  end
+  
+  describe "with waiters" do
+  
+    before do    
+      
+      q.closed?
+      
+      Thread.new do
+      
+        assert_raises ClosedQueueError do        
+          q.pop        
+        end
+      
+      end
+      
+      q.close    
+      
+    end
+  
+    it "is closed" do      
+      assert q.closed?    
+    end
+    
+  end
+  
+end

data/test/pop_closed.rb

@@ -0,0 +1,69 @@
+require 'minitest/autorun'
+require 'timeout_queue'
+
+describe "pop a closed queue" do
+
+  describe "queue is empty" do
+
+    let(:q){ TimeoutQueue.new.close }
+
+    describe "without a timeout" do
+    
+      it "raises ClosedQueueError" do
+    
+        assert_raises ClosedQueueError do
+          q.pop
+        end
+      
+      end
+    
+    end
+    
+    describe "with a timeout" do
+    
+      it "raises ClosedQueueError" do
+    
+        assert_raises ClosedQueueError do
+          q.pop(timeout: 1)
+        end
+      
+      end
+    
+    end
+    
+    describe "with non_blocking" do
+    
+      it "raises ClosedQueueError" do
+    
+        assert_raises ClosedQueueError do
+          q.pop(true)
+        end
+      
+      end
+    
+    end
+    
+  end
+  
+  describe "queue is not empty" do
+  
+    let(:obj) { {} }
+    let(:q){ TimeoutQueue.new }
+    
+    before do
+    
+      q.push obj
+      
+      q.close
+    
+    end
+    
+    it "returns obj" do
+    
+      assert_equal obj, q.pop
+    
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeout_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Cameron Harper
@@ -46,6 +46,8 @@ extra_rdoc_files: []
 files:
 - lib/timeout_queue.rb
 - lib/timeout_queue/version.rb
+- test/close.rb
+- test/pop_closed.rb
 - test/timeout.rb
 homepage: https://github.com/cjhdev/timeout_queue
 licenses:
@@ -72,4 +74,6 @@ signing_key:
 specification_version: 4
 summary: Like Queue but with a pop timeout and a few other things
 test_files:
+- test/close.rb
+- test/pop_closed.rb
 - test/timeout.rb