sunspot_rails 0.11.5 → 1.0.0

data/lib/sunspot/rails/solr_logging.rb

@@ -0,0 +1,54 @@
+module Sunspot
+  module Rails
+    module SolrLogging
+      class <<self
+        def included(base)
+          base.module_eval { alias_method_chain(:request, :rails_logging) }
+        end
+      end
+
+      def request_with_rails_logging(path, params={}, *extra)
+
+        # Set up logging text.
+        body = (params.nil? || params.empty?) ? extra.first : params.inspect
+        action = path[1..-1].capitalize
+        if body == "<commit/>"
+          action = 'Commit'
+          body = ''
+        end
+        body = body[0, 800] + '...' if body.length > 800
+
+        # Make request and log.
+        response = nil
+        begin
+          ms = Benchmark.ms do
+            response = request_without_rails_logging(path, params, *extra)
+          end
+          log_name = 'Solr %s (%.1fms)' % [action, ms]
+          ::Rails.logger.debug(format_log_entry(log_name, body))
+        rescue Exception => e
+          log_name = 'Solr %s (Error)' % [action]
+          ::Rails.logger.error(format_log_entry(log_name, body))
+          raise e
+        end
+
+        response
+      end
+
+      private
+
+      def format_log_entry(message, dump = nil)
+        if ActiveRecord::Base.colorize_logging
+          message_color, dump_color = "4;32;1", "0;1"
+          log_entry = "  \e[#{message_color}m#{message}\e[0m   "
+          log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
+          log_entry
+        else
+          "%s  %s" % [message, dump]
+        end
+      end
+    end
+  end
+end
+
+RSolr::Connection::Base.module_eval { include(Sunspot::Rails::SolrLogging) }

data/lib/sunspot/rails/spec_helper.rb

@@ -0,0 +1,19 @@
+module Sunspot
+  module Rails
+    module SpecHelper
+      def disconnect_sunspot
+        before(:each) do
+          Sunspot.session = StubSessionProxy.new(Sunspot.session)
+        end
+
+        after(:each) do
+          Sunspot.session = Sunspot.session.original_session
+        end
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.extend(Sunspot::Rails::SpecHelper)
+end

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -0,0 +1,83 @@
+module Sunspot
+  module Rails
+    class StubSessionProxy
+      attr_reader :original_session
+
+      def initialize(original_session)
+        @original_session = original_session
+      end
+
+      def index(*objects)
+      end
+
+      def index!(*objects)
+      end
+
+      def remove(*objects)
+      end
+
+      def remove!(*objects)
+      end
+
+      def remove_by_id(clazz, id)
+      end
+
+      def remove_by_id!(clazz, id)
+      end
+
+      def remove_all(clazz = nil)
+      end
+
+      def remove_all!(clazz = nil)
+      end
+
+      def dirty?
+        false
+      end
+
+      def delete_dirty?
+        false
+      end
+
+      def commit_if_dirty
+      end
+
+      def commit_if_delete_dirty
+      end
+
+      def commit
+      end
+
+      def search(*types)
+        Search.new
+      end
+
+      def new_search(*types)
+        Search.new
+      end
+
+      class Search
+        def results
+          []
+        end
+
+        def hits(options = {})
+          []
+        end
+
+        def total
+          0
+        end
+
+        def facet(name)
+        end
+
+        def dynamic_facet(name)
+        end
+
+        def execute
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/tasks.rb

@@ -5,12 +5,12 @@ namespace :sunspot do
       if RUBY_PLATFORM =~ /w(in)?32$/
         abort('This command does not work on Windows. Please use rake sunspot:solr:run to run Solr in the foreground.')
       end
-      Sunspot::Rails::Server.start
+      Sunspot::Rails::Server.new.start
     end
 
     desc 'Run the Solr instance in the foreground'
     task :run => :environment do
-      Sunspot::Rails::Server.run
+      Sunspot::Rails::Server.new.run
     end
 
     desc 'Stop the Solr instance'
@@ -18,18 +18,20 @@ namespace :sunspot do
       if RUBY_PLATFORM =~ /w(in)?32$/
         abort('This command does not work on Windows.')
       end
-      Sunspot::Rails::Server.stop
+      Sunspot::Rails::Server.new.stop
     end
 
-    desc 'Reindex all solr models'
-    task :reindex => :environment do
-      all_files = Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '*.rb'))
-      all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
-      sunspot_models = all_models.select { |m| m < ActiveRecord::Base and m.searchable? }
-      
-      sunspot_models.each do |model|
-        model.reindex :batch_commit => false
-      end
+    task :reindex => :"sunspot:reindex"
+  end
+
+  desc 'Reindex all solr models'
+  task :reindex => :environment do
+    all_files = Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '*.rb'))
+    all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
+    sunspot_models = all_models.select { |m| m < ActiveRecord::Base and m.searchable? }
+
+    sunspot_models.each do |model|
+      model.reindex :batch_commit => false
     end
   end
-end
+end

data/lib/sunspot/rails/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Rails
-    VERSION = '0.11.5'
+    VERSION = '1.0.0'
   end
 end

data/lib/sunspot/rails.rb

@@ -1,12 +1,15 @@
 require 'sunspot'
-require 'sunspot/rails/configuration'
-require 'sunspot/rails/adapters'
-require 'sunspot/rails/request_lifecycle'
-require 'sunspot/rails/searchable'
-require 'sunspot/rails/util'
+require File.join(File.dirname(__FILE__), 'rails', 'configuration')
+require File.join(File.dirname(__FILE__), 'rails', 'adapters')
+require File.join(File.dirname(__FILE__), 'rails', 'request_lifecycle')
+require File.join(File.dirname(__FILE__), 'rails', 'searchable')
 
 module Sunspot #:nodoc:
   module Rails #:nodoc:
+    autoload :StubSessionProxy, File.join(File.dirname(__FILE__), 'rails', 'stub_session_proxy')
+    autoload :Server, File.join(File.dirname(__FILE__), 'rails', 'server')
+    autoload :VERSION, File.join(File.dirname(__FILE__), 'rails', 'version')
+
     class <<self
       attr_writer :configuration
 
@@ -15,7 +18,40 @@ module Sunspot #:nodoc:
       end
 
       def reset
-        @master_session = @configuration = nil
+        @configuration = nil
+      end
+
+      def build_session(configuration = self.configuration)
+        if configuration.has_master?
+          SessionProxy::MasterSlaveSessionProxy.new(
+            SessionProxy::ThreadLocalSessionProxy.new(master_config(configuration)),
+            SessionProxy::ThreadLocalSessionProxy.new(slave_config(configuration))
+          )
+        else
+          SessionProxy::ThreadLocalSessionProxy.new(slave_config(configuration))
+        end
+      end
+
+      private
+
+      def master_config(sunspot_rails_configuration)
+        config = Sunspot::Configuration.build
+        config.solr.url = URI::HTTP.build(
+          :host => sunspot_rails_configuration.master_hostname,
+          :port => sunspot_rails_configuration.master_port,
+          :path => sunspot_rails_configuration.master_path
+        ).to_s
+        config
+      end
+
+      def slave_config(sunspot_rails_configuration)
+        config = Sunspot::Configuration.build
+        config.solr.url = URI::HTTP.build(
+          :host => configuration.hostname,
+          :port => configuration.port,
+          :path => configuration.path
+        ).to_s
+        config
       end
     end
   end

data/rails/init.rb

@@ -1,6 +1,6 @@
 require 'sunspot'
 
-Sunspot.session = Sunspot::Rails::SessionProxy.instance
+Sunspot.session = Sunspot::Rails.build_session
 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/mock_app/app/models/photo_post.rb

@@ -0,0 +1,2 @@
+class PhotoPost < PostWithAuto
+end

data/spec/mock_app/db/schema.rb

@@ -1,6 +1,7 @@
 ActiveRecord::Schema.define(:version => 0) do
   create_table :posts, :force => true do |t|
     t.string :title
+    t.string :type
     t.text :body
     t.references :blog
     t.timestamps

data/spec/mock_app/db/test.db

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

data/spec/model_lifecycle_spec.rb

@@ -1,8 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe 'searchable with lifecycle' do
-  integrate_sunspot
-  
   describe 'on create' do
     before :each do
       @post = PostWithAuto.create
@@ -24,6 +22,20 @@ describe 'searchable with lifecycle' do
     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 :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 :index
+      @post.save!
+    end
   end
   
   describe 'on destroy' do
@@ -40,8 +52,6 @@ describe 'searchable with lifecycle' do
 end
 
 describe 'searchable with lifecycle - ignoring specific attributes' do
-  integrate_sunspot
-  
   before(:each) do
     @post = PostWithAuto.create
   end

data/spec/model_spec.rb

@@ -1,8 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe 'ActiveRecord mixin' do
-  integrate_sunspot
-  
   describe 'index()' do
     before :each do
       @post = Post.create!
@@ -19,6 +17,17 @@ describe 'ActiveRecord mixin' do
     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!
@@ -107,7 +116,7 @@ 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], anything()).and_return([@post])
+      Post.should_receive(:find_all_by_id).with([@post.id.to_i], anything).and_return([@post])
       Post.search do
         with :title, 'Test Post'
       end.results.should == [@post]
@@ -135,6 +144,16 @@ describe 'ActiveRecord mixin' 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
+
   end
 
   describe 'search_ids()' do
@@ -233,8 +252,9 @@ describe 'ActiveRecord mixin' do
         Post.search.results.to_set.should == @posts.to_set
       end
     end
-    
   end
+
+
   
   describe "reindex()" do
   

data/spec/schema.rb

@@ -1,6 +1,7 @@
 ActiveRecord::Schema.define(:version => 0) do
   create_table :posts, :force => true do |t|
     t.string :title
+    t.string :type
     t.text :body
     t.references :blog
     t.timestamps

data/spec/server_spec.rb

@@ -1,124 +1,36 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Sunspot::Rails::Server do
-  before(:each) do
-    @sunspot_configuration = Sunspot::Rails::Configuration.new
+  before :each do
+    @server = Sunspot::Rails::Server.new
+    @solr_home = File.expand_path(File.join(Rails.root, 'solr'))
   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
+  it "sets the correct Solr home" do
+    @server.solr_home.should == @solr_home
   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
+  it "sets the correct Solr library path" do
+    @server.lib_path.should == File.join(@solr_home, 'lib')
   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
+  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
 
-  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 "sets the correct port" do
+    @server.port.should == 8980
+  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 "sets the correct log level" do
+    @server.log_level.should == "FINE"
+  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
+  it "sets the correct log file" do
+    @server.log_file.should == File.join(Rails.root, 'log', 'sunspot-solr-test.log')
   end
-end
+end

data/spec/spec_helper.rb

@@ -12,8 +12,7 @@ require 'spec'
 require 'spec/rails'
 require 'rake'
 require 'ruby-debug' unless RUBY_VERSION > '1.9'
-require 'sunspot/rails/tasks'
-require 'sunspot/spec/extension'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'rails', 'solr_logging')
 
 def load_schema
   stdout = $stdout
@@ -31,11 +30,8 @@ end
 
 Spec::Runner.configure do |config|
   config.before(:each) do
-    if integrate_sunspot?
-      Sunspot.remove_all
-      Sunspot.commit
-    end
     load_schema
+    Sunspot.remove_all!
   end
 end