sunspot_rails 0.11.5 → 1.0.0

data/History.txt

@@ -1,3 +1,15 @@
+== 1.0.0
+* Sunspot::Rails::Server subclasses Sunspot::Server; no longer needs to shell out
+* Use Sunspot built-in session proxies in Sunspot::Rails
+* Sunspot::Rails adapter compatible with assumed inconsistency
+* Use session proxy for disconnecting Sunspot in specs
+* Allow specification of first ID for reindex batches.
+* Log Solr requests in Rails logger
+* Use class_inheritable_hash for sunspot_options
+* Add `index` class method, which is like `reindex` but doesn't clear first
+* Rename sunspot:solr:reindex to sunspot:reindex
+* Use Sunspot::Installer to bootstrap Rails Solr home
+
 == 0.10.7
 * Added Sunspot::Rails::Server class to  start/stop/run/bootstrap the solr server
 * Added log_level key to sunspot.yml, see java docs for valid values (http://java.sun.com/j2se/1.5.0/docs/api/java/util/logging/Level.html)

data/README.rdoc

@@ -206,31 +206,24 @@ used as intended.
 
 == Testing Solr integration using RSpec
 
-To disable the sunspot-solr integration for your active record models, add the
-following line to your spec_helper.rb
+To disable the sunspot-solr integration for your active record models, require
+the file `sunspot/rails/spec_helper`
 
-require 'sunspot/spec/extension'
+Then, in your spec, use the #disconnect_sunspot method:
 
-This will disable all automatic after_save/after_destroy solr-requests generated
-via the #searchable method. This will not disable/mock explicit calls in your code.
+  require 'sunspot/rails/spec_helper'
 
-If you want to test the sunspot-solr integration with active record, you can 
-reenable the after_save/after_destroy hooks by adding 'integrate_sunspot' in your
-examples.
-
-  describe Searches do
-    integrate_sunspot
-    
-    before(:each) do
-      @movie = Factory.create :movie
-    end
+  describe Post do
+    disconnect_sunspot
     
-    it "should find a movie" do
-      Movie.search { keywords @movie.title }.first.should == @movie
+    it 'should have some behavior'
+      # ...
     end
   end
 
-
+In all of the examples in this group, all Sunspot calls will be stubbed out. The
+Sunspot#search method will return a stub search object that mimics a search with
+no results.
 
 == Further Reading
 
@@ -254,6 +247,7 @@ http://outoftime.lighthouseapp.com/projects/20339-sunspot
 - Benjamin Krause (bk@benjaminkrause.com)
 - Adam Salter (adam@codebright.net)
 - Brandon Keepers (brandon@opensoul.org)
+- Paul Canavese (paul@canavese.org)
 
 == License
 

data/TODO

@@ -1,4 +1,4 @@
-* Session proxy should give access to config
+* Delegate new_search method
 =======
 * Fix final status output for reindex
 * Add batch-per-request option

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 0
+:minor: 11

data/dev_tasks/gemspec.rake

@@ -1,7 +1,8 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'sunspot', 'lib', 'sunspot', 'gem_tasks')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'rails', 'version')
+require File.join(File.dirname(__FILE__), '..', '..', 'tools', 'gem_tasks')
 
 Sunspot::GemTasks.new do |s|
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'rails', 'version')
+
   s.name = 'sunspot_rails'
   s.version = Sunspot::Rails::VERSION
   s.summary = 'Rails integration for the Sunspot Solr search library'
@@ -15,21 +16,19 @@ running a Sunspot-compatible Solr instance for development and test
 environments, and automatically commit Solr index changes at the end of each
 Rails request.
 TEXT
-  s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause']
+  s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause', 'Adam Salter', 'Brandon Keepers', 'Paul Canavese']
   s.rubyforge_project = 'sunspot'
   s.files = FileList['[A-Z]*',
-                     '{lib,tasks,dev_tasks}/**/*',
-                     'generators/**/*',
-                     'install.rb',
-                     'MIT-LICENSE',
-                     'rails/*',
-                     'spec/*.rb',
-                     'spec/mock_app/{app,lib,db,vendor,config}/**/*',
-                     'spec/mock_app/{tmp,log,solr}']
+    '{lib,tasks,dev_tasks}/**/*',
+    'generators/**/*',
+    'install.rb',
+    'MIT-LICENSE',
+    'rails/*',
+    'spec/*.rb',
+    'spec/mock_app/{app,lib,db,vendor,config}/**/*',
+    'spec/mock_app/{tmp,log,solr}']
   s.add_dependency 'escape', '>= 0.0.4'
-  s.add_dependency 'sunspot', '>= 0.10.6', '<= 0.10.8'
+  s.add_dependency 'sunspot', Sunspot::Rails::VERSION
   s.add_development_dependency 'rspec', '~> 1.2'
   s.add_development_dependency 'rspec-rails', '~> 1.2'
-  s.add_development_dependency 'ruby-debug', '~> 0.10'
-  s.add_development_dependency 'technicalpickles-jeweler', '~> 1.0'
 end

data/lib/sunspot/rails/adapters.rb

@@ -47,7 +47,7 @@ module Sunspot #:nodoc:
         # ActiveRecord::Base:: ActiveRecord model
         # 
         def load(id)
-          @clazz.find(id.to_i, options_for_find)
+          @clazz.find_by_id(id.to_i, options_for_find)
         end
 
         # 
@@ -62,7 +62,7 @@ module Sunspot #:nodoc:
         # Array:: Collection of ActiveRecord models
         #
         def load_all(ids)
-          @clazz.find(ids.map { |id| id.to_i }, options_for_find)
+          @clazz.find_all_by_id(ids.map { |id| id.to_i }, options_for_find)
         end
         
         private

data/lib/sunspot/rails/searchable.rb

@@ -36,7 +36,7 @@ module Sunspot #:nodoc:
         #   </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.
+        #   object. Usual suspects are updated_at or counters.
         #
         # ==== Example
         #
@@ -57,13 +57,12 @@ module Sunspot #:nodoc:
           unless searchable?
             extend ClassMethods
             include InstanceMethods
-            
-            Sunspot::Rails::Util.sunspot_options[self.to_s.underscore.to_sym] = options
+
+            class_inheritable_hash :sunspot_options
             
             unless options[:auto_index] == false
-              after_save do |searchable|
-                searchable.index if Sunspot::Rails::Util.index_relevant_attribute_changed?( searchable )
-              end
+              before_save :maybe_mark_for_auto_indexing
+              after_save :maybe_auto_index
             end
 
             unless options[:auto_remove] == false
@@ -72,6 +71,7 @@ module Sunspot #:nodoc:
               end
             end
           end
+          self.sunspot_options = options
         end
 
         # 
@@ -137,17 +137,24 @@ module Sunspot #:nodoc:
         # Remove all instances of this class from the Solr index and immediately
         # commit.
         #
-        #---
-        # XXX Sunspot should implement remove_all!()
         #
         def remove_all_from_index!
-          remove_all_from_index
-          Sunspot.commit
+          Sunspot.remove_all!(self)
         end
 
         # 
         # Completely rebuild the index for this class. First removes all
-        # instances from the index, then loads records and save them. The
+        # instances from the index, then loads records and indexes them.
+        #
+        # See #index for information on options, etc.
+        #
+        def reindex(options = {})
+          remove_all_from_index
+          index(options)
+        end
+
+        #
+        # Add/update all existing records in the Solr index. The
         # +batch_size+ argument specifies how many records to load out of the
         # database at a time. The default batch size is 500; if nil is passed,
         # records will not be indexed in batches. By default, a commit is issued
@@ -166,31 +173,33 @@ module Sunspot #:nodoc:
         #                  used for including associated objects that need to be
         #                  indexed with the parent object, accepts all formats
         #                  ActiveRecord::Base.find does
+        # first_id:: The lowest possible ID for this class. Defaults to 0, which
+        #            is fine for integer IDs; string primary keys will need to
+        #            specify something reasonable here.
         #
         # ==== Examples
         #   
-        #   # reindex in batches of 500, commit after each
-        #   Post.reindex 
+        #   # index in batches of 500, commit after each
+        #   Post.index 
         #
         #   # index all rows at once, then commit
-        #   Post.reindex(:batch_size => nil) 
+        #   Post.index(:batch_size => nil) 
         #
-        #   # reindex in batches of 500, commit when all batches complete
-        #   Post.reindex(:batch_commit => false) 
+        #   # index in batches of 500, commit when all batches complete
+        #   Post.index(:batch_commit => false) 
         #
         #   # include the associated +author+ object when loading to index
-        #   Post.reindex(:include => :author) 
+        #   Post.index(:include => :author) 
         #
-        def reindex(opts={})
-          options = { :batch_size => 500, :batch_commit => true, :include => []}.merge(opts)
-          remove_all_from_index
+        def index(opts={})
+          options = { :batch_size => 500, :batch_commit => true, :include => [], :first_id => 0}.merge(opts)
           unless options[:batch_size]
             Sunspot.index!(all(:include => options[:include]))
           else
             offset = 0
             counter = 1
             record_count = count
-            last_id = 0
+            last_id = options[:first_id]
             while(offset < record_count)
               benchmark options[:batch_size], counter do
                 records = all(:include => options[:include], :conditions => ["#{table_name}.#{primary_key} > ?", last_id], :limit => options[:batch_size], :order => primary_key)
@@ -303,6 +312,25 @@ module Sunspot #:nodoc:
         def remove_from_index!
           Sunspot.remove!(self)
         end
+
+        private
+
+        def maybe_mark_for_auto_indexing
+          @marked_for_auto_indexing =
+            if !new_record? && ignore_attributes = self.class.sunspot_options[:ignore_attribute_changes_of]
+              @marked_for_auto_indexing = !(changed.map { |attr| attr.to_sym } - ignore_attributes).blank?
+            else
+              true
+            end
+          true
+        end
+
+        def maybe_auto_index
+          if @marked_for_auto_indexing
+            index
+            remove_instance_variable(:@marked_for_auto_indexing)
+          end
+        end
       end
     end
   end

data/lib/sunspot/rails/server.rb

@@ -1,229 +1,152 @@
-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
+module Sunspot
+  module Rails
+    class Server < Sunspot::Server
+      # ActiveSupport log levels are integers; this array maps them to the
+      # appropriate java.util.logging.Level constant
+      LOG_LEVELS = %w(FINE INFO WARNING SEVERE SEVERE INFO)
 
-        # 
-        # 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
+      def start
+        bootstrap
+        super
+      end
 
-        #
-        # Generate the stop command for the sunspot-solr executable
-        #
-        # ==== Returns
-        #
-        # Array:: sunspot_stop_command
-        #
-        def stop_command
-          [ SUNSPOT_EXECUTABLE, 'stop' ]
-        end
+      def run
+        bootstrap
+        super
+      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
+      #
+      # Bootstrap a new solr_home by creating all required
+      # directories. 
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def bootstrap
+        unless @bootstrapped
+          install_solr_home
+          @bootstrapped = true
         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
+
+      # 
+      # Directory to store custom libraries for solr
+      #
+      def lib_path
+        File.join( solr_home, 'lib' )
+      end
+
+      # 
+      # Directory in which to store PID files
+      #
+      def pid_dir
+        File.join(::Rails.root, 'tmp', 'pids')
+      end
+
+      # 
+      # Name of the PID file
+      #
+      def pid_file
+        "sunspot-solr-#{::Rails.env}.pid"
+      end
+
+      # 
+      # Directory to store lucene index data files
+      #
+      # ==== Returns
+      #
+      # String:: data_path
+      #
+      def solr_data_dir
+        File.join(solr_home, 'data', ::Rails.env)
+      end
+
+      # 
+      # Directory to use for Solr home.
+      #
+      def solr_home
+        File.join(::Rails.root, 'solr')
+      end
+
+      # 
+      # Port on which to run Solr
+      #
+      def port
+        configuration.port
+      end
+
+      #
+      # Severity level for logging. This is based on the severity level for the
+      # Rails logger.
+      #
+      def log_level
+        LOG_LEVELS[::Rails.logger.level]
+      end
+
+      # 
+      # Log file for Solr. File is in the rails log/ directory.
+      #
+      def log_file
+        File.join(::Rails.root, 'log', "sunspot-solr-#{::Rails.env}.log")
+      end
+
+      private
+
+      #
+      # 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
+
+      # 
+      # Directory to store solr config files
+      #
+      # ==== Returns
+      #
+      # String:: config_path
+      #
+      def config_path
+        File.join(solr_home, 'conf')
+      end
+
+      #
+      # Copy default solr configuration files from sunspot
+      # gem to the new solr_home/config directory
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def install_solr_home
+        unless File.exists?(solr_home)
+          Sunspot::Installer.execute(
+            solr_home,
+            :force => true,
+            :verbose => true
+          )
         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
+
+      # 
+      # Create new solr_home, config, log and pid directories
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def create_solr_directories
+        [solr_data_dir, pid_dir].each do |path|
+          FileUtils.mkdir_p( path )
         end
       end
     end
   end
-end
+end