initforthe-thinking-sphinx 1.1.21

data/rails/init.rb

@@ -0,0 +1,14 @@
+require 'thinking_sphinx'
+require 'action_controller/dispatcher'
+
+ActionController::Dispatcher.to_prepare :thinking_sphinx do
+  # Force internationalisation to be loaded.
+  if Rails::VERSION::STRING.to_f > 2.2
+    I18n.backend.reload!
+    I18n.backend.available_locales
+  elsif Rails::VERSION::STRING.to_f > 2.1
+    I18n.backend.load_translations(*I18n.load_path)
+  end
+  
+  ThinkingSphinx::Configuration.instance.load_models
+end

data/spec/unit/thinking_sphinx/active_record/delta_spec.rb

@@ -0,0 +1,136 @@
+require 'spec/spec_helper'
+
+describe "ThinkingSphinx::ActiveRecord::Delta" do
+  it "should call the toggle_delta method after a save" do
+    @beta = Beta.new(:name => 'beta')
+    @beta.stub_method(:toggle_delta => true)
+    
+    @beta.save
+    
+    @beta.should have_received(:toggle_delta)
+  end
+  
+  it "should call the toggle_delta method after a save!" do
+    @beta = Beta.new(:name => 'beta')
+    @beta.stub_method(:toggle_delta => true)
+    
+    @beta.save!
+    
+    @beta.should have_received(:toggle_delta)
+  end
+
+  describe "suspended_delta method" do
+    before :each do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      Person.sphinx_indexes.first.delta_object.stub_method(:` => "")
+    end
+
+    it "should execute the argument block with deltas disabled" do
+      ThinkingSphinx.should_receive(:deltas_enabled=).once.with(false)
+      ThinkingSphinx.should_receive(:deltas_enabled=).once.with(true)
+      lambda { Person.suspended_delta { raise 'i was called' } }.should(
+        raise_error(Exception)
+      )
+    end
+
+    it "should restore deltas_enabled to its original setting" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => false)
+      ThinkingSphinx.should_receive(:deltas_enabled=).twice.with(false)
+      Person.suspended_delta { 'no-op' }
+    end
+
+    it "should restore deltas_enabled to its original setting even if there was an exception" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => false)
+      ThinkingSphinx.should_receive(:deltas_enabled=).twice.with(false)
+      lambda { Person.suspended_delta { raise 'bad error' } }.should(
+        raise_error(Exception)
+      )
+    end
+
+    it "should reindex by default after the code block is run" do
+      Person.should_receive(:index_delta)
+      Person.suspended_delta { 'no-op' }
+    end
+    
+    it "should not reindex after the code block if false is passed in" do
+      Person.should_not_receive(:index_delta)
+      Person.suspended_delta(false) { 'no-op' }
+    end
+  end
+  
+  describe "toggle_delta method" do
+    it "should set the delta value to true" do
+      @person = Person.new
+      
+      @person.delta.should be_false
+      @person.send(:toggle_delta)
+      @person.delta.should be_true
+    end
+  end
+  
+  describe "index_delta method" do
+    before :each do
+      ThinkingSphinx::Configuration.stub_method(:environment => "spec")
+      ThinkingSphinx.stub_method(:deltas_enabled? => true, :sphinx_running? => true)
+      Person.delta_object.stub_methods(:` => "", :toggled => true)
+      
+      @person = Person.new
+      @person.stub_method(
+        :in_both_indexes?     => false,
+        :sphinx_document_id => 1
+      )
+      
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
+      Riddle::Client.stub_method(:new => @client)
+    end
+    
+    it "shouldn't index if delta indexing is disabled" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => false)
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+      @client.should_not have_received(:update)
+    end
+    
+    it "shouldn't index if index updating is disabled" do
+      ThinkingSphinx.stub_method(:updates_enabled? => false)
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+    end
+    
+    it "shouldn't index if the environment is 'test'" do
+      ThinkingSphinx.unstub_method(:deltas_enabled?)
+      ThinkingSphinx.deltas_enabled = nil
+      ThinkingSphinx::Configuration.stub_method(:environment => "test")
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+    end
+    
+    it "should call indexer for the delta index" do
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should have_received(:`).with(
+        "#{ThinkingSphinx::Configuration.instance.bin_path}indexer --config #{ThinkingSphinx::Configuration.instance.config_file} --rotate person_delta"
+      )
+    end
+    
+    it "shouldn't update the deleted attribute if not in the index" do
+      @client.should_not_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+    
+    it "should update the deleted attribute if in the core index" do
+      @person.stub_method(:in_both_indexes? => true)
+      @client.should_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+  end
+end

data/spec/unit/thinking_sphinx/active_record/has_many_association_spec.rb

@@ -0,0 +1,53 @@
+require 'spec/spec_helper'
+
+describe 'ThinkingSphinx::ActiveRecord::HasManyAssociation' do
+  describe "search method" do
+    before :each do
+      Friendship.stub_method(:search => true)
+      
+      @person = Person.find(:first)
+      @index  = Friendship.sphinx_indexes.first
+    end
+    
+    it "should raise an error if the required attribute doesn't exist" do
+      @index.stub_method(:attributes => [])
+      
+      lambda { @person.friendships.search "test" }.should raise_error(RuntimeError)
+      
+      @index.unstub_method(:attributes)
+    end
+    
+    it "should add a filter for the attribute into a normal search call" do
+      @person.friendships.search "test"
+      
+      Friendship.should have_received(:search).with(
+        "test", :with => {:person_id => @person.id}
+      )
+    end    
+  end
+  
+  describe "search method for has_many :through" do
+    before :each do
+      Person.stub_method(:search => true)
+      
+      @person = Person.find(:first)
+      @index  = Person.sphinx_indexes.first
+    end
+    
+    it "should raise an error if the required attribute doesn't exist" do
+      @index.stub_method(:attributes => [])
+      
+      lambda { @person.friends.search "test" }.should raise_error(RuntimeError)
+      
+      @index.unstub_method(:attributes)
+    end
+    
+    it "should add a filter for the attribute into a normal search call" do
+      @person.friends.search "test"
+      
+      Person.should have_received(:search).with(
+        "test", :with => {:friendly_ids => @person.id}
+      )
+    end
+  end
+end

data/spec/unit/thinking_sphinx/active_record/search_spec.rb

@@ -0,0 +1,107 @@
+require 'spec/spec_helper'
+
+describe "ThinkingSphinx::ActiveRecord::Search" do
+  it "should add search_for_ids to ActiveRecord::Base" do
+    ActiveRecord::Base.should respond_to("search_for_ids")
+  end
+  
+  it "should add search_for_ids to ActiveRecord::Base" do
+    ActiveRecord::Base.should respond_to("search")
+  end
+  
+  it "should add search_count to ActiveRecord::Base" do
+    ActiveRecord::Base.should respond_to("search_count")
+  end
+
+  it "should add search_for_id to ActiveRecord::Base" do
+    ActiveRecord::Base.should respond_to("search_for_id")
+  end
+  
+  describe "search_for_ids method" do
+    before :each do
+      ThinkingSphinx::Search.stub_method(:search_for_ids => true)
+    end
+    
+    it "should call ThinkingSphinx::Search#search_for_ids with the class option set" do
+      Person.search_for_ids("search")
+      
+      ThinkingSphinx::Search.should have_received(:search_for_ids).with(
+        "search", :class => Person
+      )
+    end
+    
+    it "should override the class option" do
+      Person.search_for_ids("search", :class => Friendship)
+      
+      ThinkingSphinx::Search.should have_received(:search_for_ids).with(
+        "search", :class => Person
+      )
+    end
+  end
+  
+  describe "search method" do
+    before :each do
+      ThinkingSphinx::Search.stub_method(:search => true)
+    end
+    
+    it "should call ThinkingSphinx::Search#search with the class option set" do
+      Person.search("search")
+      
+      ThinkingSphinx::Search.should have_received(:search).with(
+        "search", :class => Person
+      )
+    end
+    
+    it "should override the class option" do
+      Person.search("search", :class => Friendship)
+      
+      ThinkingSphinx::Search.should have_received(:search).with(
+        "search", :class => Person
+      )
+    end
+  end
+  
+  describe "search_for_id method" do
+    before :each do
+      ThinkingSphinx::Search.stub_method(:search_for_id => true)
+    end
+    
+    it "should call ThinkingSphinx::Search#search with the class option set" do
+      Person.search_for_id(10)
+      
+      ThinkingSphinx::Search.should have_received(:search_for_id).with(
+        10, :class => Person
+      )
+    end
+    
+    it "should override the class option" do
+      Person.search_for_id(10, :class => Friendship)
+      
+      ThinkingSphinx::Search.should have_received(:search_for_id).with(
+        10, :class => Person
+      )
+    end
+  end
+
+  describe "search_count method" do
+    before :each do
+      ThinkingSphinx::Search.stub_method(:count => true)
+    end
+
+    it "should call ThinkingSphinx::Search#search with the class option set" do
+      Person.search_count("search")
+
+      ThinkingSphinx::Search.should have_received(:count).with(
+        "search", :class => Person
+      )
+    end
+
+    it "should override the class option" do
+      Person.search_count("search", :class => Friendship)
+
+      ThinkingSphinx::Search.should have_received(:count).with(
+        "search", :class => Person
+      )
+    end
+  end
+end

data/spec/unit/thinking_sphinx/active_record_spec.rb

@@ -0,0 +1,329 @@
+require 'spec/spec_helper'
+
+describe "ThinkingSphinx::ActiveRecord" do
+  describe "define_index method" do
+    before :each do
+      module ::TestModule
+        class TestModel < ActiveRecord::Base; end
+      end
+      
+      TestModule::TestModel.stub_methods(
+        :before_save    => true,
+        :after_commit   => true,
+        :after_destroy  => true
+      )
+      
+      @index = ThinkingSphinx::Index.stub_instance(:delta? => false)
+      ThinkingSphinx::Index::Builder.stub_method(:generate => @index)
+    end
+    
+    after :each do
+      # Remove the class so we can redefine it
+      TestModule.send(:remove_const, :TestModel)
+      
+      ThinkingSphinx.indexed_models.delete "TestModule::TestModel"
+    end
+    
+    it "should do nothing if indexes are disabled" do
+      ThinkingSphinx.stub_method(:define_indexes? => false)
+      
+      TestModule::TestModel.define_index {}
+      ThinkingSphinx::Index.should_not have_received(:new)
+      
+      ThinkingSphinx.unstub_method(:define_indexes?)
+    end
+    
+    it "should add a new index to the model" do
+      TestModule::TestModel.define_index {}
+      
+      TestModule::TestModel.sphinx_indexes.length.should == 1
+    end
+    
+    it "should add to ThinkingSphinx.indexed_models if the model doesn't already exist in the array" do
+      TestModule::TestModel.define_index do; end
+      
+      ThinkingSphinx.indexed_models.should include("TestModule::TestModel")
+    end
+    
+    it "shouldn't add to ThinkingSphinx.indexed_models if the model already exists in the array" do
+      TestModule::TestModel.define_index do; end
+      
+      ThinkingSphinx.indexed_models.select { |model|
+        model == "TestModule::TestModel"
+      }.length.should == 1
+      
+      TestModule::TestModel.define_index do; end
+      
+      ThinkingSphinx.indexed_models.select { |model|
+        model == "TestModule::TestModel"
+      }.length.should == 1
+    end
+    
+    it "should add before_save and after_commit hooks to the model if delta indexing is enabled" do
+      @index.stub_method(:delta? => true)
+      
+      TestModule::TestModel.define_index do; end
+      
+      TestModule::TestModel.should have_received(:before_save).with(:toggle_delta)
+      TestModule::TestModel.should have_received(:after_commit).with(:index_delta)
+    end
+    
+    it "should not add before_save and after_commit hooks to the model if delta indexing is disabled" do
+      TestModule::TestModel.define_index do; end
+      
+      TestModule::TestModel.should_not have_received(:before_save).with(:toggle_delta)
+      TestModule::TestModel.should_not have_received(:after_commit).with(:index_delta)
+    end
+    
+    it "should add an after_destroy hook with delta indexing enabled" do
+      @index.stub_method(:delta? => true)
+      
+      TestModule::TestModel.define_index do; end
+      
+      TestModule::TestModel.should have_received(:after_destroy).with(:toggle_deleted)
+    end
+    
+    it "should add an after_destroy hook with delta indexing disabled" do
+      TestModule::TestModel.define_index do; end
+      
+      TestModule::TestModel.should have_received(:after_destroy).with(:toggle_deleted)
+    end
+    
+    it "should return the new index" do
+      TestModule::TestModel.define_index.should == @index
+    end
+    
+    it "should die quietly if there is a database error" do
+      ThinkingSphinx::Index::Builder.stub_method_to_raise(:generate => Mysql::Error)
+      
+      lambda {
+        TestModule::TestModel.define_index
+      }.should_not raise_error
+    end
+    
+    it "should die noisily if there is a non-database error" do
+      ThinkingSphinx::Index::Builder.stub_method_to_raise(:generate => StandardError)
+      
+      lambda {
+        TestModule::TestModel.define_index
+      }.should raise_error
+    end
+  end
+
+  describe "index methods" do
+    before(:all) do
+      @person = Person.find(:first)
+    end
+
+    describe "in_both_indexes?" do
+      it "should return true if in core and delta indexes" do
+        @person.should_receive(:in_core_index?).and_return(true)
+        @person.should_receive(:in_delta_index?).and_return(true)
+        @person.in_both_indexes?.should be_true
+      end
+      
+      it "should return false if in one index and not the other" do
+        @person.should_receive(:in_core_index?).and_return(true)
+        @person.should_receive(:in_delta_index?).and_return(false)
+        @person.in_both_indexes?.should be_false
+      end
+    end
+
+    describe "in_core_index?" do
+      it "should call in_index? with core" do
+        @person.should_receive(:in_index?).with('core')
+        @person.in_core_index?
+      end
+    end
+
+    describe "in_delta_index?" do
+      it "should call in_index? with delta" do
+        @person.should_receive(:in_index?).with('delta')
+        @person.in_delta_index?
+      end
+    end
+
+    describe "in_index?" do
+      it "should return true if in the specified index" do
+        @person.should_receive(:sphinx_document_id).and_return(1)
+        @person.should_receive(:sphinx_index_name).and_return('person_core')
+        Person.should_receive(:search_for_id).with(1, 'person_core').and_return(true)
+      
+        @person.in_index?('core').should be_true
+      end
+    end
+  end
+
+  describe "source_of_sphinx_index method" do
+    it "should return self if model defines an index" do
+      Person.source_of_sphinx_index.should == Person
+    end
+
+    it "should return the parent if model inherits an index" do
+      Admin::Person.source_of_sphinx_index.should == Person
+    end
+  end
+  
+  describe "to_crc32 method" do
+    it "should return an integer" do
+      Person.to_crc32.should be_a_kind_of(Integer)
+    end
+  end
+    
+  describe "to_crc32s method" do
+    it "should return an array" do
+      Person.to_crc32s.should be_a_kind_of(Array)
+    end
+  end
+    
+  describe "toggle_deleted method" do
+    before :each do
+      ThinkingSphinx.stub_method(:sphinx_running? => true)
+      
+      @configuration = ThinkingSphinx::Configuration.instance
+      @configuration.stub_methods(
+        :address  => "an address",
+        :port     => 123
+      )
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
+      @person = Person.find(:first)
+      
+      Riddle::Client.stub_method(:new => @client)
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => false) }
+      @person.stub_method(:in_core_index? => true)
+    end
+    
+    it "should create a client using the Configuration's address and port" do
+      @person.toggle_deleted
+      
+      Riddle::Client.should have_received(:new).with(
+        @configuration.address, @configuration.port
+      )
+    end
+    
+    it "should update the core index's deleted flag if in core index" do
+      @client.should_receive(:update).with(
+        "person_core", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "shouldn't update the core index's deleted flag if the record isn't in it" do
+      @person.stub_method(:in_core_index? => false)
+      @client.should_not_receive(:update).with(
+        "person_core", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "shouldn't attempt to update the deleted flag if sphinx isn't running" do
+      ThinkingSphinx.stub_method(:sphinx_running? => false)
+      @client.should_not_receive(:update)
+      
+      @person.toggle_deleted
+      
+      @person.should_not have_received(:in_core_index?)
+    end
+    
+    it "should update the delta index's deleted flag if delta indexes are enabled and the instance's delta is true" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
+      @person.delta = true
+      @client.should_receive(:update).with(
+        "person_delta", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "should not update the delta index's deleted flag if delta indexes are enabled and the instance's delta is false" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
+      @person.delta = false
+      @client.should_not_receive(:update).with(
+        "person_delta", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "should not update the delta index's deleted flag if delta indexes are enabled and the instance's delta is equivalent to false" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
+      @person.delta = 0
+      @client.should_not_receive(:update).with(
+        "person_delta", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+
+      @person.toggle_deleted
+    end
+
+    it "shouldn't update the delta index if delta indexes are disabled" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      @client.should_not_receive(:update).with(
+        "person_delta", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "should not update the delta index if delta indexing is disabled" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => false)
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
+      @person.delta = true
+      @client.should_not_receive(:update).with(
+        "person_delta", ["sphinx_deleted"], {@person.sphinx_document_id => 1}
+      )
+      
+      @person.toggle_deleted
+    end
+    
+    it "should not update either index if updates are disabled" do
+      ThinkingSphinx.stub_methods(
+        :updates_enabled? => false,
+        :deltas_enabled   => true
+      )
+      Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
+      @person.delta = true
+      @client.should_not_receive(:update)
+      
+      @person.toggle_deleted
+    end
+  end
+
+  describe "sphinx_indexes in the inheritance chain (STI)" do
+    it "should hand defined indexes on a class down to its child classes" do
+      Child.sphinx_indexes.should include(*Person.sphinx_indexes)
+    end
+
+    it "should allow associations to other STI models" do
+      source = Child.sphinx_indexes.last.sources.first
+      sql = source.to_riddle_for_core(0, 0).sql_query
+      sql.gsub!('$start', '0').gsub!('$end', '100')
+      lambda {
+        Child.connection.execute(sql)
+      }.should_not raise_error(ActiveRecord::StatementInvalid)
+    end
+  end
+  
+  it "should return the sphinx document id as expected" do
+    person      = Person.find(:first)
+    model_count = ThinkingSphinx.indexed_models.length
+    offset      = ThinkingSphinx.indexed_models.index("Person")
+    
+    (person.id * model_count + offset).should == person.sphinx_document_id
+    
+    alpha       = Alpha.find(:first)
+    offset      = ThinkingSphinx.indexed_models.index("Alpha")
+    
+    (alpha.id * model_count + offset).should == alpha.sphinx_document_id
+    
+    beta        = Beta.find(:first)
+    offset      = ThinkingSphinx.indexed_models.index("Beta")
+    
+    (beta.id * model_count + offset).should == beta.sphinx_document_id
+  end
+end