outoftime-sunspot_rails 0.9.12 → 0.10.0

data/README.rdoc

@@ -236,9 +236,9 @@ http://outoftime.lighthouseapp.com/projects/20339-sunspot
 
 == Contributors
 
-Mat Brown (mat@patch.com)
-Peer Allan (peer.allan@gmail.com)
-Michael Moen (michael@underpantsgnome.com)
+- Mat Brown (mat@patch.com)
+- Peer Allan (peer.allan@gmail.com)
+- Michael Moen (michael@underpantsgnome.com)
 
 == License
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 12
+:patch: 0
 :major: 0
-:minor: 9
+:minor: 10

data/lib/sunspot/rails/searchable.rb

@@ -147,32 +147,53 @@ module Sunspot #:nodoc:
         # database at a time. The default batch size is 500; if nil is passed,
         # records will not be indexed in batches. By default, a commit is issued
         # after each batch; passing +false+ for +batch_commit+ will disable
-        # this, and only issue a commit at the end of the process.
+        # this, and only issue a commit at the end of the process. If associated
+        # objects need to indexed also, you can specify +include+ in format 
+        # accepted by ActiveRecord to improve your sql select performance
         #
-        # ==== Parameters
+        # ==== Options (passed as a hash)
         #
         # batch_size<Integer>:: Batch size with which to load records. Passing
         #                       'nil' will skip batches.  Default is 500.
-        # batch_commit<Boolean>:: Flag singaling if a commit should be done after
+        # batch_commit<Boolean>:: Flag signalling if a commit should be done after
         #                         after each batch is indexed, default is 'true'
+        # include<Mixed>:: include option to be passed to the ActiveRecord find,
+        #                  used for including associated objects that need to be
+        #                  indexed with the parent object, accepts all formats
+        #                  ActiveRecord::Base.find does
         #
-        def reindex(batch_size = 500, batch_commit = true)
+        # ==== Examples
+        #   
+        #   # reindex in batches of 500, commit after each
+        #   Post.reindex 
+        #
+        #   # index all rows at once, then commit
+        #   Post.reindex(:batch_size => nil) 
+        #
+        #   # reindex in batches of 500, commit when all batches complete
+        #   Post.reindex(:batch_commit => false) 
+        #
+        #   # include the associated +author+ object when loading to index
+        #   Post.reindex(:include => :author) 
+        #
+        def reindex(opts={})
+          options = { :batch_size => 500, :batch_commit => true, :include => []}.merge(opts)
           remove_all_from_index
-          unless batch_size
-            Sunspot.index!(all)
+          unless options[:batch_size]
+            Sunspot.index!(all(:include => options[:include]))
           else
             record_count = count(:order => primary_key)
             counter = 1
             offset = 0
             while(offset < record_count)
-              benchmark batch_size, counter do
-                Sunspot.index(all(:offset => offset, :limit => batch_size, :order => primary_key))
+              benchmark options[:batch_size], counter do
+                Sunspot.index(all(:include => options[:include], :offset => offset, :limit => options[:batch_size], :order => primary_key))
               end
-              Sunspot.commit if batch_commit
-              offset += batch_size
+              Sunspot.commit if options[:batch_commit]
+              offset += options[:batch_size]
               counter += 1
             end
-            Sunspot.commit unless batch_commit
+            Sunspot.commit unless options[:batch_commit]
           end
         end
 

data/spec/model_spec.rb

@@ -158,10 +158,32 @@ describe 'ActiveRecord mixin' do
     end
 
     it 'should index all instances' do
+      Post.reindex(:batch_size => nil)
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+
+    it 'should remove all currently indexed instances' do
+      old_post = Post.create!
+      old_post.index!
+      old_post.destroy
       Post.reindex
       Sunspot.commit
       Post.search.results.to_set.should == @posts.to_set
     end
+    
+  end
+
+  describe 'reindex() with real data' do
+    before :each do
+      @posts = Array.new(2) { Post.create }
+    end
+
+    it 'should index all instances' do
+      Post.reindex(:batch_size => nil)
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
 
     it 'should remove all currently indexed instances' do
       old_post = Post.create!
@@ -173,11 +195,78 @@ describe 'ActiveRecord mixin' do
     end
     
     describe "using batch sizes" do
-      it 'should index with a batch size' do
-        Post.reindex(1)
+      it 'should index with a specified batch size' do
+        Post.reindex(:batch_size => 1)
         Sunspot.commit
         Post.search.results.to_set.should == @posts.to_set
       end
     end
+    
   end
+  
+  describe "reindex()" do
+  
+    before(:each) do
+      @posts = Array.new(10) { Post.create }
+    end
+
+    describe "when not using batches" do
+      
+      it "should select all if the batch_size is nil" do
+        Post.should_receive(:all).with(:include => []).and_return([])
+        Post.reindex(:batch_size => nil)
+      end
+
+      it "should search for models with includes" do
+        Post.should_receive(:all).with(:include => :author).and_return([])
+        Post.reindex(:batch_size => nil, :include => :author)
+      end
+    
+    end
+
+    describe "when using batches" do
+      
+      it "should use the default options" do
+        Post.should_receive(:all).with do |params|
+          params[:limit].should == 500
+          params[:include].should == []
+        end.and_return(@posts)
+        Post.reindex
+      end
+
+      it "should count the number of records to index" do
+        Post.should_receive(:count).and_return(10)
+        Post.reindex
+      end
+
+      it "should override the batch_size" do
+        Post.should_receive(:all).with do |params|
+          params[:limit].should == 20
+          @posts
+        end.and_return(@posts)
+        Post.reindex(:batch_size => 20)
+      end
+
+      it "should set the include option" do
+        Post.should_receive(:all).with do |params|
+          params[:include].should == [{:author => :address}]
+          @posts
+        end.and_return(@posts)
+        Post.reindex(:include => [{:author => :address}])
+      end
+
+      it "should commit after indexing each batch" do
+        Sunspot.should_receive(:commit).twice
+        Post.reindex(:batch_size => 5)
+      end
+
+      it "should commit after indexing everything" do
+        Sunspot.should_receive(:commit).once
+        Post.reindex(:batch_commit => false)
+      end
+      
+    end
+  end
+  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: outoftime-sunspot_rails
 version: !ruby/object:Gem::Version 
-  version: 0.9.12
+  version: 0.10.0
 platform: ruby
 authors: 
 - Mat Brown
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 -07:00
+date: 2009-06-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency