burt-delay_queue 1.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+/.rvmrc
+/pkg

data/delay_queue.gemspec

@@ -0,0 +1,21 @@
+$: << File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'burt-delay_queue'
+  s.version     = '1.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Theo Hultberg']
+  s.email       = ['theo@burtcorp.com']
+  s.homepage    = 'https://github.com/iconara/delay_queue'
+  s.summary     = 'A TTL based priority queue'
+  s.description = 'Delay queue keeps it\'s elements ordered by a timestamp, popping off the items with the lowest timestamp first'
+
+  s.rubyforge_project = 'delay_queue'
+  
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+
+  s.files         = `git ls-files`.split("\n")
+  # s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/delay_queue.rb

@@ -0,0 +1,157 @@
+# encoding: utf-8
+
+if RUBY_PLATFORM == 'java'
+  require 'java'
+
+  class DelayQueue
+    java_import 'java.util.TreeMap'
+    java_import 'java.util.HashSet'
+
+    def initialize(clock=Time)
+      @clock = clock
+      @timestamp_to_elements = TreeMap.new
+      @element_to_timestamp = {}
+    end
+
+    def put(element, timestamp=Time.now.to_i, options={})
+      existing_timestamp = @element_to_timestamp[element]
+      if !existing_timestamp || existing_timestamp < timestamp || options[:force]
+        remove(element) if existing_timestamp
+        elements = @timestamp_to_elements.get(timestamp)
+        elements ||= HashSet.new
+        elements.add(element)
+        @timestamp_to_elements.put(timestamp, elements)
+        @element_to_timestamp[element] = timestamp
+      end
+    end
+    
+    def remove(element)
+      timestamp = @element_to_timestamp.delete(element)
+      if timestamp
+        elements = @timestamp_to_elements.get(timestamp)
+        elements.remove(element)
+        @timestamp_to_elements.remove(timestamp) if elements.empty?
+      end
+    end
+    
+    def pop(n=1)
+      popped_elements = []
+      loop do
+        entry = @timestamp_to_elements.first_entry
+        break unless entry
+        break if entry.key > @clock.now.to_i
+        elements = entry.value
+        iterator = elements.iterator
+        while iterator.has_next && popped_elements.size < n
+          element = iterator.next
+          @element_to_timestamp.delete(element)
+          iterator.remove
+          popped_elements << element
+        end
+        break unless elements.empty?
+        @timestamp_to_elements.delete(entry.key)
+      end
+      if n == 1
+        popped_elements.first
+      else
+        popped_elements
+      end
+    end
+    
+    def pop_all
+      popped_elements = []
+      cutoff = @timestamp_to_elements.floor_key(@clock.now.to_i)
+      if cutoff
+        loop do
+          entry = @timestamp_to_elements.poll_first_entry
+          elements = entry.value
+          elements.each do |element|
+            @element_to_timestamp.delete(element)
+            popped_elements << element
+          end
+          break if entry.key == cutoff 
+        end
+      end
+      popped_elements
+    end
+    
+    def include?(element)
+      @element_to_timestamp.key?(element)
+    end
+    
+    def to_h
+      @element_to_timestamp.dup
+    end
+
+    def size
+      @element_to_timestamp.size
+    end
+  end
+else
+  require 'set'
+
+  class DelayQueue
+    def initialize(clock=Time)
+      @clock = clock
+      @elements = {}
+      @timestamps = SortedSet.new
+      @reverse_elements = Hash.new { |h, k| h[k] = Set.new }
+    end
+    
+    def put(element, timestamp=Time.now.to_i, options={})
+      if @elements[element]
+        return unless options[:force] || timestamp > @elements[element]
+        remove(element)
+      end
+      @elements[element] = timestamp
+      @reverse_elements[timestamp] << element
+      @timestamps << timestamp
+    end
+    
+    def remove(element)
+      timestamp = @elements.delete(element)
+      return unless timestamp
+      @reverse_elements[timestamp].delete(element)
+      if @reverse_elements[timestamp].empty?
+        @reverse_elements.delete(timestamp)
+        @timestamps.delete(timestamp)
+      end
+    end
+    
+    def pop(n=1)
+      elements = peek_all.take(n)
+      elements.each { |e| remove(e) }
+      if n == 1
+        elements.first
+      else
+        elements
+      end
+    end
+    
+    def pop_all
+      elements = peek_all
+      elements.each { |e| remove(e) }
+      elements
+    end
+    
+    def include?(element)
+      @elements.key?(element)
+    end
+    
+    def to_h
+      @elements.dup
+    end
+
+    def size
+      @elements.size
+    end
+
+  private
+    
+    def peek_all
+      now = @clock.now.to_i
+      expired_timestamps = @timestamps.take_while { |ts| ts <= now }
+      expired_timestamps.flat_map { |ts| @reverse_elements[ts].to_a }
+    end
+  end
+end

data/spec/delay_queue_spec.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+require_relative 'spec_helper'
+
+
+class Clock
+  attr_accessor :now
+end
+
+describe DelayQueue do
+  before do
+    @clock = Clock.new
+    @q = DelayQueue.new(@clock)
+  end
+
+  describe '#put' do
+    it 'does not replace elements whose timestamp has been updated to an earlier time (by default)' do
+      @clock.now = 4
+      @q.put('blopp', 5)
+      @q.put('blipp', 4)
+      @q.put('blupp', 3)
+      @q.put('blopp', 1)
+      @q.pop.should == 'blupp'
+    end
+    
+    it 'does not replace elements whose timestamp has been updated to an earlier time unless specifically asked to' do
+      @clock.now = 4
+      @q.put('blopp', 5)
+      @q.put('blipp', 4)
+      @q.put('blupp', 3)
+      @q.put('blopp', 1, :force => true)
+      @q.pop.should == 'blopp'
+    end
+  end
+  
+  describe '#pop' do
+    it 'returns nil if no elements have expired' do
+      @clock.now = 1
+      @q.put('blipp', 4)
+      @q.pop.should be_nil
+    end
+
+    it 'returns the oldest expired element' do
+      @clock.now = 5
+      @q.put('blopp', 4)
+      @q.put('blipp', 3)
+      @q.pop.should == 'blipp'
+    end
+    
+    it 'removes elements' do
+      @clock.now = 5
+      @q.put('blopp', 4)
+      @q.pop
+      @q.pop.should be_nil
+    end
+
+    it 'returns as many expired elements as you want, in age order' do
+      @clock.now = 5
+      @q.put('blopp', 5)
+      @q.put('blipp', 4)
+      @q.put('blupp', 3)
+      @q.pop(2).should == %w(blupp blipp)
+    end
+
+    it 'returns only as many elements as are available' do
+      @clock.now = 4
+      @q.put('blopp', 5)
+      @q.put('blipp', 4)
+      @q.put('blupp', 3)
+      @q.pop(10).should == %w(blupp blipp)
+    end
+
+    it 'does not return elements whose timestamp has been updated to a later time' do
+      @clock.now = 4
+      @q.put('blopp', 5)
+      @q.put('blipp', 4)
+      @q.put('blupp', 3)
+      @q.put('blipp', 10)
+      @q.pop(2).should == %w(blupp)
+    end
+  end
+  
+  describe '#pop_all' do
+    it 'returns all expired elements' do
+      @clock.now = 3
+      @q.put('blopp', 1)
+      @q.put('blipp', 2)
+      @q.put('blupp', 3)
+      @q.put('blepp', 4)
+      @q.pop_all.should == %w(blopp blipp blupp)
+    end
+    
+    it 'removes elements' do
+      @clock.now = 3
+      @q.put('blopp', 1)
+      @q.put('blipp', 2)
+      @q.put('blupp', 3)
+      @q.put('blepp', 4)
+      @q.pop_all.should == %w(blopp blipp blupp)
+      @q.pop_all.should == []
+      @clock.now = 4
+      @q.pop_all.should == ['blepp']
+      @q.pop_all.should == []
+    end
+  end
+  
+  describe '#include?' do
+    it 'returns true if the element is in the queue' do
+      @q.put('x', 3)
+      @q.should include('x')
+    end
+
+    it 'returns false if the element is not in the queue' do
+      @q.should_not include('x')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'delay_queue'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: burt-delay_queue
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Theo Hultberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70312679188040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70312679188040
+description: Delay queue keeps it's elements ordered by a timestamp, popping off the
+  items with the lowest timestamp first
+email:
+- theo@burtcorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- delay_queue.gemspec
+- lib/delay_queue.rb
+- spec/delay_queue_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iconara/delay_queue
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: delay_queue
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A TTL based priority queue
+test_files: []