sunspot-queue 0.9.1 → 0.10.0

data/History.md

@@ -0,0 +1,14 @@
+# Sunspot Queue Changelog
+
+## 0.10.0
+* Sidekiq support
+* SessionProxy now takes a backend as a second required option
+* Sunspot::Queue::Resque::Backend is the backend for Resque
+* Sunspot::Queue::Sidekiq::Backend is the backend for Sidekiq
+
+## 0.9.1
+* Jobs no longer auto commit the solr index. Commits should be done by another process or
+  Solr should be configured handle commits automatically (autoCommit config option).
+
+## 0.9.0
+* Initial Release

data/README.md

@@ -1,25 +1,88 @@
-# sunspot-queue
+# sunspot-queue [![Build Status](https://secure.travis-ci.org/gaffneyc/sunspot-queue.png?branch=master)](http://travis-ci.org/gaffneyc/sunspot-queue)
 
 Background search indexing using existing worker systems.
 
 ## Install
 
-    $ gem install sunspot-queue
+```console
+$ gem install sunspot-queue
+```
 
-## Usage with Rails (or without)
+## Usage with Rails and Resque
 
 In your Gemfile
 
-    gem "sunspot-queue"
-    gem "resque"
+```ruby
+gem "sunspot-queue"
+gem "resque"
+```
 
 In config/initializers/sunspot.rb
 
-    Sunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session)
+```ruby
+require "sunspot/queue/resque"
+backend = Sunspot::Queue::Resque::Backend.new
+Sunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)
+```
 
 Start Resque
 
-    $ QUEUE=sunspot rake resque:work
+```console
+$ QUEUE=sunspot rake resque:work
+```
+
+## Usage with Rails and Sidekiq
+
+In your Gemfile
+
+```ruby
+gem "sunspot-queue"
+gem "sidekiq"
+```
+
+In config/initializers/sunspot.rb
+
+```ruby
+require "sunspot/queue/sidekiq"
+backend = Sunspot::Queue::Sidekiq::Backend.new
+Sunspot.session = Sunspot::Queue::SessionProxy.new(Sunspot.session, backend)
+```
+
+Start Sidekiq
+
+```console
+$ sidekiq -q sunspot
+```
+
+## Configuring Sunspot Queue
+
+In config/initializers/sunspot.rb
+
+```ruby
+Sunspot::Queue.configure do |config|
+  # Override default job classes
+  config.index_job   = CustomIndexJob
+  config.removal_job = CustomRemovalJob
+end
+```
+
+## Configuring Auto Commit
+
+The sunspot-queue jobs update the Solr index but those changes don't appear in
+search results until Solr commits those changes. Solr supports automatically
+commiting changes based on either the number of changes and / or time between
+commits.
+
+Add (or uncomment) the following in solrconfig.xml
+
+```xml
+<autoCommit>
+  <maxDocs>10000</maxDocs>
+  <maxTime>30000</maxTime>
+</autoCommit>
+```
+
+See [Solr's documentation](http://wiki.apache.org/solr/SolrConfigXml#Update_Handler_Section) for more information.
 
 ## Note on Patches/Pull Requests
 
@@ -32,9 +95,11 @@ Please don't make changes to the Rakefile, version, or history.
 
 ## Development
 
-    $ gem install bundler (if you don't have it)
-    $ bundle install
-    $ guard
+```console
+$ gem install bundler
+$ bundle
+$ guard
+```
 
 ## Copyright
 

data/lib/sunspot/queue.rb

@@ -2,10 +2,17 @@ module Sunspot
   module Queue
     class Error < StandardError; end
     class NotPersistedError < Error; end
+
+    def self.configure(&blk)
+      yield configuration
+    end
+
+    def self.configuration
+      @configuration ||= Sunspot::Queue::Configuration.new
+    end
   end
 end
 
 require "sunspot/queue/version"
+require "sunspot/queue/configuration"
 require "sunspot/queue/session_proxy"
-require "sunspot/queue/index_job"
-require "sunspot/queue/removal_job"

data/lib/sunspot/queue/configuration.rb

@@ -0,0 +1,5 @@
+module Sunspot::Queue
+  class Configuration
+    attr_accessor :index_job, :removal_job
+  end
+end

data/lib/sunspot/queue/helpers.rb

@@ -16,5 +16,16 @@ module Sunspot::Queue
     ensure
       Sunspot.session = proxy if proxy
     end
+
+    def constantize(klass)
+      names = klass.to_s.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
   end
 end

data/lib/sunspot/queue/inline.rb

@@ -0,0 +1,5 @@
+module Sunspot::Queue
+  module Inline
+    require "sunspot/queue/inline/backend"
+  end
+end

data/lib/sunspot/queue/inline/backend.rb

@@ -0,0 +1,20 @@
+require "sunspot/queue/inline"
+require "sunspot/queue/helpers"
+
+module Sunspot::Queue::Inline
+  class Backend
+    include ::Sunspot::Queue::Helpers
+
+    def index(klass, id)
+      without_proxy do
+        constantize(klass).find(id).solr_index
+      end
+    end
+
+    def remove(klass, id)
+      without_proxy do
+        ::Sunspot.remove_by_id(klass, id)
+      end
+    end
+  end
+end

data/lib/sunspot/queue/resque.rb

@@ -0,0 +1,13 @@
+require "sunspot/queue"
+
+module Sunspot::Queue
+  module Resque
+    require "sunspot/queue/resque/backend"
+    require "sunspot/queue/resque/index_job"
+    require "sunspot/queue/resque/removal_job"
+  end
+end
+
+# Backwards compatability with 0.9.x. Will be removed by 1.0 / 0.11.
+::Sunspot::Queue::IndexJob   = ::Sunspot::Queue::Resque::IndexJob
+::Sunspot::Queue::RemovalJob = ::Sunspot::Queue::Resque::RemovalJob

data/lib/sunspot/queue/resque/backend.rb

@@ -0,0 +1,35 @@
+require "resque"
+require "sunspot/queue/resque/index_job"
+require "sunspot/queue/resque/removal_job"
+
+module Sunspot::Queue::Resque
+  class Backend
+    attr_reader :configuration
+
+    def initialize(configuration = Sunspot::Queue.configuration)
+      @configuration = configuration
+    end
+
+    def enqueue(job, klass, id)
+      ::Resque.enqueue(job, klass, id)
+    end
+
+    def index(klass, id)
+      enqueue(index_job, klass, id)
+    end
+
+    def remove(klass, id)
+      enqueue(removal_job, klass, id)
+    end
+
+    private
+
+    def index_job
+      configuration.index_job || ::Sunspot::Queue::Resque::IndexJob
+    end
+
+    def removal_job
+      configuration.removal_job || ::Sunspot::Queue::Resque::RemovalJob
+    end
+  end
+end

data/lib/sunspot/queue/{index_job.rb → resque/index_job.rb}

@@ -1,8 +1,8 @@
 require "sunspot/queue/helpers"
 
-module Sunspot::Queue
+module Sunspot::Queue::Resque
   class IndexJob
-    extend Helpers
+    extend ::Sunspot::Queue::Helpers
 
     def self.queue
       :sunspot
@@ -10,7 +10,7 @@ module Sunspot::Queue
 
     def self.perform(klass, id)
       without_proxy do
-        ::Resque.constantize(klass).find(id).solr_index
+        constantize(klass).find(id).solr_index
       end
     end
   end

data/lib/sunspot/queue/{removal_job.rb → resque/removal_job.rb}

@@ -1,8 +1,8 @@
 require "sunspot/queue/helpers"
 
-module Sunspot::Queue
+module Sunspot::Queue::Resque
   class RemovalJob
-    extend Helpers
+    extend ::Sunspot::Queue::Helpers
 
     def self.queue
       :sunspot

data/lib/sunspot/queue/session_proxy.rb

@@ -1,13 +1,11 @@
-require "resque"
-require "sunspot/queue/index_job"
-require "sunspot/queue/removal_job"
-
 module Sunspot::Queue
   class SessionProxy
     attr_reader :session
+    attr_accessor :backend
 
-    def initialize(session)
+    def initialize(session, backend)
       @session = session
+      @backend = backend
     end
 
     def index(*objects)
@@ -18,7 +16,7 @@ module Sunspot::Queue
       end
 
       objects.each do |object|
-        ::Resque.enqueue(IndexJob, object.class.name, object.id)
+        @backend.index(object.class.name, object.id)
       end
     end
     alias :index! :index
@@ -34,7 +32,7 @@ module Sunspot::Queue
           # persisted and can safely be ignored since it shouldn't exist in the
           # search index.
           if object.id
-            ::Resque.enqueue(RemovalJob, object.class.name, object.id)
+            @backend.remove(object.class.name, object.id)
           end
         end
       end
@@ -51,7 +49,7 @@ module Sunspot::Queue
 
     # Enqueues a removal job based on class and id.
     def remove_by_id(klass, id)
-      ::Resque.enqueue(RemovalJob, klass.to_s, id)
+      @backend.remove(klass.to_s, id)
     end
     alias :remove_by_id! :remove_by_id
 

data/lib/sunspot/queue/sidekiq.rb

@@ -0,0 +1,9 @@
+require "sunspot/queue"
+
+module Sunspot::Queue
+  module Sidekiq
+    require "sunspot/queue/sidekiq/backend"
+    require "sunspot/queue/sidekiq/index_job"
+    require "sunspot/queue/sidekiq/removal_job"
+  end
+end

data/lib/sunspot/queue/sidekiq/backend.rb

@@ -0,0 +1,35 @@
+require "sunspot/queue/sidekiq/index_job"
+require "sunspot/queue/sidekiq/removal_job"
+
+module Sunspot::Queue::Sidekiq
+  class Backend
+    attr_reader :configuration
+
+    def initialize(configuration = Sunspot::Queue.configuration)
+      @configuration = configuration
+    end
+
+    # Job needs to include Sidekiq::Worker
+    def enqueue(job, klass, id)
+      job.perform_async(klass, id)
+    end
+
+    def index(klass, id)
+      index_job.perform_async(klass, id)
+    end
+
+    def remove(klass, id)
+      removal_job.perform_async(klass, id)
+    end
+
+    private
+
+    def index_job
+      configuration.index_job || ::Sunspot::Queue::Sidekiq::IndexJob
+    end
+
+    def removal_job
+      configuration.removal_job || ::Sunspot::Queue::Sidekiq::RemovalJob
+    end
+  end
+end

data/lib/sunspot/queue/sidekiq/index_job.rb

@@ -0,0 +1,16 @@
+require "sidekiq/worker"
+
+module Sunspot::Queue::Sidekiq
+  class IndexJob
+    include ::Sunspot::Queue::Helpers
+    include ::Sidekiq::Worker
+
+    sidekiq_options :queue => "sunspot"
+
+    def perform(klass, id)
+      without_proxy do
+        constantize(klass).find(id).solr_index
+      end
+    end
+  end
+end

data/lib/sunspot/queue/sidekiq/removal_job.rb

@@ -0,0 +1,16 @@
+require "sidekiq/worker"
+
+module Sunspot::Queue::Sidekiq
+  class RemovalJob
+    include ::Sunspot::Queue::Helpers
+    include ::Sidekiq::Worker
+
+    sidekiq_options :queue => "sunspot"
+
+    def perform(klass, id)
+      without_proxy do
+        ::Sunspot.remove_by_id(klass, id)
+      end
+    end
+  end
+end

data/lib/sunspot/queue/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Queue
-    VERSION = "0.9.1"
+    VERSION = "0.10.0"
   end
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Sunspot::Queue::Configuration do
+  subject(:configuration) { described_class.new }
+
+  describe "#index_job" do
+    it "defaults to nil" do
+      configuration.index_job.should be_nil
+    end
+
+    it "can be set to a custom job" do
+      expect {
+        configuration.index_job = "CustomIndexJob"
+      }.to change(configuration, :index_job).to("CustomIndexJob")
+    end
+  end
+
+  describe "#removal_job" do
+    it "defaults to nil" do
+      configuration.removal_job.should be_nil
+    end
+
+    it "can be set to a custom job" do
+      expect do
+        configuration.removal_job = "CustomRemovalJob"
+      end.to change(configuration, :removal_job).to("CustomRemovalJob")
+    end
+  end
+end

data/spec/inline/backend_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require "sunspot/queue/inline"
+
+describe Sunspot::Queue::Inline::Backend, :backend => :inline do
+  it "indexes the class inline" do
+    expect do
+      Person.create(:name => "Steven Seagal")
+      commit
+    end.to change { Person.search.hits.size }.by(1)
+  end
+
+  it "removes the class inline" do
+    chuck = Person.create(:name => "Chuck Norris")
+    commit
+
+    expect do
+      chuck.destroy
+      commit
+    end.to change { Person.search.hits.size }.by(-1)
+  end
+end

data/spec/integration/indexing_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "Queued Indexing" do
+describe "Queued Indexing", :backend => :resque do
   # Given an active record model
   # When I save the model
   # Then the record should not be in solr

data/spec/integration/sidekiq_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe "Sidekiq Integration", :backend => :sidekiq do
+  let(:index_job)   { Sunspot::Queue::Sidekiq::IndexJob }
+  let(:removal_job) { Sunspot::Queue::Sidekiq::RemovalJob }
+
+  #
+  it "queues indexing on creation and update" do
+    jimmy = Person.create(:name => "Jimmy Olson")
+
+    index_job.jobs.size.should == 1
+    index_job.perform_work
+    commit
+
+    Person.search { fulltext "Olson" }.hits.size.should == 1
+
+    jimmy.update_attribute(:name, "James Bartholomew Olsen")
+    index_job.jobs.size.should == 1
+    index_job.perform_work
+    commit
+
+    Person.search { fulltext "Bartholomew" }.hits.size.should == 1
+  end
+
+  it "queues removal on destroy" do
+    pinky =
+      without_proxy do
+        Person.create(:name => "Pinky the Whiz Kid")
+      end
+    commit
+
+    Person.search.hits.size.should == 1
+
+    pinky.destroy
+    removal_job.jobs.size.should == 1
+    removal_job.perform_work
+    commit
+
+    Person.search.hits.size.should == 0
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Sunspot::Queue do
+
+  describe "#configuration" do
+    it "returns a default configuration" do
+      config = Sunspot::Queue.configuration
+      config.should be_kind_of(Sunspot::Queue::Configuration)
+    end
+
+    it "returns the same configuration when requested multiple times" do
+      config = Sunspot::Queue.configuration
+      Sunspot::Queue.configuration.should be(config)
+      Sunspot::Queue.configuration.should be(config)
+    end
+  end
+
+  describe "#configure(&blk)" do
+    it "yields the configuration to a block" do
+      config = Sunspot::Queue.configuration
+      expect do |blk|
+        Sunspot::Queue.configure(&blk)
+      end.to yield_with_args(config)
+    end
+  end
+
+end

data/spec/resque/backend_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Sunspot::Queue::Resque::Backend do
+
+  # Mock ResqueJob
+  class CustomResqueJob
+    @queue = :custom_queue
+
+    def perform(klass, id)
+    end
+  end
+
+  subject(:backend) { described_class.new(configuration) }
+
+  let(:configuration) { ::Sunspot::Queue::Configuration.new }
+
+  describe "#index" do
+    it "uses the index job set in the global configuration" do
+      configuration.index_job = CustomResqueJob
+
+      expect do
+        backend.index(Person, 3)
+      end.to change { ResqueSpec.queue_for(CustomResqueJob).size }.by(1)
+    end
+
+    it "uses the default index job if one is not configured" do
+      expect do
+        backend.index(Person, 12)
+      end.to change { ResqueSpec.queue_for(Sunspot::Queue::Resque::IndexJob).size }.by(1)
+    end
+  end
+
+  describe "#remove" do
+    it "uses the removal job set in the global configuration" do
+      configuration.removal_job = CustomResqueJob
+
+      expect do
+        backend.remove(Person, 3)
+      end.to change { ResqueSpec.queue_for(CustomResqueJob).size }.by(1)
+    end
+
+    it "uses the default index job if one is not configured" do
+      expect do
+        backend.remove(Person, 12)
+      end.to change { ResqueSpec.queue_for(Sunspot::Queue::Resque::RemovalJob).size }.by(1)
+    end
+  end
+end

data/spec/{index_job_spec.rb → resque/index_job_spec.rb}

@@ -1,13 +1,19 @@
 require "spec_helper"
 
-describe Sunspot::Queue::IndexJob do
+describe Sunspot::Queue::Resque::IndexJob do
+  it "is linked to Sunspot::Queue::IndexJob for backwards compatibility" do
+    ::Sunspot::Queue::IndexJob.should == ::Sunspot::Queue::Resque::IndexJob
+  end
+
   context "ActiveRecord" do
+    let(:job) { Sunspot::Queue::Resque::IndexJob }
+
     it "indexes an ActiveRecord model" do
       # This will queue a job but we'll just ignore it to isolate the job
       person = Person.create(:name => "The Grandson")
 
       expect do
-        Sunspot::Queue::IndexJob.perform(Person, person.id)
+        job.perform(Person, person.id)
         commit
       end.to change { Person.search.hits.size }.by(1)
 
@@ -17,13 +23,13 @@ describe Sunspot::Queue::IndexJob do
 
     it "raises an error if the record could not be found" do
       expect do
-        Sunspot::Queue::IndexJob.perform(Person, 404)
+        job.perform(Person, 404)
       end.to raise_error(ActiveRecord::RecordNotFound)
     end
 
     it "maintains the existing proxy if there was an error" do
       expect do
-        Sunspot::Queue::IndexJob.perform(Person, 404) rescue nil
+        job.perform(Person, 404) rescue nil
       end.to_not change { Sunspot.session }
     end
 
@@ -31,7 +37,7 @@ describe Sunspot::Queue::IndexJob do
       person = Person.create(:name => "The Grandson")
 
       expect do
-        Sunspot::Queue::IndexJob.perform(Person, person.id)
+        job.perform(Person, person.id)
       end.to_not change { Person.search.hits.size }
 
       expect do

data/spec/resque/removal_job_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "sunspot/queue/resque"
+require "sunspot/queue/helpers"
+
+describe Sunspot::Queue::Resque::RemovalJob do
+  let(:job) { Sunspot::Queue::Resque::RemovalJob }
+
+  it "is linked to Sunspot::Queue::IndexJob for backwards compatibility" do
+    ::Sunspot::Queue::RemovalJob.should == ::Sunspot::Queue::Resque::RemovalJob
+  end
+
+  it "removes a job from the search index" do
+    person =
+      without_proxy do
+        Person.create(:name => "The Albino")
+      end
+    commit
+
+    Person.search.hits.size.should == 1
+
+    expect do
+      job.perform(Person, person.id)
+      commit
+    end.to change { Person.search.hits.size }.by(-1)
+  end
+end

data/spec/session_proxy_spec.rb

@@ -1,7 +1,8 @@
 require "spec_helper"
 
 describe Sunspot::Queue::SessionProxy do
-  let(:proxy) { Sunspot::Queue::SessionProxy.new(mock) }
+  let(:backend) { mock }
+  let(:proxy)   { Sunspot::Queue::SessionProxy.new(mock, backend) }
 
   context "#index" do
     it "enqueues a single job for each class" do
@@ -9,8 +10,7 @@ describe Sunspot::Queue::SessionProxy do
         Person.create(:name => "#{i} of 5")
       end
 
-      Resque.should_receive(:enqueue).with do |job, klass, id|
-        job.should == ::Sunspot::Queue::IndexJob
+      backend.should_receive(:index).with do |klass, _|
         klass.should == "Person"
       end.exactly(5).times
 
@@ -22,7 +22,7 @@ describe Sunspot::Queue::SessionProxy do
         Person.create(:name => "Clone ##{i}")
       end
 
-      Resque.should_receive(:enqueue).exactly(2).times
+      backend.should_receive(:index).exactly(2).times
 
       proxy.index(people)
     end
@@ -30,7 +30,7 @@ describe Sunspot::Queue::SessionProxy do
     it "handles a single object being enqueued" do
       person = Person.create(:name => "Buttercup")
 
-      Resque.should_receive(:enqueue).with do |_,_,id|
+      backend.should_receive(:index).with do |_, id|
         id.should == person.id
       end
 
@@ -62,7 +62,8 @@ describe Sunspot::Queue::SessionProxy do
       people = 2.times.map { |i| Person.new(:name => i) }
       people.first.save
 
-      Resque.should_not_receive(:enqueue)
+      backend.should_not_receive(:index)
+
       expect do
         proxy.index(people)
       end.to raise_error(Sunspot::Queue::NotPersistedError)
@@ -75,8 +76,7 @@ describe Sunspot::Queue::SessionProxy do
         Person.create(:name => "#{i} of 5")
       end
 
-      Resque.should_receive(:enqueue).with do |job, klass, id|
-        job.should == ::Sunspot::Queue::RemovalJob
+      backend.should_receive(:remove).with do |klass, id|
         klass.should == "Person"
       end.exactly(5).times
 
@@ -88,7 +88,7 @@ describe Sunspot::Queue::SessionProxy do
         Person.create(:name => "Clone ##{i}")
       end
 
-      Resque.should_receive(:enqueue).exactly(2).times
+      backend.should_receive(:remove).exactly(2).times
 
       proxy.remove(people)
     end
@@ -96,8 +96,7 @@ describe Sunspot::Queue::SessionProxy do
     it "handles a single object" do
       person = Person.create(:name => "Buttercup")
 
-      Resque.should_receive(:enqueue).with do |job, _, id|
-        job.should == ::Sunspot::Queue::RemovalJob
+      backend.should_receive(:remove).with do |_, id|
         id.should == person.id
       end
 
@@ -108,7 +107,7 @@ describe Sunspot::Queue::SessionProxy do
       people = 2.times.map { |i| Person.new(:name => "Thing #{i}") }
       people.first.save
 
-      Resque.should_receive(:enqueue).once
+      backend.should_receive(:remove).once
 
       proxy.remove(people)
     end

data/spec/sidekiq/backend_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Sunspot::Queue::Sidekiq::Backend do
+
+  # Mock SidekiqJob
+  class CustomSidekiqJob
+    include ::Sidekiq::Worker
+
+    def perform(klass, id)
+    end
+  end
+
+  subject(:backend) { described_class.new(configuration) }
+
+  let(:configuration) { ::Sunspot::Queue::Configuration.new }
+
+  describe "#index" do
+    it "uses the index job set in the global configuration" do
+      configuration.index_job = CustomSidekiqJob
+
+      expect do
+        backend.index(Person, 9)
+      end.to change { CustomSidekiqJob.jobs.size }.by(1)
+    end
+
+    it "uses the default index job if one is not configured" do
+      expect do
+        backend.index(Person, 11)
+      end.to change { ::Sunspot::Queue::Sidekiq::IndexJob.jobs.size }.by(1)
+    end
+  end
+
+  describe "#remove" do
+    it "uses the removal job set in the global configuration" do
+      configuration.removal_job = CustomSidekiqJob
+
+      expect do
+        backend.remove(Person, 11)
+      end.to change { CustomSidekiqJob.jobs.size }.by(1)
+    end
+
+    it "uses the default removal job if one is not configured" do
+      expect do
+        backend.remove(Person, 11)
+      end.to change { ::Sunspot::Queue::Sidekiq::RemovalJob.jobs.size }.by(1)
+    end
+  end
+end

data/spec/sidekiq/index_job_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Sunspot::Queue::Sidekiq::IndexJob do
+  context "ActiveRecord" do
+    let(:job) { Sunspot::Queue::Sidekiq::IndexJob.new }
+
+    it "index an ActiveRecord model" do
+      person = Person.create(:name => "Dum Dum Dugen")
+
+      expect do
+        job.perform(Person, person.id)
+        commit
+      end.to change { Person.search.hits.size }.by(1)
+    end
+
+    it "raises an error if the record could not be found" do
+      expect do
+        job.perform(Person, 404)
+      end.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "maintains the existing proxy if there was an error" do
+      expect do
+        job.perform(Person, 404) rescue nil
+      end.to_not change { Sunspot.session }
+    end
+
+    it "does not commit changes to the index" do
+      person = Person.create(:name => "Kato")
+
+      expect do
+        job.perform(Person, person.id)
+      end.to_not change { Person.search.hits.size }
+
+      expect do
+        commit
+      end.to change { Person.search.hits.size }
+    end
+  end
+end

data/spec/sidekiq/removal_job.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Sunspot::Queue::Sidekiq::RemovalJob do
+  let(:job) { Sunspot::Queue::Sidekiq::RemovalJob.new }
+
+  it "removes a job from the search index" do
+    person = Person.create(:name => "James 'Bucky' Barnes")
+    commit
+
+    Person.search.hits.size.should == 1
+
+    expect do
+      job.perform(Person, person.id)
+      commit
+    end.to change { Person.search.hits.size }.by(-1)
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,14 @@ require "sunspot/rails"
 require "sunspot/solr/server"
 require "resque_spec"
 
+# Neither is required when loading sunspot/queue
+require "sunspot/queue/resque"
+require "sunspot/queue/sidekiq"
+
+# Sidekiq
+require "sidekiq"
+require "sidekiq/testing"
+
 # Configure ActiveRecord and Sunspot to work with ActiveRecord
 ActiveRecord::Base.establish_connection(
   :adapter  => "sqlite3",
@@ -35,7 +43,11 @@ end
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  config.order = "random"
+
+  # Requires supporting ruby files with custom matchers and macros, etc,
+  # in spec/support/ and its subdirectories.
+  Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require(f) }
 
   config.include(Sunspot::Queue::Helpers)
   config.include(
@@ -49,11 +61,30 @@ RSpec.configure do |config|
   # Original sunspot session not wrapped in our proxy object
   session = Sunspot.session
 
+  # Clean up data between tests and reset the session
   config.before(:each) do
+    Sunspot.session = session
     session.remove_all!
+  end
+
+  config.before(:each, :backend => :resque) do
     ResqueSpec.reset!
 
-    Sunspot.session = Sunspot::Queue::SessionProxy.new(session)
+    backend = Sunspot::Queue::Resque::Backend.new
+    Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
+  end
+
+  config.before(:each, :backend => :sidekiq) do
+    Sidekiq::Worker.clear_all
+
+    require "sunspot/queue/sidekiq"
+    backend = Sunspot::Queue::Sidekiq::Backend.new
+    Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
+  end
+
+  config.before(:each, :backend => :inline) do
+    backend = Sunspot::Queue::Inline::Backend.new
+    Sunspot.session = Sunspot::Queue::SessionProxy.new(session, backend)
   end
 
   # Configure Solr and run a server in the background for the duration of the

data/spec/support/sidekiq.rb

@@ -0,0 +1,19 @@
+module Sidekiq
+    module Worker
+    module ClassMethods
+      def perform_work
+        if job = jobs.pop
+          self.new.perform(*Sidekiq.load_json(Sidekiq.dump_json(job["args"])))
+        end
+
+        true
+      end
+
+      def perform_all_the_work
+        while jobs.any?
+          perform_work
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot-queue
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sunspot_rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -19,7 +35,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,21 +44,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sunspot_rails
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: resque_spec
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +146,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +154,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +210,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sunspot/queue/configuration.rb
 - lib/sunspot/queue/helpers.rb
-- lib/sunspot/queue/index_job.rb
-- lib/sunspot/queue/removal_job.rb
+- lib/sunspot/queue/inline/backend.rb
+- lib/sunspot/queue/inline.rb
+- lib/sunspot/queue/resque/backend.rb
+- lib/sunspot/queue/resque/index_job.rb
+- lib/sunspot/queue/resque/removal_job.rb
+- lib/sunspot/queue/resque.rb
 - lib/sunspot/queue/session_proxy.rb
+- lib/sunspot/queue/sidekiq/backend.rb
+- lib/sunspot/queue/sidekiq/index_job.rb
+- lib/sunspot/queue/sidekiq/removal_job.rb
+- lib/sunspot/queue/sidekiq.rb
 - lib/sunspot/queue/version.rb
 - lib/sunspot/queue.rb
 - lib/sunspot-queue.rb
-- spec/index_job_spec.rb
+- spec/configuration_spec.rb
+- spec/inline/backend_spec.rb
 - spec/integration/indexing_spec.rb
-- spec/removal_job_spec.rb
+- spec/integration/sidekiq_spec.rb
+- spec/queue_spec.rb
+- spec/resque/backend_spec.rb
+- spec/resque/index_job_spec.rb
+- spec/resque/removal_job_spec.rb
 - spec/session_proxy_spec.rb
+- spec/sidekiq/backend_spec.rb
+- spec/sidekiq/index_job_spec.rb
+- spec/sidekiq/removal_job.rb
 - spec/spec_helper.rb
+- spec/support/sidekiq.rb
 - LICENSE
 - README.md
+- History.md
 homepage: https://github.com/gaffneyc/sunspot-queue
 licenses: []
 post_install_message: 
@@ -204,12 +255,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2557787847468836943
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2557787847468836943
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/spec/removal_job_spec.rb

@@ -1,20 +0,0 @@
-require "spec_helper"
-require "sunspot/queue/helpers"
-
-describe Sunspot::Queue::IndexJob do
-  it "removes a job from the search index" do
-    person = 
-      without_proxy do
-        Person.create(:name => "The Albino").tap do
-          commit
-        end
-      end
-
-    Person.search.hits.size.should == 1
-
-    expect do
-      Sunspot::Queue::RemovalJob.perform(Person, person.id)
-      commit
-    end.to change { Person.search.hits.size }.by(-1)
-  end
-end