gojee-sunspot-rails 2.0.3 → 2.0.4

data/lib/sunspot/rails/spec_helper.rb

@@ -0,0 +1,26 @@
+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
+
+rspec =
+  begin
+    RSpec
+  rescue NameError, ArgumentError
+    Spec::Runner
+  end
+
+rspec.configure do |config|
+  config.extend(Sunspot::Rails::SpecHelper)
+end

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -0,0 +1,142 @@
+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
+      
+      def new_more_like_this(*args)
+        Search.new
+      end
+
+      class Search
+        
+        def build
+          self
+        end
+
+        def results
+          PaginatedCollection.new
+        end
+
+        def hits(options = {})
+          PaginatedCollection.new
+        end
+
+        def total
+          0
+        end
+
+        def facet(name)
+        end
+
+        def dynamic_facet(name)
+        end
+
+        def execute
+          self
+        end
+      end
+      
+      
+      class PaginatedCollection < Array
+        
+        def total_count
+          0
+        end
+        alias :total_entries :total_count
+        
+        def current_page
+          1
+        end
+        
+        def per_page
+          30
+        end
+        alias :limit_value :per_page
+        
+        def total_pages
+          1
+        end
+        alias :num_pages :total_pages
+
+        def first_page?
+          true
+        end
+
+        def last_page?
+          true
+        end
+
+        def previous_page
+          nil
+        end
+
+        def next_page
+          nil
+        end
+
+        def out_of_bounds?
+          false
+        end
+
+        def offset
+          0
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/sunspot/rails/tasks.rb

@@ -0,0 +1,84 @@
+namespace :sunspot do
+
+  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 50 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] => [:environment] do |t, args|
+    # Set up general options for reindexing
+    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
+
+    # Load all the application's models. Models which invoke 'searchable' will register themselves
+    # in Sunspot.searchable.
+    Dir.glob(Rails.root.join('app/models/**/*.rb')).each { |path| require path }
+
+    # By default, reindex all searchable models
+    sunspot_models = Sunspot.searchable
+
+    # Choose a specific subset of models, if requested
+    if args[:models]
+      model_names = args[:models].split('+')
+      sunspot_models = model_names.map{ |m| m.constantize }
+    end
+    
+    # Set up progress_bar to, ah, report progress
+    begin
+      require 'progress_bar'
+      total_documents = sunspot_models.map { | m | m.count }.sum
+      reindex_options[:progress_bar] = ProgressBar.new(total_documents)
+    rescue LoadError => e
+      $stdout.puts "Skipping progress bar: for progress reporting, add gem 'progress_bar' to your Gemfile"
+    rescue Exception => e
+      $stderr.puts "Error using progress bar: #{e.message}"
+    end
+    
+    # Finally, invoke the class-level solr_reindex on each model
+    sunspot_models.each do |model|
+      model.solr_reindex(reindex_options)
+    end
+  end
+
+
+  unless defined?(Sunspot::Solr)
+    namespace :solr do
+  		task :moved_to_sunspot_solr do
+  	    abort %(
+  Note: This task has been moved to the sunspot_solr gem. To install, start and
+  stop a local Solr instance, please add sunspot_solr to your Gemfile:
+
+  group :development do
+    gem 'sunspot_solr'
+  end
+
+)
+  		end
+  		
+      desc 'Start the Solr instance'
+      task :start => :moved_to_sunspot_solr
+      desc 'Run the Solr instance in the foreground'
+      task :run => :moved_to_sunspot_solr
+      desc 'Stop the Solr instance'
+      task :stop => :moved_to_sunspot_solr
+  		# for backwards compatibility
+      task :reindex => :"sunspot:reindex"
+    end
+  end
+  
+end

data/lib/sunspot/rails.rb

@@ -0,0 +1,69 @@
+require 'sunspot'
+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 :SolrInstrumentation, File.join(File.dirname(__FILE__), 'rails', 'solr_instrumentation')
+    autoload :StubSessionProxy, File.join(File.dirname(__FILE__), 'rails', 'stub_session_proxy')
+    begin
+      require 'sunspot_solr'
+      autoload :Server, File.join(File.dirname(__FILE__), 'rails', 'server')
+    rescue LoadError => e
+      # We're fine
+    end
+
+    class <<self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Sunspot::Rails::Configuration.new
+      end
+
+      def reset
+        @configuration = nil
+      end
+
+      def build_session(configuration = self.configuration)
+        if configuration.disabled?
+          StubSessionProxy.new(Sunspot.session)
+        elsif 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.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
+        config
+      end
+
+      def slave_config(sunspot_rails_configuration)
+        config = Sunspot::Configuration.build
+        config.solr.url = URI::HTTP.build(
+          :host => sunspot_rails_configuration.hostname,
+          :port => sunspot_rails_configuration.port,
+          :path => sunspot_rails_configuration.path
+        ).to_s
+        config.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
+        config
+      end
+    end
+  end
+end

data/lib/sunspot_rails.rb

@@ -0,0 +1,12 @@
+# This needs to be loaded before sunspot/search/paginated_collection
+# or #to_json gets defined in Object breaking delegation to Array via
+# method_missing
+require 'active_support/core_ext/object/to_json' if Rails::VERSION::MAJOR == 3
+
+require 'sunspot/rails'
+
+if Rails::VERSION::MAJOR == 3
+  require 'sunspot/rails/railtie'
+else
+  require 'sunspot/rails/init'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,209 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" do
+  before(:each) do
+    File.stub!(:exist?).and_return(false) # simulate sunspot.yml not existing
+    @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
+
+  describe "port" do
+    it "should default to port 8981 in test" do
+      ::Rails.stub!(:env => 'test')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8981
+    end
+    it "should default to port 8982 in development" do
+      ::Rails.stub!(:env => 'development')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8982
+    end
+    it "should default to 8983 in production" do
+      ::Rails.stub!(:env => 'production')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8983
+    end
+    it "should generally default to 8983" do
+      ::Rails.stub!(:env => 'staging')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8983
+    end
+  end
+  
+  it "should set the read timeout to nil when not set" do
+    @config.read_timeout == nil
+  end
+
+  it "should set the open timeout to nil when not set" do
+    @config.open_timeout == nil
+  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_dir' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.pid_dir.should == '/some/path/solr/pids/test'
+  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
+
+  it "should handle the 'bind_address' property when not set" do
+    @config.bind_address.should be_nil
+  end
+
+  it "should handle the 'disabled' property when not set" do
+    @config.disabled?.should be_false
+  end
+end
+
+describe Sunspot::Rails::Configuration, "user provided sunspot.yml" 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_dir' property when set" do
+    @config.pid_dir.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
+
+  it "should handle the 'bind_address' property when set" do
+    @config.bind_address.should == "127.0.0.1"
+  end
+  it "should handle the 'read_timeout' property when set" do
+    @config.read_timeout.should == 2
+  end
+  it "should handle the 'open_timeout' property when set" do
+    @config.open_timeout.should == 0.5
+  end
+end
+
+describe Sunspot::Rails::Configuration, "with disabled: true in sunspot.yml" do
+  before(:each) do
+    ::Rails.stub!(:env => 'config_disabled_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'disabled' property when set" do
+    @config.disabled?.should be_true
+  end
+end
+
+describe Sunspot::Rails::Configuration, "with ENV['SOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['SOLR_URL'] = 'http://environment.host:5432/solr/env'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('SOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'environment.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 5432
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/env'
+  end
+end
+
+describe Sunspot::Rails::Configuration, "with ENV['WEBSOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['WEBSOLR_URL'] = 'http://index.websolr.test/solr/a1b2c3d4e5f'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('WEBSOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'index.websolr.test'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 80
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/a1b2c3d4e5f'
+  end
+end
+

data/spec/model_lifecycle_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'searchable with lifecycle' do
+  describe 'on create' do
+    before :each do
+      @post = PostWithAuto.create
+      Sunspot.commit
+    end
+
+    it 'should automatically index' do
+      PostWithAuto.search.results.should == [@post]
+    end
+  end
+
+  describe 'on update' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.update_attributes(:title => 'Test 1')
+      Sunspot.commit
+    end
+
+    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 :solr_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 :solr_index
+      @post.save!
+    end
+  end
+  
+  describe 'on destroy' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.destroy
+      Sunspot.commit
+    end
+
+    it 'should automatically remove it from the index' do
+      PostWithAuto.search_ids.should be_empty
+    end
+  end
+end
+
+describe 'searchable with lifecycle - ignoring specific attributes' do
+  before(:each) do
+    @post = PostWithAuto.create
+  end
+  
+  it "should not reindex the object on an update_at change, because it is marked as to-ignore" do
+    Sunspot.should_not_receive(:index).with(@post)
+    @post.update_attribute :updated_at, 123.seconds.from_now
+  end
+end