sunspot_plus 0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Louis Gillies
+
+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,34 @@
+= sunspot_plus
+
+Extension to sunport_rails
+Currently includes a delayed_job proxy to queue Active Record re-indexing.
+Particularly useful for using 3rd party or remote solr servers over http as often the round trip can delay page response times.
+
+== Usage
+
+* Use rails initializer to create the sunspot session
+
+  require 'sunspot_rails'
+  # set the session to the delayed_job handler - this will send all model CRUD reindexing to delayed_job
+  Sunspot.session = Sunspot::SessionProxy::DelayedJobSessionProxy.new(Sunspot.session)
+  
+* Define your searchable blocks as usual in ActiveRecord models.
+  class Model < ActiveRecord::Base
+    searchable do
+      text :name
+    end
+  end
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Louis Gillies. See LICENSE for details.

data/lib/sunspot_plus.rb

@@ -0,0 +1,5 @@
+require 'sunspot'
+require 'sunspot_plus/session_proxy/delayed_job_session_proxy'
+require 'sunspot_plus/session_proxy/silent_fail_session_proxy'
+require 'sunspot_plus/session_proxy/delayed_job/indexing_job'
+require 'sunspot_plus/session_proxy/delayed_job/safe_configuration'

data/lib/sunspot_plus/session_proxy/delayed_job/indexing_job.rb

@@ -0,0 +1,33 @@
+module Sunspot
+  module SessionProxy
+    #
+    # Queue indexing to job.
+    #
+    #
+    
+    module DelayedJob
+      class IndexingJob
+
+        attr_reader :session, :proxy, :method
+        
+        def initialize(proxy, method, *args, &block)
+          @session = proxy.session
+          @proxy = proxy
+          @method = method
+          @args = args
+        end
+
+        def rebuild_config
+          @session.instance_variable_set("@config", proxy.class.rebuild_config(session.config))
+        end
+
+        def perform
+          # Delayed job serializes ruby objects to yaml.
+          # Yaml doesn't rebuild the LightConfiguration object correctly so we need to brute force a rebuild of the configuration
+          rebuild_config
+          @args ? @session.send(method, *@args) : @session.send(method)
+        end
+      end
+    end
+  end
+end

data/lib/sunspot_plus/session_proxy/delayed_job/safe_configuration.rb

@@ -0,0 +1,36 @@
+
+module Sunspot
+  module SessionProxy
+    module DelayedJob
+      
+      # Problems arise when trying to load a yaml serialised sunspot config
+      # The recursive properties set up from the build blocks can't be accessed and the methods raise a not defined error.
+      # To see an example of this.
+      #   config = Sunspot::Configuration.build 
+      #   config.solr.url => "http://127.0.0.1:8983/solr"
+      #   YAML.load(YAML.dump(config).solr.url => undefined method solr raised.
+      # This class will attempt to wrap and rebuild the original config and create a safe version of it.
+      class SafeConfiguration
+        def initialize(config)
+          @config = config
+          singleton = (class <<self; self; end)
+          @properties = @config.instance_variable_get("@properties") || {}
+          @properties.keys.each do |property|
+            singleton.module_eval do
+              define_method property do
+                if @properties[property].is_a?(LightConfig::Configuration)
+                  self.class.new(@properties[property])
+                else
+                  @properties[property]
+                end
+              end
+              define_method "#{property}=" do |value|
+                @properties[property] = value
+              end
+            end
+          end
+        end        
+      end
+    end
+  end
+end

data/lib/sunspot_plus/session_proxy/delayed_job_session_proxy.rb

@@ -0,0 +1,61 @@
+module Sunspot
+  module SessionProxy
+    #
+    # Queue commits to delayed_job.
+    # 
+    #
+    # To configure, add this to an initializer:
+    #    Sunspot.session = DelayedJobSessionProxy.new(Sunspot.session)
+    #
+    #
+    
+    class DelayedJobSessionProxy < Sunspot::SessionProxy::AbstractSessionProxy
+      
+      attr_reader :session
+      attr_writer :config
+      
+      delegate :new_search, :search, :new_more_like_this, :more_like_this, :config, :index,
+        :delete_dirty?, :dirty?, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!, 
+        :to => :session   
+      
+      def batch(&block)
+        Delayed::Job.enqueue Sunspot::SessionProxy::DelayedJob::IndexingJob.new(self, :batch, &block)
+      end
+            
+      def commit
+        Delayed::Job.enqueue Sunspot::SessionProxy::DelayedJob::IndexingJob.new(self, :commit)
+      end
+      
+      # 
+      # We can't delegate to @session as commit needs to be sent to delayed job.
+      #
+      def index!(*objects)
+        @session.index(*objects)
+        commit
+      end
+      # 
+      # We can't delegate to @session as commit needs to be sent to delayed job.
+      #
+      def commit_if_dirty
+        commit if @session.dirty?
+      end
+      
+      # 
+      # We can't delegate to @session as commit needs to be sent to delayed job.
+      #
+      def commit_if_delete_dirty
+        commit if @session.delete_dirty?
+      end
+      
+      def self.rebuild_config(config)
+        Sunspot::SessionProxy::DelayedJob::SafeConfiguration.new(config)
+      end
+      
+      def initialize(session)
+        @config = session.config
+        @session = session
+      end
+      
+    end
+  end
+end

data/lib/sunspot_plus/session_proxy/silent_fail_session_proxy.rb

@@ -0,0 +1,35 @@
+module Sunspot
+  module SessionProxy
+    #
+    # Silently fail instead of raising an exception when an error occurs while writing to Solr.
+    # NOTE: does not fail for reads; you should catch those exceptions, for example in a rescue_from statement.
+    #
+    # To configure, add this to an initializer:
+    #    Sunspot.session = SilentFailSessionProxy.new(Sunspot.session)
+    #
+    # 
+    #
+    class SilentFailSessionProxy < Sunspot::SessionProxy::AbstractSessionProxy
+
+      attr_reader :session
+      delegate :new_search, :search, :configuration, :config, :to => :session
+
+      [:index, :index!, :commit, :remove, :remove!, :remove_by_id,
+       :remove_by_id!, :remove_all, :remove_all!, :dirty?, :commit_if_dirty, :batch].each do |method|
+        module_eval(<<-RUBY)
+          def #{method}(*args, &block)
+            begin
+              session.#{method}(*args, &block)
+            rescue => e
+              Rails.logger.error(e.message)
+            end
+          end
+        RUBY
+      end
+
+      def initialize(session)
+        @session = session
+      end
+    end
+  end
+end

data/spec/helpers/delayed_job_stub.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'sunspot'
+require 'sunspot_plus'
+require 'sunspot/session_proxy/abstract_session_proxy'
+require 'spec'
+require 'spec/autorun'
+require 'helpers/delayed_job_stub'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/sunspot/session_proxy/delayed_job/safe_configuration_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe Sunspot::SessionProxy::DelayedJob::SafeConfiguration do
+  # TODO test hacked config rebuild to overcome YAML serialization bug in sunspot config object.
+end

data/spec/sunspot/session_proxy/delayed_job_session_proxy_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Sunspot::SessionProxy::DelayedJobSessionProxy do
+  
+
+  
+  before(:each) do
+
+    @original_session = Sunspot::Session.new
+    @proxy = Sunspot::SessionProxy::DelayedJobSessionProxy.new( @original_session )
+  end
+
+  
+  it "should wrap a current session" do
+    @proxy.session.should == @original_session
+  end
+  
+  context "methods that should be delegated to the default session" do
+    ([:new_search, :search, :new_more_like_this, :more_like_this, :config, :index, 
+      :delete_dirty?, :dirty?, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!]).each do |method|
+      it "should delegate #{method.inspect} to its 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
+  
+  context "methods that commit should queue to delayed job." do
+    describe "index" do 
+      it "should delegate index to @session" do
+        @proxy.session.should_receive(:index)
+        @proxy.should_receive(:commit)
+        @proxy.index!(mock("Model"))
+      end
+    end
+    
+    describe "commit_if_dirty" do  
+      it "should delegate dirty? to @session" do
+        @proxy.session.should_receive(:dirty?).and_return(true)
+        @proxy.should_receive(:commit)
+        @proxy.commit_if_dirty
+      end
+    end
+
+    describe "commit_if_delete_dirty" do
+      it "should delegate delete_dirty? to @session" do
+        @proxy.session.should_receive(:delete_dirty?).and_return(true)
+        @proxy.should_receive(:commit)
+        @proxy.commit_if_delete_dirty
+      end        
+    end
+  end
+  
+  context "methods that should be queued" do 
+     [:commit, :batch].each do |method|
+       it "should send #{method} to the delayed_job queue" do
+         args = Array.new(Sunspot::Session.instance_method(method).arity.abs) do
+           stub('arg')
+         end
+         Delayed::Job.should_receive(:enqueue)
+         @proxy.send(method, *args)
+       end
+     end
+  end
+  
+  it_should_behave_like 'session proxy'
+end
+

data/spec/sunspot/session_proxy/spec_helper.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+shared_examples_for 'session proxy' do
+  Sunspot::SessionProxy::AbstractSessionProxy.public_instance_methods(false).each do |method|
+    it "should respond to #{method.inspect}" do
+      @proxy.should respond_to(method)
+    end
+  end
+end

data/spec/sunspot_plus_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SunspotPlus" do
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: sunspot_plus
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- Louis Gillies
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-25 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sunspot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: delayed_job
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "A library of extensions for outoftime's sunspot gem for solr indexing server. Using the session adapter design pattern to add support for:\n      1) delayed_job to move indexing commits out of process.\n    "
+email: louisgillies@yahoo.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/sunspot_plus.rb
+- lib/sunspot_plus/session_proxy/delayed_job/indexing_job.rb
+- lib/sunspot_plus/session_proxy/delayed_job/safe_configuration.rb
+- lib/sunspot_plus/session_proxy/delayed_job_session_proxy.rb
+- lib/sunspot_plus/session_proxy/silent_fail_session_proxy.rb
+- LICENSE
+- README.rdoc
+- spec/helpers/delayed_job_stub.rb
+- spec/spec_helper.rb
+- spec/sunspot/session_proxy/delayed_job/safe_configuration_spec.rb
+- spec/sunspot/session_proxy/delayed_job_session_proxy_spec.rb
+- spec/sunspot/session_proxy/spec_helper.rb
+- spec/sunspot_plus_spec.rb
+has_rdoc: true
+homepage: http://github.com/playgood/sunspot_plus
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Extensions for outoftime's sunspot gem.
+test_files: 
+- spec/helpers/delayed_job_stub.rb
+- spec/spec_helper.rb
+- spec/sunspot/session_proxy/delayed_job/safe_configuration_spec.rb
+- spec/sunspot/session_proxy/delayed_job_session_proxy_spec.rb
+- spec/sunspot/session_proxy/spec_helper.rb
+- spec/sunspot_plus_spec.rb