ebeigarts-thinking-sphinx 1.1.21

data/spec/unit/thinking_sphinx/search_spec.rb

@@ -0,0 +1,228 @@
+require 'spec/spec_helper'
+require 'will_paginate/collection'
+
+describe ThinkingSphinx::Search do
+  describe "search method" do
+    describe ":star option" do
+      before :each do
+        @client = Riddle::Client.new
+        @client.stub!(
+          :filters    => [],
+          :filters=   => true,
+          :id_range=  => true,
+          :sort_mode  => :asc,
+          :limit      => 5,
+          :offset=    => 0,
+          :sort_mode= => true,
+          :query      => {
+            :matches  => [],
+            :total    => 50
+          }
+        )
+
+        ThinkingSphinx::Search.stub_methods(
+          :client_from_options => @client,
+          :search_conditions   => ["", []]
+        )
+      end
+      
+      it "should not apply by default" do
+        @client.should_receive(:query).with("foo bar",'*','')
+        
+        ThinkingSphinx::Search.search "foo bar"
+      end
+
+      it "should apply when passed, and handle full extended syntax" do
+        input    = %{a b* c (d | e) 123 5&6 (f_f g) !h "i j" "k l"~10 "m n"/3 @o p -(q|r)}
+        expected = %{*a* b* *c* (*d* | *e*) *123* *5*&*6* (*f_f* *g*) !*h* "i j" "k l"~10 "m n"/3 @o *p* -(*q*|*r*)}
+        @client.should_receive(:query).with(expected,'*','')
+        
+        ThinkingSphinx::Search.search input, :star => true
+      end
+
+      it "should default to /\w+/ as token" do
+        @client.should_receive(:query).with("*foo*@*bar*.*com*",'*','')
+        
+        ThinkingSphinx::Search.search "foo@bar.com", :star => true
+      end
+
+      it "should honour custom token" do
+        @client.should_receive(:query).with("*foo@bar.com* -*foo-bar*",'*','')
+        
+        ThinkingSphinx::Search.search "foo@bar.com -foo-bar", :star => /[\w@.-]+/u
+      end
+    end
+    
+    describe "sort modes" do
+      before :each do
+        @client = Riddle::Client.new
+        @client.stub_method(:query => {:matches => []})
+        Riddle::Client.stub_method(:new => @client)
+      end
+      
+      it "should use :relevance as a default" do
+        ThinkingSphinx::Search.search "foo"
+        @client.sort_mode.should == :relevance
+      end
+      
+      it "should use :attr_asc if a symbol is supplied to :order" do
+        ThinkingSphinx::Search.search "foo", :order => :created_at
+        @client.sort_mode.should == :attr_asc
+      end
+      
+      it "should use :attr_desc if a symbol is supplied and :desc is the mode" do
+        ThinkingSphinx::Search.search "foo", :order => :created_at, :sort_mode => :desc
+        @client.sort_mode.should == :attr_desc
+      end
+      
+      it "should use :extended if a string is supplied to :order" do
+        ThinkingSphinx::Search.search "foo", :order => "created_at ASC"
+        @client.sort_mode.should == :extended
+      end
+      
+      it "should use :expr if explicitly requested with a string supplied to :order" do
+        ThinkingSphinx::Search.search "foo", :order => "created_at ASC", :sort_mode => :expr
+        @client.sort_mode.should == :expr
+      end
+      
+      it "should use :attr_desc if explicitly requested with a string supplied to :order" do
+        ThinkingSphinx::Search.search "foo", :order => "created_at", :sort_mode => :desc
+        @client.sort_mode.should == :attr_desc
+      end
+    end
+    
+    describe "grouping" do
+      before :each do
+        @client = Riddle::Client.new
+        @client.stub_method(:query => {:matches => []})
+        Riddle::Client.stub_method(:new => @client)
+      end
+
+      it "should convert group into group_by and group_function" do
+        ThinkingSphinx::Search.search "foo", :group => :edition
+        @client.group_function.should == :attr
+        @client.group_by.should == "edition"
+      end
+    end
+    
+    describe ":comment option" do
+      before :each do
+        @client = Riddle::Client.new
+        @client.stub_method(:query => {:matches => []})
+        Riddle::Client.stub_method(:new => @client)
+      end
+      
+      it "should add comment to log" do
+        ThinkingSphinx::Search.search 'foo bar', :comment => 'custom log'
+        @client.should have_received(:query).with('foo bar', '*', 'custom log')
+      end
+      
+      it "should use a blank string when no comment is specified" do
+        ThinkingSphinx::Search.search 'foo bar'
+        @client.should have_received(:query).with('foo bar', '*', '')
+      end
+    end
+  end
+  
+  describe "facets method" do
+    before :each do
+      @person = Person.find(:first)
+      
+      @city_results = [@person]
+      @city_results.stub!(:each_with_groupby_and_count).
+        and_yield(@person, @person.city.to_crc32, 1)
+      
+      @birthday_results = [@person]
+      @birthday_results.stub!(:each_with_groupby_and_count).
+        and_yield(@person, @person.birthday.to_i, 1)
+      
+      @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::Search.stub!(:search).and_return(@city_results, @birthday_results)
+      
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+      end
+      
+      ThinkingSphinx::Search.facets :all_attributes => true
+    end
+    
+    it "should use the default max-matches if there is no explicit setting" do
+      ThinkingSphinx::Search.stub!(:search).and_return(@city_results, @birthday_results)
+      
+      @config.configuration.searchd.max_matches = nil
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 1000
+        options[:limit].should        == 1000
+      end
+      
+      ThinkingSphinx::Search.facets :all_attributes => true
+    end
+    
+    it "should ignore user-provided max_matches and limit on facet calls" do
+      ThinkingSphinx::Search.stub!(:search).and_return(@city_results, @birthday_results)
+      
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+      end
+      
+      ThinkingSphinx::Search.facets(
+        :all_attributes => true,
+        :max_matches    => 500,
+        :limit          => 200
+      )
+    end
+    
+    it "should use explicit facet list if one is provided" do
+      ThinkingSphinx::Search.should_receive(:search).once.and_return(@city_results)
+      
+      ThinkingSphinx::Search.facets(
+        :facets => ['city'],
+        :class  => Person
+      )
+    end
+    
+    it "should not use an explicit :page" do
+      ThinkingSphinx::Search.stub!(:search).and_return(@city_results, @birthday_results)
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:page].should == 1
+      end
+      
+      ThinkingSphinx::Search.facets(
+        :all_attributes => true,
+        :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)
+        Alpha.sphinx_indexes.delete_at(-1)
+      end
+      
+      it "should raise an error if searching with facets of same name but different type" do
+        lambda {
+          ThinkingSphinx::Search.facets :all_attributes => true
+        }.should raise_error
+      end
+    end
+  end
+end
+
+describe ThinkingSphinx::Search, "playing nice with Search model" do
+  it "should not conflict with models called Search" do
+    lambda { Search.find(:all) }.should_not raise_error
+  end
+end

data/spec/unit/thinking_sphinx/source_spec.rb

@@ -0,0 +1,217 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::Source do
+  before :each do
+    @index  = ThinkingSphinx::Index.new(Person)
+    @source = ThinkingSphinx::Source.new(@index, :sql_range_step => 1000)
+  end
+  
+  it "should generate the name from the model" do
+    @source.name.should == "person"
+  end
+  
+  it "should handle namespaced models for name generation" do
+    index  = ThinkingSphinx::Index.new(Admin::Person)
+    source = ThinkingSphinx::Source.new(index)
+    source.name.should == "admin_person"
+  end
+  
+  describe "#to_riddle_for_core" do
+    before :each do
+      config = ThinkingSphinx::Configuration.instance
+      config.source_options[:sql_ranged_throttle] = 100
+      
+      ThinkingSphinx::Field.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:first_name)
+      )
+      ThinkingSphinx::Field.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:last_name)
+      )
+      
+      ThinkingSphinx::Attribute.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:id), :as => :internal_id
+      )
+      ThinkingSphinx::Attribute.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:birthday)
+      )
+      ThinkingSphinx::Attribute.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:tags, :id), :as => :tag_ids
+      )
+      ThinkingSphinx::Attribute.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:contacts, :id),
+        :as => :contact_ids, :source => :query
+      )
+      
+      @source.conditions << "`birthday` <= NOW()"
+      @source.groupings  << "`first_name`"
+      
+      @index.local_options[:group_concat_max_len] = 1024
+      
+      @riddle = @source.to_riddle_for_core(1, 0)
+    end
+    
+    it "should generate a Riddle Source object" do
+      @riddle.should be_a_kind_of(Riddle::Configuration::SQLSource)
+    end
+    
+    it "should use the index and name its own name" do
+      @riddle.name.should == "person_core_0"
+    end
+    
+    it "should use the model's database connection to determine type" do
+      @riddle.type.should == "mysql"
+    end
+    
+    it "should match the model's database settings" do
+      config = Person.connection.instance_variable_get(:@config)
+      @riddle.sql_db.should   == config[:database]
+      @riddle.sql_user.should == config[:username]
+      @riddle.sql_pass.should == config[:password].to_s
+      @riddle.sql_host.should == config[:host]
+      @riddle.sql_port.should == config[:port]
+      @riddle.sql_sock.should == config[:socket]
+    end
+    
+    it "should assign attributes" do
+      # 3 internal attributes plus the one requested
+      @riddle.sql_attr_uint.length.should == 4
+      @riddle.sql_attr_uint.last.should == :internal_id
+      
+      @riddle.sql_attr_timestamp.length.should == 1
+      @riddle.sql_attr_timestamp.first.should == :birthday
+    end
+    
+    it "should set Sphinx Source options" do
+      @riddle.sql_range_step.should      == 1000
+      @riddle.sql_ranged_throttle.should == 100
+    end
+    
+    describe "#sql_query" do
+      before :each do
+        @query = @riddle.sql_query
+      end
+      
+      it "should select data from the model table" do
+        @query.should match(/FROM `people`/)
+      end
+      
+      it "should select each of the fields" do
+        @query.should match(/`first_name`.+FROM/)
+        @query.should match(/`last_name`.+FROM/)
+      end
+      
+      it "should select each of the attributes" do
+        @query.should match(/`id` AS `internal_id`.+FROM/)
+        @query.should match(/`birthday`.+FROM/)
+        @query.should match(/`tags`.`id`.+ AS `tag_ids`.+FROM/)
+      end
+      
+      it "should not match the sourced MVA attribute" do
+        @query.should_not match(/contact_ids/)
+      end
+      
+      it "should include joins for required associations" do
+        @query.should match(/LEFT OUTER JOIN `tags`/)
+      end
+      
+      it "should not include joins for the sourced MVA attribute" do
+        @query.should_not match(/LEFT OUTER JOIN `contacts`/)
+      end
+      
+      it "should include any defined conditions" do
+        @query.should match(/WHERE.+`birthday` <= NOW()/)
+      end
+      
+      it "should include any defined groupings" do
+        @query.should match(/GROUP BY.+`first_name`/)
+      end
+    end
+    
+    describe "#sql_query_range" do
+      before :each do
+        @query = @riddle.sql_query_range
+      end
+      
+      it "should select data from the model table" do
+        @query.should match(/FROM `people`/)
+      end
+      
+      it "should select the minimum and the maximum ids" do
+        @query.should match(/SELECT.+MIN.+MAX.+FROM/)
+      end
+    end
+    
+    describe "#sql_query_info" do
+      before :each do
+        @query = @riddle.sql_query_info
+      end
+      
+      it "should select all fields from the model table" do
+        @query.should match(/SELECT \* FROM `people`/)
+      end
+      
+      it "should filter the primary key with the offset" do
+        model_count = ThinkingSphinx.indexed_models.size
+        @query.should match(/WHERE `id` = \(\(\$id - 1\) \/ #{model_count}\)/)
+      end
+    end
+    
+    describe "#sql_query_pre" do
+      before :each do
+        @queries = @riddle.sql_query_pre
+      end
+      
+      it "should default to just the UTF8 statement" do
+        @queries.detect { |query|
+          query == "SET NAMES utf8"
+        }.should_not be_nil
+      end
+      
+      it "should set the group_concat_max_len session value for MySQL if requested" do
+        @queries.detect { |query|
+          query == "SET SESSION group_concat_max_len = 1024"
+        }.should_not be_nil
+      end
+    end
+  end
+  
+  describe "#to_riddle_for_core with range disabled" do
+    before :each do
+      ThinkingSphinx::Field.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:first_name)
+      )
+    end
+    
+    describe "set per-index" do
+      before :each do
+        @index.local_options[:disable_range] = true
+        @riddle = @source.to_riddle_for_core(1, 0)
+      end
+      
+      it "should not have the range in the sql_query" do
+        @riddle.sql_query.should_not match(/`people`.`id` >= \$start/)
+        @riddle.sql_query.should_not match(/`people`.`id` <= \$end/)
+      end
+    
+      it "should not have a sql_query_range" do
+        @riddle.sql_query_range.should be_nil
+      end
+    end
+    
+    describe "set globally" do
+      before :each do
+        ThinkingSphinx::Configuration.instance.index_options[:disable_range] = true
+        @riddle = @source.to_riddle_for_core(1, 0)
+      end
+      
+      it "should not have the range in the sql_query" do
+        @riddle.sql_query.should_not match(/`people`.`id` >= \$start/)
+        @riddle.sql_query.should_not match(/`people`.`id` <= \$end/)
+      end
+    
+      it "should not have a sql_query_range" do
+        @riddle.sql_query_range.should be_nil
+      end
+    end
+  end
+end

data/spec/unit/thinking_sphinx_spec.rb

@@ -0,0 +1,151 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx do
+  it "should define indexes by default" do
+    ThinkingSphinx.define_indexes?.should be_true
+  end
+  
+  it "should disable index definition" do
+    ThinkingSphinx.define_indexes = false
+    ThinkingSphinx.define_indexes?.should be_false
+  end
+  
+  it "should enable index definition" do
+    ThinkingSphinx.define_indexes = false
+    ThinkingSphinx.define_indexes?.should be_false
+    ThinkingSphinx.define_indexes = true
+    ThinkingSphinx.define_indexes?.should be_true
+  end
+  
+  it "should index deltas by default" do
+    ThinkingSphinx.deltas_enabled = nil
+    ThinkingSphinx.deltas_enabled?.should be_true
+  end
+  
+  it "should disable delta indexing" do
+    ThinkingSphinx.deltas_enabled = false
+    ThinkingSphinx.deltas_enabled?.should be_false
+  end
+  
+  it "should enable delta indexing" do
+    ThinkingSphinx.deltas_enabled = false
+    ThinkingSphinx.deltas_enabled?.should be_false
+    ThinkingSphinx.deltas_enabled = true
+    ThinkingSphinx.deltas_enabled?.should be_true
+  end
+  
+  it "should update indexes by default" do
+    ThinkingSphinx.updates_enabled = nil
+    ThinkingSphinx.updates_enabled?.should be_true
+  end
+  
+  it "should disable index updating" do
+    ThinkingSphinx.updates_enabled = false
+    ThinkingSphinx.updates_enabled?.should be_false
+  end
+  
+  it "should enable index updating" do
+    ThinkingSphinx.updates_enabled = false
+    ThinkingSphinx.updates_enabled?.should be_false
+    ThinkingSphinx.updates_enabled = true
+    ThinkingSphinx.updates_enabled?.should be_true
+  end
+  
+  it "should always say Sphinx is running if flagged as being on a remote machine" do
+    ThinkingSphinx.remote_sphinx = true
+    ThinkingSphinx.stub_method(:sphinx_running_by_pid? => false)
+    
+    ThinkingSphinx.sphinx_running?.should be_true
+  end
+  
+  it "should actually pay attention to Sphinx if not on a remote machine" do
+    ThinkingSphinx.remote_sphinx = false
+    ThinkingSphinx.stub_method(:sphinx_running_by_pid? => false)
+    ThinkingSphinx.sphinx_running?.should be_false
+    
+    ThinkingSphinx.stub_method(:sphinx_running_by_pid? => true)
+    ThinkingSphinx.sphinx_running?.should be_true
+  end
+  
+  describe "use_group_by_shortcut? method" do
+    before :each do
+      adapter = defined?(JRUBY_VERSION) ? :JdbcAdapter : :MysqlAdapter
+      unless ::ActiveRecord::ConnectionAdapters.const_defined?(adapter)
+        pending "No MySQL"
+        return
+      end
+      
+      @connection = ::ActiveRecord::ConnectionAdapters.const_get(adapter).stub_instance(
+        :select_all => true,
+        :config => {:adapter => defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'}
+      )
+      ::ActiveRecord::Base.stub_method(
+        :connection => @connection
+      )
+    end
+    
+    it "should return true if no ONLY_FULL_GROUP_BY" do
+      @connection.stub_method(
+        :select_all => {:a => "OTHER SETTINGS"}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_true
+    end
+  
+    it "should return true if NULL value" do
+      @connection.stub_method(
+        :select_all => {:a => nil}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_true
+    end
+  
+    it "should return false if ONLY_FULL_GROUP_BY is set" do
+      @connection.stub_method(
+        :select_all => {:a => "OTHER SETTINGS,ONLY_FULL_GROUP_BY,blah"}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_false
+    end
+    
+    it "should return false if ONLY_FULL_GROUP_BY is set in any of the values" do
+      @connection.stub_method(
+        :select_all => {
+          :a => "OTHER SETTINGS",
+          :b => "ONLY_FULL_GROUP_BY"
+        }
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_false
+    end
+    
+    describe "if not using MySQL" do
+      before :each do
+        adapter = defined?(JRUBY_VERSION) ? 'JdbcAdapter' : 'PostgreSQLAdapter'
+        unless ::ActiveRecord::ConnectionAdapters.const_defined?(adapter)
+          pending "No PostgreSQL"
+          return
+        end
+        
+        @connection = stub(adapter).as_null_object
+        @connection.stub!(
+          :select_all => true,
+          :config => {:adapter => defined?(JRUBY_VERSION) ? 'jdbcpostgresql' : 'postgresql'}
+        )
+        ::ActiveRecord::Base.stub_method(
+          :connection => @connection
+        )
+      end
+    
+      it "should return false" do
+        ThinkingSphinx.use_group_by_shortcut?.should be_false
+      end
+    
+      it "should not call select_all" do
+        @connection.should_not_receive(:select_all)
+        
+        ThinkingSphinx.use_group_by_shortcut?
+      end
+    end
+  end
+end