sunspot_rails 0.10.9 → 0.11.0

data/lib/sunspot/rails/request_lifecycle.rb

@@ -9,7 +9,11 @@ module Sunspot #:nodoc:
       class <<self
         def included(base) #:nodoc:
           base.after_filter do
-            Sunspot.commit_if_dirty if Sunspot::Rails.configuration.auto_commit_after_request?
+            if Sunspot::Rails.configuration.auto_commit_after_request?
+              Sunspot.commit_if_dirty
+            elsif Sunspot::Rails.configuration.auto_commit_after_delete_request?
+              Sunspot.commit_if_delete_dirty
+            end
           end
         end
       end

data/lib/sunspot/rails/searchable.rb

@@ -34,6 +34,9 @@ module Sunspot #:nodoc:
         #   Automatically remove models from the Solr index when they are
         #   destroyed. <b>Setting this option to +false+ is not recommended
         #   </b>(see the README).
+        # :ignore_attribute_changes_of<Array>::
+        #   Define attributes, that should not trigger a reindex of that
+        #   object. Usual suspects are update_at or counters.
         #
         # ==== Example
         #
@@ -54,10 +57,12 @@ module Sunspot #:nodoc:
           unless searchable?
             extend ClassMethods
             include InstanceMethods
-
+            
+            Sunspot::Rails::Util.sunspot_options[self.to_s.underscore.to_sym] = options
+            
             unless options[:auto_index] == false
               after_save do |searchable|
-                searchable.index
+                searchable.index if Sunspot::Rails::Util.index_relevant_attribute_changed?( searchable )
               end
             end
 
@@ -136,7 +141,7 @@ module Sunspot #:nodoc:
         # XXX Sunspot should implement remove_all!()
         #
         def remove_all_from_index!
-          Sunspot.remove_all(self)
+          remove_all_from_index
           Sunspot.commit
         end
 
@@ -182,12 +187,15 @@ module Sunspot #:nodoc:
           unless options[:batch_size]
             Sunspot.index!(all(:include => options[:include]))
           else
-            record_count = count
-            counter = 1
             offset = 0
+            counter = 1
+            record_count = count
+            last_id = 0
             while(offset < record_count)
               benchmark options[:batch_size], counter do
-                Sunspot.index(all(:include => options[:include], :offset => offset, :limit => options[:batch_size], :order => primary_key))
+                records = all(:include => options[:include], :conditions => ["#{table_name}.#{primary_key} > ?", last_id], :limit => options[:batch_size], :order => primary_key)
+                Sunspot.index(records)
+                last_id = records.last.id
               end
               Sunspot.commit if options[:batch_commit]
               offset += options[:batch_size]
@@ -292,12 +300,8 @@ module Sunspot #:nodoc:
         # Remove the model from the Solr index and commit immediately. See
         # #remove_from_index
         #
-        #---
-        #FIXME Sunspot should implement remove!()
-        #
         def remove_from_index!
-          Sunspot.remove(self)
-          Sunspot.commit
+          Sunspot.remove!(self)
         end
       end
     end

data/lib/sunspot/rails/server.rb

@@ -0,0 +1,229 @@
+require 'escape'
+
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    # The Sunspot::Rails::Server class is a simple wrapper around
+    # the start/stop scripts for solr.
+    class Server
+      
+      class << self
+        delegate :log_file, :log_level, :port, :solr_home, :to => :configuration
+        
+        # Name of the sunspot executable (shell script)
+        SUNSPOT_EXECUTABLE = (RUBY_PLATFORM =~ /w(in)?32$/ ? 'sunspot-solr.bat' : 'sunspot-solr')
+      
+        #
+        # Start the sunspot-solr server. Bootstrap solr_home first,
+        # if neccessary.
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def start
+          bootstrap if bootstrap_neccessary?
+          execute( start_command )
+        end
+        
+        # 
+        # Run the sunspot-solr server in the foreground. Boostrap
+        # solr_home first, if neccessary.
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def run
+          bootstrap if bootstrap_neccessary?
+          execute( run_command )
+        end
+        
+        # 
+        # Stop the sunspot-solr server.
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def stop
+          execute( stop_command )
+        end
+        
+        # 
+        # Directory to store solr config files
+        #
+        # ==== Returns
+        #
+        # String:: config_path
+        #
+        def config_path
+          File.join( solr_home, 'conf' )
+        end
+        
+        # 
+        # Directory to store lucene index data files
+        #
+        # ==== Returns
+        #
+        # String:: data_path
+        #
+        def data_path
+          File.join( solr_home, 'data', ::Rails.env )
+        end
+
+        # 
+        # Directory to store custom libraries for solr
+        #
+        # ==== Returns
+        #
+        # String:: lib_path
+        #
+        def lib_path
+          File.join( solr_home, 'lib' )
+        end
+        
+        # 
+        # Directory to store pid files
+        #
+        # ==== Returns
+        #
+        # String:: pid_path
+        #
+        def pid_path
+          File.join( solr_home, 'pids', ::Rails.env )
+        end
+        
+        #
+        # Bootstrap a new solr_home by creating all required
+        # directories. 
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def bootstrap
+          create_solr_directories and create_solr_configuration_files and copy_custom_solr_libraries
+        end
+        
+        # 
+        # Check for bootstrap necessity
+        #
+        # ==== Returns
+        #
+        # Boolean:: neccessary
+        #
+        def bootstrap_neccessary?
+          !File.directory?( solr_home ) or !File.exists?( File.join( config_path, 'solrconfig.xml' ) )
+        end
+        
+        
+        protected
+        
+        # 
+        # Generate the start command for the sunspot-solr executable
+        #
+        # ==== Returns
+        #
+        # Array:: sunspot_start_command
+        #
+        def start_command
+          [ SUNSPOT_EXECUTABLE, 'start', '-p', port.to_s, '-d', data_path, '-s', solr_home, '-l', log_level, '--log-file', log_file ]
+        end
+
+        #
+        # Generate the stop command for the sunspot-solr executable
+        #
+        # ==== Returns
+        #
+        # Array:: sunspot_stop_command
+        #
+        def stop_command
+          [ SUNSPOT_EXECUTABLE, 'stop' ]
+        end
+
+        # 
+        # Generate the run command for the sunspot-solr executable
+        #
+        # ==== Returns
+        # 
+        # Array:: run_command
+        #
+        def run_command
+          [ SUNSPOT_EXECUTABLE, 'run', '-p', port.to_s, '-d', data_path, '-s', solr_home, '-l', log_level, '-lf', log_file ]
+        end
+        
+        #
+        # access to the Sunspot::Rails::Configuration, defined in
+        # sunspot.yml. Use Sunspot::Rails.configuration if you want
+        # to access the configuration directly.
+        #
+        # ==== returns
+        #
+        # Sunspot::Rails::Configuration:: configuration
+        #
+        def configuration
+          Sunspot::Rails.configuration
+        end
+        
+        private 
+        
+        #
+        # Change directory to the pid file path and execute a
+        # command on a subshell.
+        # 
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def execute( command )
+          success = false
+          FileUtils.cd( pid_path ) do
+            success = Kernel.system(Escape.shell_command( command ))
+          end
+          success
+        end
+        
+        # 
+        # Create new solr_home, config, log and pid directories
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def create_solr_directories
+          [ solr_home, config_path, data_path, pid_path, lib_path ].each do |path|
+            FileUtils.mkdir_p( path )
+          end
+        end
+        
+        #
+        # Copy custom solr libraries (like localsolr) to the
+        # lib directory
+        #
+        # ==== Returns
+        # 
+        # Boolean:: success
+        #
+        def copy_custom_solr_libraries
+          Dir.glob( File.join( Sunspot::Configuration.solr_default_configuration_location, '..', 'lib', '*.jar') ).each do |jar_file|
+            FileUtils.cp( jar_file, lib_path )
+          end
+        end
+        
+        #
+        # Copy default solr configuration files from sunspot
+        # gem to the new solr_home/config directory
+        #
+        # ==== Returns
+        #
+        # Boolean:: success
+        #
+        def create_solr_configuration_files
+          Dir.glob( File.join( Sunspot::Configuration.solr_default_configuration_location, '*') ).each do |config_file|
+            FileUtils.cp( config_file, config_path )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/session_proxy.rb

@@ -0,0 +1,62 @@
+module Sunspot
+  module Rails
+    class SessionProxy
+      extend MonitorMixin
+
+      class <<self
+        def instance
+          synchronize do
+            @instance ||= new
+          end
+        end
+
+        def reset!
+          synchronize do
+            @instance = nil
+          end
+        end
+
+        private :new
+      end
+
+      delegate :new_search, :search, :to => :read_session
+      delegate :index, :index!, :commit, :remove, :remove!, :remove_by_id,
+               :remove_by_id!, :remove_all, :remove_all!, :dirty?, :commit_if_dirty, :batch,
+               :to => :write_session
+
+      def initialize
+        @configuration = Sunspot::Rails::Configuration.new
+      end
+
+      private
+
+      def read_session
+        Thread.current[:sunspot_rails_read_session] ||=
+          begin
+            session = Sunspot::Session.new
+            session.config.solr.url = URI::HTTP.build(
+              :host => @configuration.hostname,
+              :port => @configuration.port,
+              :path => @configuration.path
+            ).to_s
+            session
+          end
+      end
+
+      def write_session
+        Thread.current[:sunspot_rails_write_session] ||=
+          if @configuration.has_master?
+            master_session = Sunspot::Session.new
+            master_session.config.solr.url = URI::HTTP.build(
+              :host => configuration.master_hostname,
+              :port => configuration.master_port,
+              :path => configuration.master_path
+            ).to_s
+            master_session
+          else
+            read_session
+          end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/tasks.rb

@@ -1,5 +1,3 @@
-require 'escape'
-
 namespace :sunspot do
   namespace :solr do
     desc 'Start the Solr instance'
@@ -7,47 +5,31 @@ 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
-      data_path = File.join(::Rails.root, 'solr', 'data', ::Rails.env)
-      pid_path = File.join(::Rails.root, 'solr', 'pids', ::Rails.env)
-      solr_home =
-        if %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
-          File.join(::Rails.root, 'solr')
-        end
-      [data_path, pid_path].each { |path| FileUtils.mkdir_p(path) }
-      port = Sunspot::Rails.configuration.port
-      FileUtils.cd(File.join(pid_path)) do
-        command = ['sunspot-solr', 'start', '-p', port.to_s, '-d', data_path]
-        if solr_home
-          command << '-s' << solr_home
-        end
-        system(Escape.shell_command(command))
-      end
+      Sunspot::Rails::Server.start
     end
 
     desc 'Run the Solr instance in the foreground'
     task :run => :environment do
-      data_path = File.join(::Rails.root, 'solr', 'data', ::Rails.env)
-      solr_home =
-        if %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
-          File.join(::Rails.root, 'solr')
-        end
-      FileUtils.mkdir_p(data_path)
-      port = Sunspot::Rails.configuration.port
-      command = ['sunspot-solr', 'run', '-p', port.to_s, '-d', data_path]
-      if RUBY_PLATFORM =~ /w(in)?32$/
-        command.first << '.bat'
-      end
-      if solr_home
-        command << '-s' << solr_home
-      end
-      exec(Escape.shell_command(command))
+      Sunspot::Rails::Server.run
     end
 
     desc 'Stop the Solr instance'
     task :stop => :environment do
-      FileUtils.cd(File.join(::Rails.root, 'solr', 'pids', ::Rails.env)) do
-        system(Escape.shell_command(['sunspot-solr', 'stop']))
+      if RUBY_PLATFORM =~ /w(in)?32$/
+        abort('This command does not work on Windows.')
+      end
+      Sunspot::Rails::Server.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
     end
   end
-end
+end

data/lib/sunspot/rails/util.rb

@@ -0,0 +1,20 @@
+require 'escape'
+
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    class Util
+      class << self
+        def sunspot_options
+          @sunspot_options ||= {}
+        end
+        
+        def index_relevant_attribute_changed?( object )
+          class_key = object.class.to_s.underscore.to_sym
+          ignore_attributes = (sunspot_options[class_key][:ignore_attribute_changes_of] || [])
+          !(object.changes.symbolize_keys.keys - ignore_attributes).blank?
+        end
+        
+      end
+    end
+  end
+end