robsharp-sunspot_rails 1.1.0.2

data/lib/sunspot/rails/server.rb

@@ -0,0 +1,173 @@
+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)
+
+      def start
+        bootstrap
+        super
+      end
+
+      def run
+        bootstrap
+        super
+      end
+
+      #
+      # Bootstrap a new solr_home by creating all required
+      # directories. 
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def bootstrap
+        unless @bootstrapped
+          install_solr_home
+          @bootstrapped = true
+        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
+
+      #
+      # Solr start jar
+      #
+      def solr_jar
+        configuration.solr_jar || super
+      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
+
+      # 
+      # Minimum Java heap size for Solr
+      #
+      def min_memory
+        configuration.min_memory
+      end
+
+      # 
+      # Maximum Java heap size for Solr
+      #
+      def max_memory
+        configuration.max_memory
+      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
+      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

data/lib/sunspot/rails/solr_logging.rb

@@ -0,0 +1,58 @@
+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
+
+begin
+  RSolr::Client.module_eval { include(Sunspot::Rails::SolrLogging) }
+rescue NameError # RSolr 0.9.6
+  RSolr::Connection::Base.module_eval { include(Sunspot::Rails::SolrLogging) }
+end

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,88 @@
+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 build
+          self
+        end
+
+        def results
+          []
+        end
+
+        def hits(options = {})
+          []
+        end
+
+        def total
+          0
+        end
+
+        def facet(name)
+        end
+
+        def dynamic_facet(name)
+        end
+
+        def execute
+          self
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/tasks.rb

@@ -0,0 +1,62 @@
+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.new.start
+    end
+
+    desc 'Run the Solr instance in the foreground'
+    task :run => :environment do
+      Sunspot::Rails::Server.new.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.new.stop
+    end
+
+    task :reindex => :"sunspot:reindex"
+  end
+
+  desc "Reindex all solr models that are located in your application's models directory."
+  # This task depends on the standard Rails file naming \
+  # conventions, in that the file name matches the defined class name. \
+  # By default the indexing system works in batches of 500 records, you can \
+  # set your own value for this by using the batch_size argument. You can \
+  # also optionally define a list of models to separated by a forward slash '/'
+  # 
+  # $ rake sunspot:reindex                # reindex all models
+  # $ rake sunspot:reindex[1000]          # reindex in batches of 1000
+  # $ rake sunspot:reindex[false]         # reindex without batching
+  # $ rake sunspot:reindex[,Post]         # reindex only the Post model
+  # $ rake sunspot:reindex[1000,Post]     # reindex only the Post model in
+  #                                       # batchs of 1000
+  # $ rake sunspot:reindex[,Post+Author]  # reindex Post and Author model
+  task :reindex, :batch_size, :models, :needs => :environment do |t, args|
+    reindex_options = {:batch_commit => false}
+    case args[:batch_size]
+    when 'false'
+      reindex_options[:batch_size] = nil
+    when /^\d+$/ 
+      reindex_options[:batch_size] = args[:batch_size].to_i if args[:batch_size].to_i > 0
+    end
+    unless args[:models]
+      all_files = Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '*.rb'))
+      all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
+      # FIXME: Workaround the hack
+      sunspot_models = all_models #.select { |m| m < ActiveRecord::Base and m.searchable? }
+    else
+      sunspot_models = args[:models].split('+').map{|m| m.constantize}
+    end
+    sunspot_models.each do |model|
+      model.solr_reindex reindex_options
+    end
+  end
+  
+end

data/lib/sunspot/rails/version.rb

@@ -0,0 +1,5 @@
+module Sunspot
+  module Rails
+    VERSION = '1.1.0'
+  end
+end

data/rails/init.rb

@@ -0,0 +1,10 @@
+require 'sunspot'
+
+Sunspot.session = Sunspot::Rails.build_session
+Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
+Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveResourceInstanceAdapter, ActiveResource::Base)
+Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)
+Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveResourceDataAccessor, ActiveResource::Base)
+ActiveRecord::Base.module_eval { include(Sunspot::Rails::Searchable) }
+ActiveResource::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