sunspot_rails_rbg 1.3.0

data/spec/model_spec.rb

@@ -0,0 +1,356 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+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 '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 '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!()' 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_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()" 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

data/spec/request_lifecycle_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe PostsController, :type => :controller do
+  begin
+    include ::RSpec::Rails::ControllerExampleGroup
+  rescue NameError
+    # Silent -- rspec-rails 1.x catches the :type => :controller
+  end
+
+  before(:each) do
+    Sunspot::Rails.configuration = @configuration = Sunspot::Rails::Configuration.new
+  end
+
+  after(:each) do
+    Sunspot::Rails.configuration = nil
+  end
+
+  unless respond_to?(:describes)
+    controller_name :posts  # RSpec 1
+  end
+
+  it 'should automatically commit after each action if specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => true }
+    Sunspot.should_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  it 'should not commit, if configuration is set to false' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false }
+    Sunspot.should_not_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+
+  it 'should commit if configuration is not specified' do
+    @configuration.user_configuration = {}
+    Sunspot.should_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  ### auto_commit_if_delete_dirty
+  
+  it 'should automatically commit after each delete if specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false,
+                                          'auto_commit_after_delete_request' => true }
+    Sunspot.should_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  it 'should not automatically commit on delete if configuration is set to false' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false,
+                                          'auto_commit_after_delete_request' => false }
+    Sunspot.should_not_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+
+  it 'should not automatically commit on delete if configuration is not specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false }
+    Sunspot.should_not_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.string :type
+    t.integer :location_id
+    t.text :body
+    t.references :blog
+    t.timestamps
+  end
+
+  create_table :locations, :force => true do |t|
+    t.float :lat
+    t.float :lng
+  end
+
+  create_table :blogs, :force => true do |t|
+    t.string :name
+    t.string :subdomain
+    t.timestamps
+  end
+
+  create_table :writers, :force => true, :primary_key => :writer_id do |t|
+    t.string :name
+    t.timestamps
+  end
+
+end

data/spec/server_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Sunspot::Rails::Server do
+  before :each do
+    @server = Sunspot::Rails::Server.new
+    @config = Sunspot::Rails::Configuration.new
+    @solr_home = File.join(@config.solr_home)
+  end
+
+  it "sets the correct Solr home" do
+    @server.solr_home.should == @solr_home
+  end
+
+  it "sets the correct Solr library path" do
+    @server.lib_path.should == File.join(@solr_home, 'lib')
+  end
+
+  it "sets the correct Solr PID path" do
+    @server.pid_path.should == File.join(Rails.root, 'tmp', 'pids', 'sunspot-solr-test.pid')
+  end
+
+  it "sets the correct Solr data dir" do
+    @server.solr_data_dir.should == File.join(@solr_home, 'data', 'test')
+  end
+
+  it "sets the correct port" do
+    @server.port.should == 8980
+  end
+
+  it "sets the correct log level" do
+    @server.log_level.should == "FINE"
+  end
+
+  it "sets the correct log file" do
+    @server.log_file.should == File.join(Rails.root, 'log', 'sunspot-solr-test.log')
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'Sunspot::Rails session' do
+  it 'should be a different object for each thread' do
+  end
+
+  it 'should create a separate master/slave session if configured' do
+  end
+
+  it 'should not create a separate master/slave session if no master configured' do
+  end
+
+  private
+
+  def with_configuration(options)
+    original_configuration = Sunspot::Rails.configuration
+    Sunspot::Rails.reset
+    Sunspot::Rails.configuration = Sunspot::Rails::Configuration.new
+    Sunspot::Rails.configuration.user_configuration = options
+    yield
+    Sunspot::Rails.reset
+    Sunspot::Rails.configuration = original_configuration
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), 'rails3')
+if rsolr_version = ENV['RSOLR_GEM_VERSION']
+  STDERR.puts("Forcing RSolr version #{rsolr_version}")
+  gem "rsolr", rsolr_version
+end
+
+require File.expand_path('config/environment', ENV['RAILS_ROOT'])
+
+begin
+  require 'rspec'
+  require 'rspec/rails'
+rescue LoadError => e
+  require 'spec'
+  require 'spec/rails'
+end
+require 'rake'
+require File.join('sunspot', 'rails', 'solr_logging')
+
+def load_schema
+  stdout = $stdout
+  $stdout = StringIO.new # suppress output while building the schema
+  load File.join(ENV['RAILS_ROOT'], 'db', 'schema.rb')
+  $stdout = stdout
+end
+
+def silence_stderr(&block)
+  stderr = $stderr
+  $stderr = StringIO.new
+  yield
+  $stderr = stderr
+end
+
+rspec = 
+  begin
+    RSpec
+  rescue NameError, ArgumentError
+    Spec::Runner
+  end
+
+rspec.configure do |config|
+  config.before(:each) do
+    load_schema
+    Sunspot.remove_all!
+  end
+end

data/spec/stub_session_proxy_spec.rb

@@ -0,0 +1,122 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'rails', 'spec_helper')
+
+describe 'specs with Sunspot stubbed' do
+  disconnect_sunspot
+
+  before :each do
+    @session = Sunspot.session.original_session
+    @post = Post.create!
+  end
+
+  it 'should not send index to session' do
+    @session.should_not_receive(:index)
+    @post.index
+  end
+
+  it 'should not send index! to session' do
+    @session.should_not_receive(:index!)
+    @post.index!
+  end
+
+  it 'should not send commit to session' do
+    @session.should_not_receive(:commit)
+    Sunspot.commit
+  end
+
+  it 'should not send remove to session' do
+    @session.should_not_receive(:remove)
+    @post.remove_from_index
+  end
+
+  it 'should not send remove! to session' do
+    @session.should_not_receive(:remove)
+    @post.remove_from_index!
+  end
+
+  it 'should not send remove_by_id to session' do
+    @session.should_not_receive(:remove_by_id)
+    Sunspot.remove_by_id(Post, 1)
+  end
+
+  it 'should not send remove_by_id! to session' do
+    @session.should_not_receive(:remove_by_id!)
+    Sunspot.remove_by_id!(Post, 1)
+  end
+
+  it 'should not send remove_all to session' do
+    @session.should_not_receive(:remove_all)
+    Post.remove_all_from_index
+  end
+
+  it 'should not send remove_all! to session' do
+    @session.should_not_receive(:remove_all!)
+    Post.remove_all_from_index!
+  end
+
+  it 'should return false for dirty?' do
+    @session.should_not_receive(:dirty?)
+    Sunspot.dirty?.should == false
+  end
+
+  it 'should not send commit_if_dirty to session' do
+    @session.should_not_receive(:commit_if_dirty)
+    Sunspot.commit_if_dirty
+  end
+
+  it 'should return false for delete_dirty?' do
+    @session.should_not_receive(:delete_dirty?)
+    Sunspot.delete_dirty?.should == false
+  end
+
+  it 'should not send commit_if_delete_dirty to session' do
+    @session.should_not_receive(:commit_if_delete_dirty)
+    Sunspot.commit_if_delete_dirty
+  end
+
+  it 'should not execute a search when #search called' do
+    @session.should_not_receive(:search)
+    Post.search
+  end
+
+  it 'should not execute a search when #search called' do
+    @session.should_not_receive(:search)
+    Post.search
+  end
+
+  it 'should not execute a search when #search called with parameters' do
+    @session.should_not_receive(:search)
+    Post.search(:include => :blog, :select => 'id, title')
+  end
+
+  it 'should return a new search' do
+    @session.should_not_receive(:new_search)
+    Sunspot.new_search(Post).should respond_to(:execute)
+  end
+
+  describe 'stub search' do
+    before :each do
+      @search = Post.search
+    end
+
+    it 'should return empty results' do
+      @search.results.should == []
+    end
+
+    it 'should return empty hits' do
+      @search.hits.should == []
+    end
+
+    it 'should return zero total' do
+      @search.total.should == 0
+    end
+
+    it 'should return nil for a given facet' do
+      @search.facet(:category_id).should be_nil
+    end
+
+    it 'should return nil for a given dynamic facet' do
+      @search.dynamic_facet(:custom).should be_nil
+    end
+  end
+end