delayed_sunspot 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anthony Smith
+
+MIT License
+
+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,69 @@
+# DelayedSunspot [![endorse](http://api.coderwall.com/anthonator/endorsecount.png)](http://coderwall.com/anthonator)
+
+Adds support for indexing objects asynchronously using [Sunspot](https://github.com/sunspot/sunspot) and [Delayed Job](https://github.com/collectiveidea/delayed_job).
+
+[![Build Status](https://secure.travis-ci.org/anthonator/delayed_sunspot.png)](http://travis-ci.org/anthonator/delayed_sunspot)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'delayed_sunspot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayed_sunspot
+
+## Usage
+
+You will need to configure Sunspot to use delayed_sunspot's session proxy in order to push Sunspot commands through Delayed Job.
+
+```ruby
+Sunspot.session = Sunspot::SessionProxy::DelayedJobSessionProxy.new(Sunspot.session)
+```
+
+If you're using Rails put the above line of code in an initializer.
+
+## ZOMG! WHY AREN'T MY OBJECTS BEING INDEXED?!
+
+If you're using the sunspot_rails gem you might have noticed that the objects you've been indexing aren't coming back in your search results. This is due to the sunspot_rails gem being configured to autocommit indexes through a controller hook. This functionality doesn't exist when indexing outside of a controller.
+
+You can enable autocommit by putting the following code in your solrconfig.xml under the updateHandler section:
+
+```xml
+<autoCommit>
+    <maxDocs>10000</maxDocs> <!-- maximum uncommited docs before autocommit triggered -->
+    <maxTime>15000</maxTime> <!-- maximum time (in MS) after adding a doc before an autocommit is triggered -->
+</autoCommit>
+```
+
+To find out more about autocommits [read the Solr documentation](http://wiki.apache.org/solr/SolrConfigXml#Update_Handler_Section)
+
+If you've already configured Solr for autocommits you're good to go.
+
+## Asynchronous Commands
+
+batch  
+commit  
+commit_if_delete_dirty  
+commit_if_dirty  
+index  
+index!  
+remove  
+remove!  
+remove_all  
+remove_all!  
+remove_by_id  
+remove_by_id!  
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+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

data/delayed_sunspot.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delayed_sunspot/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "delayed_sunspot"
+  gem.version       = DelayedSunspot::VERSION
+  gem.authors       = ["Anthony Smith"]
+  gem.email         = ["anthony@sticksnleaves.com"]
+  gem.description   = %q{Delayed Job support for Sunspot}
+  gem.summary       = %q{Toss your Sunspot Solr commits into a background job.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'sunspot'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sunspot_matchers'
+end

data/lib/delayed_sunspot.rb

@@ -0,0 +1,5 @@
+require 'sunspot'
+require 'delayed_sunspot/delayed_job/sunspot_job'
+require 'delayed_sunspot/sunspot/session_proxy/delayed_job_session_proxy'
+require 'delayed_sunspot/sunspot/configuration'
+require 'delayed_sunspot/version'

data/lib/delayed_sunspot/delayed_job/sunspot_job.rb

@@ -0,0 +1,24 @@
+module DelayedSunspot
+  module DelayedJob
+    class SunspotJob
+      attr_reader :session, :proxy, :method
+
+      def initialize(proxy, method, *args, &block)
+        @proxy = proxy
+        @session = proxy.session
+        @method = method
+        @args = args
+      end
+
+      def perform
+        rebuild_config
+        @args ? @session.send(method, *@args) : @session.send(method)
+      end
+
+      private
+      def rebuild_config
+        @session.instance_variable_set("@config", DelayedSunspot::Sunspot::Configuration.new(session.config))
+      end
+    end
+  end
+end

data/lib/delayed_sunspot/sunspot/configuration.rb

@@ -0,0 +1,25 @@
+module DelayedSunspot
+  module Sunspot
+    class Configuration
+      def initialize(config)
+        @config = config
+        singleton = (class <<self; self; end)
+        @properties = @config.instance_variable_get("@properties") || {}
+        @properties.keys.each do |key|
+          singleton.module_eval do
+            define_method key do
+              if @properties[key].is_a?(LightConfig::Configuration)
+                self.class.new(@properties[key])
+              else
+                @properties[key]
+              end
+            end
+            define_method "#{key}=" do |value|
+              @properties[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delayed_sunspot/sunspot/session_proxy/delayed_job_session_proxy.rb

@@ -0,0 +1,72 @@
+module Sunspot
+  module SessionProxy
+    class DelayedJobSessionProxy < ::Sunspot::SessionProxy::AbstractSessionProxy
+      attr_reader :session
+
+      delegate :config, :delete_dirty?, :dirty?, :more_like_this, :new_more_like_this, :new_search,
+               :optimize, :search,
+               :to => :session
+
+      def initialize(session)
+        @session = session
+      end
+
+      def batch(&block)
+        enqueue(:batch, &block)
+      end
+
+      def commit
+        enqueue(:commit)
+      end
+
+      def commit_if_delete_dirty
+        commit if @session.delete_dirty?
+      end
+
+      def commit_if_dirty
+        commit if @session.dirty?
+      end
+
+      def index(*objects)
+        enqueue(:index, *objects)
+      end
+
+      def index!(*objects)
+        index(*objects)
+        commit
+      end
+
+      def remove(*objects, &block)
+        enqueue(:remove, *objects, &block)
+      end
+
+      def remove!(*objects)
+        remove(*objects)
+        commit
+      end
+
+      def remove_all(*classes)
+        enqueue(:remove_all, *classes)
+      end
+
+      def remove_all!(*classes)
+        remove_all(*classes)
+        commit
+      end
+
+      def remove_by_id(clazz, id)
+        enqueue(:remove_by_id, clazz, id)
+      end
+
+      def remove_by_id!(clazz, id)
+        remove_by_id(clazz, id)
+        commit
+      end
+
+      private
+      def enqueue(method, *args, &block)
+        Delayed::Job.enqueue(DelayedSunspot::DelayedJob::SunspotJob.new(self, method, *args, &block))
+      end
+    end
+  end
+end

data/lib/delayed_sunspot/version.rb

@@ -0,0 +1,3 @@
+module DelayedSunspot
+  VERSION = "0.1.0"
+end

data/spec/delayed_sunspot_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Sunspot::SessionProxy::DelayedJobSessionProxy do
+  before(:each) do
+    @original_session = Sunspot::Session.new
+    @proxy = Sunspot::SessionProxy::DelayedJobSessionProxy.new(@original_session)
+  end
+
+  describe :proxy do
+    it "should wrap original session" do
+      @proxy.session.should == @original_session
+    end
+  end
+
+  describe "delegated method" do
+    [:config, :delete_dirty?, :dirty?, :more_like_this, :new_more_like_this, :new_search, :optimize, :search].each do |method|
+      it "#{method} should be called on the original session" do
+        args = Array.new(Sunspot::Session.instance_method(method).arity.abs) do
+          stub('arg')
+        end
+        @proxy.session.should_receive(method).with(*args)
+        @proxy.send(method, *args)
+      end
+    end
+  end
+
+  describe "queued method" do
+    [:batch, :commit, :index, :index!, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!].each do |method|
+      it "#{method} should queue a job" do
+        args = Array.new(Sunspot::Session.instance_method(method).arity.abs) do
+          stub('arg')
+        end
+        @proxy.send(method, *args).should == true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'sunspot'
+require 'sunspot_matchers'
+require 'delayed_sunspot/sunspot/session_proxy/delayed_job_session_proxy'
+require 'delayed_sunspot/delayed_job/sunspot_job'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before :suite do
+    Sunspot.session = SunspotMatchers::SunspotSessionSpy.new(Sunspot.session)
+  end
+  config.include SunspotMatchers
+end

data/spec/support/delayed_job_stub.rb

@@ -0,0 +1,7 @@
+module Delayed
+  class Job
+    def self.enqueue(objects)
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: delayed_sunspot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Anthony Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sunspot
+  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: 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: '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_matchers
+  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: Delayed Job support for Sunspot
+email:
+- anthony@sticksnleaves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delayed_sunspot.gemspec
+- lib/delayed_sunspot.rb
+- lib/delayed_sunspot/delayed_job/sunspot_job.rb
+- lib/delayed_sunspot/sunspot/configuration.rb
+- lib/delayed_sunspot/sunspot/session_proxy/delayed_job_session_proxy.rb
+- lib/delayed_sunspot/version.rb
+- spec/delayed_sunspot_spec.rb
+- spec/spec_helper.rb
+- spec/support/delayed_job_stub.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Toss your Sunspot Solr commits into a background job.
+test_files:
+- spec/delayed_sunspot_spec.rb
+- spec/spec_helper.rb
+- spec/support/delayed_job_stub.rb