zipme-thinking-sphinx 1.3.14

data/spec/thinking_sphinx/source_spec.rb

@@ -0,0 +1,235 @@
+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
+  
+  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
+  
+  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 use a default username of root if nothing else is provided" do
+      Person.connection.stub!(:instance_variable_get => {
+        :user     => nil,
+        :username => nil
+      })
+      @source = ThinkingSphinx::Source.new(@index)
+      
+      riddle = @source.to_riddle_for_core(1, 0)
+      riddle.sql_user.should == 'root'
+    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.context.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/thinking_sphinx_spec.rb

@@ -0,0 +1,204 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx do
+  describe '.context' do
+    it "should return a Context instance" do
+      ThinkingSphinx.context.should be_a(ThinkingSphinx::Context)
+    end
+    
+    it "should remember changes to the Context instance" do
+      models = ThinkingSphinx.context.indexed_models
+      
+      ThinkingSphinx.context.indexed_models.replace([:model])
+      ThinkingSphinx.context.indexed_models.should == [:model]
+      
+      ThinkingSphinx.context.indexed_models.replace(models)
+    end
+  end
+  
+  describe '.reset_context!' do
+    it "should remove the existing Context instance" do
+      existing = ThinkingSphinx.context
+      
+      ThinkingSphinx.reset_context!
+      ThinkingSphinx.context.should_not == existing
+      
+      Thread.current[:thinking_sphinx_context] = existing
+    end
+  end
+  
+  describe '.define_indexes?' do
+    it "should define indexes by default" do
+      ThinkingSphinx.define_indexes?.should be_true
+    end
+  end
+  
+  describe '.define_indexes=' do
+    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
+  end
+  
+  describe '.deltas_enabled?' do
+    it "should index deltas by default" do
+      ThinkingSphinx.deltas_enabled = nil
+      ThinkingSphinx.deltas_enabled?.should be_true
+    end
+  end
+  
+  describe '.deltas_enabled=' do
+    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
+  end
+  
+  describe '.updates_enabled?' do
+    it "should update indexes by default" do
+      ThinkingSphinx.updates_enabled = nil
+      ThinkingSphinx.updates_enabled?.should be_true
+    end
+  end
+  
+  describe '.updates_enabled=' do
+    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
+  end
+  
+  describe '.sphinx_running?' do
+    it "should always say Sphinx is running if flagged as being on a remote machine" do
+      ThinkingSphinx.remote_sphinx = true
+      ThinkingSphinx.stub!(: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!(:sphinx_running_by_pid? => false)
+      ThinkingSphinx.sphinx_running?.should be_false
+    
+      ThinkingSphinx.stub!(:sphinx_running_by_pid? => true)
+      ThinkingSphinx.sphinx_running?.should be_true
+    end
+  end
+  
+  describe '.version' do
+    it "should return the version from the stored YAML file" do
+      version = Jeweler::VersionHelper.new(
+        File.join(File.dirname(__FILE__), '..')
+      ).to_s
+      
+      ThinkingSphinx.version.should == version
+    end
+  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 = stub('adapter',
+        :select_all => true,
+        :class      => ActiveRecord::ConnectionAdapters::MysqlAdapter,
+        :config => {:adapter => defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'}
+      )
+      ::ActiveRecord::Base.stub!(
+        :connection => @connection
+      )
+      
+      Thread.current[:thinking_sphinx_use_group_by_shortcut] = nil
+    end
+    
+    it "should return true if no ONLY_FULL_GROUP_BY" do
+      @connection.stub!(
+        :select_all => {:a => "OTHER SETTINGS"}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_true
+    end
+  
+    it "should return true if NULL value" do
+      @connection.stub!(
+        :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!(
+        :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!(
+        :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!(
+          :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

data/tasks/distribution.rb

@@ -0,0 +1,39 @@
+require 'yard'
+require 'jeweler'
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "thinking-sphinx"
+  gem.summary     = "ActiveRecord/Rails Sphinx library"
+  gem.description = "A concise and easy-to-use Ruby library that connects ActiveRecord to the Sphinx search daemon, managing configuration, indexing and searching."
+  gem.author      = "Pat Allan"
+  gem.email       = "pat@freelancing-gods.com"
+  gem.homepage    = "http://ts.freelancing-gods.com"
+    
+  # s.rubyforge_project = "thinking-sphinx"
+  gem.files     = FileList[
+    "rails/*.rb",
+    "lib/**/*.rb",
+    "LICENCE",
+    "README.textile",
+    "tasks/**/*.rb",
+    "tasks/**/*.rake",
+    "VERSION"
+  ]
+  gem.test_files = FileList[
+    "features/**/*",
+    "spec/**/*_spec.rb"
+  ]
+  
+  gem.add_dependency 'activerecord', '>= 1.15.6'
+  gem.add_dependency 'riddle',       '>= 1.0.8'
+  gem.add_dependency 'after_commit', '>= 1.0.5'
+  
+  gem.post_install_message = <<-MESSAGE
+If you're upgrading, you should read this:
+http://freelancing-god.github.com/ts/en/upgrading.html
+
+MESSAGE
+end