freelancing-god-thinking-sphinx 1.1.24 → 1.2.0

data/spec/lib/thinking_sphinx/active_record/scopes_spec.rb

@@ -0,0 +1,92 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::ActiveRecord::Scopes do
+  after :each do
+    Alpha.remove_sphinx_scopes
+  end
+  
+  it "should be included into models with indexes" do
+    Alpha.included_modules.should include(ThinkingSphinx::ActiveRecord::Scopes)
+  end
+  
+  it "should not be included into models without indexes" do
+    Gamma.included_modules.should_not include(
+      ThinkingSphinx::ActiveRecord::Scopes
+    )
+  end
+  
+  describe '.sphinx_scope' do
+    before :each do
+      Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
+    end
+    
+    it "should define a method on the model" do
+      Alpha.should respond_to(:by_name)
+    end
+  end
+  
+  describe '.sphinx_scopes' do
+    before :each do
+      Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
+    end
+    
+    it "should return an array of defined scope names as symbols" do
+      Alpha.sphinx_scopes.should == [:by_name]
+    end
+  end
+  
+  describe '.remove_sphinx_scopes' do
+    before :each do
+      Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
+      Alpha.remove_sphinx_scopes
+    end
+    
+    it "should remove sphinx scope methods" do
+      Alpha.should_not respond_to(:by_name)
+    end
+    
+    it "should empty the list of sphinx scopes" do
+      Alpha.sphinx_scopes.should be_empty
+    end
+  end
+  
+  describe '.example_scope' do
+    before :each do
+      Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
+      Alpha.sphinx_scope(:by_foo)  { |foo|  {:conditions => {:foo  => foo}}  }
+      Alpha.sphinx_scope(:with_betas) { {:classes => [Beta]} }
+    end
+    
+    it "should return a ThinkingSphinx object" do
+      Alpha.by_name('foo').should be_a(ThinkingSphinx::Search)
+    end
+    
+    it "should be able to be called on a ThinkingSphinx::Search object" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      lambda {
+        search.by_name('foo')
+      }.should_not raise_error
+    end
+    
+    it "should return the search object it gets called upon" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('foo').should == search
+    end
+    
+    it "should apply the scope options to the underlying search object" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('foo').options[:conditions].should == {:name => 'foo'}
+    end
+    
+    it "should combine hash option scopes such as :conditions" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('foo').by_foo('bar').options[:conditions].
+        should == {:name => 'foo', :foo => 'bar'}
+    end
+    
+    it "should combine array option scopes such as :classes" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.with_betas.options[:classes].should == [Alpha, Beta]
+    end
+  end
+end

data/spec/{unit → lib}/thinking_sphinx/configuration_spec.rb

@@ -219,4 +219,29 @@ describe ThinkingSphinx::Configuration do
     }
     file.should_not match(/index alpha_core\s+\{\s+[^\}]*prefix_fields\s+=[^\}]*\}/m)
   end
+  
+  describe '#client' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @config.address     = 'domain.url'
+      @config.port        = 3333
+      @config.configuration.searchd.max_matches = 100
+    end
+    
+    it "should return an instance of Riddle::Client" do
+      @config.client.should be_a(Riddle::Client)
+    end
+    
+    it "should use the configuration address" do
+      @config.client.server.should == 'domain.url'
+    end
+    
+    it "should use the configuration port" do
+      @config.client.port.should == 3333
+    end
+    
+    it "should use the configuration max matches" do
+      @config.client.max_matches.should == 100
+    end
+  end
 end

data/spec/lib/thinking_sphinx/excerpter_spec.rb

@@ -0,0 +1,49 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::Excerpter do
+  before :each do
+    @alpha      = Alpha.find(:first)
+    @search     = mock 'search', :excerpt_for => 'excerpted value'
+    @excerpter  = ThinkingSphinx::Excerpter.new(@search, @alpha)
+  end
+  
+  it "should not respond to id" do
+    @excerpter.should_not respond_to(:id)
+  end
+  
+  describe '#method_missing' do
+    it "should return the excerpt from Sphinx" do
+      @excerpter.name.should == 'excerpted value'
+    end
+    
+    it "should send through the instance class to excerpt_for" do
+      @search.should_receive(:excerpt_for) do |string, model|
+        model.should == Alpha
+      end
+      
+      @excerpter.name
+    end
+    
+    it "should use attribute methods for excerpts calls" do
+      @search.should_receive(:excerpt_for) do |string, model|
+        string.should == 'one'
+      end
+      
+      @excerpter.name
+    end
+    
+    it "should use instance methods for excerpts calls" do
+      @search.should_receive(:excerpt_for) do |string, model|
+        string.should == 'ONE'
+      end
+      
+      @excerpter.big_name
+    end
+    
+    it "should still raise an exception if no column or method exists" do
+      lambda {
+        @excerpter.foo
+      }.should raise_error(NoMethodError)
+    end
+  end
+end

data/spec/lib/thinking_sphinx/facet_search_spec.rb

@@ -0,0 +1,176 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::FacetSearch do
+  describe 'populate' do
+    it "should make separate Sphinx queries for each facet" do
+      ThinkingSphinx.should_receive(:search).with(
+        hash_including(:group_by => 'city_facet')
+      ).and_return([])
+      ThinkingSphinx.should_receive(:search).with(
+        hash_including(:group_by => 'state_facet')
+      ).and_return([])
+      ThinkingSphinx.should_receive(:search).with(
+        hash_including(:group_by => 'birthday')
+      ).and_return([])
+      
+      ThinkingSphinx::FacetSearch.new(:classes => [Person])
+    end
+    
+    it "should request all shared facets in a multi-model request by default" do
+      ThinkingSphinx.stub!(:search => [])
+      ThinkingSphinx::FacetSearch.new.facet_names.should == ['class_crc']
+    end
+    
+    it "should request all facets in a multi-model request if specified" do
+      ThinkingSphinx.stub!(:search => [])
+      ThinkingSphinx::FacetSearch.new(
+        :all_facets => true
+      ).facet_names.should == [
+        'class_crc', 'city_facet', 'state_facet', 'birthday'
+      ]
+    end
+    
+    describe ':facets option' do
+      it "should limit facets to the requested set" do
+        ThinkingSphinx.should_receive(:search).once.and_return([])
+        
+        ThinkingSphinx::FacetSearch.new(
+          :classes => [Person], :facets => :state
+        )
+      end
+    end
+    
+    describe "empty result set for attributes" do
+      before :each do
+        ThinkingSphinx.stub!(:search => [])
+        @facets = ThinkingSphinx::FacetSearch.new(
+          :classes => [Person], :facets => :state
+        )
+      end
+      
+      it "should add key as attribute" do
+        @facets.should have_key(:state)
+      end
+
+      it "should return an empty hash for the facet results" do
+        @facets[:state].should be_empty
+      end
+    end
+
+    describe "non-empty result set" do
+      before :each do
+        @person = Person.find(:first)
+        @people = [@person]
+        @people.stub!(:each_with_groupby_and_count).
+          and_yield(@person, @person.city.to_crc32, 1)
+        ThinkingSphinx.stub!(:search => @people)
+        
+        @facets = ThinkingSphinx::FacetSearch.new(
+          :classes => [Person], :facets => :city
+        )
+      end
+
+      it "should return a hash" do
+        @facets.should be_a_kind_of(Hash)
+      end
+
+      it "should add key as attribute" do
+        @facets.keys.should include(:city)
+      end
+
+      it "should return a hash" do
+        @facets[:city].should == {@person.city => 1}
+      end
+    end
+    
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @config.configuration.searchd.max_matches = 10_000
+    end
+    
+    it "should use the system-set max_matches for limit on facet calls" do
+      ThinkingSphinx.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+        []
+      end
+      
+      ThinkingSphinx::FacetSearch.new
+    end
+    
+    it "should use the default max-matches if there is no explicit setting" do
+      @config.configuration.searchd.max_matches = nil
+      ThinkingSphinx.should_receive(:search) do |options|
+        options[:max_matches].should  == 1000
+        options[:limit].should        == 1000
+        []
+      end
+      
+      ThinkingSphinx::FacetSearch.new
+    end
+    
+    it "should ignore user-provided max_matches and limit on facet calls" do
+      ThinkingSphinx.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+        []
+      end
+      
+      ThinkingSphinx::FacetSearch.new(
+        :max_matches    => 500,
+        :limit          => 200
+      )
+    end
+    
+    it "should not use an explicit :page" do
+      ThinkingSphinx.should_receive(:search) do |options|
+        options[:page].should == 1
+        []
+      end
+      
+      ThinkingSphinx::FacetSearch.new(:page => 3)
+    end
+    
+    describe "conflicting facets" do
+      before :each do
+        @index = ThinkingSphinx::Index::Builder.generate(Alpha) do
+          indexes :name
+          has :value, :as => :city, :facet => true
+        end
+      end
+      
+      after :each do
+        Alpha.sphinx_facets.delete_at(-1)
+      end
+      
+      it "should raise an error if searching with facets of same name but different type" do
+        lambda {
+          facets = ThinkingSphinx.facets :all_facets => true
+        }.should raise_error
+      end
+    end
+  end
+  
+  describe "#for" do
+    before do
+      @person = Person.find(:first)
+      @people = [@person]
+      @people.stub!(:each_with_groupby_and_count).
+        and_yield(@person, @person.city.to_crc32, 1)
+      ThinkingSphinx.stub!(:search => @people)
+      
+      @facets = ThinkingSphinx::FacetSearch.new(
+        :classes => [Person], :facets => :city
+      )
+    end
+
+    it "should return the search results for the attribute and key pair" do
+      ThinkingSphinx.should_receive(:search) do |options|
+        options[:with].should have_key('city_facet')
+        options[:with]['city_facet'].should == @person.city.to_crc32
+      end
+      
+      @facets.for(:city => @person.city)
+    end
+  end
+end

data/spec/lib/thinking_sphinx/search_methods_spec.rb

@@ -0,0 +1,152 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::SearchMethods do
+  it "should be included into models with indexes" do
+    Alpha.included_modules.should include(ThinkingSphinx::SearchMethods)
+  end
+  
+  it "should not be included into models that don't have indexes" do
+    Gamma.included_modules.should_not include(ThinkingSphinx::SearchMethods)
+  end
+  
+  describe '.search_context' do
+    it "should return nil if not within a model" do
+      ThinkingSphinx.search_context.should be_nil
+    end
+    
+    it "should return the model if within one" do
+      Alpha.search_context.should == Alpha
+    end
+  end
+  
+  describe '.search' do
+    it "should return an instance of ThinkingSphinx::Search" do
+      Alpha.search.class.should == ThinkingSphinx::Search
+    end
+    
+    it "should set the classes option if not already set" do
+      search = Alpha.search
+      search.options[:classes].should == [Alpha]
+    end
+    
+    it "shouldn't set the classes option if already defined" do
+      search = Alpha.search :classes => [Beta]
+      search.options[:classes].should == [Beta]
+    end
+    
+    it "should default to nil for the classes options" do
+      ThinkingSphinx.search.options[:classes].should be_nil
+    end
+  end
+  
+  describe '.search_for_ids' do
+    it "should return an instance of ThinkingSphinx::Search" do
+      Alpha.search.class.should == ThinkingSphinx::Search
+    end
+    
+    it "should set the classes option if not already set" do
+      search = Alpha.search_for_ids
+      search.options[:classes].should == [Alpha]
+    end
+    
+    it "shouldn't set the classes option if already defined" do
+      search = Alpha.search_for_ids :classes => [Beta]
+      search.options[:classes].should == [Beta]
+    end
+    
+    it "should set ids_only to true" do
+      search = Alpha.search_for_ids
+      search.options[:ids_only].should be_true
+    end
+  end
+  
+  describe '.search_for_id' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @client = Riddle::Client.new
+
+      @config.stub!(:client => @client)
+      @client.stub!(:query => {:matches => [], :total_found => 0})
+    end
+    
+    it "should set the id range to the given id value" do
+      ThinkingSphinx.search_for_id(101, 'alpha_core')
+      
+      @client.id_range.should == (101..101)
+    end
+    
+    it "should not make any calls to the database" do
+      Alpha.should_not_receive(:find)
+      
+      ThinkingSphinx.search_for_id(101, 'alpha_core', :classes => [Alpha])
+    end
+    
+    it "should return true if there is a record" do
+      @client.stub!(:query => {:matches => [
+        {:attributes => {'sphinx_internal_id' => 100}}
+      ], :total_found => 1})
+      
+      ThinkingSphinx.search_for_id(101, 'alpha_core').should be_true
+    end
+    
+    it "should return false if there isn't a record" do
+      ThinkingSphinx.search_for_id(101, 'alpha_core').should be_false
+    end
+  end
+  
+  describe '.count' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @client = Riddle::Client.new
+
+      @config.stub!(:client => @client)
+      @client.stub!(:query => {:matches => [], :total_found => 42})
+    end
+    
+    it "should fall through to ActiveRecord if called on a class" do
+      @client.should_not_receive(:query)
+      
+      Alpha.count
+    end
+    
+    it "should return the total number of results if called globally" do
+      ThinkingSphinx.count.should == 42
+    end
+  end
+  
+  describe '.search_count' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @client = Riddle::Client.new
+
+      @config.stub!(:client => @client)
+      @client.stub!(:query => {:matches => [], :total_found => 42})
+    end
+    
+    it "should return the total number of results" do
+      Alpha.search_count.should == 42
+    end
+    
+    it "should not make any calls to the database" do
+      Alpha.should_not_receive(:find)
+      
+      Alpha.search_count
+    end
+  end
+  
+  describe '.facets' do
+    it "should return a FacetSearch instance" do
+      Alpha.facets.should be_a(ThinkingSphinx::FacetSearch)
+    end
+    
+    it "should set the classes option if not already set" do
+      facets = Alpha.facets
+      facets.options[:classes].should == [Alpha]
+    end
+    
+    it "shouldn't set the classes option if already defined" do
+      facets = Alpha.facets :classes => [Beta]
+      facets.options[:classes].should == [Beta]
+    end
+  end
+end