sunspot-queue 0.9.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Gaffney
+
+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,26 @@
+# sunspot-queue
+
+Background search indexing using existing worker systems.
+
+## Install
+
+    $ gem install sunspot-queue
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Add tests to show the problem or test your feature
+* Make your feature addition or bug fix.
+* Send me a pull request. Bonus points for topic branches.
+
+Please don't make changes to the Rakefile, version, or history. 
+
+## Development
+
+    $ gem install bundler (if you don't have it)
+    $ bundle install
+    $ guard
+
+## Copyright
+
+See LICENSE for details.

data/lib/sunspot-queue.rb

@@ -0,0 +1 @@
+require "sunspot/queue"

data/lib/sunspot/queue.rb

@@ -0,0 +1,12 @@
+module Sunspot
+  module Queue
+    class Error < StandardError; end
+    class NotPersistedError < Error; end
+
+    VERSION = "0.9.0"
+  end
+end
+
+require "sunspot/queue/session_proxy"
+require "sunspot/queue/index_job"
+require "sunspot/queue/removal_job"

data/lib/sunspot/queue/helpers.rb

@@ -0,0 +1,23 @@
+require "sunspot/queue/session_proxy"
+
+module Sunspot::Queue
+  module Helpers
+    def without_proxy
+      # Pop off the queueing proxy for the block if it's in place so we don't
+      # requeue the same job multiple times.
+      if Sunspot.session.instance_of?(SessionProxy)
+        proxy = Sunspot.session
+        Sunspot.session = proxy.session
+
+        begin
+          yield
+        ensure
+          Sunspot.commit rescue nil
+          Sunspot.session = proxy
+        end
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/sunspot/queue/index_job.rb

@@ -0,0 +1,19 @@
+require "sunspot/queue/helpers"
+
+module Sunspot::Queue
+  class IndexJob
+    extend Helpers
+
+    def self.queue
+      :sunspot
+    end
+
+    def self.perform(klass, id)
+      without_proxy do
+        record = ::Resque.constantize(klass).find(id)
+
+        Sunspot.index!(record)
+      end
+    end
+  end
+end

data/lib/sunspot/queue/removal_job.rb

@@ -0,0 +1,17 @@
+require "sunspot/queue/helpers"
+
+module Sunspot::Queue
+  class RemovalJob
+    extend Helpers
+
+    def self.queue
+      :sunspot
+    end
+
+    def self.perform(klass, id)
+      without_proxy do
+        ::Sunspot.remove_by_id(klass, id)
+      end
+    end
+  end
+end

data/lib/sunspot/queue/session_proxy.rb

@@ -0,0 +1,110 @@
+require "resque"
+require "sunspot/queue/index_job"
+require "sunspot/queue/removal_job"
+
+module Sunspot::Queue
+  class SessionProxy
+    attr_reader :session
+
+    def initialize(session)
+      @session = session
+    end
+
+    def index(*objects)
+      objects.flatten!
+
+      if !objects.all?(&:persisted?)
+        raise NotPersistedError.new("Cannot index records that have not been saved")
+      end
+
+      objects.each do |object|
+        ::Resque.enqueue(IndexJob, object.class.name, object.id)
+      end
+    end
+    alias :index! :index
+
+    def remove(*objects, &block)
+      if block
+        # Delete by query not supported by queue, so send to server
+        session.remove(*objects, &block)
+      else
+        objects.flatten.each do |object|
+          # Remove cannot remove an object from Solr if it doesn't have an id.
+          # We're assuming if it doesn't have an id then it hasn't been
+          # 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)
+          end
+        end
+      end
+    end
+
+    def remove!(*objects, &block)
+      if block
+        # Delete by query not supported by queue, so send to server
+        session.remove!(*objects, &block)
+      else
+        remove(*objects)
+      end
+    end
+
+    # Enqueues a removal job based on class and id.
+    def remove_by_id(klass, id)
+      ::Resque.enqueue(RemovalJob, klass.to_s, id)
+    end
+    alias :remove_by_id! :remove_by_id
+
+    # The following are all delegated to session
+    def new_search(*args, &block)
+      session.new_search(*args, &block)
+    end
+
+    def search(*args, &block)
+      session.search(*args, &block)
+    end
+
+    def new_more_like_this(*args, &block)
+      session.new_more_like_this(*args, &block)
+    end
+
+    def more_like_this(*args, &block)
+      session.more_like_this(*args, &block)
+    end
+
+    def config
+      session.config
+    end
+
+    def remove_all(*args)
+      session.remove_all(*args)
+    end
+
+    def remove_all!(*args)
+      session.remove_all(*args)
+    end
+
+    # All of the following are are here to match API but don't make sense to be
+    # implemented
+    def batch
+      yield if block_given?
+    end
+
+    def commit
+    end
+
+    def commit_if_delete_dirty
+    end
+
+    def commit_if_dirty
+    end
+
+    def delete_dirty?
+      false
+    end
+
+    def dirty?
+      false
+    end
+  end
+end

data/spec/index_job_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Sunspot::Queue::IndexJob do
+  context "ActiveRecord" do
+    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)
+      end.to change { Person.search.hits.size }.by(1)
+
+      results = Person.search { fulltext "grandson" }.results
+      results.first.should == person
+    end
+
+    it "raises an error if the record could not be found" do
+      expect do
+        Sunspot::Queue::IndexJob.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
+      end.to_not change { Sunspot.session }
+    end
+  end
+end

data/spec/integration/indexing_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "sunspot/queue/helpers"
+
+describe "Queued Indexing" do
+  include Sunspot::Queue::Helpers
+
+  # Given an active record model
+  # When I save the model
+  # Then the record should not be in solr
+  #
+  # When resque jobs are run
+  # Then the record should be in solr
+  it "queues indexing of ActiveRecord models using resque" do
+    person = Person.create(:name => "Inigo Montoya")
+    Person.search.results.should be_empty
+
+    expect do
+      ResqueSpec.perform_all(:sunspot)
+    end.to change { Person.search.hits.size }.by(1)
+
+    results = Person.search { fulltext "Montoya" }.results
+    results.first.should == person
+  end
+
+  # Given an active record model that is in Solr
+  # When I destroy the model
+  # Then the record should be in solr
+  #
+  # When resque jobs are run
+  # Then the record should not be in solr
+  it "queues removal of ActiveRecord models using Resque" do
+    person = Person.create(:name => "Fezzik")
+    ResqueSpec.perform_all(:sunspot)
+    Person.search.hits.size.should == 1
+
+    expect do
+      person.destroy
+    end.to_not change { Person.search.hits.size }
+
+    expect do
+      ResqueSpec.perform_all(:sunspot)
+    end.to change { Person.search.hits.size }.by(-1)
+  end
+end

data/spec/removal_job_spec.rb

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

data/spec/session_proxy_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe Sunspot::Queue::SessionProxy do
+  let(:proxy) { Sunspot::Queue::SessionProxy.new(mock) }
+
+  context "#index" do
+    it "enqueues a single job for each class" do
+      people = 5.times.map do |i|
+        Person.create(:name => "#{i} of 5")
+      end
+
+      Resque.should_receive(:enqueue).with do |job, klass, id|
+        job.should == ::Sunspot::Queue::IndexJob
+        klass.should == "Person"
+      end.exactly(5).times
+
+      proxy.index(people)
+    end
+
+    it "handles an array of objects given to index" do
+      people = 2.times.map do |i|
+        Person.create(:name => "Clone ##{i}")
+      end
+
+      Resque.should_receive(:enqueue).exactly(2).times
+
+      proxy.index(people)
+    end
+
+    it "handles a single object being enqueued" do
+      person = Person.create(:name => "Buttercup")
+
+      Resque.should_receive(:enqueue).with do |_,_,id|
+        id.should == person.id
+      end
+
+      proxy.index(person)
+    end
+
+    it "raises an error if object is not persisted" do
+      person = Person.new(:name => "Vizzini")
+
+      expect do
+        proxy.index(person)
+      end.to raise_error(Sunspot::Queue::NotPersistedError)
+    end
+
+    it "raises an error if one of a set is not persisted" do
+      people = 5.times.map do |i|
+        Person.new(:name => "Minion ##{i}")
+      end
+
+      # This will leave 1 person not saved to the database
+      4.times { |i| people[i].save }
+
+      expect do
+        proxy.index(people)
+      end.to raise_error(Sunspot::Queue::NotPersistedError)
+    end
+
+    it "does not process any records if one is not persisted" do
+      people = 2.times.map { |i| Person.new(:name => i) }
+      people.first.save
+
+      Resque.should_not_receive(:enqueue)
+      expect do
+        proxy.index(people)
+      end.to raise_error(Sunspot::Queue::NotPersistedError)
+    end
+  end
+
+  context "#remove" do
+    it "enqueues a single job for each class" do
+      people = 5.times.map do |i|
+        Person.create(:name => "#{i} of 5")
+      end
+
+      Resque.should_receive(:enqueue).with do |job, klass, id|
+        job.should == ::Sunspot::Queue::RemovalJob
+        klass.should == "Person"
+      end.exactly(5).times
+
+      proxy.remove(people)
+    end
+
+    it "handles an array of objects" do
+      people = 2.times.map do |i|
+        Person.create(:name => "Clone ##{i}")
+      end
+
+      Resque.should_receive(:enqueue).exactly(2).times
+
+      proxy.remove(people)
+    end
+
+    it "handles a single object" do
+      person = Person.create(:name => "Buttercup")
+
+      Resque.should_receive(:enqueue).with do |job, _, id|
+        job.should == ::Sunspot::Queue::RemovalJob
+        id.should == person.id
+      end
+
+      proxy.remove(person)
+    end
+
+    it "silently ignores records that do not have an id" do
+      people = 2.times.map { |i| Person.new(:name => "Thing #{i}") }
+      people.first.save
+
+      Resque.should_receive(:enqueue).once
+
+      proxy.remove(people)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,72 @@
+require "sunspot/queue"
+
+require "socket"
+require "active_record"
+require "sunspot"
+require "sunspot/rails"
+require "sunspot/solr/server"
+require "resque_spec"
+
+# Configure ActiveRecord and Sunspot to work with ActiveRecord
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  create_table :people, :force => true do |t|
+    t.string :name
+  end
+end
+
+# Pulled from the sunspot_rails Rails 3 railtie
+Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
+Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)
+
+class Person < ActiveRecord::Base
+  include Sunspot::Rails::Searchable
+
+  searchable do
+    text :name
+  end
+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
+
+  # Original sunspot session not wrapped in our proxy object
+  session = Sunspot.session
+
+  config.before(:each) do
+    session.remove_all!
+    ResqueSpec.reset!
+
+    Sunspot.session = Sunspot::Queue::SessionProxy.new(session)
+  end
+
+  # Configure Solr and run a server in the background for the duration of the
+  # tests.
+  config.before(:suite) do
+    solr_pid = fork do
+      STDERR.reopen("/dev/null")
+      STDOUT.reopen("/dev/null")
+
+      server = Sunspot::Solr::Server.new
+      server.run
+    end
+
+    at_exit { Process.kill("TERM", solr_pid) }
+
+    # Wait for up to 5 seconds for Solr to boot
+    10.times do
+      begin
+        TCPSocket.new("localhost", 8983)
+        break
+      rescue
+        sleep 0.5
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: sunspot-queue
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Gaffney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  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: 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: 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
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  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: sunspot_solr
+  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: sqlite3
+  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: activerecord
+  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: guard
+  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: guard-rspec
+  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: guard-bundler
+  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'
+description: 
+email:
+- gaffneyc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sunspot/queue/helpers.rb
+- lib/sunspot/queue/index_job.rb
+- lib/sunspot/queue/removal_job.rb
+- lib/sunspot/queue/session_proxy.rb
+- lib/sunspot/queue.rb
+- lib/sunspot-queue.rb
+- spec/index_job_spec.rb
+- spec/integration/indexing_spec.rb
+- spec/removal_job_spec.rb
+- spec/session_proxy_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+homepage: https://github.com/gaffneyc/sunspot-queue
+licenses: []
+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: -3459963560005130599
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3459963560005130599
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Background search indexing using existing worker systems.
+test_files: []