hash_queue 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
-## 0.1
+## 0.1.1
+
++ [FEATURE] Added queueing in batches (queueing more items in a single method call)
++ [BUGFIX] Fixed bug when popping from HashQueue::Queue with blocking option didn't take nil or an empty array as a valid value [ISSUE#1]
+
+## 0.1.0
 
 + Initial release

data/README.md

@@ -46,9 +46,19 @@ hash_queue[:my_queue].queue Stuff.new
 hash_queue.queue :my_queue, Stuff.new
 ```
 
-Keys (or namespaces if you prefer) can be anything you want. Usually those will be symbols or strings but don't need to be. Objects, classes, numbers or even `true` or `nil` will work. Same applies for queued items.
+You can also queue multiple items in a single method call:
 
-`#queue` is aliased as `#enqueue` and `#push` for convenience on both hash_queue and individual queues.
+```ruby
+hash_queue[:my_queue].queue_many :foo, :bar, :xyz
+
+# Ruby itself provides some handy magic syntax for expanding arrays into arguments. The result is identical.
+stuff = [:foo, :bar, :xyz]
+hash_queue[:my_queue].queue_many *stuff
+```
+
+Keys (or namespaces if you prefer) can be anything you want. Usually those will be symbols or strings but don't need to be. Objects, classes, numbers or even `true` or `nil` will work. Same applies for queued items (but beware if you don't pop with `:size` option, you logically won't be able to distinguish if `nil` you get back is `nil` you queued there or just null return value of popping from an empty queue)
+
+`#queue` is aliased as `#enqueue`, `#push` and `#<<` for convenience. `#queue_many` is aliased as `#enqueue_many` and `#push_many` accordingly.
 
 ### Working with hash_queue as a whole
 
@@ -65,9 +75,11 @@ hash_queue.queue :favourite_rubies, 'rubinius'
 hash_queue.size  # => 2
 ```
 
+Also aliased as `#count` and `#length`.
+
 ##### empty?
 
-Returns `true` or `false` whether hash_queue is empty or not.
+Returns `true` or `false` whether HashQueue instance is empty or not.
 
 ```ruby
 hash_queue = HashQueue.new

data/lib/hash_queue/hash.rb

@@ -89,8 +89,9 @@ module HashQueue
   
   class QueueProxy
     
-    [ :queue, :enqueue, :push, :<<, :pop, :shift, :size, :count, :length, :empty?, :clear, :lock, :unlock, 
-     :locked?, :unlock_all, :count_locks, :locks_count].each do |m|
+    [ :queue, :enqueue, :push, :<<, :queue_many, :enqueue_many, :push_many, 
+      :pop, :shift, :size, :count, :length, :empty?, :clear, :lock, :unlock, 
+      :locked?, :unlock_all, :count_locks, :locks_count].each do |m|
       define_method m do |*args|
         subject.send m, *args
       end

data/lib/hash_queue/queue.rb

@@ -8,27 +8,33 @@ module HashQueue
       @mutex = Mutex.new 
       @queue = []
       @locks = []
+      @waiting = []
     end
     
-    def queue(obj)
+    def queue(*objs)
       @mutex.synchronize do
-        @queue.push obj
+        @queue.concat objs
+        
+        wake_waiting unless @waiting.empty?
       end
     end
     alias_method :enqueue, :queue
     alias_method :push, :queue
     alias_method :<<, :queue
+    alias_method :queue_many, :queue
+    alias_method :enqueue_many, :queue
+    alias_method :push_many, :queue
     
     def pop(options = {}, results = [])
-      if options[:blocking] 
-        loop do 
-          result = _pop(options, results)
-          
-          return result unless result.nil? or result == [] 
-          sleep 0.01
+      @mutex.synchronize do
+        loop do
+          if options[:blocking] and _empty?
+            @waiting.push Thread.current
+            @mutex.sleep
+          else
+            return _pop(options,results)
+          end
         end
-      else
-        _pop(options,results)
       end
     end
     alias_method :shift, :pop
@@ -56,34 +62,38 @@ module HashQueue
     private
     
     def _pop(options,results)
-      @mutex.synchronize do
-        size = options.fetch(:size, 1)
-        
-        if _locked? and _count_locks >= size
-          if options.key? :size
-            return [] 
-          else
-            return nil
-          end
-        end
-              
-        (size - _count_locks).times do
-          break if _empty?
-          results.push @queue.shift
-          _lock if options[:lock]
-        end
-        
-        if options.key? :size 
-          results
+      size = options.fetch(:size, 1)
+      
+      if _locked? and _count_locks >= size
+        if options.key? :size
+          return [] 
         else
-          results[0]
+          return nil
         end
-      end      
+      end
+            
+      (size - _count_locks).times do
+        break if _empty?
+        results.push @queue.shift
+        _lock if options[:lock]
+      end
+      
+      if options.key? :size 
+        results
+      else
+        results[0]
+      end
     end 
     
     def _empty?
       @queue.empty?
     end
+    
+    def wake_waiting
+      @waiting.shift.wakeup
+    rescue ThreadError
+      retry
+    end
       
   end
 end

data/lib/hash_queue/version.rb

@@ -1,3 +1,3 @@
 module HashQueue  
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/hash_queue/hash_queue_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-#require 'timeout'
 
 describe HashQueue do
   it 'should be able to create new HashQueue instance' do
@@ -159,6 +158,15 @@ describe HashQueue::Hash do
         @hash_queue.pop(blocking: true).wont_be_empty
       end
       
+      it 'should work as expected when an empty array is queued' do
+        Thread.new {
+          sleep 0.5
+          @hash_queue[:foo].queue []
+        }   
+        
+        Timeout::timeout(0.7) { @hash_queue.pop(blocking: true).must_equal [[]] }
+      end
+      
     end
   
   end

data/spec/hash_queue/queue_spec.rb

@@ -12,6 +12,16 @@ describe HashQueue::Queue do
       @queue.size.must_equal 0
     end
     
+    it 'should be able to queue stuff' do
+      @queue.queue :foo
+      @queue.size.must_equal 1
+    end
+    
+    it 'should be to queue stuff in batches' do
+      @queue.queue_many :foo, :bar, :xyz
+      @queue.size.must_equal 3
+    end
+    
   end
   
   describe 'when queued stuff' do
@@ -89,6 +99,26 @@ describe HashQueue::Queue do
       @queue.pop(blocking: true, size: 1).wont_be_empty
     end
     
+    it 'should handle nil in queue' do
+      Thread.new {
+        sleep 0.5
+        @queue.queue_many nil, nil
+      }   
+      
+      Timeout::timeout(0.7) { @queue.pop(blocking: true).must_equal nil }
+      Timeout::timeout(0.7) { @queue.pop(blocking: true, size: 1).must_equal [nil] }
+    end
+    
+    it 'should handle empty array in queue' do
+      Thread.new {
+        sleep 0.5
+        @queue.queue_many [], []
+      }   
+      
+      Timeout::timeout(0.7) { @queue.pop(blocking: true).must_equal [] }
+      Timeout::timeout(0.7) { @queue.pop(blocking: true, size: 1).must_equal [[]] }
+    end
+    
   end
   
   describe 'locking' do

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'timeout'
 
 require 'minitest/autorun'
 require 'turn/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest