hash_queue 0.1.1 → 0.1.2

data/README.md

@@ -22,7 +22,7 @@ For those living on the edge:
     
 ..with Bundler 1.1 or newer:
 
-    gem 'mimi', github: 'mikekreeki/hash_queue'
+    gem 'hash_queue', github: 'mikekreeki/hash_queue'
 
 ## Usage
 
@@ -187,7 +187,30 @@ hash_queue[:foo].pop # => #<Object:0x000001008d4658>
 hash_queue[:foo].pop(size: 2) # => [#<Object:0x000001008ae228>, #<Object:0x000001008ae200>]
 ```
 
-You can use same options as mentioned above.
+You can use same options as mentioned above plus you can pass in a block into play. Block passed to `HashQueue::Queue#pop` yields items that otherwise would be directly returned, e.g. popped from the queue, and method actually pops values only if return value of a block evaluates to true.
+
+```ruby
+food = HashQueue::Queue.new
+food.push :carrot
+
+food.pop do |snack|
+  current_user.favors? snack
+end
+```
+
+##### peek
+
+Use `#peek` to look what is in the head of the queue but without removing it from there.
+
+```ruby
+queue = HashQueue::Queue.new
+queue.push :foo
+
+queue.peek # => :foo
+queue.size # => 1
+```
+
+You can peek on more items in the head of the queue specifying `:size` option. Be aware, using `#peek` your code might be subject to race condition. If you want to pop only when some condition is met, use `#pop` with a block mentioned above.
 
 ### Locking capabilities
 

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs << 'spec'
   t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = true
+  t.verbose = false
 end
 
 desc "Run tests"

data/hash_queue.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/mikekreeki/hash_queue"
 
   gem.add_development_dependency('minitest')
-  gem.add_development_dependency('turn')
-  gem.add_development_dependency('term-ansicolor')
+  gem.add_development_dependency('minitest-reporters')
   
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/lib/hash_queue/hash.rb

@@ -90,7 +90,7 @@ module HashQueue
   class QueueProxy
     
     [ :queue, :enqueue, :push, :<<, :queue_many, :enqueue_many, :push_many, 
-      :pop, :shift, :size, :count, :length, :empty?, :clear, :lock, :unlock, 
+      :pop, :peek, :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

data/lib/hash_queue/queue.rb

@@ -1,4 +1,5 @@
 require 'hash_queue/queue/lockable'
+require 'ostruct'
 
 module HashQueue
   class Queue
@@ -15,7 +16,7 @@ module HashQueue
       @mutex.synchronize do
         @queue.concat objs
         
-        wake_waiting unless @waiting.empty?
+        wake_waiting
       end
     end
     alias_method :enqueue, :queue
@@ -28,17 +29,33 @@ module HashQueue
     def pop(options = {}, results = [])
       @mutex.synchronize do
         loop do
-          if options[:blocking] and _empty?
-            @waiting.push Thread.current
+          if options[:blocking] and not can_pop?(options[:size] || 1)
+            @waiting.push OpenStruct.new(thread: Thread.current, pop_size: options[:size] || 1) 
             @mutex.sleep
           else
-            return _pop(options,results)
+            if block_given?
+              should_pop = yield _peek(options)
+              
+              if should_pop
+                return _pop(options,results)
+              else
+                return 
+              end
+            else
+              return _pop(options,results)
+            end
           end
         end
       end
     end
     alias_method :shift, :pop
     
+    def peek(options = {})
+      @mutex.synchronize do
+        _peek(options)
+      end
+    end
+    
     def size
       @mutex.synchronize do
         @queue.size
@@ -64,7 +81,7 @@ module HashQueue
     def _pop(options,results)
       size = options.fetch(:size, 1)
       
-      if _locked? and _count_locks >= size
+      unless can_pop?(size)
         if options.key? :size
           return [] 
         else
@@ -85,14 +102,34 @@ module HashQueue
       end
     end 
     
+    def _peek(options)
+      if options.has_key? :size
+        @queue[0..options[:size]]
+      else
+        @queue[0]
+      end
+    end
+    
     def _empty?
       @queue.empty?
     end
     
     def wake_waiting
-      @waiting.shift.wakeup
-    rescue ThreadError
-      retry
+      unless @waiting.empty?
+        while @waiting[0] and can_pop? @waiting[0].pop_size
+          begin
+            @waiting.shift.thread.wakeup
+          rescue ThreadError
+            retry
+          end
+        end
+      end
+    end
+    
+    def can_pop?(size)   
+      size = @queue.size if size > @queue.size
+
+      (not _empty?) and (size > _count_locks)
     end
       
   end

data/lib/hash_queue/queue/lockable.rb

@@ -10,6 +10,8 @@ module HashQueue
     def unlock(n = 1)
       @mutex.synchronize do
         @locks.shift(n)
+        
+        wake_waiting
       end
     end
     
@@ -22,6 +24,8 @@ module HashQueue
     def unlock_all
       @mutex.synchronize do
         @locks.clear
+        
+        wake_waiting
       end
     end
     

data/lib/hash_queue/version.rb

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

data/spec/hash_queue/queue_spec.rb

@@ -62,6 +62,35 @@ describe HashQueue::Queue do
      @queue.clear
      @queue.pop(size: 1).must_equal []
     end
+    
+    it 'should yeild items in the block passed to #pop' do
+      @queue.pop { |item| item.must_equal 1 }
+      @queue.pop(size: 1) { |items| items.must_equal [2] }
+    end
+    
+    it 'should pop when block passed to #pop evaluates to truthy value' do
+      item = @queue.pop do
+        true
+      end
+      
+      item.must_equal 1
+    end
+    
+    it 'shouldnt pop when block passed to #pop evaluates to falsy value' do
+      item = @queue.pop {}
+      
+      item.must_be_nil
+    end
+    
+    it 'should be able to peek in the queue' do
+      @queue.peek.must_equal 1
+      @queue.size.must_equal 2
+    end
+    
+    it 'should be able to peek on batch of items' do
+      @queue.peek(size: 2).must_equal [1,2]
+      @queue.size.must_equal 2
+    end
   end
   
   describe 'when we queue weird stuff' do
@@ -99,6 +128,43 @@ describe HashQueue::Queue do
       @queue.pop(blocking: true, size: 1).wont_be_empty
     end
     
+    it 'should return appropriate number of items when locked and size is specified' do
+      @queue.lock 1
+      
+      Thread.new {
+        sleep 0.5       
+        @queue.queue :foo
+        @queue.queue :bar
+      }
+      
+      Timeout::timeout(0.7) { @queue.pop(blocking: true, size: 2).must_equal [:foo] }
+    end 
+    
+    it 'should wait until queue is unlocked' do
+      @queue.push :foo, :bar, :xyz
+      @queue.lock 3
+      
+      Thread.new {
+        sleep 0.5
+        @queue.unlock
+        sleep 0.5
+        @queue.unlock_all
+      }
+
+      Timeout::timeout(0.7) { @queue.pop(blocking: true, size: 3).must_equal [:foo] }
+      Timeout::timeout(0.7) { @queue.pop(blocking: true, size: 3).must_equal [:bar, :xyz] }
+    end
+    
+    it 'should wake multiple threads if necessary' do
+      threads = []
+      threads << Thread.new { sleep 0.1; @queue.pop(blocking: true).must_equal :foo }
+      threads << Thread.new { sleep 0.2; @queue.pop(blocking: true).must_equal :bar }
+      
+      sleep 0.1
+      @queue.push :foo, :bar
+      Timeout::timeout(0.7) { threads.map(&:join) }
+    end
+    
     it 'should handle nil in queue' do
       Thread.new {
         sleep 0.5

data/spec/spec_helper.rb

@@ -2,7 +2,9 @@ require 'bundler/setup'
 require 'timeout'
 
 require 'minitest/autorun'
-require 'turn/autorun'
+require "minitest/reporters"
 
 require 'hash_queue'
 
+
+MiniTest::Reporters.use! MiniTest::Reporters::ProgressReporter.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -28,23 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: turn
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: term-ansicolor
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: