turnpike 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 826cb79526ad3b850c35706cf2f83d31d964bea9
-  data.tar.gz: 2660a866510fe81c2fa4803d3934d1c7cc391dfa
+  metadata.gz: 71c0caf5486b4a3dd29477c55ad64dd46a524413
+  data.tar.gz: 74a7c074fb111de0d96a35b5d8de8ac75d509270
 SHA512:
-  metadata.gz: bbfc8eac02fb62742f91149a17efe40acbd3ee12c68403fe279ec68b7298c75734efed720ccdcb279326a3b0c5c3a9340e3b97e7c106a69b5f61b7fb931505e6
-  data.tar.gz: 7a715795ff4ff9e7d9f4aead0e3d4e1bda67d5f86bb34361474fd70fc4dbf21bcb89e9261521eff8b4c11e9d6c750c5fdbeca625e9a9e50d0186edd89aa3d667
+  metadata.gz: 80372b97d3b71ec35006cd72c933d2466de7334cf983496ba64c942e19ed8f81e3f577efe6a3bf44e31a665de96f759c53cf2824c946f57ea3d0f1dd05ff55b8
+  data.tar.gz: 641c1458dc324d58e98369c04bf8e403e403be5acbac3747236cadcffe0edba72c176c8e68a8d0d57edf43ede2a30d2b1972c9333c7fa9e1c82d43456826f194

data/.travis.yml

@@ -1,7 +1,5 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
 services:
   - redis-server

data/Gemfile

@@ -1,2 +1,2 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -2,19 +2,41 @@
 
 ![turnpike][nj]
 
-Turnpike wraps [Redis][redis], uses [Message Pack][msgpack], and speaks Ruby.
+Turnpike is a minimal [Redis][red]-backed FIFO queue in Ruby.
+
+## Usage
+
+Push and pop:
+
+```ruby
+q = Turnpike.call('queue name')
+q.push('foo', 'bar', 'baz', 'qux') # => 4
+q.pop # => 'foo'
+```
+
+Pop multiple items:
+
+```ruby
+q.pop(2) # => ['bar', 'baz']
+```
+
+Push payload to the front of the queue:
+
+```ruby
+q.unshift('foo') # => 2
+q.pop # => 'foo"'
+```
+
+Use a queue with set-like properties to ensure uniqueness of queued items:
 
 ```ruby
-queue = Turnpike['foo']
-queue << 1, 2, 3
-queue.pop # => 1
-queue << 4
-queue.unshift(1)
-queue.pop(4) # => [1, 2, 3, 4]
+q = Turnpike.call('queue name', unique: true)
+q.push('foo', 'bar') # => 2
+q.push('bar') # => 2
+q.pop(3) # => ['foo', 'bar']
 ```
 
-Turnpike requires Redis 2.4 or higher.
+Turnpike requires Ruby 2.0 and Redis 2.6 or higher.
 
 [nj]: http://f.cl.ly/items/33242X323P3M1t1G400H/turnpike.jpg
-[redis]: http://redis.io/
-[msgpack]: http://msgpack.org/
+[red]: http://redis.io/

data/lib/turnpike.rb

@@ -1,13 +1,8 @@
 require 'turnpike/queue'
+require 'turnpike/unique_queue'
 
-# A Redis-backed queue.
 module Turnpike
-  # Create a queue.
-  #
-  # name - A queue name that responds to to_s.
-  #
-  # Returns a Turnpike::Queue.
-  def self.[](name)
-    Queue.new(name)
+  def self.call(name = 'default', unique: false)
+    (unique ? UniqueQueue : Queue).new(name)
   end
 end

data/lib/turnpike/base.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+require 'msgpack'
+require 'redis'
+
+module Turnpike
+  class Base
+    extend Forwardable
+
+    def_delegator :Redis, :current, :redis
+    def_delegators :MessagePack, :pack, :unpack
+
+    attr :name
+
+    def initialize(name)
+      @name = "turnpike:#{name}"
+    end
+
+    def clear
+      redis.del(name)
+    end
+
+    def empty?
+      size == 0
+    end
+
+    def pop(*); raise NotImplementedError; end
+    def push(*); raise NotImplementedError; end
+    def size; raise NotImplementedError; end
+    def unshift(*); raise NotImplementedError; end
+  end
+end

data/lib/turnpike/queue.rb

@@ -1,32 +1,8 @@
-require 'msgpack'
-require 'redis'
+require 'turnpike/base'
 
 module Turnpike
-  # A queue.
-  class Queue
-    # Returns a String name.
-    attr :name
-
-    # Create a new queue.
-    #
-    # name - A queue name that responds to to_s.
-    def initialize(name = 'queue')
-      @name = "turnpike:#{name}"
-    end
-
-    # Remove all items from the queue.
-    #
-    # Returns Integer number of items that were removed.
-    def clear
-      redis.del(name)
-    end
-
-    # Returns whether the queue is empty.
-    def empty?
-      size == 0
-    end
-
-    # Pop one or more items from the front of the queue.
+  class Queue < Base
+    # Pop one or more items from the queue.
     #
     # n - Integer number of items to pop.
     #
@@ -35,7 +11,7 @@ module Turnpike
       items = []
       n.times do
         break unless item = redis.lpop(name)
-        items << MessagePack.unpack(item)
+        items << unpack(item)
       end
 
       n == 1 ? items.first : items
@@ -47,10 +23,9 @@ module Turnpike
     #
     # Returns the Integer size of the queue after the operation.
     def push(*items)
-      redis.rpush(name, items.map { |i| MessagePack.pack(i) })
+      redis.rpush(name, items.map { |i| pack(i) })
     end
 
-    # Syntactic sugar.
     alias << push
 
     # Returns the Integer size of the queue.
@@ -64,13 +39,7 @@ module Turnpike
     #
     # Returns the Integer size of the queue after the operation.
     def unshift(*items)
-      redis.lpush(name, items.map { |i| MessagePack.pack(i) })
-    end
-
-    private
-
-    def redis
-      Redis.current
+      redis.lpush(name, items.map { |i| pack(i) })
     end
   end
 end

data/lib/turnpike/unique_queue.rb

@@ -0,0 +1,59 @@
+require 'digest/sha1'
+require 'turnpike/base'
+
+module Turnpike
+  class UniqueQueue < Base
+    ZPOP = <<-EOF
+      local res = redis.call('zrange', KEYS[1], 0, KEYS[2] - 1)
+      redis.pcall('zrem', KEYS[1], unpack(res))
+      return res
+    EOF
+
+    ZPOP_SHA = Digest::SHA1.hexdigest(ZPOP)
+
+    # Pop one or more items from the queue.
+    #
+    # n - Integer number of items to pop.
+    #
+    # Returns a String item, an Array of items, or nil if the queue is empty.
+    def pop(n = 1)
+      items = begin
+        redis.evalsha(ZPOP_SHA, [name, n])
+      rescue Redis::CommandError
+        redis.eval(ZPOP, [name, n])
+      end
+      items.map! { |i| unpack(i) }
+
+      n == 1 ? items.first : items
+    end
+
+    # Push items to the end of the queue.
+    #
+    # items - A splat Array of items.
+    #
+    # Returns the Integer size of the queue after the operation.
+    def push(*items, score: Time.now.to_f)
+      redis.multi do
+        redis.zadd(name, items.reduce([]) { |ary, i| ary.push(score, pack(i)) })
+        size
+      end
+    end
+
+    alias << push
+
+    # Returns the Integer size of the queue.
+    def size
+      redis.zcard(name)
+    end
+
+    # Push items to the front of the queue.
+    #
+    # items - A splat Array of items.
+    #
+    # Returns the Integer size of the queue after the operation.
+    def unshift(*items)
+      _, score = redis.zrange(name, 0, 0, with_scores: true).pop
+      score ? push(*items, score: score - 1) : push(*items)
+    end
+  end
+end

data/lib/turnpike/version.rb

@@ -1,3 +1,3 @@
 module Turnpike
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/test/turnpike_test.rb

@@ -1,52 +1,75 @@
-require 'bundler/setup'
+$: << File.expand_path('../lib', File.dirname(__FILE__))
 require 'minitest/autorun'
-require File.expand_path('../lib/turnpike', File.dirname(__FILE__))
+require 'minitest/benchmark' if ENV['BENCH']
+require 'turnpike'
 
 class TestTurnpike < MiniTest::Unit::TestCase
-  def setup
-    Redis.current.flushall
+  def test_call
+    assert_kind_of Turnpike::Queue, Turnpike.call
+    assert_kind_of Turnpike::UniqueQueue, Turnpike.call(unique: true)
   end
 
-  def peek(queue)
-    redis = queue.send(:redis)
-    redis.lrange(queue.name, 0, -1).map { |i| MessagePack.unpack(i) }
+  def test_queue_name
+    queue = Turnpike::Base.new('foo')
+    assert_includes queue.name, 'foo'
   end
 
-  def test_bracket
-    queue = Turnpike['foo']
-    assert_kind_of Turnpike::Queue, queue
-    assert_equal 'turnpike:foo', queue.name
+  def test_abstract_class
+    queue = Turnpike::Base.new('foo')
+    %w(push pop unshift size).each do |mth|
+      assert_raises(NotImplementedError) { queue.send(mth) }
+    end
   end
 
-  def test_emptiness
-    queue = Turnpike::Queue.new
-    assert queue.empty?
-    queue << 1
-    assert !queue.empty?
-    queue.clear
-    assert queue.empty?
+  def bench_queue
+    queue = Turnpike.call
+    assert_performance_linear do |n|
+      queue.push(*(1..n).to_a)
+      1.upto(n) { queue.pop }
+    end
+  end
+
+  def bench_unique
+    queue = Turnpike.call(unique: true)
+    assert_performance_linear do |n|
+      queue.push(*(1..n).to_a)
+      1.upto(n) { queue.pop }
+    end
+  end
+end
+
+module QueueTests
+  def queue
+    @queue ||= klass.new('foo')
+  end
+
+  def setup
+    Redis.current.flushall
   end
 
   def test_push
-    queue = Turnpike::Queue.new
     queue.push(1)
     assert_equal 1, queue.size
     queue.push(2, 3)
-    assert_equal 3, queue.size
     assert_equal [1, 2, 3], peek(queue)
   end
 
+  def test_emptiness
+    assert queue.empty?
+    queue << 1
+    assert !queue.empty?
+    queue.clear
+    assert queue.empty?
+  end
+
   def test_unshift
-    queue = Turnpike::Queue.new
-    queue.unshift(1)
-    assert_equal 1, queue.size
+    queue.push(1)
     queue.unshift(2, 3)
     assert_equal 3, queue.size
-    assert_equal [3, 2, 1], peek(queue)
+    assert_equal 1, peek(queue).last
   end
 
   def test_pop
-    queue = Turnpike::Queue.new
     queue.push(1, 2)
     assert_equal 1, queue.pop
     assert_equal 2, queue.pop
@@ -54,7 +77,6 @@ class TestTurnpike < MiniTest::Unit::TestCase
   end
 
   def test_pop_many
-    queue = Turnpike::Queue.new
     queue.push(1, 2, 3)
     assert_equal [1, 2], queue.pop(2)
     assert_equal [3], queue.pop(2)
@@ -62,7 +84,6 @@ class TestTurnpike < MiniTest::Unit::TestCase
   end
 
   def test_order
-    queue = Turnpike::Queue.new
     queue.push(1, 2)
     queue.unshift(3)
     assert_equal 3, queue.pop
@@ -70,12 +91,33 @@ class TestTurnpike < MiniTest::Unit::TestCase
     assert_equal 2, queue.pop
   end
 
-  def test_multiple_queues
-    queue1 = Turnpike::Queue.new 'foo'
-    queue2 = Turnpike::Queue.new 'bar'
-    queue1.push(1)
-    queue2.push(2, 3)
-    assert_equal 1, queue1.size
-    assert_equal 2, queue2.size
+  def test_multiplicity
+    q1 = klass.new('foo')
+    q2 = klass.new('bar')
+    q1.push(1)
+    q2.push(2, 3)
+    assert_equal 1, q1.size
+    assert_equal 2, q2.size
+  end
+end
+
+class TestQueue < MiniTest::Unit::TestCase
+  include QueueTests
+
+  def klass; Turnpike::Queue; end
+
+  def peek(queue)
+    queue.redis.lrange(queue.name, 0, -1).map { |i| queue.unpack(i) }
+  end
+end
+
+
+class TestUniqueQueue < MiniTest::Unit::TestCase
+  include QueueTests
+
+  def klass; Turnpike::UniqueQueue; end
+
+  def peek(queue)
+    queue.redis.zrange(queue.name, 0, -1).map { |i| queue.unpack(i) }
   end
 end

data/turnpike.gemspec

@@ -8,15 +8,16 @@ Gem::Specification.new do |s|
   s.authors     = ['Hakan Ensari']
   s.email       = ['hakan.ensari@papercavalier.com']
   s.homepage    = 'http://github.com/hakanensari/turnpike'
-  s.summary     = %q{A Redis-backed queue}
-  s.description = %q{Turnpike is a Redis-backed queue.}
+  s.description = %q{A Redis-backed FIFO queue}
+  s.summary     = %q{A Redis-backed FIFO queue}
 
   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']
 
   s.add_runtime_dependency 'redis', '~> 3.0'
   s.add_runtime_dependency 'msgpack', '~> 0.5.4'
   s.add_development_dependency 'rake'
+
+  s.required_ruby_version = '>= 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnpike
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -52,7 +52,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Turnpike is a Redis-backed queue.
+description: A Redis-backed FIFO queue
 email:
 - hakan.ensari@papercavalier.com
 executables: []
@@ -66,7 +66,9 @@ files:
 - README.md
 - Rakefile
 - lib/turnpike.rb
+- lib/turnpike/base.rb
 - lib/turnpike/queue.rb
+- lib/turnpike/unique_queue.rb
 - lib/turnpike/version.rb
 - test/turnpike_test.rb
 - turnpike.gemspec
@@ -81,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -92,7 +94,6 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: A Redis-backed queue
+summary: A Redis-backed FIFO queue
 test_files:
 - test/turnpike_test.rb
-has_rdoc: