hotseat 0.1.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "couchrest", ">= 1.1.0"
+
+group :development, :test do
+  gem "rspec"
+  gem "yard"
+  gem "bundler"
+  gem "jeweler"
+end
+
+group :test do
+  gem 'simplecov', '>= 0.4.0', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Elad Kehat
+
+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.rdoc

@@ -0,0 +1,19 @@
+= Hotseat
+
+Add work queue functionality to an existing CouchDB database.
+
+== Contributing to Hotseat
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Elad Kehat. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+# 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 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "hotseat"
+  gem.homepage = "http://github.com/eladkehat/hotseat"
+  gem.license = "MIT"
+  gem.summary = %Q{Add work queue functionality to an existing CouchDB database}
+  #gem.description = %Q{longer description of the gem}
+  gem.email = "eladkehat@gmail.com"
+  gem.authors = ["Elad Kehat"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/hotseat.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hotseat}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elad Kehat"]
+  s.date = %q{2011-08-06}
+  s.email = %q{eladkehat@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/hotseat.rb",
+    "lib/hotseat/hotseat.rb",
+    "lib/hotseat/queue.rb",
+    "spec/hotseat/hotseat_spec.rb",
+    "spec/hotseat/queue_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/eladkehat/hotseat}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Add work queue functionality to an existing CouchDB database}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<couchrest>, [">= 1.1.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<couchrest>, [">= 1.1.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<couchrest>, [">= 1.1.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/hotseat/hotseat.rb

@@ -0,0 +1,89 @@
+module Hotseat
+
+  class << self
+
+    def queue(db)
+      Hotseat::Queue.new(db)
+    end
+    alias :make_queue :queue
+
+    def queue?(db)
+      # ignore system dbs like _replicator and _users
+      return false if db.name =~ /^_/
+      begin
+        db.get design_doc_id
+      rescue RestClient::ResourceNotFound
+      # either the database or the design doc does not exist
+        false
+      end
+    end
+
+    def queues(couch_server)
+      couch_server.databases.select do |db|
+        queue?(couch_server.database(db))
+      end
+    end
+
+    def design_doc_id
+      "_design/#{config[:design_doc_name]}"
+    end
+
+    def pending_view_name
+      "#{config[:design_doc_name]}/#{config[:pending_view_name]}"
+    end
+
+    def locked_view_name
+      "#{config[:design_doc_name]}/#{config[:locked_view_name]}"
+    end
+
+    def done_view_name
+      "#{config[:design_doc_name]}/#{config[:done_view_name]}"
+    end
+
+    def all_view_name
+      "#{config[:design_doc_name]}/#{config[:all_view_name]}"
+    end
+
+    def design_doc
+      q = "doc.#{config[:object_name]}"
+      lock = "#{q}.lock"
+      done = "#{q}.done"
+      pending_func = <<-JAVASCRIPT
+function(doc) { if (#{q} && !(#{lock} || #{done})) emit(#{q}.at, null); }
+      JAVASCRIPT
+      locked_func = <<-JAVASCRIPT
+function(doc) { if (#{q} && #{lock}) emit(#{lock}.at, null); }
+      JAVASCRIPT
+      done_func = <<-JAVASCRIPT
+function(doc) { if (#{q} && #{done}) emit(#{done}.at, null); }
+      JAVASCRIPT
+      all_func = <<-JAVASCRIPT
+function(doc) { if (#{q}) emit(#{q}.at, null); }
+      JAVASCRIPT
+      {
+        '_id' => "_design/#{config[:design_doc_name]}",
+        :views => {
+          config[:pending_view_name] => { :map => pending_func.chomp },
+          config[:locked_view_name] => { :map => locked_func.chomp },
+          config[:done_view_name] => { :map => done_func.chomp },
+          config[:all_view_name] => { :map => all_func.chomp },
+        }
+      }
+    end
+
+    def config
+      CONFIG
+    end
+
+  end
+
+  CONFIG = {
+    :design_doc_name => 'hotseat_queue',
+    :pending_view_name => 'pending',
+    :locked_view_name => 'locked',
+    :done_view_name => 'done',
+    :all_view_name => 'all',
+    :object_name => 'hotseat',
+  }
+
+end

data/lib/hotseat/queue.rb

@@ -0,0 +1,157 @@
+require 'time'
+
+module Hotseat
+
+  class QueueError < RuntimeError
+  end
+
+  class Queue
+    attr_reader :db
+
+    class << self
+
+      def patch(doc)
+        doc[Hotseat.config[:object_name]] = {'at' => Time.now.utc.iso8601, 'by' => $$}
+        doc
+      end
+
+      def unpatch(doc)
+        doc.delete( Hotseat.config[:object_name] )
+        doc
+      end
+
+      def add_lock(doc)
+        obj = doc[Hotseat.config[:object_name]]
+        obj['lock'] = {'at' => Time.now.utc.iso8601, 'by' => $$}
+        doc
+      end
+
+      def locked?(doc)
+        if obj = doc[Hotseat.config[:object_name]]
+          obj.has_key? 'lock'
+        end
+      end
+
+      def remove_lock(doc)
+        obj = doc[Hotseat.config[:object_name]]
+        obj.delete 'lock'
+        doc
+      end
+
+      def mark_done(doc)
+        obj = doc[Hotseat.config[:object_name]]
+        obj['done'] = {'at' => Time.now.utc.iso8601, 'by' => $$}
+        doc
+      end
+
+    end
+
+    def initialize(db)
+      @db = db
+      unless Hotseat.queue?(@db)
+        @db.save_doc Hotseat.design_doc
+      end
+    end
+
+    def add(doc_id)
+      @db.update_doc(doc_id) {|doc| Queue.patch doc }
+    end
+
+    def add_bulk(doc_ids)
+      #Note: this silently ignores missing doc_ids
+      docs = @db.bulk_load(doc_ids)['rows'].map{|row| row['doc']}.compact
+      docs.each {|doc| Queue.patch doc }
+      @db.bulk_save docs, use_uuids=false
+    end
+
+    def num_pending
+      @db.view(Hotseat.pending_view_name, :limit => 0)['total_rows']
+    end
+    alias :size :num_pending
+
+    def get(n=1)
+      rows = @db.view(Hotseat.pending_view_name, :limit => n, :include_docs => true)['rows']
+      rows.map{|row| row['doc']} unless rows.empty?
+    end
+
+    def lease(n=1)
+      if docs = get(n)
+        docs.each {|doc| Queue.add_lock doc }
+        response = @db.bulk_save docs, use_uuids=false
+        # Some docs may have failed to lock - probably updated by another process
+        locked_ids = response.reject{|res| res['error']}.map{|res| res['id']}
+        if locked_ids.length < docs.length
+          # This runs in O(n^2) time. Performance will be bad here if the number of documents
+          # is very large. Assuming that this isn't normally the case I'm keeping it simple.
+          docs.keep_if{|doc| locked_ids.include? doc['_id']}
+        end
+        docs
+      end
+    end
+
+    def num_locked
+      @db.view(Hotseat.locked_view_name, :limit => 0)['total_rows']
+    end
+
+    def remove(doc_id, opts={})
+      @db.update_doc(doc_id) do |doc|
+        raise(QueueError, "Document was already removed") unless Queue.locked?(doc)
+        if opts.delete(:forget)
+          Queue.unpatch doc
+        else
+          Queue.mark_done( Queue.remove_lock( doc ) )
+        end
+      end
+    end
+
+    def remove_bulk(doc_ids, opts={})
+      rows = @db.bulk_load(doc_ids)['rows']
+      docs, missing = rows.partition {|row| row['doc'] }
+      docs.map! {|row| row['doc'] }
+      locked, unlocked = docs.partition {|doc| Queue.locked? doc }
+      forget = opts.delete(:forget)
+      locked.each do |doc|
+        if forget
+          Queue.unpatch doc
+        else
+          Queue.mark_done( Queue.remove_lock( doc ) )
+        end
+      end
+      @db.bulk_save locked, use_uuids=false
+      {'errors' =>
+        unlocked.map {|doc| {'id' => doc['_id'], 'error' => 'unlocked' } } +
+        missing.map {|row| {'id' => row['key'], 'error' => row['error']} }
+      }
+    end
+
+    def num_done
+      @db.view(Hotseat.done_view_name, :limit => 0)['total_rows']
+    end
+
+    def num_all
+      @db.view(Hotseat.all_view_name, :limit => 0)['total_rows']
+    end
+    alias :num_total :num_all
+
+    def forget(doc_id)
+      @db.update_doc(doc_id) do |doc|
+        Queue.unpatch doc
+      end
+    end
+
+    def forget_bulk(doc_ids)
+      #Note: this silently ignores missing doc_ids
+      docs = @db.bulk_load(doc_ids)['rows'].map{|row| row['doc']}.compact
+      docs.each {|doc| Queue.unpatch doc }
+      @db.bulk_save docs, use_uuids=false
+    end
+
+    def purge
+      rows = @db.view(Hotseat.all_view_name, :include_docs => true)['rows']
+      docs = rows.map{|row| row['doc']}
+      docs.each{|doc| Queue.unpatch doc }
+      @db.bulk_save docs, use_uuids=false
+    end
+
+  end
+end

data/lib/hotseat.rb

@@ -0,0 +1,2 @@
+require 'hotseat/queue'
+require 'hotseat/hotseat'

data/spec/hotseat/hotseat_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Hotseat
+
+  describe "#queue" do
+    it "should return a queue on the given database" do
+      reset_test_db!
+      q = Hotseat.queue DB
+      q.should be_instance_of Hotseat::Queue
+      Hotseat.queue?(DB).should be_true
+    end
+
+  end
+
+  describe "#queue?" do
+    it "should be true when a given database is a queue" do
+      reset_test_db!
+      Hotseat.queue DB
+      Hotseat.queue?(DB).should be_true
+    end
+
+    it "should be false when a given database is not a queue" do
+      reset_test_db!
+      Hotseat.queue?(DB).should be_false
+    end
+
+    it "should be false when a given database does not exist" do
+      delete_test_db!
+      Hotseat.queue?(DB).should be_false
+    end
+  end
+
+  describe "#queues" do
+    # not making sure that non-queues aren't returned since the host we test on
+    # may be have some non-testing (production) queues on it which we don't know about
+    it "should return a list of queues (database names) on the host" do
+      delete_test_db!
+      test_dbs = (1..3).map{|i| TEST_SERVER.database("#{TESTDB}#{i}") }
+      begin
+        test_dbs.each do |db|
+          db.create!
+          Hotseat.queue(db)
+        end
+        results = Hotseat.queues TEST_SERVER
+        test_dbs.each {|db| results.should include URI.unescape(db.name) }
+      ensure test_dbs.each{|db| db.delete! rescue nil } end
+    end
+  end
+
+end

data/spec/hotseat/queue_spec.rb

@@ -0,0 +1,394 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Hotseat
+  describe Queue do
+
+    ########################
+    ###  Helper methods  ###
+    ########################
+    def reset_test_queue!
+      reset_test_db!
+      @q = Hotseat.make_queue DB
+    end
+
+    def sample_doc(var=nil)
+      {:field => var || 'value' }
+    end
+
+    # Returns the new doc id's
+    def create_some_docs(n=3)
+      (1..n).map {|i| DB.save_doc(sample_doc(i))['id'] }
+    end
+
+    def enqueue(doc_ids)
+      @q.add_bulk doc_ids
+    end
+
+    describe "#initialize" do
+      it "should create a Hotseat design doc in the database if one does not exist" do
+        reset_test_db!
+        q = Hotseat::Queue.new(DB)
+        q.db.get(Hotseat.design_doc_id).should_not be_nil
+      end
+    end
+
+    describe "#patch" do
+      it "should add a queue object on a document" do
+        doc = sample_doc
+        Queue.patch doc
+        doc.should have_key(Hotseat.config[:object_name])
+      end
+
+      it "should return the patched document with original data intact" do
+        doc = Queue.patch sample_doc
+        sample_doc.each do |k,v|
+          doc[k].should == v
+        end
+      end
+    end
+
+    describe "#unpatch" do
+      it "should remove the queue object from a document" do
+        doc = Queue.unpatch( Queue.patch( sample_doc ) )
+        doc.should_not have_key(Hotseat.config[:object_name])
+      end
+    end
+    
+    describe "#add_lock" do
+      it "should add a lock object on a patched document" do
+        doc = Queue.add_lock( Queue.patch( sample_doc ) )
+        patch = doc[Hotseat.config[:object_name]]
+        patch.should have_key('lock')
+      end
+    end
+
+    describe "#remove_lock" do
+      before(:each) { @doc = Queue.remove_lock( Queue.add_lock( Queue.patch( sample_doc ) ) ) }
+      it "should remove a lock object added by #add_lock" do
+        patch = @doc[Hotseat.config[:object_name]]
+        patch.should_not have_key('lock')
+      end
+      it "should leave the queue patch intact" do
+        @doc.should have_key(Hotseat.config[:object_name])
+      end
+    end
+    
+    describe "#locked?" do
+      it "should be true for a locked document" do
+        doc = Queue.add_lock( Queue.patch( sample_doc ) )
+        Queue.locked?(doc).should be_true
+      end
+      it "should be false for a patched, but not locked document" do
+        doc = Queue.patch( sample_doc )
+        Queue.locked?(doc).should be_false
+      end
+      it "should be false for an unlocked document" do
+        doc = Queue.remove_lock( Queue.add_lock( Queue.patch( sample_doc ) ) )
+        Queue.locked?(doc).should be_false
+      end
+    end
+    
+    describe "#mark_done" do
+      before(:each) { @doc = Queue.mark_done( Queue.patch( sample_doc ) ) }
+      it "should leave the queue patch intact" do
+        @doc.should have_key(Hotseat.config[:object_name])
+      end
+      it "should add a 'done' object on a patched document" do
+        patch = @doc[Hotseat.config[:object_name]]
+        patch.should have_key('done')
+      end
+    end
+    
+    describe "#add" do
+      it "should add a document to the queue, given a doc id" do
+        reset_test_queue!
+        doc_id = DB.save_doc(sample_doc)['id']
+        @q.add doc_id
+        DB.get(doc_id).should have_key(Hotseat.config[:object_name])
+      end
+    end
+
+    describe "#add_bulk" do
+      it "should add multiple documents in bulk, given multiple doc ids" do
+        reset_test_queue!
+        doc_ids = create_some_docs
+        @q.add_bulk doc_ids
+        doc_ids.each do |doc_id|
+          DB.get(doc_id).should have_key(Hotseat.config[:object_name])
+        end
+      end
+    end
+
+    describe "#num_pending" do
+      it "should return the number of documents available for lease" do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+        @q.num_pending.should == 3
+      end
+    end
+
+    describe "#lease" do
+      before(:each) do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+      end
+
+      it "should return an array of queued documents" do
+        docs = @q.lease 2
+        docs.should_not be_nil
+        docs.should have(2).items
+        docs.each do |doc|
+          db_doc = DB.get(doc['_id'])
+          db_doc.should be_kind_of CouchRest::Document
+          db_doc.should have_key(Hotseat.config[:object_name])
+        end
+      end
+
+      it "should lock a pending document" do
+        doc_id = @q.lease.first['_id']
+        doc = DB.get(doc_id)
+        doc.should have_key(Hotseat.config[:object_name])
+        doc[Hotseat.config[:object_name]].should have_key('lock')
+      end
+
+      it "should lock and return up to the specified number of documents" do
+        ids = @q.lease 4
+        ids.should have(3).items
+      end
+    end
+
+    context "when no documents are pending" do
+      before(:each) { reset_test_queue! }
+
+      it "#lease should return nil" do
+        @q.lease.should be_nil
+      end
+
+      it "#get should return nil" do
+        @q.get.should be_nil
+      end
+
+      it "#num_pending should return zero" do
+        @q.num_pending.should be_zero
+      end
+    end
+
+    context "locked documents" do
+      before(:each) do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+      end
+
+      it "should not be pending" do
+        locked_id = @q.lease.first['_id']
+        pending_ids = @q.db.view(Hotseat.pending_view_name)['rows'].map{|row| row['id']}
+        pending_ids.should_not include(locked_id)
+      end
+
+      it "should be counted by #num_locked" do
+        @q.lease 2
+        @q.num_locked.should == 2
+      end
+    end
+
+    describe "#get" do
+      before(:each) do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+      end
+
+      it "should return an array of pending documents" do
+        docs = @q.get 2
+        docs.should_not be_nil
+        docs.should have(2).items
+        docs.each do |doc|
+          db_doc = DB.get(doc['_id'])
+          db_doc.should have_key(Hotseat.config[:object_name])
+        end
+      end
+
+      it "should not lock the documents it returns" do
+        doc_id = @q.get.first['_id']
+        doc = DB.get(doc_id)
+        doc.should have_key(Hotseat.config[:object_name])
+        doc[Hotseat.config[:object_name]].should_not have_key('lock')
+      end
+
+      it "should return up to the specified number of documents" do
+        docs = @q.get 4
+        docs.should have(3).items
+      end
+    end
+
+    describe "#remove" do
+      before(:each) do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+        @leased = @q.lease 2
+        @doc_id = @leased.first['_id']
+      end
+
+      it "should unlock a leased document" do
+        @q.remove @doc_id
+        doc = DB.get(@doc_id)
+        doc.should have_key(Hotseat.config[:object_name])
+        doc[Hotseat.config[:object_name]].should_not have_key('lock')
+      end
+
+      it "should remove a document from the queue" do
+        @q.remove @doc_id
+        pending_docs = @q.get 3 # ensure we get all remaining pending docs
+        pending_docs.map{|doc| doc['_id']}.should_not include(@doc_id)
+      end
+
+      it "should raise an error if the lock was already removed" do
+        doc = @leased.first
+        @q.remove @doc_id
+        expect {
+          @q.remove @doc_id
+        }.to raise_error(Hotseat::QueueError)
+      end
+
+      it "should raise an error if the document is missing from the database" do
+        doc_id = @leased.first['_id']
+        doc = @q.db.get(doc_id)
+        @q.db.delete_doc(doc)
+        expect {
+          @q.remove doc['_id']
+        }.to raise_error
+      end
+
+      it "should leave queue history in the document (mark as done) by default" do
+        @q.remove @doc_id
+        doc = DB.get(@doc_id)
+        doc.should have_key(Hotseat.config[:object_name])
+        doc[Hotseat.config[:object_name]].should have_key('done')
+      end
+
+      it "should delete queue history from the document when forget=true" do
+        @q.remove @doc_id, :forget => true
+        doc = DB.get(@doc_id)
+        doc.should_not have_key(Hotseat.config[:object_name])
+      end
+    end
+
+    describe "#remove_bulk" do
+      before(:each) do
+        reset_test_queue!
+        enqueue( create_some_docs(10) )
+        @leased = @q.lease 8
+        @doc_ids = @leased.take(5).map{|doc| doc['_id'] }
+      end
+
+      it "should unlock leased documents" do
+        @q.remove_bulk @doc_ids
+        docs = DB.get_bulk(@doc_ids)['rows'].map{|row| row['doc']}
+        docs.each do |doc|
+          doc.should have_key(Hotseat.config[:object_name])
+          doc[Hotseat.config[:object_name]].should_not have_key('lock')
+        end
+      end
+
+      it "should remove multiple documents from the queue" do
+        @q.remove_bulk @doc_ids
+        pending_docs = @q.get 3 # ensure we get all remaining pending docs
+        pending_ids = pending_docs.map{|doc| doc['_id'] }
+        (pending_ids - @doc_ids).should eql(pending_ids)
+      end
+
+      it "should report docs whose lock was already removed" do
+        rem_ids = @doc_ids.take(2)
+        @q.remove_bulk rem_ids
+        res = @q.remove_bulk @doc_ids
+        res['errors'].should have(2).errors
+        res['errors'].map{|err| err['id']}.should == rem_ids
+      end
+
+      it "should report docs that are missing from the database" do
+        rem_ids = @doc_ids.take(2)
+        docs = rem_ids.map{|id| @q.db.get(id) }
+        docs.each {|doc| @q.db.delete_doc(doc) }
+        res = @q.remove_bulk @doc_ids
+        res['errors'].should have(2).errors
+        res['errors'].map{|err| err['id']}.should == rem_ids
+      end
+
+      it "should leave queue history in the document (mark as done) by default" do
+        @q.remove_bulk @doc_ids
+        docs = DB.get_bulk(@doc_ids)['rows'].map{|row| row['doc']}
+        docs.each do |doc|
+          doc.should have_key(Hotseat.config[:object_name])
+          doc[Hotseat.config[:object_name]].should have_key('done')
+        end
+      end
+
+      it "should delete queue history from the document when forget=true" do
+        @q.remove_bulk @doc_ids, :forget => true
+        docs = DB.get_bulk(@doc_ids)['rows'].map{|row| row['doc']}
+        docs.each do |doc|
+          doc.should_not have_key(Hotseat.config[:object_name])
+        end
+      end
+    end
+
+    describe "#num_done" do
+      it "should return the number of documents done" do
+        reset_test_queue!
+        enqueue( create_some_docs(10) )
+        @leased = @q.lease 8
+        @doc_ids = @leased.take(5).map{|doc| doc['_id'] }
+        @q.remove_bulk @doc_ids
+        @q.num_done.should == 5
+      end
+    end
+
+    describe "#num_all" do
+      it "should return the total number of documents in the queue" do
+        reset_test_queue!
+        enqueue( create_some_docs(10) )
+        @leased = @q.lease 8
+        @doc_ids = @leased.take(5).map{|doc| doc['_id'] }
+        @q.remove_bulk @doc_ids
+        @q.num_all.should == 10
+      end
+    end
+
+    describe "#forget" do
+      it "should delete queue history from a document" do
+        reset_test_queue!
+        enqueue( create_some_docs(1) )
+        doc_id = @q.get.first['_id']
+        @q.forget doc_id
+        doc = DB.get(doc_id)
+        doc.should_not have_key(Hotseat.config[:object_name])
+      end
+    end
+
+    describe "#forget_bulk" do
+      it "should delete queue history from multiple document" do
+        reset_test_queue!
+        enqueue( create_some_docs(3) )
+        doc_ids = @q.get(3).map{|doc| doc['_id'] }
+        @q.forget_bulk doc_ids
+        @q.db.bulk_load(doc_ids)['rows'].map{|row| row['doc']}.each do |doc|
+          doc.should_not have_key(Hotseat.config[:object_name])
+        end
+      end
+    end
+
+    describe "#purge" do
+      before do
+        reset_test_queue!
+        enqueue( create_some_docs(10) )
+        leased = @q.lease 5
+        @q.remove_bulk leased.take(2)
+      end
+
+      it "should remove (and forget) all documents from the queue" do
+        @q.purge
+        @q.num_all.should == 0
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :test)
+require 'simplecov'
+SimpleCov.start
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'hotseat'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# copied and modified from https://github.com/couchrest/couchrest/blob/master/spec/spec_helper.rb
+unless defined?(TESTDB)
+  COUCHHOST = ENV['COUCHHOST'] || "http://127.0.0.1:5984"
+  TESTDB = "hotseat%2Ftest"
+  TEST_SERVER = CouchRest.new COUCHHOST
+  TEST_SERVER.default_database = TESTDB
+  DB = TEST_SERVER.database(TESTDB)
+end
+
+def reset_test_db!
+  DB.recreate! rescue nil
+  DB
+end
+
+def delete_test_db!
+  DB.delete! rescue nil
+end
+
+def clean_up_test_dbs
+  cr = TEST_SERVER
+  test_dbs = cr.databases.select { |db| db =~ /^#{URI.unescape(TESTDB)}/ }
+  test_dbs.each do |db|
+    cr.database(db).delete! rescue nil
+  end
+end
+
+RSpec.configure do |config|
+  config.after(:all) do
+    clean_up_test_dbs
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: hotseat
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Elad Kehat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  requirement: &76166650 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *76166650
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &76165700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76165700
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &76165210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76165210
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &76160770 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76160770
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &76160430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76160430
+description: 
+email: eladkehat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- hotseat.gemspec
+- lib/hotseat.rb
+- lib/hotseat/hotseat.rb
+- lib/hotseat/queue.rb
+- spec/hotseat/hotseat_spec.rb
+- spec/hotseat/queue_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/eladkehat/hotseat
+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: -1003361075
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Add work queue functionality to an existing CouchDB database
+test_files: []