turnpike 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@turnpike

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# CHANGELOG
+
+See [here](http://code.papercavalier.com/turnpike).

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in turnpike.gemspec
+gemspec

data/README.md

@@ -0,0 +1,32 @@
+# Turnpike
+
+Turnpike is a Redis-backed processing queue.
+
+# Usage
+
+Set up:
+
+```ruby
+require "turnpike"
+
+queue = Turnpike.new(:processing_queue)
+```
+
+Queue:
+
+```ruby
+queue << "unit of work"
+```
+
+Process:
+
+```ruby
+queue.each do |work|
+  # create value
+end
+
+# alternatively
+queue.each_slice(10) do |slice)
+  # create value
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/**/*_test.rb']
+end

data/lib/turnpike.rb

@@ -0,0 +1,121 @@
+require 'redis'
+
+# A Redis-backed queue.
+class Turnpike
+  REDIS_VERSION = Redis.current.info['redis_version']
+  TIMEOUT       = ENV['TURNPIKE_TIMEOUT'] || 2
+  VERSION       = '0.0.1'
+
+  # The name of the queue.
+  attr :name
+
+  # Creates a new queue.
+  #
+  # Takes an optional name.
+  def initialize(name = 'default')
+    @name = "turnpike:#{name}"
+  end
+
+  # Removes all queued items.
+  def clear
+    redis.del(name)
+  end
+
+  # Calls block once for each queued item.
+  #
+  # Takes an optional boolean argument to specify if the command should block
+  # the connection when the queue is empty. This argument defaults to false.
+  def each(blocking = false, &block)
+    while item = shift(blocking)
+      block.call(item)
+    end
+  end
+
+  # Iterates the given block for each slice of `n` queued items.
+  def each_slice(n, blocking = false, &block)
+    slice = []
+
+    each(blocking) do |item|
+      slice << item
+      if slice.size == n
+        yield slice
+        slice = []
+      end
+    end
+
+    yield slice unless slice.empty?
+  end
+
+  # Returns `true` if the queue is empty.
+  def empty?
+    length == 0
+  end
+
+  # Returns the length of the queue.
+  def length
+    redis.llen(name)
+  end
+  alias size length
+
+  # Returns an array of items currently queued.
+  #
+  # `start` is an integer and indicates the start offset, 0 being the first
+  # queued item. If negative, it indicates the offset from the end, -1 being
+  # the last queued item.
+  #
+  # `count` is also an integer and indicates the number of items to return.
+  def peek(start, count)
+    redis.lrange(name, start, count)
+  end
+
+  # Retrieves the last queued item.
+  #
+  # Takes an optional boolean argument to specify if the command should block
+  # the connection when the queue is empty. This argument defaults to false.
+  def pop(blocking = false)
+    if blocking
+      redis.brpop(name, TIMEOUT)[1] rescue nil
+    else
+      redis.rpop(name)
+    end
+  end
+
+  # Pushes items to the end of the queue.
+  def push(*items)
+    # Up until Redis 2.3, `rpush` accepts a single value.
+    if REDIS_VERSION < '2.3'
+      items.each { |item| redis.rpush(name, item) }
+    else
+      redis.rpush(name, items)
+    end
+  end
+  alias << push
+
+  # Retrieves the first queued item.
+  #
+  # Takes an optional boolean argument to specify if the command should block
+  # the connection when the queue is empty. This argument defaults to false.
+  def shift(blocking = false)
+    if blocking
+      redis.blpop(name, TIMEOUT)[1] rescue nil
+    else
+      redis.lpop(name)
+    end
+  end
+
+  # Pushes items to the front of the queue.
+  def unshift(*items)
+    # Up until Redis 2.3, `rpush` accepts a single value.
+    if REDIS_VERSION < '2.3'
+      items.each { |item| redis.lpush(name, item) }
+    else
+      redis.lpush(name, items)
+    end
+  end
+
+  private
+
+  def redis
+    Redis.current
+  end
+end

data/test/turnpike_test.rb

@@ -0,0 +1,131 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'test/unit'
+
+require File.expand_path('../lib/turnpike', File.dirname(__FILE__))
+
+class TestTurnpike < Test::Unit::TestCase
+  def setup
+    Redis.current.flushall
+  end
+
+  def test_emptiness
+    queue = Turnpike.new
+    assert(queue.empty?)
+
+    queue << 1
+    assert(!queue.empty?)
+
+    queue.clear
+    assert(queue.empty?)
+  end
+
+  def test_pushing_items
+    queue = Turnpike.new
+    queue.push(1)
+    assert_equal(1, queue.length)
+
+    queue.push(2, 3)
+    assert_equal(3, queue.length)
+    assert_equal(['1', '2', '3'], queue.peek(0, 3))
+  end
+
+  def test_unshifting_items
+    queue = Turnpike.new
+    queue.unshift(1)
+    assert_equal(1, queue.length)
+
+    queue.unshift(2, 3)
+    assert_equal(3, queue.length)
+    assert_equal(['3', '2', '1'], queue.peek(0, 3))
+  end
+
+  def test_popping_items
+    queue = Turnpike.new
+    queue.push(1, 2)
+    assert_equal('2', queue.pop)
+    assert_equal('1', queue.pop)
+    assert_equal(nil, queue.pop)
+  end
+
+  def test_shifting_items
+    queue = Turnpike.new
+    queue.push(1, 2)
+    assert_equal('1', queue.shift)
+    assert_equal('2', queue.shift)
+    assert_equal(nil, queue.shift)
+  end
+
+  def test_enumeration
+    queue = Turnpike.new
+    queue.push(1, 2)
+    items = []
+    queue.each { |item| items << item }
+    assert_equal(['1', '2'], items)
+
+    queue.push(1, 2, 3, 4)
+    slices = []
+    queue.each_slice(3) { |slice| slices << slice }
+    assert_equal([['1', '2', '3'], ['4']], slices)
+
+    queue.push(1, 2)
+    slices = []
+    queue.each_slice(2) { |slice| slices << slice }
+    assert_equal([['1', '2']], slices)
+  end
+
+  def test_aliases
+    queue = Turnpike.new
+    queue << 1
+    assert_equal(1, queue.size)
+  end
+
+  def test_multiple_queues
+    queue1 = Turnpike.new("foo")
+    queue2 = Turnpike.new("bar")
+
+    queue1.push(1)
+    queue2.push(2, 3)
+
+    assert_equal(1, queue1.length)
+    assert_equal(2, queue2.length)
+  end
+
+  def test_blocking_pop
+    queue = Turnpike.new
+    started_at = Time.now.to_i
+    Thread.new do
+      sleep(1)
+      queue.push(1)
+    end
+    assert_equal(0, queue.length)
+    assert_equal('1', queue.pop(true))
+    assert_equal(1, Time.now.to_i - started_at)
+  end
+
+  def test_blocking_shift
+    queue = Turnpike.new
+    started_at = Time.now.to_i
+    Thread.new do
+      sleep(1)
+      queue.push(1)
+    end
+    assert_equal(0, queue.length)
+    assert_equal('1', queue.shift(true))
+    assert_equal(1, Time.now.to_i - started_at)
+  end
+
+  def test_timeout
+    queue = Turnpike.new
+    thread = Thread.new do
+      sleep(3)
+      queue.push(1)
+    end
+    assert_equal(0, queue.length)
+    assert_equal(nil, queue.shift(true))
+
+    thread.join
+    assert_equal(1, queue.length)
+  end
+end

data/turnpike.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require "./lib/turnpike"
+
+Gem::Specification.new do |s|
+  s.name        = "turnpike"
+  s.version     = Turnpike::VERSION
+  s.authors     = ["Paper Cavalier"]
+  s.email       = ["code@papercavalier.com"]
+  s.homepage    = ""
+  s.summary     = %q{Turnpike is a Redis-backed processing queue.}
+  s.description = %q{Turnpike is a Redis-backed processing queue.}
+
+  s.rubyforge_project = "turnpike"
+
+  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"]
+
+  {
+    'redis'               => '~> 2.2'
+  }.each do |lib, version|
+    s.add_runtime_dependency lib, version
+  end
+
+  {
+    'rake'                => '~> 0.9'
+  }.each do |lib, version|
+    s.add_development_dependency lib, version
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: turnpike
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paper Cavalier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: Turnpike is a Redis-backed processing queue.
+email: 
+- code@papercavalier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/turnpike.rb
+- test/turnpike_test.rb
+- turnpike.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -65682769668407542
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -65682769668407542
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: turnpike
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Turnpike is a Redis-backed processing queue.
+test_files: 
+- test/turnpike_test.rb