nxa-sunspot_rails 0.11.3

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

@@ -0,0 +1,35 @@
+namespace :sunspot do
+  namespace :solr do
+    desc 'Start the Solr instance'
+    task :start => :environment 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
+    end
+
+    desc 'Run the Solr instance in the foreground'
+    task :run => :environment do
+      Sunspot::Rails::Server.run
+    end
+
+    desc 'Stop the Solr instance'
+    task :stop => :environment do
+      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

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

data/lib/sunspot/rails.rb

@@ -0,0 +1,22 @@
+require 'sunspot'
+require 'sunspot/rails/configuration'
+require 'sunspot/rails/adapters'
+require 'sunspot/rails/request_lifecycle'
+require 'sunspot/rails/searchable'
+require 'sunspot/rails/util'
+
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    class <<self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Sunspot::Rails::Configuration.new
+      end
+
+      def reset
+        @master_session = @configuration = nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+require 'sunspot'
+
+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) }
+ActionController::Base.module_eval { include(Sunspot::Rails::RequestLifecycle) }

data/spec/configuration_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Sunspot::Rails::Configuration, "default values" do
+  before(:each) do
+    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.hostname.should == 'localhost'
+  end  
+  
+  it "should handle the 'path' property when not set" do
+    @config.path.should == '/solr'
+  end
+
+  it "should handle the 'port' property when not set" do
+    @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.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')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'some.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 1234
+  end
+  
+  it "should handle the 'path' property when set" do
+    @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.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/controllers/application.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/mock_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/mock_app/app/controllers/posts_controller.rb

@@ -0,0 +1,6 @@
+class PostsController < ApplicationController
+  def create
+    PostWithAuto.create(params[:post])
+    render :nothing => 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/blog.rb

@@ -0,0 +1,2 @@
+class Blog < ActiveRecord::Base
+end

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

@@ -0,0 +1,5 @@
+class Post < ActiveRecord::Base
+  searchable :auto_index => false, :auto_remove => false do
+    string :title
+  end
+end

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

@@ -0,0 +1,9 @@
+class PostWithAuto < ActiveRecord::Base
+  def self.table_name
+    'posts'
+  end
+
+  searchable :ignore_attribute_changes_of => [ :updated_at ] do
+    string :title
+  end
+end

data/spec/mock_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!