thinking-sphinx 1.2.13 → 1.4.0

data/spec/thinking_sphinx/index_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe ThinkingSphinx::Index do
+  describe "prefix_fields method" do
+    before :each do
+      @index = ThinkingSphinx::Index.new(Person)
+      
+      @field_a = stub('field', :prefixes => true)
+      @field_b = stub('field', :prefixes => false)
+      @field_c = stub('field', :prefixes => true)
+      
+      @index.stub!(:fields => [@field_a, @field_b, @field_c])
+    end
+    
+    it "should return fields that are flagged as prefixed" do
+      @index.prefix_fields.should include(@field_a)
+      @index.prefix_fields.should include(@field_c)
+    end
+    
+    it "should not return fields that aren't flagged as prefixed" do
+      @index.prefix_fields.should_not include(@field_b)
+    end
+  end
+  
+  describe "infix_fields method" do
+    before :each do
+      @index = ThinkingSphinx::Index.new(Person)
+      
+      @field_a = stub('field', :infixes => true)
+      @field_b = stub('field', :infixes => false)
+      @field_c = stub('field', :infixes => true)
+      
+      @index.stub!(:fields => [@field_a, @field_b, @field_c])
+    end
+    
+    it "should return fields that are flagged as infixed" do
+      @index.infix_fields.should include(@field_a)
+      @index.infix_fields.should include(@field_c)
+    end
+    
+    it "should not return fields that aren't flagged as infixed" do
+      @index.infix_fields.should_not include(@field_b)
+    end
+  end
+  
+  describe '.name_for' do
+    it "should return the model's name downcased" do
+      ThinkingSphinx::Index.name_for(Alpha).should == 'alpha'
+    end
+    
+    it "should separate words by underscores" do
+      ThinkingSphinx::Index.name_for(ActiveRecord).should == 'active_record'
+    end
+    
+    it "should separate namespaces by underscores" do
+      ThinkingSphinx::Index.name_for(ActiveRecord::Base).
+        should == 'active_record_base'
+    end
+  end
+  
+  describe '#name' do
+    it "should return the downcased name of the index's model" do
+      ThinkingSphinx::Index.new(Alpha).name.should == 'alpha'
+    end
+    
+    it "should return a custom name if one is set" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      index.name = 'custom'
+      index.name.should == 'custom'
+    end
+  end
+  
+  describe '#core_name' do
+    it "should take the index's name and append _core" do
+      ThinkingSphinx::Index.new(Alpha).core_name.should == 'alpha_core'
+    end
+  end
+  
+  describe '#delta_name' do
+    it "should take the index's name and append _delta" do
+      ThinkingSphinx::Index.new(Alpha).delta_name.should == 'alpha_delta'
+    end
+  end
+  
+  describe '#all_names' do
+    it "should return the core index name by default" do
+      ThinkingSphinx::Index.new(Alpha).all_names.should == ['alpha_core']
+    end
+    
+    it "should return both core and delta names if deltas are enabled" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      index.delta_object = stub('delta')
+      
+      index.all_names.should == ['alpha_core', 'alpha_delta']
+    end
+    
+    it "should respect custom names" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      index.name = 'custom'
+      
+      index.all_names.should == ['custom_core']
+    end
+    
+    it "should respect custom names when deltas are enabled" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      index.name = 'custom'
+      index.delta_object = stub('delta')
+      
+      index.all_names.should == ['custom_core', 'custom_delta']
+    end
+  end
+  
+  describe '#to_riddle' do
+    it "should return two Riddle indexes if deltas are disabled" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      
+      index.to_riddle(0).length.should == 2
+    end
+    
+    it "should return three Riddle indexes if deltas are enabled" do
+      index = ThinkingSphinx::Index.new(Beta)
+      index.delta_object = stub('delta')
+      
+      index.to_riddle(0).length.should == 3
+    end
+    
+    it "should include a distributed index" do
+      index = ThinkingSphinx::Index.new(Alpha)
+      
+      index.to_riddle(0).last.
+        should be_a(Riddle::Configuration::DistributedIndex)
+    end
+    
+    context 'core index' do
+      it "should use the core name" do
+        @index = ThinkingSphinx::Index.new(Alpha).to_riddle(0).first
+        @index.name.should == 'alpha_core'
+      end
+      
+      it "should not try to set disable_range on the index" do
+        ThinkingSphinx::Configuration.instance.
+          index_options[:disable_range] = true
+        
+        lambda {
+          @index = ThinkingSphinx::Index.new(Alpha).to_riddle(0).first
+        }.should_not raise_error(NoMethodError)
+      end
+    end
+    
+    context 'delta index' do
+      before :each do
+        index = ThinkingSphinx::Index.new(Beta)
+        index.delta_object = stub('delta')
+        @index = index.to_riddle(0)[1]
+      end
+      
+      it "should use the delta name" do
+        @index.name.should == 'beta_delta'
+      end
+    end
+    
+    context 'distributed index' do
+      it "should use the index's name" do
+        index = ThinkingSphinx::Index.new(Alpha)
+
+        index.to_riddle(0).last.name.should == 'alpha'
+      end
+      
+      it "should add the core index" do
+        index = ThinkingSphinx::Index.new(Alpha)
+
+        index.to_riddle(0).last.local_indexes.should include('alpha_core')
+      end
+      
+      it "should add the delta index if there is one" do
+        index = ThinkingSphinx::Index.new(Beta)
+        index.delta_object = stub('delta')
+
+        index.to_riddle(0).last.local_indexes.should include('beta_delta')
+      end
+    end
+  end
+end

data/spec/{lib/thinking_sphinx → thinking_sphinx}/rails_additions_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe ThinkingSphinx::HashExcept do
   before(:each) do
@@ -118,14 +118,14 @@ describe ThinkingSphinx::ActiveRecordStoreFullSTIClass do
   end
 end
 
-describe ThinkingSphinx::MetaClass do
-  describe 'metaclass' do
+describe ThinkingSphinx::SingletonClass do
+  describe 'singleton_class' do
     it "should exist as an instance method in Object" do
-      Object.new.should respond_to('metaclass')
+      Object.new.should respond_to('singleton_class')
     end
     
     it "should return the meta/eigen/singleton class" do
-      Object.new.metaclass.should be_a(Class)
+      Object.new.singleton_class.should be_a(Class)
     end
   end
 end

data/spec/{lib/thinking_sphinx → thinking_sphinx}/search_methods_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe ThinkingSphinx::SearchMethods do
   it "should be included into models with indexes" do
@@ -135,6 +135,10 @@ describe ThinkingSphinx::SearchMethods do
   end
   
   describe '.facets' do
+    before :each do
+      ThinkingSphinx::Search.stub!(:bundle_searches => [])
+    end
+    
     it "should return a FacetSearch instance" do
       Alpha.facets.should be_a(ThinkingSphinx::FacetSearch)
     end

data/spec/{lib/thinking_sphinx → thinking_sphinx}/search_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 require 'will_paginate/collection'
 
 describe ThinkingSphinx::Search do
@@ -43,7 +43,12 @@ describe ThinkingSphinx::Search do
     
     it "should be true once the client request has been made" do
       @search.first
-      @search.populated?.should be_true
+      @search.should be_populated
+    end
+    
+    it "should be populated if :populate is set to true" do
+      search = ThinkingSphinx::Search.new(:populate => true)
+      search.should be_populated
     end
   end
   
@@ -153,6 +158,17 @@ describe ThinkingSphinx::Search do
     end
   end
   
+  describe '.matching_fields' do
+    it "should return objects with indexes matching 1's in the bitmask" do
+      fields = ['alpha', 'beta', 'gamma', 'delta', 'epsilon', 'zeta', 'eta']
+      ThinkingSphinx::Search.matching_fields(fields, 85).
+        should == ['alpha', 'gamma', 'epsilon', 'eta']
+      
+      ThinkingSphinx::Search.matching_fields(fields, 42).
+        should == ['beta', 'delta', 'zeta']
+    end
+  end
+  
   describe '#populate' do
     before :each do
       @alpha_a, @alpha_b  = Alpha.new,  Alpha.new
@@ -164,7 +180,8 @@ describe ThinkingSphinx::Search do
       @beta_b.stub!  :id => 2, :read_attribute => 2
       
       @client.stub! :query => {
-        :matches => minimal_result_hashes(@alpha_a, @beta_b, @alpha_b, @beta_a)
+        :matches => minimal_result_hashes(@alpha_a, @beta_b, @alpha_b, @beta_a),
+        :fields  => ["one", "two", "three", "four", "five"]
       }
       Alpha.stub! :find => [@alpha_a, @alpha_b]
       Beta.stub!  :find => [@beta_a, @beta_b]
@@ -201,6 +218,34 @@ describe ThinkingSphinx::Search do
       ThinkingSphinx::Search.new(:classes => [Alpha, Beta]).first
     end
     
+    it "should restrict includes to the relevant classes" do
+      Alpha.should_receive(:find) do |type, options|
+        options[:include].should == [:betas]
+        [@alpha_a, @alpha_b]
+      end
+      
+      Beta.should_receive(:find) do |type, options|
+        options[:include].should == [:gammas]
+        [@beta_a, @beta_b]
+      end
+      
+      ThinkingSphinx::Search.new(:include => [:betas, :gammas]).first
+    end
+    
+    it "should restrict single includes to the relevant classes" do
+      Alpha.should_receive(:find) do |type, options|
+        options[:include].should == :betas
+        [@alpha_a, @alpha_b]
+      end
+      
+      Beta.should_receive(:find) do |type, options|
+        options[:include].should be_nil
+        [@beta_a, @beta_b]
+      end
+      
+      ThinkingSphinx::Search.new(:include => :betas).first
+    end
+    
     describe 'query' do
       it "should concatenate arguments with spaces" do
         @client.should_receive(:query) do |query, index, comment|
@@ -259,6 +304,32 @@ describe ThinkingSphinx::Search do
           'foo@bar.com -foo-bar', :star => /[\w@.-]+/u
         ).first
       end
+      
+      it "should ignore multi-field limitations" do
+        @client.should_receive(:query) do |query, index, comment|
+          query.should == '@(foo,bar) *baz*'
+        end
+        
+        ThinkingSphinx::Search.new('@(foo,bar) baz', :star => true).first
+      end
+      
+      it "should ignore multi-field limitations with spaces" do
+        @client.should_receive(:query) do |query, index, comment|
+          query.should == '@(foo bar) *baz*'
+        end
+        
+        ThinkingSphinx::Search.new('@(foo bar) baz', :star => true).first
+      end
+      
+      it "should ignore multi-field limitations in the middle of queries" do
+        @client.should_receive(:query) do |query, index, comment|
+          query.should == '*baz* @foo *bar* @(foo,bar) *baz*'
+        end
+        
+        ThinkingSphinx::Search.new(
+          'baz @foo bar @(foo,bar) baz', :star => true
+        ).first
+      end
     end
     
     describe 'comment' do
@@ -302,6 +373,23 @@ describe ThinkingSphinx::Search do
         @client.match_mode.should == :extended2
       end
     end
+
+    describe 'sphinx_select' do
+      it "should default to *" do
+        ThinkingSphinx::Search.new.first
+        
+        @client.select.should == "*"
+      end
+      
+      it "should get set on the client if specified" do
+        ThinkingSphinx::Search.new('general',
+          :sphinx_select => "*, foo as bar"
+        ).first
+        
+        @client.select.should == "*, foo as bar"
+      end
+
+    end
     
     describe 'pagination' do
       it "should set the limit using per_page" do
@@ -476,31 +564,6 @@ describe ThinkingSphinx::Search do
         filter.attribute.should == 'sphinx_internal_id'
         filter.exclude?.should be_true
       end
-      
-      describe 'in :conditions' do
-        it "should add as filters for known attributes in :conditions option" do
-          ThinkingSphinx::Search.new('general',
-            :conditions => {:word => 'specific', :lat => 1.5},
-            :classes    => [Alpha]
-          ).first
-          
-          filter = @client.filters.last
-          filter.values.should == [1.5]
-          filter.attribute.should == 'lat'
-          filter.exclude?.should be_false        
-        end
-        
-        it "should not add the filter to the query string" do
-          @client.should_receive(:query) do |query, index, comment|
-            query.should == 'general @word specific'
-          end
-          
-          ThinkingSphinx::Search.new('general',
-            :conditions => {:word => 'specific', :lat => 1.5},
-            :classes    => [Alpha]
-          ).first
-        end
-      end
     end
     
     describe 'sort mode' do
@@ -751,9 +814,10 @@ describe ThinkingSphinx::Search do
         end
       
         it "should set up the excerpter with the instances and search" do
-          ThinkingSphinx::Excerpter.should_receive(:new).with(@search, @alpha_a)
-          ThinkingSphinx::Excerpter.should_receive(:new).with(@search, @alpha_b)
-        
+          [@alpha_a, @beta_b, @alpha_b, @beta_a].each do |object|
+            ThinkingSphinx::Excerpter.should_receive(:new).with(@search, object)
+          end
+          
           @search.first
         end
       end
@@ -781,6 +845,28 @@ describe ThinkingSphinx::Search do
           hash['class_crc'].should == @search.last.class.to_crc32
         end
       end
+      
+      describe '#matching_fields' do
+        it "should add matching_fields method if using fieldmask ranking mode" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.should respond_to(:matching_fields)
+        end
+        
+        it "should not add matching_fields method if object already have one" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.last.matching_fields.should_not be_an(Array)
+        end
+        
+        it "should return an array" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.matching_fields.should be_an(Array)
+        end
+        
+        it "should return the fields that the bitmask match" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.matching_fields.should == ['one', 'three', 'five']
+        end
+      end
     end
   end
   
@@ -816,6 +902,10 @@ describe ThinkingSphinx::Search do
         :per_page => 30, :limit => 40
       ).per_page.should == 40
     end
+    
+    it "should allow for string arguments" do
+      ThinkingSphinx::Search.new(:per_page => '10').per_page.should == 10
+    end
   end
   
   describe '#total_pages' do
@@ -834,6 +924,14 @@ describe ThinkingSphinx::Search do
       
       ThinkingSphinx::Search.new.total_pages.should == 2
     end
+    
+    it "should return 0 if there is no index and therefore no results" do
+      @client.stub!(:query => {
+        :matches => [], :total_found => nil, :total => nil
+      })
+      
+      ThinkingSphinx::Search.new.total_pages.should == 0
+    end
   end
   
   describe '#next_page' do
@@ -860,6 +958,14 @@ describe ThinkingSphinx::Search do
     it "should return the total number of results, not just the amount on the page" do
       ThinkingSphinx::Search.new.total_entries.should == 41
     end
+    
+    it "should return 0 if there is no index and therefore no results" do
+      @client.stub!(:query => {
+        :matches => [], :total_found => nil
+      })
+      
+      ThinkingSphinx::Search.new.total_entries.should == 0
+    end
   end
   
   describe '#offset' do
@@ -870,6 +976,10 @@ describe ThinkingSphinx::Search do
     it "should increase by the per_page value for each page in" do
       ThinkingSphinx::Search.new(:per_page => 25, :page => 2).offset.should == 25
     end
+
+    it "should prioritise explicit :offset over calculated if given" do
+      ThinkingSphinx::Search.new(:offset => 5).offset.should == 5
+    end
   end
   
   describe '#indexes' do
@@ -1027,6 +1137,15 @@ describe ThinkingSphinx::Search do
       @search.excerpt_for('string')
     end
     
+    it "should respect the provided index option" do
+      @search = ThinkingSphinx::Search.new(:classes => [Alpha], :index => 'foo')
+      @client.should_receive(:excerpts) do |options|
+        options[:index].should == 'foo'
+      end
+      
+      @search.excerpt_for('string')
+    end
+    
     it "should optionally take a second argument to allow for multi-model searches" do
       @client.should_receive(:excerpts) do |options|
         options[:index].should == 'beta_core'
@@ -1092,6 +1211,39 @@ describe ThinkingSphinx::Search do
       }.should_not be_nil
     end
   end
+  
+  describe '#freeze' do
+    before :each do
+      @search = ThinkingSphinx::Search.new
+    end
+    
+    it "should populate the result set" do
+      @search.freeze
+      @search.should be_populated
+    end
+    
+    it "should freeze the underlying array" do
+      @search.freeze
+      @search.to_a.should be_frozen
+    end
+    
+    it "should return the Search object" do
+      @search.freeze.should be_a(ThinkingSphinx::Search)
+    end
+  end
+  
+  describe '#client' do
+    let(:client) { Riddle::Client.new }
+    it "should respect the client in options" do
+      search = ThinkingSphinx::Search.new :client => client
+      search.client.should == client
+    end
+    
+    it "should get a new client from the configuration singleton by default" do
+      ThinkingSphinx::Configuration.instance.stub!(:client => client)
+      ThinkingSphinx::Search.new.client.should == client
+    end
+  end
 end
 
 describe ThinkingSphinx::Search, "playing nice with Search model" do

data/spec/{lib/thinking_sphinx → thinking_sphinx}/source_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe ThinkingSphinx::Source do
   before :each do
@@ -6,6 +6,13 @@ describe ThinkingSphinx::Source do
     @source = ThinkingSphinx::Source.new(@index, :sql_range_step => 1000)
   end
   
+  describe '#initialize' do
+    it "should store the current connection details" do
+      config = Person.connection.instance_variable_get(:@config)
+      @source.database_configuration.should == config
+    end
+  end
+  
   it "should generate the name from the model" do
     @source.name.should == "person"
   end
@@ -42,6 +49,10 @@ describe ThinkingSphinx::Source do
         :as => :contact_ids, :source => :query
       )
       
+      ThinkingSphinx::Join.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:links)
+      )
+      
       @source.conditions << "`birthday` <= NOW()"
       @source.groupings  << "`first_name`"
       
@@ -77,6 +88,7 @@ describe ThinkingSphinx::Source do
         :user     => nil,
         :username => nil
       })
+      @source = ThinkingSphinx::Source.new(@index)
       
       riddle = @source.to_riddle_for_core(1, 0)
       riddle.sql_user.should == 'root'
@@ -128,6 +140,10 @@ describe ThinkingSphinx::Source do
         @query.should_not match(/LEFT OUTER JOIN `contacts`/)
       end
       
+      it "should include explicitly requested joins" do
+        @query.should match(/LEFT OUTER JOIN `links`/)
+      end
+      
       it "should include any defined conditions" do
         @query.should match(/WHERE.+`birthday` <= NOW()/)
       end
@@ -161,7 +177,7 @@ describe ThinkingSphinx::Source do
       end
       
       it "should filter the primary key with the offset" do
-        model_count = ThinkingSphinx.indexed_models.size
+        model_count = ThinkingSphinx.context.indexed_models.size
         @query.should match(/WHERE `id` = \(\(\$id - 1\) \/ #{model_count}\)/)
       end
     end

data/spec/thinking_sphinx/test_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require "#{File.dirname(__FILE__)}/../../lib/thinking_sphinx/test"
+
+describe ThinkingSphinx::Test do
+  describe ".run" do
+    before :each do
+      ThinkingSphinx::Test.stub!(:start)
+    end
+
+    it "should call stop when an exception is raised by passed block" do
+      ThinkingSphinx::Test.should_receive(:stop)
+      
+      begin
+        ThinkingSphinx::Test.run { raise FakeError }
+      rescue => FakeError
+        # we raised it manually ourselves!
+      end
+    end
+  end
+end