evented-queue 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+gem "abstract", ">= 0"
+gem "unified-queues", ">= 0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler2", ">= 2.0.0"
+  gem "riot", ">= 0.12.3"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    git (1.2.5)
+    hash-utils (1.0.0)
+      ruby-version
+    jeweler2 (2.0.9)
+      git (>= 1.2.5)
+    lookup-hash (0.2.0)
+      hash-utils (>= 0.11.0)
+    riot (0.12.5)
+      rr
+    rr (1.0.4)
+    ruby-version (0.3.1)
+    unified-queues (0.1.0)
+      abstract (>= 1.0.0)
+      hash-utils (>= 0.18.1)
+      lookup-hash
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abstract
+  bundler (>= 1.0.0)
+  jeweler2 (>= 2.0.0)
+  riot (>= 0.12.3)
+  unified-queues

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 - 2012 Martin Kozák (martinkozak@martinkozak.net)
+
+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,63 @@
+Ruby Evented Queue
+==================
+
+**evented-queue** simply wraps non-evented queue to an evented 
+interface. It directly uses the [Unified Queues][1] gem which means, 
+wide spectrum of queues can be converted to the evented queues. 
+Advantage of the evented queue is, they can be *recurring*, so 
+can serve as de-facto permanent provider of the events.
+
+An example:
+
+    require "evented-queue"
+    require "depq"      # will serve as example here
+    
+    queue = EventedQueue::new(Depq)
+    queue.push(:foo)
+    
+    queue.pop do |item|
+        item    # will contain :foo
+    end
+    
+    queue.push(:bar)
+    
+    queue.pop do |item|
+        item    # will contain :bar
+    end 
+
+    
+And recurring queue example:
+
+    require "evented-queue/recurring"
+    
+    queue = EventedQueue::Recurring::new(Array)
+    queue.push(:foo)
+    
+    queue.pop do |item|     # :foo will be written out now
+        p item
+    end
+    
+    queue.push(:bar)        # :bar will be written out now
+    queue.push(:delta)      # :delta will be written out now
+
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][9] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright © 2011 - 2012 [Martin Kozák][10]. See `LICENSE.txt` for
+further details.
+
+[1]: http://github.com/martinkozak/unified-queues
+[9]: http://github.com/martinkozak/evented-queue/issues
+[10]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler2'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "evented-queue"
+  gem.homepage = "http://github.com/martinkozak/evented-queue"
+  gem.license = "MIT"
+  gem.summary = 'Provides queue driven by callbacks so suitable for asynchronous processing environments and its recurring variant for request distribution to more clients or emulating of server behaviour.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/evented-queue.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "evented-queue/abstract"
+require "unified-queues/single"
+
+##
+# Non thread-safe queue working using callbacks
+# usable especially for evented environments such as EventMachine
+#
+
+class EventedQueue < AbstractEventedQueue
+  
+    ##
+    # Holds values stack.
+    # @return [UnifiedQueues::Single]
+    #
+    
+    attr_accessor :stack
+    @stack
+    
+    ##
+    # Holds callbacks waiting for value.
+    # @return [Array]
+    #
+    
+    attr_accessor :callbacks
+    @callbacks
+    
+    ##
+    # Constructor.
+    # @param [UnifiedQueues::Single]  stak holder instance wrapped to unified queue
+    #
+    
+    def initialize(stack = UnifiedQueues::Single::new(Array))
+        @stack = stack
+        @callbacks = [ ]
+    end
+    
+    ##
+    # Pushes value into the queue. Priority isn't supported
+    # by default but can be obtained using the +stack+ argument
+    # of constructor by giving priority queue instance.
+    #
+    # @param [Object] value  value to push
+    # @param [Object] key  key fo priority purposes
+    # @yield [nil]
+    #
+    
+    def push(value, key = value, &block)
+        @stack.push(value, key)
+        if not @callbacks.empty?
+            self.pop &@callbacks.shift
+        end
+        
+        yield if not block.nil?
+    end
+    
+    ##
+    # Pushes value out of the queue.
+    #
+    # @return [Object] value from the queue
+    # @yield [Object] value from the queue
+    #
+    
+    def pop(&block)
+        if self.empty?
+            @callbacks << block
+        else
+            result = @stack.pop
+            yield result if not block.nil?
+            return result
+        end
+    end
+    
+    alias :pop! :pop
+    
+    ##
+    # Indicates length of the queue.
+    #
+    # @return [Integer] length of the queue
+    # @yield [Integer] length of the queue
+    #
+    
+    def length(&block)
+        length = @stack.length
+        yield length if not block.nil?
+        return length
+    end
+    
+    ##
+    # Indicates queue is empty.
+    #
+    # @return [Boolean] +true+ it it is, +false+ otherwise
+    # @yield [Boolean] +true+ it it is, +false+ otherwise
+    #
+    
+    def empty?(&block)
+        empty = @stack.empty?
+        yield empty if not block.nil?
+        return empty
+    end
+    
+    ##
+    # Clears the queue.
+    #
+    
+    def clear(&block)
+        result = @stack.clear
+        yield result if not block.nil?
+        return result
+    end
+    
+    alias :clear! :clear
+end
+
+require "evented-queue/recurring"
+

data/lib/evented-queue/abstract.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "abstract"
+
+##
+# Abstract evented queue.
+# @abstract
+#
+
+class AbstractEventedQueue
+  
+    ##
+    # Pushes value into the queue.
+    #
+    # @param value [Object]  object to push
+    # @abstract
+    #
+    
+    def push(value, &block)
+        not_implemented
+    end
+    
+    ##
+    # Pushes value out of the queue.
+    #
+    # @yield [Object]  an object from the queue
+    # @abstract
+    #
+    
+    def pop(&block)
+        not_implemented
+    end
+    
+    ##
+    # Indicates length of the queue.
+    #
+    # @return [Integer]  queue length
+    # @yield [Integer]  queue length
+    # @abstract
+    #
+    
+    def length(&block)
+        not_implemented
+    end
+    
+    ##
+    # Indicates queue is empty.
+    #
+    # @return [Boolean] +true+ it it is, +false+ otherwise
+    # @yield [Boolean] +true+ it it is, +false+ otherwise
+    # @abstract
+    #
+    
+    def empty?(&block)
+        not_implemented
+    end
+    
+    ##
+    # Clears the queue.
+    #
+    # @yield [nil]
+    # @abstract
+    #
+    
+    def clear(&block)
+        not_implemented
+    end
+    
+    alias :clear! :clear
+    
+end

data/lib/evented-queue/recurring.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "evented-queue"
+
+##
+# Recurring evented queue implementation.
+#
+
+class EventedQueue::Recurring < EventedQueue
+  
+    ##
+    # Holds scheduling routine.
+    # @return [Proc]
+    #
+    
+    attr_accessor :scheduler
+    @scheduler
+    
+    ##
+    # Constructor.
+    # @param [Proc] &scheduler  which indicates how to schedule recurring
+    #
+    
+    def initialize(stack = UnifiedQueues::Single::new(Array), &scheduler)
+        super(stack)
+        @scheduler = scheduler
+    end
+     
+    ##
+    # Pushes value out of the queue.
+    #
+    # @return [Object] value from the queue
+    # @yield [Object] value from the queue
+    #
+
+    def pop(&block)
+        if self.empty?
+            result = super(&block)
+        else
+            result = super(&block)
+            
+            if @scheduler.nil?
+                self.pop(&block)
+            else
+                @scheduler.call(Proc::new { self.pop(&block) })
+            end
+        end
+        
+        return result
+    end
+    
+end

data/test

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+$:.unshift("./lib")
+
+require "evented-queue"
+require "riot"
+  
+context "EventedQueue" do
+    setup do
+        EventedQueue::new
+    end
+    
+    asserts("#push") do
+        done = false
+        topic.push(:foo)
+        topic.pop do |v| 
+            done = v == :foo
+        end
+        done
+    end
+    asserts("#pop") do
+        d1 = false
+        d2 = false
+        
+        topic.push(:foo)
+        topic.pop do |v| 
+            d1 = v == :foo
+        end
+        topic.pop do |v| 
+            d2 = v == :bar
+        end
+        topic.push(:bar)
+        
+        d1 and d2
+    end
+    asserts("#length") do
+        topic.push(:foo)
+        topic.pop
+        d1 = topic.length == 0
+        topic.push(:foo)
+        d2 = topic.length == 1
+        
+        d1 and d2
+    end
+    asserts("#empty?") do
+        topic.clear!
+        topic.push(:foo)
+        d1 = not(topic.empty?)
+        topic.pop
+        d2 = topic.empty?
+        
+        d1 and d2
+    end
+    asserts("#clear!") do
+        topic.push(:foo)
+        topic.clear!
+        topic.empty?
+    end
+end
+
+context "EventedQueue::Recurring" do
+    asserts("#push") do
+        topic = EventedQueue::Recurring::new
+        done = false
+        topic.push(:foo)
+        topic.pop do |v| 
+            done = v == :foo
+        end
+        done
+    end
+    asserts("#pop") do
+        topic = EventedQueue::Recurring::new
+        result = [ ]
+        topic.push(:foo)
+        topic.pop do |v| 
+            result << v
+        end
+        topic.push(:bar)
+        result == [:foo, :bar]
+    end
+    asserts("#length") do
+        topic = EventedQueue::Recurring::new
+        topic.push(:foo)
+        topic.pop
+        d1 = topic.length == 0
+        topic.push(:foo)
+        d2 = topic.length == 1
+        
+        d1 and d2
+    end
+    asserts("#empty?") do
+        topic = EventedQueue::Recurring::new
+        topic.clear!
+        topic.push(:foo)
+        d1 = not(topic.empty?)
+        topic.pop
+        d2 = topic.empty?
+        
+        d1 and d2
+    end
+    asserts("#clear!") do
+        topic = EventedQueue::Recurring::new
+        topic.push(:foo)
+        topic.clear!
+        topic.empty?
+    end
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: evented-queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Martin Kozák
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: abstract
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unified-queues
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/evented-queue.rb
+- lib/evented-queue/abstract.rb
+- lib/evented-queue/recurring.rb
+- test
+homepage: http://github.com/martinkozak/evented-queue
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4134528818554253317
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides queue driven by callbacks so suitable for asynchronous processing
+  environments and its recurring variant for request distribution to more clients
+  or emulating of server behaviour.
+test_files: []