uv-priority-queue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce2839b2762f789c1ae3f558340d78f26385f31d
+  data.tar.gz: 75ebd539b5be58167c80b6b9cc8d1be0bef1f4d7
+SHA512:
+  metadata.gz: c5f1cfffa15a6ab557fd6809bd3c5bf995a7c0a2f42df8b0fd26682bc664cbb8db2565e7a4b19076186c43a77138387107bb52a3cd24e645d169011f7e771eab
+  data.tar.gz: 3dc35beeaadab01635c0284250dd8f52fc862c2654bb51967afa3ac0c2c99197dd90b004bbc083fd55f3f4121b364f60b206edc74d8019698d2250f7bdc50169

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 CoTag Media
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+Libuv Priority Queue
+=============
+
+[![Build Status](https://secure.travis-ci.org/cotag/uv-priority-queue.png)](http://travis-ci.org/cotag/uv-priority-queue)
+
+
+##Install
+    [sudo] gem install uv-priority-queue
+
+##Usage
+
+  **Basic**
+
+    @q = UV::PriorityQueue.new
+
+    responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 22)
+        @q.push("Tim", 18)
+
+        4.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if responses.size == 4
+          end
+        end
+      end
+
+      responses[0] # Bob
+      responses[1] # Alex
+      responses[2] # Mike
+      responses[3] # Tim
+
+  **Custom Priority**
+
+    @q = UV::PriorityQueue.new {|x,y| x < y}
+
+    responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 22)
+        @q.push("Tim", 18)
+
+        4.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if responses.size == 4
+          end
+        end
+      end
+
+      responses[0] # Tim
+      responses[1] # Mike
+      responses[2] # Alex
+      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 = UV::PriorityQueue.new(:fifo => true)
+
+    responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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 = UV::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+
+    responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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.
+
+
+##License
+
+Copyright (c) 2011 Mike Lewis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+include Rake::DSL
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/uv-priority-queue.rb

@@ -0,0 +1,4 @@
+require 'libuv'
+require 'algorithms'
+
+require 'uv-priority-queue/priority_queue'

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

@@ -0,0 +1,68 @@
+module UV
+    class PriorityQueue
+        include Enumerable
+
+        def initialize(opts = {}, loop = ::Libuv::Loop.current, &blk)
+            blk ||= lambda { |x, y| (x <=> y) == 1 }
+            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 = []
+            @loop = loop || ::Libuv::Loop.default
+        end
+
+        def size
+            @heap.size
+        end
+
+        def push(obj, pri)
+            pri = [pri, Time.now.to_i] if @fifo
+            @loop.schedule do
+                @heap.push(pri, obj)
+                @callbacks.shift.call(@heap.pop) until @heap.empty? || @callbacks.empty?
+            end
+        end
+
+        def clear
+            @heap.clear
+        end
+
+        def empty?
+            @heap.empty?
+        end
+
+        def has_priority?(priority)
+            @heap.has_key?(priority)
+        end
+
+        def next
+            @heap.next
+        end
+
+        def pop(callback = nil, &blk)
+            callback ||= blk
+            @loop.schedule do
+                if @heap.empty?
+                    @callbacks << callback
+                else
+                    callback.call @heap.pop
+                end
+            end
+            nil
+        end
+
+        def delete(pri)
+            @heap.delete(pri)
+        end
+
+    end
+end

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

@@ -0,0 +1,5 @@
+module UV
+    class PriorityQueue
+        VERSION = "1.0.0"
+    end
+end

data/spec/spec_helper.rb

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

data/spec/uv-priority-queue_spec.rb

@@ -0,0 +1,267 @@
+require 'spec_helper'
+
+describe UV::PriorityQueue do
+
+  before do
+    @q = UV::PriorityQueue.new
+  end
+
+  context "Reg. Queue" do
+    it "should return 0 for size and be empty" do
+      @q.size.should == 0
+      @q.empty?.should == true
+    end
+
+    it "should should push things onto the queue" do
+      loop = Libuv::Loop.default
+      loop.run do
+        5.times do |i|
+          @q.push(i, 1)
+        end
+        loop.stop
+      end
+
+      @q.size.should == 5
+    end
+
+    it "should pop elements after adding them" do
+      responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+        5.times do |i|
+          @q.push(i, 1)
+        end
+
+        5.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if @q.empty?
+          end
+        end
+      end
+
+      responses.length.should == 5
+      [0,1,2,3,4].each do |n|
+        responses.should include(n)
+      end
+    end
+
+    it "should pop elements if there are callbacks waiting for pushes" do
+      responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+        3.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if responses.size == 3
+          end
+        end
+
+        5.times do |n|
+          @q.push(n, 1)
+        end
+      end
+      responses.length.should == 3
+      [0,1,2].each do |n|
+        responses.should include(n)
+      end
+    end
+  end
+
+  context "Priority Queue" do
+    it "should give elements in the order of their priority" do
+      responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 22)
+        @q.push("Tim", 18)
+
+        4.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if responses.size == 4
+          end
+        end
+      end
+
+      responses[0].should == "Bob"
+      responses[1].should == "Alex"
+      responses[2].should == "Mike"
+      responses[3].should == "Tim"
+
+    end
+
+    it "should create a fifo priority queue if specified" do
+      fifo_queue = UV::PriorityQueue.new(:fifo => true)
+      responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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 = UV::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+      responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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 = UV::PriorityQueue.new {|x,y| x < y}
+      responses = []
+      loop = Libuv::Loop.default
+      loop.run do
+
+
+        @q.push("Mike", 20)
+        @q.push("Alex", 21)
+        @q.push("Bob", 22)
+        @q.push("Tim", 18)
+
+        4.times do
+          @q.pop do |e|
+            responses << e
+            loop.stop if responses.size == 4
+          end
+        end
+      end
+
+      responses[0].should == "Tim"
+      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 = UV::PriorityQueue.new(:fifo => true)
+
+    responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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 = UV::PriorityQueue.new(:fifo => true) {|x,y| x < y}
+
+      responses = []
+      loop = Libuv::Loop.default
+      loop.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
+            loop.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/uv-priority-queue.gemspec

@@ -0,0 +1,27 @@
+
+require File.expand_path("../lib/uv-priority-queue/version", __FILE__)
+
+
+Gem::Specification.new do |s|
+  s.name        = "uv-priority-queue"
+  s.version     = UV::PriorityQueue::VERSION
+  s.license     = 'MIT'
+  s.authors     = ["Stephen von Takach", "Mike Lewis"]
+  s.email       = ["steve@cotag.me", "ft.mikelewis@gmail.com"]
+  s.homepage    = "https://github.com/cotag/uv-priority-queue"
+  s.summary     = %q{Libuv Priority Queue}
+  s.description = %q{Asynchronous Priority Queue for use with Libuv}
+
+  s.files         = Dir["lib/**/*"] + %w(Rakefile uv-priority-queue.gemspec README.md LICENSE)
+  s.test_files    = Dir["spec/**/*"]
+  s.require_paths = ["lib"]
+
+
+  s.add_runtime_dependency "libuv"
+  s.add_runtime_dependency "algorithms"
+
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency "delorean", ">= 1.1.1"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: uv-priority-queue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stephen von Takach
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libuv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: algorithms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  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: delorean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: Asynchronous Priority Queue for use with Libuv
+email:
+- steve@cotag.me
+- ft.mikelewis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/uv-priority-queue/priority_queue.rb
+- lib/uv-priority-queue/version.rb
+- lib/uv-priority-queue.rb
+- Rakefile
+- uv-priority-queue.gemspec
+- README.md
+- LICENSE
+- spec/spec_helper.rb
+- spec/uv-priority-queue_spec.rb
+homepage: https://github.com/cotag/uv-priority-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Libuv Priority Queue
+test_files:
+- spec/spec_helper.rb
+- spec/uv-priority-queue_spec.rb
+has_rdoc: