sunspot_rails 2.1.1 → 2.2.0

data/README.rdoc

@@ -188,6 +188,29 @@ remove those documents from the index, use +clean_index_orphans+. Note that
 neither of these operations should be needed if Sunspot and Sunspot::Rails are
 used as intended.
 
+=== Configuration
+
+==== ActiveRecord index hooks
+
+By default, `sunspot_rails` uses `after_save` and `after_destroy` hooks to
+automatically index or remove ActiveRecord models. When you're using any sort
+of asynchronous indexing like
+[sunspot_index_queue](https://github.com/bdurand/sunspot_index_queue) or
+[sunspot-queue](https://github.com/gaffneyc/sunspot-queue) you may want
+these to be after_commit hooks or you may have timing issues.
+
+To do this, add the following to your `sunspot.yml` for each environment:
+
+    production:
+      # ...
+      auto_index_callback: after_commit
+      auto_remove_callback: after_commit
+
+Note that if you set these to `after_commit` in the `test` environment you may
+need https://github.com/grosser/test_after_commit if you use
+`transactionnal_fixtures = true`.
+
+
 == Testing Solr integration using RSpec
 
 To disable the sunspot-solr integration for your active record models, require

data/generators/sunspot/templates/sunspot.yml

@@ -6,6 +6,8 @@ production:
     path: /solr/production
     read_timeout: 20
     open_timeout: 1
+  auto_index_callback: after_commit
+  auto_remove_callback: after_commit
 
 development:
   solr:
@@ -13,6 +15,8 @@ development:
     port: 8983
     log_level: INFO
     path: /solr/development
+  auto_index_callback: after_commit
+  auto_remove_callback: after_commit
 
 test:
   solr:
@@ -20,4 +24,5 @@ test:
     port: 8983
     log_level: WARNING
     path: /solr/test
-    
+  auto_index_callback: after_commit
+  auto_remove_callback: after_commit

data/lib/sunspot/rails/configuration.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'yaml'
 
 module Sunspot #:nodoc:
   module Rails #:nodoc:
@@ -39,6 +40,8 @@ module Sunspot #:nodoc:
     #       hostname: localhost
     #       port: 8982
     #       path: /solr
+    #     auto_index_callback: after_commit
+    #     auto_remove_callback: after_commit
     #     auto_commit_after_request: true
     #
     # Sunspot::Rails uses the configuration to set up the Solr connection, as
@@ -315,6 +318,24 @@ module Sunspot #:nodoc:
         @disabled ||= (user_configuration_from_key('disabled') || false)
       end
 
+      #
+      # The callback to use when automatically indexing records.
+      # Defaults to after_save.
+      #
+      def auto_index_callback
+        @auto_index_callback ||=
+          (user_configuration_from_key('auto_index_callback') || 'after_save')
+      end
+
+      #
+      # The callback to use when automatically removing records after deletation.
+      # Defaults to after_destroy.
+      #
+      def auto_remove_callback
+        @auto_remove_callback ||=
+          (user_configuration_from_key('auto_remove_callback') || 'after_destroy')
+      end
+
       private
 
       #

data/lib/sunspot/rails/searchable.rb

@@ -90,16 +90,21 @@ module Sunspot #:nodoc:
 
             unless options[:auto_index] == false
               before_save :mark_for_auto_indexing_or_removal
-              after_save :perform_index_tasks
+
+              # after_commit :perform_index_tasks, :if => :persisted?
+              __send__ Sunspot::Rails.configuration.auto_index_callback,
+                       :perform_index_tasks,
+                       :if => :persisted?
             end
 
             unless options[:auto_remove] == false
-              after_destroy do |searchable|
-                searchable.remove_from_index
-              end
+              # after_commit { |searchable| searchable.remove_from_index }, :on => :destroy
+              __send__ Sunspot::Rails.configuration.auto_remove_callback,
+                       proc { |searchable| searchable.remove_from_index },
+                       :on => :destroy
             end
             options[:include] = Util::Array(options[:include])
-            
+
             self.sunspot_options = options
           end
         end

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -46,13 +46,13 @@ module Sunspot
         false
       end
 
-      def commit_if_dirty
+      def commit_if_dirty(soft_commit = false)
       end
 
-      def commit_if_delete_dirty
+      def commit_if_delete_dirty(soft_commit = false)
       end
 
-      def commit
+      def commit(soft_commit = false)
       end
 
       def search(*types)
@@ -71,8 +71,12 @@ module Sunspot
         Search.new
       end
 
+      class DataAccessorStub
+        attr_accessor :include, :select
+      end
+
       class Search
-        
+
         def build
           self
         end
@@ -102,28 +106,32 @@ module Sunspot
           FacetStub.new
         end
 
+        def data_accessor_for(klass)
+          DataAccessorStub.new
+        end
+
         def execute
           self
         end
       end
-      
-      
+
+
       class PaginatedCollection < Array
-        
+
         def total_count
           0
         end
         alias :total_entries :total_count
-        
+
         def current_page
           1
         end
-        
+
         def per_page
           30
         end
         alias :limit_value :per_page
-        
+
         def total_pages
           1
         end
@@ -152,7 +160,7 @@ module Sunspot
         def offset
           0
         end
-        
+
       end
 
       class FacetStub
@@ -162,7 +170,7 @@ module Sunspot
         end
 
       end
-      
+
     end
   end
 end

data/lib/sunspot/rails/tasks.rb

@@ -31,6 +31,7 @@ namespace :sunspot do
       # Load all the application's models. Models which invoke 'searchable' will register themselves
       # in Sunspot.searchable.
       Rails.application.eager_load!
+      Rails::Engine.subclasses.each{|engine| engine.instance.eager_load!}
 
       if args[:models].present?
         # Choose a specific subset of models, if requested

data/spec/configuration_spec.rb

@@ -92,6 +92,14 @@ describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" d
   it "should handle the 'disabled' property when not set" do
     @config.disabled?.should be_false
   end
+
+  it "should handle the 'auto_index_callback' property when not set" do
+    @config.auto_index_callback.should == "after_save"
+  end
+
+  it "should handle the 'auto_remove_callback' property when not set" do
+    @config.auto_remove_callback.should == "after_destroy"
+  end
 end
 
 describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
@@ -161,6 +169,21 @@ describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
   end
 end
 
+describe Sunspot::Rails::Configuration, "with auto_index_callback and auto_remove_callback set" do
+  before do
+    ::Rails.stub!(:env => 'config_commit_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'auto_index_callback' property when set" do
+    @config.auto_index_callback.should == "after_commit"
+  end
+
+  it "should handle the 'auto_remove_callback' property when set" do
+    @config.auto_remove_callback.should == "after_commit"
+  end
+end
+
 describe Sunspot::Rails::Configuration, "with disabled: true in sunspot.yml" do
   before(:each) do
     ::Rails.stub(:env => 'config_disabled_test')

data/spec/rails_template/config/sunspot.yml

@@ -2,6 +2,8 @@ test:
   solr:
     hostname: localhost
     port: 8983
+  auto_index_callback: after_save
+  auto_remove_callback: after_destroy
 development:
   solr:
     hostname: localhost
@@ -25,3 +27,6 @@ config_test:
   auto_commit_after_delete_request: true
 config_disabled_test:
   disabled: true
+config_commit_test:
+  auto_index_callback: after_commit
+  auto_remove_callback: after_commit

data/spec/stub_session_proxy_spec.rb

@@ -140,5 +140,19 @@ describe 'specs with Sunspot stubbed' do
     it 'should return empty array if listing facets' do
       @search.facets.should == []
     end
+
+    describe '#data_accessor_for' do
+      before do
+        @accessor = @search.data_accessor_for(Post)
+      end
+
+      it 'should provide accessor for select' do
+        @accessor.should respond_to(:select, :select=)
+      end
+
+      it 'should provide accessor for include' do
+        @accessor.should respond_to(:include, :include=)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: sunspot_rails
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Mat Brown
@@ -26,11 +27,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -38,6 +40,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -45,20 +48,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sunspot
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -66,6 +72,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -73,6 +80,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -80,6 +88,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -87,6 +96,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -94,6 +104,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
@@ -182,7 +193,6 @@ files:
 homepage: http://github.com/outoftime/sunspot/tree/master/sunspot_rails
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options:
 - "--webcvs=http://github.com/outoftime/sunspot/tree/master/%s"
@@ -193,20 +203,22 @@ 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: sunspot
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Rails integration for the Sunspot Solr search library
 test_files:
 - spec/configuration_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: e4265b8bc7f396dcf434243ff31d073722ce37e4
-  data.tar.gz: 6a31e3de9ff96687f791fbca0ff71b29644a3b7e
-SHA512:
-  metadata.gz: 476e1c959c213af1972a51abbd779a535d6b698544dc3a93348c4825433819b441cc082736ccbc73f44043ddfe5493f90cb0e963b0669e35b03d050322930516
-  data.tar.gz: e0afd66ab79b43f53df67f4434dface8feaed30185b2f3b21e4d150c6ffdb60ef63ba44f52c0ba6e3f35cdfb7aec927775c23ef19bd3c42494eb87e727ed954c