timeout_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59b969678d331842aae14d22898b8ec774048d64387b9edcadad821870c5e4e8
+  data.tar.gz: 1b0e23ffb8727cddafb4dc52a0bfc448d620ec634cfb40d98f9568056b7c4ef0
+SHA512:
+  metadata.gz: f6007cde65568613756d2469236ec5dd78a1b5cdd7a8551300aaac55a68fa892b49f1e14a187d8b330a7d6d199993b4e6f3ec267fe837887bfbef2ca406f416c
+  data.tar.gz: 64b1bb7f09a1942d8309306739b7e12c10b36ec9bcf05bc64489216c149b3d414018bf9af6963200ac52b290e40f7ff27c576df0882dfb89e2f16a73ed1e33ca

data/lib/timeout_queue/version.rb

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

data/lib/timeout_queue.rb

@@ -0,0 +1,134 @@
+class TimeoutQueue
+    
+  def initialize(**opt)
+  
+    @queue = []
+    @mutex = Mutex.new
+    @received = ConditionVariable.new
+      
+  end
+  
+  # push object into end of queue
+  #
+  # @param object
+  # @return object
+  #
+  def push(object, **opt)
+    __push do 
+      @queue.send(__method__, object)
+    end  
+  end
+  
+  # push object into front of the queue
+  #
+  # @param object
+  # @return object
+  #
+  def unshift(object)
+    __push do 
+      @queue.send(__method__, object)
+    end
+  end
+  
+  # delete an object from the queue before it can be popped
+  #
+  # @param object
+  # @return object
+  #
+  def delete(object)
+  
+    with_mutex do        
+      @queue.delete(object)                                
+    end
+  
+    object
+  
+  end
+  
+  # retrieve next object from queue
+  #
+  # @param non_block [TrueClass,FalseClass] set true to enable non-blocking mode
+  # @param opts [Hash]
+  #
+  # @option opts [Float,Integer] :timeout seconds to wait (in blocking mode)
+  #
+  # @raise ThreadError if timeout expires or queue is empty in non_block mode
+  # 
+  def pop(non_block=false, **opts)
+  
+    timeout = opts[:timeout]
+  
+    if timeout
+                
+      end_time = Time.now + timeout.to_f
+    
+    end
+      
+    with_mutex do
+    
+      while @queue.empty? and not(non_block)
+      
+        if timeout
+        
+          break unless ((time_now = Time.now) < end_time)            
+          
+          @received.wait(@mutex, end_time - time_now)
+            
+        else
+        
+          @received.wait(@mutex)
+            
+        end
+      
+      end 
+      
+      raise ThreadError unless not @queue.empty?
+                             
+      @queue.shift
+            
+    end
+  
+  end
+
+  def empty?
+    @queue.send __method__
+  end
+
+  def size
+    @queue.send __method__
+  end
+  
+  def clear
+    with_mutex do
+      @queue.clear
+    end
+    self
+  end
+
+  def with_mutex
+    @mutex.synchronize do
+      yield
+    end
+  end
+  
+  def __push(object)
+    with_mutex do          
+      yield
+      @received.signal                
+    end    
+    object
+  end
+
+  alias_method :length, :size
+  
+  alias_method :'<<', :push
+  alias_method :enq, :push
+
+  alias_method :shift, :pop
+  alias_method :deq, :pop
+  
+  private :with_mutex, :__push
+
+end
+
+require 'timeout_queue/version'

data/test/timeout.rb

@@ -0,0 +1,32 @@
+require 'minitest/autorun'
+require 'timeout_queue'
+
+describe "pop an empty queue" do
+
+  let(:q){ TimeoutQueue.new }
+
+  describe "with a timeout" do
+  
+    it "raises ThreadError" do
+  
+      assert_raises ThreadError do
+        q.pop(timeout: 1)
+      end
+    
+    end
+  
+  end
+  
+  describe "with non_blocking" do
+  
+    it "raises ThreadError" do
+  
+      assert_raises ThreadError do
+        q.pop(true)
+      end
+    
+    end
+  
+  end
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: timeout_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Harper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-07 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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: 
+email: contact@cjh.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/timeout_queue.rb
+- lib/timeout_queue/version.rb
+- test/timeout.rb
+homepage: https://github.com/cjhdev/timeout_queue
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Like Queue but with a pop timeout and a few other things
+test_files:
+- test/timeout.rb