pduey-sunspot_rails 1.2.1.1

data/lib/sunspot_rails.rb

@@ -0,0 +1,12 @@
+# This needs to be loaded before sunspot/search/paginated_collection
+# or #to_json gets defined in Object breaking delegation to Array via
+# method_missing
+require 'active_support/core_ext/object/to_json' if Rails::VERSION::MAJOR == 3
+
+require 'sunspot/rails'
+
+if Rails::VERSION::MAJOR == 3
+  require 'sunspot/rails/railtie'
+else
+  require 'sunspot/rails/init'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,173 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" do
+  before(:each) do
+    File.stub!(:exist?).and_return(false) # simulate sunspot.yml not existing
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  it "should handle the 'hostname' property when not set" do
+    @config.hostname.should == 'localhost'
+  end  
+  
+  it "should handle the 'path' property when not set" do
+    @config.path.should == '/solr'
+  end
+
+  describe "port" do
+    it "should default to port 8981 in test" do
+      ::Rails.stub!(:env => 'test')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8981
+    end
+    it "should default to port 8982 in development" do
+      ::Rails.stub!(:env => 'development')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8982
+    end
+    it "should default to 8983 in production" do
+      ::Rails.stub!(:env => 'production')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8983
+    end
+    it "should generally default to 8983" do
+      ::Rails.stub!(:env => 'staging')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8983
+    end
+  end
+
+  it "should handle the 'log_level' property when not set" do
+    @config.log_level.should == 'INFO'
+  end
+  
+  it "should handle the 'log_file' property" do
+    @config.log_file.should =~ /log\/solr_test.log/
+  end
+  
+  it "should handle the 'solr_home' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.solr_home.should == '/some/path/solr'
+  end
+
+  it "should handle the 'data_path' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.data_path.should == '/some/path/solr/data/test'
+  end
+
+  it "should handle the 'pid_dir' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.pid_dir.should == '/some/path/solr/pids/test'
+  end
+  
+  it "should handle the 'auto_commit_after_request' propery when not set" do
+    @config.auto_commit_after_request?.should == true
+  end
+  
+  it "should handle the 'auto_commit_after_delete_request' propery when not set" do
+    @config.auto_commit_after_delete_request?.should == false
+  end
+end
+
+describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'some.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 1234
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/idx'
+  end
+  
+  it "should handle the 'log_level' propery when set" do
+    @config.log_level.should == 'WARNING'
+  end
+  
+  it "should handle the 'solr_home' propery when set" do
+    @config.solr_home.should == '/my_superior_path'
+  end
+
+  it "should handle the 'data_path' property when set" do
+    @config.data_path.should == '/my_superior_path/data'
+  end
+
+  it "should handle the 'pid_dir' property when set" do
+    @config.pid_dir.should == '/my_superior_path/pids'
+  end
+  
+  it "should handle the 'solr_home' property when set" do
+    @config.solr_home.should == '/my_superior_path'
+  end
+
+  it "should handle the 'auto_commit_after_request' propery when set" do
+    @config.auto_commit_after_request?.should == false
+  end
+  
+  it "should handle the 'auto_commit_after_delete_request' propery when set" do
+    @config.auto_commit_after_delete_request?.should == true
+  end
+end
+
+
+describe Sunspot::Rails::Configuration, "with ENV['SOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['SOLR_URL'] = 'http://environment.host:5432/solr/env'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('SOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'environment.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 5432
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/env'
+  end
+end
+
+describe Sunspot::Rails::Configuration, "with ENV['WEBSOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['WEBSOLR_URL'] = 'http://index.websolr.test/solr/a1b2c3d4e5f'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('WEBSOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'index.websolr.test'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 80
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/a1b2c3d4e5f'
+  end
+end
+

data/spec/model_lifecycle_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'searchable with lifecycle' do
+  describe 'on create' do
+    before :each do
+      @post = PostWithAuto.create
+      Sunspot.commit
+    end
+
+    it 'should automatically index' do
+      PostWithAuto.search.results.should == [@post]
+    end
+  end
+
+  describe 'on update' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.update_attributes(:title => 'Test 1')
+      Sunspot.commit
+    end
+
+    it 'should automatically update index' do
+      PostWithAuto.search { with :title, 'Test 1' }.results.should == [@post]
+    end
+
+    it "should index model if relevant attribute changed" do
+      @post = PostWithAuto.create!
+      @post.title = 'new title'
+      @post.should_receive :solr_index
+      @post.save!
+    end
+
+    it "should not index model if relevant attribute not changed" do
+      @post = PostWithAuto.create!
+      @post.updated_at = Date.tomorrow
+      @post.should_not_receive :solr_index
+      @post.save!
+    end
+  end
+  
+  describe 'on destroy' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.destroy
+      Sunspot.commit
+    end
+
+    it 'should automatically remove it from the index' do
+      PostWithAuto.search_ids.should be_empty
+    end
+  end
+end
+
+describe 'searchable with lifecycle - ignoring specific attributes' do
+  before(:each) do
+    @post = PostWithAuto.create
+  end
+  
+  it "should not reindex the object on an update_at change, because it is marked as to-ignore" do
+    Sunspot.should_not_receive(:index).with(@post)
+    @post.update_attribute :updated_at, 123.seconds.from_now
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,478 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'ActiveRecord mixin' do
+  describe 'index()' do
+    before :each do
+      @post = Post.create!
+      @post.index
+    end
+
+    it 'should not commit the model' do
+      Post.search.results.should be_empty
+    end
+
+    it 'should index the model' do
+      Sunspot.commit
+      Post.search.results.should == [@post]
+    end
+
+    it "should not blow up if there's a default scope specifying order" do
+      posts = Array.new(2) { |j| PostWithDefaultScope.create! :title => (10-j).to_s }
+      lambda { PostWithDefaultScope.index(:batch_size => 1) }.should_not raise_error
+    end
+  end
+
+  describe 'index() with conditional indexing' do
+    describe 'when conditional is false' do
+      before :each do
+        @post = PostWithConditionalIndex.create!(:title => nil)
+        @post.index
+        Sunspot.commit
+      end
+
+      it 'should not index the model' do
+        PostWithConditionalIndex.search.results.should be_empty
+      end
+    end
+
+    describe 'when conditional is true' do
+      before :each do
+        @post = PostWithConditionalIndex.create!(:title => 'Present')
+        @post.index
+        Sunspot.commit
+      end
+
+      it 'should index the model' do
+        PostWithConditionalIndex.search.results.should == [@post]
+      end
+    end
+  end
+
+  describe 'single table inheritence' do
+    before :each do
+      @post = PhotoPost.create!
+    end
+
+    it 'should not break auto-indexing' do
+      @post.title = 'Title'
+      lambda { @post.save! }.should_not raise_error
+    end
+  end
+
+  describe 'index!()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+    end
+
+    it 'should immediately index and commit' do
+      Post.search.results.should == [@post]
+    end
+  end
+
+  describe 'index!() with conditional indexing' do
+    describe 'when conditional is false' do
+      before :each do
+        @post = PostWithConditionalIndex.create!(:title => nil)
+        @post.index!
+      end
+
+      it 'should not index the model' do
+        PostWithConditionalIndex.search.results.should be_empty
+      end
+    end
+
+    describe 'when conditional is true' do
+      before :each do
+        @post = PostWithConditionalIndex.create!(:title => 'Present')
+        @post.index!
+      end
+
+      it 'should index the model' do
+        PostWithConditionalIndex.search.results.should == [@post]
+      end
+    end
+  end
+
+  describe 'remove_from_index()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+      @post.remove_from_index
+    end
+
+    it 'should not commit immediately' do
+      Post.search.results.should == [@post]
+    end
+
+    it 'should remove the model from the index' do
+      Sunspot.commit
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_from_index() with conditional indexing' do
+    before :each do
+      @post = PostWithConditionalIndex.create!(:title => 'Present')
+      @post.index!
+    end
+
+    describe 'when conditional is false' do
+      before :each do
+        @post.title = nil
+      end
+
+      it 'should not remove the model from the index' do
+        @post.remove_from_index
+        Sunspot.commit
+        PostWithConditionalIndex.search.results.should == [@post]
+      end
+    end
+
+    describe 'when conditional is true' do
+      it 'should remove the model from the index' do
+        @post.remove_from_index
+        Sunspot.commit
+        PostWithConditionalIndex.search.results.should be_empty
+      end
+    end
+  end
+
+  describe 'remove_from_index!()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+      @post.remove_from_index!
+    end
+
+    it 'should immediately remove the model and commit' do
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_from_index!() with conditional indexing' do
+    before :each do
+      @post = PostWithConditionalIndex.create!(:title => 'Present')
+      @post.index!
+    end
+
+    describe 'when conditional is false' do
+      before :each do
+        @post.title = nil
+      end
+
+      it 'should not remove the model from the index' do
+        @post.remove_from_index!
+        PostWithConditionalIndex.search.results.should == [@post]
+      end
+    end
+
+    describe 'when conditional is true' do
+      it 'should remove the model from the index' do
+        @post.remove_from_index!
+        PostWithConditionalIndex.search.results.should be_empty
+      end
+    end
+  end
+
+  describe 'remove_all_from_index' do
+    before :each do
+      @posts = Array.new(2) { Post.create! }.each { |post| Sunspot.index(post) }
+      Sunspot.commit
+      Post.remove_all_from_index
+    end
+
+    it 'should not commit immediately' do
+      Post.search.results.to_set.should == @posts.to_set
+    end
+
+    it 'should remove all instances from the index' do
+      Sunspot.commit
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_all_from_index!' do
+    before :each do
+      Array.new(2) { Post.create! }.each { |post| Sunspot.index(post) }
+      Sunspot.commit
+      Post.remove_all_from_index!
+    end
+
+    it 'should remove all instances from the index and commit immediately' do
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'search()' do
+    before :each do
+      @post = Post.create!(:title => 'Test Post')
+      @post.index!
+    end
+
+    it 'should return results specified by search' do
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should not return results excluded by search' do
+      Post.search do
+        with :title, 'Bogus Post'
+      end.results.should be_empty
+    end
+    
+    it 'should use the include option on the data accessor when specified' do
+      Post.should_receive(:all).with(hash_including(:include => [:blog])).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+        data_accessor_for(Post).include = [:blog]
+      end.results.should == [@post]
+    end
+
+    it 'should pass :include option from search call to data accessor' do
+      Post.should_receive(:all).with(hash_including(:include => [:blog])).and_return([@post])
+      Post.search(:include => [:blog]) do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+    
+    it 'should use the select option from search call to data accessor' do
+      Post.should_receive(:all).with(hash_including(:select => 'title, published_at')).and_return([@post])
+      Post.search(:select => 'title, published_at') do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should not allow bogus options to search' do
+      lambda { Post.search(:bogus => :option) }.should raise_error(ArgumentError)
+    end
+    
+    it 'should use the select option on the data accessor when specified' do
+      Post.should_receive(:all).with(hash_including(:select => 'title, published_at')).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+        data_accessor_for(Post).select = [:title, :published_at]
+      end.results.should == [@post]
+    end
+    
+    it 'should not use the select option on the data accessor when not specified' do
+      Post.should_receive(:all).with(hash_not_including(:select)).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should gracefully handle nonexistent records' do
+      post2 = Post.create!(:title => 'Test Post')
+      post2.index!
+      post2.destroy
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should use an ActiveRecord object for coordinates' do
+      post = Post.new(:title => 'Test Post')
+      post.location = Location.create!(:lat => 40.0, :lng => -70.0)
+      post.save
+      post.index!
+      Post.search { with(:location).near(40.0, -70.0) }.results.should == [post]
+    end
+
+  end
+
+  describe 'search_ids()' do
+    before :each do
+      @posts = Array.new(2) { Post.create! }.each { |post| post.index }
+      Sunspot.commit
+    end
+
+    it 'should return IDs' do
+      Post.search_ids.to_set.should == @posts.map { |post| post.id }.to_set
+    end
+  end
+  
+  describe 'searchable?()' do
+    it 'should not be true for models that have not been configured for search' do
+      Location.should_not be_searchable
+    end
+
+    it 'should be true for models that have been configured for search' do
+      Post.should be_searchable
+    end
+  end
+
+  describe 'index_orphans()' do
+    before :each do
+      @posts = Array.new(2) { Post.create }.each { |post| post.index }
+      Sunspot.commit
+      @posts.first.destroy
+    end
+
+    it 'should return IDs of objects that are in the index but not the database' do
+      Post.index_orphans.should == [@posts.first.id]
+    end
+  end
+
+  describe 'clean_index_orphans()' do
+    before :each do
+      @posts = Array.new(2) { Post.create }.each { |post| post.index }
+      Sunspot.commit
+      @posts.first.destroy
+    end
+
+    it 'should remove orphans from the index' do
+      Post.clean_index_orphans
+      Sunspot.commit
+      Post.search.results.should == [@posts.last]
+    end
+  end
+
+  describe 'reindex()' 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!
+      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!
+      old_post.index!
+      old_post.destroy
+      Post.reindex
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+    
+    describe "using batch sizes" do
+      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() with conditional indexing' do
+    before :each do
+      @non_indexed_post = PostWithConditionalIndex.create!(:title => nil)
+      @indexed_post = PostWithConditionalIndex.create!(:title => 'Present')
+    end
+
+    describe "when not using batches" do
+      it 'should not include non indexed records' do
+        PostWithConditionalIndex.reindex(:batch_size => nil)
+        Sunspot.commit
+        PostWithConditionalIndex.search.results.should == [@indexed_post]
+      end
+    end
+
+    describe "when using batches" do
+      it 'should not include non indexed records' do
+        PostWithConditionalIndex.reindex(:batch_size => 1)
+        Sunspot.commit
+        PostWithConditionalIndex.search.results.should == [@indexed_post]
+      end
+    end
+  end
+  
+  describe "reindex()" do
+  
+    before(:each) do
+      @posts = Array.new(2) { 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 commit after indexing each batch" do
+        Sunspot.should_receive(:commit).twice
+        Post.reindex(:batch_size => 1)
+      end
+
+      it "should commit after indexing everything" do
+        Sunspot.should_receive(:commit).once
+        Post.reindex(:batch_commit => false)
+      end
+    end
+  end
+  
+  describe "more_like_this()" do
+    before(:each) do
+      @posts = [
+        Post.create!(:title => 'Post123', :body => "one two three"),
+        Post.create!(:title => 'Post345', :body => "three four five"),
+        Post.create!(:title => 'Post456', :body => "four five six"),
+        Post.create!(:title => 'Post234', :body => "two three four"),
+      ]
+      @posts_with_auto = [
+        PostWithAuto.create!(:body => "one two three"),
+        PostWithAuto.create!(:body => "four five six")
+      ]
+      @posts.each { |p| p.index! }
+    end
+
+    it "should return results" do
+      @posts.first.more_like_this.results.should == [@posts[3], @posts[1]]
+    end
+
+    it "should return results for specified classes" do
+      @posts.first.more_like_this(Post, PostWithAuto).results.to_set.should ==
+        Set[@posts_with_auto[0], @posts[1], @posts[3]]
+    end
+  end
+
+  describe 'more_like_this_ids()' do
+    before :each do
+      @posts = [
+        Post.create!(:title => 'Post123', :body => "one two three"),
+        Post.create!(:title => 'Post345', :body => "three four five"),
+        Post.create!(:title => 'Post456', :body => "four five six"),
+        Post.create!(:title => 'Post234', :body => "two three four"),
+      ]
+      @posts.each { |p| p.index! }
+    end
+
+    it 'should return IDs' do
+      @posts.first.more_like_this_ids.to_set.should == [@posts[3], @posts[1]].map { |post| post.id }.to_set
+    end
+  end
+end