em-priority-queue 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    em-priority-queue (0.0.2)
+    em-priority-queue (1.1.0)
       algorithms (~> 0.3.0)
       eventmachine (>= 1.0.0.beta.3)
 
@@ -9,8 +9,11 @@ GEM
   remote: http://rubygems.org/
   specs:
     algorithms (0.3.0)
+    chronic (0.6.6)
+    delorean (1.1.1)
+      chronic
     diff-lcs (1.1.2)
-    eventmachine (1.0.0.beta.3)
+    eventmachine (1.0.0.beta.4)
     rake (0.9.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -25,8 +28,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  algorithms (~> 0.3.0)
+  delorean (>= 1.1.1)
   em-priority-queue!
-  eventmachine (>= 1.0.0.beta.3)
   rake
   rspec

data/README.md

@@ -59,6 +59,64 @@ EventMachine Priority Queue
       responses[3] # Bob
 
 
+  **FIFO (first in, first out)**
+
+  When values have the same priority, you may want to use FIFO to prioritize even more. This way, em-priority-queue will pop the items in the order that they were pushed.
+
+    @q = EM::PriorityQueue.new(:fifo => true)
+
+    responses = []
+      EM.run do
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 20)
+        @q.push("Tim", 18)
+        @q.push("Carol", 20)
+
+        5.times do
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 5
+          end
+        end
+      end
+
+      responses[0] # Alex
+      responses[1] # Mike
+      responses[2] # Bob
+      responses[3] # Carol
+      responses[4] # Tim
+
+  **FIFO with custom priority**
+
+    @q = EM::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+
+    responses = []
+      EM.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 20)
+        @q.push("Tim", 18)
+        @q.push("Carol", 20)
+
+        5.times do
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 5
+          end
+        end
+      end
+
+      responses[0] # Tim
+      responses[1] # Mike
+      responses[2] # Bob
+      responses[3] # Carol
+      responses[4] # Alex
+
+
+
 
 
   To see all examples/cases, see the spec file.

data/em-priority-queue.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency "delorean", ">= 1.1.1"
 end

data/lib/em-priority-queue/priority_queue.rb

@@ -2,9 +2,20 @@ module EventMachine
   class PriorityQueue
     include Enumerable
 
-    def initialize(&blk)
+    def initialize(opts={}, &blk)
       blk ||= lambda { |x, y| (x <=> y) == 1 }
-      @heap = Containers::Heap.new(&blk)
+      fifo_blk = nil
+      @fifo = !!opts[:fifo]
+      if @fifo
+        fifo_blk = lambda do |x,y|
+          if x[0] == y[0]
+            x[1] < y[1]
+          else
+            blk.call(x[0], y[0])
+          end
+        end
+      end
+      @heap = Containers::Heap.new(&(fifo_blk || blk))
       @callbacks = []
     end
 
@@ -13,6 +24,7 @@ module EventMachine
     end
 
     def push(obj, pri)
+      pri = [pri, Time.now.to_i] if @fifo
       EM.schedule do
         @heap.push(pri, obj)
         @callbacks.shift.call(@heap.pop) until @heap.empty? || @callbacks.empty?

data/lib/em-priority-queue/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class PriorityQueue
-      VERSION = "1.0.0"
+      VERSION = "1.1.0"
   end
 end

data/spec/em-priority-queue_spec.rb

@@ -77,10 +77,10 @@ describe EventMachine::PriorityQueue do
         @q.push("Tim", 18)
 
         4.times do
-        @q.pop do |e|
-          responses << e
-          EM.stop if responses.size == 4
-        end
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 4
+          end
         end
       end
 
@@ -90,8 +90,89 @@ describe EventMachine::PriorityQueue do
       responses[3].should == "Tim"
 
     end
-      it "should give elements in the order of their priority - custom ordering schema" do
-        @q = EM::PriorityQueue.new {|x,y| x < y}
+
+    it "should create a fifo priority queue if specified" do
+      fifo_queue = EM::PriorityQueue.new(:fifo => true)
+      responses = []
+      EM.run do
+        fifo_queue.push("Checking1", 20)
+        Delorean.jump 30
+        fifo_queue.push("Other1", 16)
+        Delorean.jump 30
+        fifo_queue.push("Other2", 18)
+        Delorean.jump 30
+        fifo_queue.push("Checking2", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking3", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking4", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking5", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking6", 20)
+        Delorean.jump 30
+        fifo_queue.push("Other3", 33)
+        Delorean.jump 30
+        fifo_queue.push("Checking7", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking8", 20)
+        Delorean.jump 30
+
+        11.times do
+          fifo_queue.pop do |e|
+            responses << e
+            EM.stop if responses.size == 4
+          end
+        end
+
+      end
+
+      responses.first(5).should == ["Other3", "Checking1", "Checking2", "Checking3", "Checking4"]
+
+    end
+    it "should create a fifo priority queue if specified - custom ordering schema" do
+      fifo_queue = EM::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+      responses = []
+      EM.run do
+        fifo_queue.push("Checking1", 20)
+        Delorean.jump 30
+        fifo_queue.push("Other1", 16)
+        Delorean.jump 30
+        fifo_queue.push("Other2", 18)
+        Delorean.jump 30
+        fifo_queue.push("Checking2", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking3", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking4", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking5", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking6", 20)
+        Delorean.jump 30
+        fifo_queue.push("Other3", 33)
+        Delorean.jump 30
+        fifo_queue.push("Checking7", 20)
+        Delorean.jump 30
+        fifo_queue.push("Checking8", 20)
+        Delorean.jump 30
+
+        11.times do
+          fifo_queue.pop do |e|
+            responses << e
+            EM.stop if responses.size == 4
+          end
+        end
+
+      end
+
+      responses.first(5).should == ["Other1", "Other2", "Checking1", "Checking2", "Checking3"]
+
+    end
+
+
+    it "should give elements in the order of their priority - custom ordering schema" do
+      @q = EM::PriorityQueue.new {|x,y| x < y}
       responses = []
       EM.run do
 
@@ -102,10 +183,10 @@ describe EventMachine::PriorityQueue do
         @q.push("Tim", 18)
 
         4.times do
-        @q.pop do |e|
-          responses << e
-          EM.stop if responses.size == 4
-        end
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 4
+          end
         end
       end
 
@@ -113,8 +194,65 @@ describe EventMachine::PriorityQueue do
       responses[1].should == "Mike"
       responses[2].should == "Alex"
       responses[3].should == "Bob"
+    end
+  end
 
+  context "README demos" do
+    it "should run the first fifo example" do
+          @q = EM::PriorityQueue.new(:fifo => true)
+
+    responses = []
+      EM.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 20)
+        @q.push("Tim", 18)
+        @q.push("Carol", 20)
+
+        5.times do
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 5
+          end
+        end
+      end
+
+      responses[0].should == "Alex"
+      responses[1].should == "Mike"
+      responses[2].should == "Bob"
+      responses[3].should == "Carol"
+      responses[4].should ==  "Tim"
     end
 
+    it "should run the second fifo example" do
+      @q = EM::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+
+      responses = []
+      EM.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 20)
+        @q.push("Tim", 18)
+        @q.push("Carol", 20)
+
+        5.times do
+          @q.pop do |e|
+            responses << e
+            EM.stop if responses.size == 5
+          end
+        end
+      end
+
+      responses[0].should == "Tim" # Tim
+      responses[1].should == "Mike" # Mike
+      responses[2].should == "Bob" # Bob
+      responses[3].should == "Carol" # Carol
+      responses[4].should == "Alex" # Alex
+
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,9 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'em-priority-queue'
+require 'delorean'
+
+RSpec.configure do |config|
+  config.include Delorean
+  config.after(:each) { back_to_the_present }
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-priority-queue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2011-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2153108280 !ruby/object:Gem::Requirement
+  requirement: &2152680760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.beta.3
   type: :runtime
   prerelease: false
-  version_requirements: *2153108280
+  version_requirements: *2152680760
 - !ruby/object:Gem::Dependency
   name: algorithms
-  requirement: &2153107780 !ruby/object:Gem::Requirement
+  requirement: &2152680260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153107780
+  version_requirements: *2152680260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152578500 !ruby/object:Gem::Requirement
+  requirement: &2152679880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152578500
+  version_requirements: *2152679880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152574420 !ruby/object:Gem::Requirement
+  requirement: &2152679420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152574420
+  version_requirements: *2152679420
+- !ruby/object:Gem::Dependency
+  name: delorean
+  requirement: &2152678920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: *2152678920
 description: Asynchronous Priority Queue with EventMachine
 email:
 - ft.mikelewis@gmail.com