sunspot_rails 0.10.9 → 0.11.0

data/lib/sunspot/spec/extension.rb

@@ -0,0 +1,45 @@
+module Sunspot
+  module Rails
+    module Spec
+      module Extension
+        def self.included(base)
+          base.class_eval do
+            class_inheritable_accessor :sunspot_integration
+            extend  ClassMethods
+          end
+        end
+        
+        def integrate_sunspot?
+          self.class.integrate_sunspot?
+        end
+        
+        def mock_sunspot
+          [ :index, :remove_from_index ].each do |method_name|
+            Sunspot.stub!(method_name)
+          end
+        end
+        
+      end
+      
+      module ClassMethods
+        def integrate_sunspot( integrate = true )
+          self.sunspot_integration = integrate
+        end
+
+        def integrate_sunspot?
+          !!self.sunspot_integration
+        end
+      end
+    end
+  end
+end
+
+module ActiveSupport
+  class TestCase
+    before(:each) do
+      mock_sunspot unless integrate_sunspot?
+    end
+    
+    include Sunspot::Rails::Spec::Extension
+  end
+end

data/rails/init.rb

@@ -1,9 +1,6 @@
 require 'sunspot'
 
-Sunspot.config.solr.url = URI::HTTP.build(:host => Sunspot::Rails.configuration.hostname,
-                                          :port => Sunspot::Rails.configuration.port,
-                                          :path => Sunspot::Rails.configuration.path).to_s
-
+Sunspot.session = Sunspot::Rails::SessionProxy.instance
 Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
 Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)
 ActiveRecord::Base.module_eval { include(Sunspot::Rails::Searchable) }

data/spec/configuration_spec.rb

@@ -1,53 +1,102 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe Sunspot::Rails::Configuration, "default values" do
   before(:each) do
-    File.should_receive(:exist?).and_return(false)
+    File.should_receive(:exist?).at_least(:once).and_return(false)
+    @config = Sunspot::Rails::Configuration.new
   end
   
   it "should handle the 'hostname' property when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.hostname.should == 'localhost'
+    @config.hostname.should == 'localhost'
   end  
   
   it "should handle the 'path' property when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.path.should == '/solr'
+    @config.path.should == '/solr'
   end
 
   it "should handle the 'port' property when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.port.should == 8983
+    @config.port.should == 8983
+  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_path' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.pid_path.should == '/some/path/solr/pids/test'
+  end
+  
+  it "should handle the 'solr_home' property when not set" do
+    @config.solr_home.should_not == nil
   end
 
   it "should handle the 'auto_commit_after_request' propery when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.auto_commit_after_request?.should == true
+    @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 settings" do
   before(:each) do
-    Rails.stub!(:env => 'config_test')
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
   end
 
-  it "should handle the 'hostname' property when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.hostname.should == 'some.host'
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'some.host'
   end
 
-  it "should handle the 'port' property when not set" do
-    config = Sunspot::Rails::Configuration.new
-    config.port.should == 1234
+  it "should handle the 'port' property when set" do
+    @config.port.should == 1234
   end
   
   it "should handle the 'path' property when set" do
-    config = Sunspot::Rails::Configuration.new
-    config.path.should == '/solr/idx'
+    @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_path' property when set" do
+    @config.pid_path.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 = Sunspot::Rails::Configuration.new
-    config.auto_commit_after_request?.should == false
+    @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

data/spec/mock_app/app/models/author.rb

@@ -0,0 +1,8 @@
+class Author < ActiveRecord::Base
+  set_table_name :writers
+  set_primary_key :writer_id
+
+  searchable do
+    string :name
+  end
+end

data/spec/mock_app/app/models/post_with_auto.rb

@@ -3,7 +3,7 @@ class PostWithAuto < ActiveRecord::Base
     'posts'
   end
 
-  searchable do
+  searchable :ignore_attribute_changes_of => [ :updated_at ] do
     string :title
   end
 end

data/spec/mock_app/config/database.yml

@@ -1,4 +1,4 @@
 test: &test
   :adapter: sqlite3
-  :dbfile: vendor/plugins/sunspot_rails/spec/test.db
+  :database: db/test.db
 development: *test

data/spec/mock_app/config/environment.rb

@@ -1,7 +1,7 @@
 # Be sure to restart your server when you modify this file
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = ENV['RAILS_GEM_VERSION'] || '2.3.2' unless defined? RAILS_GEM_VERSION
+# RAILS_GEM_VERSION = ENV['RAILS_GEM_VERSION'] || '2.3.3' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
@@ -19,6 +19,7 @@ Rails::Initializer.run do |config|
   # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
   # config.gem "sqlite3-ruby", :lib => "sqlite3"
   # config.gem "aws-s3", :lib => "aws/s3"
+  config.gem "qoobaa-sqlite3-ruby", :lib => 'sqlite3', :source => "http://gems.github.com" if RUBY_VERSION > '1.9'
 
   # Only load the plugins named here, in the order given (default is alphabetical).
   # :all can be used as a placeholder for all plugins not explicitly named

data/spec/mock_app/config/sunspot.yml

@@ -11,4 +11,9 @@ config_test:
     hostname: some.host
     port: 1234
     path: /solr/idx
+    log_level: WARNING
+    data_path: /my_superior_path/data
+    pid_path: /my_superior_path/pids
+    solr_home: /my_superior_path
   auto_commit_after_request: false
+  auto_commit_after_delete_request: true

data/spec/mock_app/db/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+    t.references :blog
+    t.timestamps
+  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/mock_app/db/test.db

@@ -0,0 +1 @@
+S

data/spec/model_lifecycle_spec.rb

@@ -1,6 +1,8 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe 'searchable with lifecycle' do
+  integrate_sunspot
+  
   describe 'on create' do
     before :each do
       @post = PostWithAuto.create
@@ -23,7 +25,7 @@ describe 'searchable with lifecycle' do
       PostWithAuto.search { with :title, 'Test 1' }.results.should == [@post]
     end
   end
-
+  
   describe 'on destroy' do
     before :each do
       @post = PostWithAuto.create
@@ -36,3 +38,16 @@ describe 'searchable with lifecycle' do
     end
   end
 end
+
+describe 'searchable with lifecycle - ignoring specific attributes' do
+  integrate_sunspot
+  
+  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

@@ -1,6 +1,8 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe 'ActiveRecord mixin' do
+  integrate_sunspot
+  
   describe 'index()' do
     before :each do
       @post = Post.create!
@@ -105,7 +107,30 @@ describe 'ActiveRecord mixin' do
     end
     
     it 'should find ActiveRecord objects with an integer, not a string' do
-      Post.should_receive(:find).with([@post.id.to_i]).and_return([@post])
+      Post.should_receive(:find).with([@post.id.to_i], anything()).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+    
+    it 'should use the include option on the data accessor when specified' do
+      Post.should_receive(:find).with(anything(), 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 use the select option on the data accessor when specified' do
+      Post.should_receive(:find).with(anything(), 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(:find).with(anything(), hash_not_including(:select)).and_return([@post])
       Post.search do
         with :title, 'Test Post'
       end.results.should == [@post]
@@ -237,10 +262,21 @@ describe 'ActiveRecord mixin' do
         Post.should_receive(:all).with do |params|
           params[:limit].should == 500
           params[:include].should == []
+          params[:conditions].should == ['posts.id > ?', 0]
+          params[:order].should == 'id'
         end.and_return(@posts)
         Post.reindex
       end
 
+      it "should set the conditions using the overridden table attributes" do
+        @posts = Array.new(10) { Author.create }
+        Author.should_receive(:all).with do |params|
+          params[:conditions].should == ['writers.writer_id > ?', 0]
+          params[:order].should == 'writer_id'
+        end.and_return(@posts)
+        Author.reindex
+      end
+
       it "should count the number of records to index" do
         Post.should_receive(:count).and_return(10)
         Post.reindex

data/spec/request_lifecycle_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe 'request lifecycle', :type => :controller do
   before(:each) do
@@ -27,4 +27,26 @@ describe 'request lifecycle', :type => :controller do
     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

@@ -11,4 +11,10 @@ ActiveRecord::Schema.define(:version => 0) do
     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,124 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Sunspot::Rails::Server do
+  before(:each) do
+    @sunspot_configuration = Sunspot::Rails::Configuration.new
+  end
+
+  describe "rake task commands" do
+    before(:each) do
+      Sunspot::Rails::Server.should_receive(:pid_path).and_return('/tmp')
+    end
+    
+    it "should generate and execute the start command" do
+      Sunspot::Rails::Server.should_receive(:start_command).and_return('sunspot-start')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:bootstrap_neccessary?).and_return(false)
+      Kernel.should_receive(:system).with('sunspot-start').and_return(true)
+      Sunspot::Rails::Server.start.should == true
+    end
+
+    it "should generate and execute the stop command" do
+      Sunspot::Rails::Server.should_receive(:stop_command).and_return('sunspot-stop')
+      Sunspot::Rails::Server.should_not_receive(:bootstrap_neccessary?)
+      Kernel.should_receive(:system).with('sunspot-stop').and_return(true)
+      Sunspot::Rails::Server.stop.should == true
+    end
+
+    it "should generate and execute the run command" do
+      Sunspot::Rails::Server.should_receive(:run_command).and_return('sunspot-run')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:bootstrap_neccessary?).and_return(false)
+      Kernel.should_receive(:system).with('sunspot-run').and_return(true)
+      Sunspot::Rails::Server.run.should == true
+    end
+  end
+
+  describe "bootstraping" do
+    before(:each) do
+      @temp_dir = File.join( Dir.tmpdir, 'solr_rspec', Time.now.to_i.to_s, rand(1000).to_s )
+      Sunspot::Rails::Server.should_receive(:solr_home).at_least(1).and_return( @temp_dir )
+    end
+    
+    it "should require bootstraping" do
+      Sunspot::Rails::Server.bootstrap_neccessary?.should == true
+    end
+    
+    it "should not require bootstrapping again" do
+      Sunspot::Rails::Server.bootstrap_neccessary?.should == true
+      Sunspot::Rails::Server.bootstrap
+      Sunspot::Rails::Server.bootstrap_neccessary?.should == false
+    end
+  end
+
+  describe "delegate methods" do
+    before(:each) do
+      Sunspot::Rails::Server.should_receive(:configuration).at_least(1).and_return(@sunspot_configuration)
+    end
+
+    it "should delegate the port method to the configuration" do
+      @sunspot_configuration.should_respond_to_and_receive(:port).and_return(1234)
+      Sunspot::Rails::Server.port.should == 1234
+    end
+    
+    it "should delegate the solr_home method to the configuration" do
+      @sunspot_configuration.should_respond_to_and_receive(:solr_home).and_return('/some/path')
+      Sunspot::Rails::Server.solr_home.should == '/some/path'
+    end
+    
+    it "should delegate the log_level method to the configuration" do
+      @sunspot_configuration.should_respond_to_and_receive(:log_level).and_return('LOG_LEVEL')
+      Sunspot::Rails::Server.log_level.should == 'LOG_LEVEL'
+    end
+
+    it "should delegate the log_dir method to the configuration" do
+      @sunspot_configuration.should_respond_to_and_receive(:log_file).and_return('log_file')
+      Sunspot::Rails::Server.log_file.should =~ /log_file/
+    end
+
+  end
+
+  describe "protected methods" do
+    it "should generate the start command" do
+      Sunspot::Rails::Server.should_respond_to_and_receive(:port).and_return('1')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:solr_home).and_return('home')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:data_path).and_return('data')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:log_level).and_return('LOG')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:log_file).and_return('log_file')
+      Sunspot::Rails::Server.send(:start_command).should == \
+          [ 'sunspot-solr', 'start', '-p', '1', '-d', 'data', '-s', 'home', '-l', 'LOG', '--log-file', 'log_file' ]
+    end
+  
+    it "should generate the stop command" do
+      Sunspot::Rails::Server.send(:stop_command).should == [ 'sunspot-solr', 'stop' ]
+    end
+  
+    it "should generate the run command" do
+      Sunspot::Rails::Server.should_respond_to_and_receive(:port).and_return('1')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:solr_home).and_return('home')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:data_path).and_return('data')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:log_level).and_return('LOG')
+      Sunspot::Rails::Server.should_respond_to_and_receive(:log_file).and_return('log_file')
+      Sunspot::Rails::Server.send(:run_command).should == \
+          [ 'sunspot-solr', 'run', '-p', '1', '-d', 'data', '-s', 'home', '-l', 'LOG', '-lf', 'log_file' ]
+    end
+
+    it "should generate the path for config files" do
+      Sunspot::Rails::Server.should_receive(:solr_home).and_return('/solr/home')
+      Sunspot::Rails::Server.config_path.should == '/solr/home/conf'
+    end
+    
+    it "should generate the path for custom libraries" do
+      Sunspot::Rails::Server.should_receive(:solr_home).and_return('/solr/home')
+      Sunspot::Rails::Server.lib_path.should == '/solr/home/lib'
+    end
+  
+    it "should generate the path for the index data" do
+      Sunspot::Rails::Server.should_receive(:solr_home).and_return('/solr/home')
+      Sunspot::Rails::Server.data_path.should == '/solr/home/data/test'
+    end
+
+    it "should generate the path for pid files" do
+      Sunspot::Rails::Server.should_receive(:solr_home).and_return('/solr/home')
+      Sunspot::Rails::Server.pid_path.should == '/solr/home/pids/test'
+    end
+  end
+end