dpickett-thinking-sphinx 1.1.12 → 1.1.23

data/lib/thinking_sphinx/source/internal_properties.rb

@@ -0,0 +1,46 @@
+module ThinkingSphinx
+  class Source
+    module InternalProperties
+      def add_internal_attributes_and_facets
+        add_internal_attribute :sphinx_internal_id, :integer, @model.primary_key.to_sym
+        add_internal_attribute :class_crc,          :integer, crc_column, true
+        add_internal_attribute :subclass_crcs,      :multi,   subclasses_to_s
+        add_internal_attribute :sphinx_deleted,     :integer, "0"
+
+        add_internal_facet :class_crc
+      end
+
+      def add_internal_attribute(name, type, contents, facet = false)
+        return unless attribute_by_alias(name).nil?
+
+        Attribute.new(self,
+          ThinkingSphinx::Index::FauxColumn.new(contents),
+          :type   => type,
+          :as     => name,
+          :facet  => facet,
+          :admin  => true
+        )
+      end
+
+      def add_internal_facet(name)
+        return unless facet_by_alias(name).nil?
+
+        @model.sphinx_facets << ClassFacet.new(attribute_by_alias(name))
+      end
+
+      def attribute_by_alias(attr_alias)
+        @attributes.detect { |attrib| attrib.alias == attr_alias }
+      end
+
+      def facet_by_alias(name)
+        @model.sphinx_facets.detect { |facet| facet.name == name }
+      end
+
+      def subclasses_to_s
+        "'" + (@model.send(:subclasses).collect { |klass|
+          klass.to_crc32.to_s
+        } << @model.to_crc32.to_s).join(",") + "'"
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/source/sql.rb

@@ -0,0 +1,128 @@
+module ThinkingSphinx
+  class Source
+    module SQL
+      # Generates the big SQL statement to get the data back for all the fields
+      # and attributes, using all the relevant association joins. If you want
+      # the version filtered for delta values, send through :delta => true in the
+      # options. Won't do much though if the index isn't set up to support a
+      # delta sibling.
+      # 
+      # Examples:
+      # 
+      #   source.to_sql
+      #   source.to_sql(:delta => true)
+      #
+      def to_sql(options={})
+        sql = <<-SQL
+SELECT #{ sql_select_clause options[:offset] }
+FROM #{ @model.quoted_table_name }
+  #{ all_associations.collect { |assoc| assoc.to_sql }.join(' ') }
+#{ sql_where_clause(options) }
+GROUP BY #{ sql_group_clause }
+        SQL
+
+        sql += " ORDER BY NULL" if adapter.sphinx_identifier == "mysql"
+        sql
+      end
+
+      # Simple helper method for the query range SQL - which is a statement that
+      # returns minimum and maximum id values. These can be filtered by delta -
+      # so pass in :delta => true to get the delta version of the SQL.
+      # 
+      def to_sql_query_range(options={})
+        return nil if @index.options[:disable_range]
+        
+        min_statement = adapter.convert_nulls(
+          "MIN(#{quote_column(@model.primary_key)})", 1
+        )
+        max_statement = adapter.convert_nulls(
+          "MAX(#{quote_column(@model.primary_key)})", 1
+        )
+
+        sql = "SELECT #{min_statement}, #{max_statement} " +
+              "FROM #{@model.quoted_table_name} "
+        if self.delta? && !@index.delta_object.clause(@model, options[:delta]).blank?
+          sql << "WHERE #{@index.delta_object.clause(@model, options[:delta])}"
+        end
+
+        sql
+      end
+
+      # Simple helper method for the query info SQL - which is a statement that
+      # returns the single row for a corresponding id.
+      # 
+      def to_sql_query_info(offset)
+        "SELECT * FROM #{@model.quoted_table_name} WHERE " +
+        "#{quote_column(@model.primary_key)} = (($id - #{offset}) / #{ThinkingSphinx.indexed_models.size})"
+      end
+
+      def sql_select_clause(offset)
+        unique_id_expr = ThinkingSphinx.unique_id_expression(offset)
+
+        (
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key)} #{unique_id_expr} AS #{quote_column(@model.primary_key)} "] + 
+          @fields.collect     { |field|     field.to_select_sql     } +
+          @attributes.collect { |attribute| attribute.to_select_sql }
+        ).compact.join(", ")
+      end
+
+      def sql_where_clause(options)
+        logic = []
+        logic += [
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key)} >= $start",
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key)} <= $end"
+        ] unless @index.options[:disable_range]
+
+        if self.delta? && !@index.delta_object.clause(@model, options[:delta]).blank?
+          logic << "#{@index.delta_object.clause(@model, options[:delta])}"
+        end
+
+        logic += (@conditions || [])
+        logic.empty? ? "" : "WHERE #{logic.join(' AND ')}"
+      end
+
+      def sql_group_clause
+        internal_groupings = []
+        if @model.column_names.include?(@model.inheritance_column)
+           internal_groupings << "#{@model.quoted_table_name}.#{quote_column(@model.inheritance_column)}"
+        end
+
+        (
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key)}"] + 
+          @fields.collect     { |field|     field.to_group_sql     }.compact +
+          @attributes.collect { |attribute| attribute.to_group_sql }.compact +
+          @groupings + internal_groupings
+        ).join(", ")
+      end
+
+      def sql_query_pre_for_core
+        if self.delta? && !@index.delta_object.reset_query(@model).blank?
+          [@index.delta_object.reset_query(@model)]
+        else
+          []
+        end
+      end
+
+      def sql_query_pre_for_delta
+        [""]
+      end
+
+      def quote_column(column)
+        @model.connection.quote_column_name(column)
+      end
+
+      def crc_column
+        if @model.table_exists? &&
+          @model.column_names.include?(@model.inheritance_column)
+          
+          adapter.cast_to_unsigned(adapter.convert_nulls(
+            adapter.crc(adapter.quote_with_table(@model.inheritance_column), true),
+            @model.to_crc32
+          ))
+        else
+          @model.to_crc32.to_s
+        end
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/tasks.rb

@@ -2,10 +2,19 @@ require 'fileutils'
 
 namespace :thinking_sphinx do
   task :app_env do
-    Rake::Task[:environment].invoke if defined?(RAILS_ROOT)
+    if defined?(RAILS_ROOT)
+      Rake::Task[:environment].invoke
+      Rails.configuration.cache_classes = false
+    end
+    
     Rake::Task[:merb_env].invoke    if defined?(Merb)
   end
   
+  desc "Output the current Thinking Sphinx version"
+  task :version => :app_env do
+    puts "Thinking Sphinx v" + ThinkingSphinx::Version::String
+  end
+  
   desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
   task :running_start => :app_env do
     Rake::Task["thinking_sphinx:stop"].invoke if sphinx_running?
@@ -21,9 +30,7 @@ namespace :thinking_sphinx do
     
     Dir["#{config.searchd_file_path}/*.spl"].each { |file| File.delete(file) }
 
-    cmd = "#{config.bin_path}searchd --pidfile --config #{config.config_file}"
-    puts cmd
-    system cmd
+    system! "#{config.bin_path}#{config.searchd_binary_name} --pidfile --config #{config.config_file}"
     
     sleep(2)
     
@@ -39,7 +46,7 @@ namespace :thinking_sphinx do
     raise RuntimeError, "searchd is not running." unless sphinx_running?
     config = ThinkingSphinx::Configuration.instance
     pid    = sphinx_pid
-    system "#{config.bin_path}searchd --stop --config #{config.config_file}"
+    system! "#{config.bin_path}#{config.searchd_binary_name} --stop --config #{config.config_file}"
     puts "Stopped search daemon (pid #{pid})."
   end
   
@@ -64,10 +71,17 @@ namespace :thinking_sphinx do
     end
         
     FileUtils.mkdir_p config.searchd_file_path
-    cmd = "#{config.bin_path}indexer --config #{config.config_file} --all"
+    cmd = "#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} --all"
     cmd << " --rotate" if sphinx_running?
-    puts cmd
-    system cmd
+    
+    system! cmd
+  end
+  
+  desc "Stop Sphinx (if it's running), rebuild the indexes, and start Sphinx"
+  task :rebuild => :app_env do
+    Rake::Task["thinking_sphinx:stop"].invoke if sphinx_running?
+    Rake::Task["thinking_sphinx:index"].invoke
+    Rake::Task["thinking_sphinx:start"].invoke
   end
   
   namespace :index do
@@ -96,6 +110,8 @@ namespace :thinking_sphinx do
 end
 
 namespace :ts do
+  desc "Output the current Thinking Sphinx version"
+  task :version => "thinking_sphinx:version"
   desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
   task :run     => "thinking_sphinx:running_start"
   desc "Start a Sphinx searchd daemon using Thinking Sphinx's settings"
@@ -115,6 +131,8 @@ namespace :ts do
   task :conf    => "thinking_sphinx:configure"
   desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
   task :config  => "thinking_sphinx:configure"
+  desc "Stop Sphinx (if it's running), rebuild the indexes, and start Sphinx"
+  task :rebuild => "thinking_sphinx:rebuild"
   desc "Process stored delta index requests"
   task :dd      => "thinking_sphinx:delayed_delta"
 end
@@ -126,3 +144,19 @@ end
 def sphinx_running?
   ThinkingSphinx.sphinx_running?
 end
+
+# a fail-fast, hopefully helpful version of system
+def system!(cmd)
+  unless system(cmd)
+    raise <<-SYSTEM_CALL_FAILED
+The following command failed:
+  #{cmd}
+
+This could be caused by a PATH issue in the environment of cron/passenger/etc. Your current PATH:
+  #{ENV['PATH']}
+You can set the path to your indexer and searchd binaries using the bin_path property in config/sphinx.yml:
+  production:
+    bin_path: '/usr/local/bin'
+SYSTEM_CALL_FAILED
+  end
+end

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

@@ -80,7 +80,8 @@ describe "ThinkingSphinx::ActiveRecord::Delta" do
         :sphinx_document_id => 1
       )
       
-      @client = Riddle::Client.stub_instance(:update => true)
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
       Riddle::Client.stub_method(:new => @client)
     end
     
@@ -120,17 +121,16 @@ describe "ThinkingSphinx::ActiveRecord::Delta" do
     end
     
     it "shouldn't update the deleted attribute if not in the index" do
-      @person.send(:index_delta)
+      @client.should_not_receive(:update)
       
-      @client.should_not have_received(: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)
-      
-      @client.should have_received(:update)
     end
   end
 end

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

@@ -2,19 +2,19 @@ require 'spec/spec_helper'
 
 describe "ThinkingSphinx::ActiveRecord::Search" do
   it "should add search_for_ids to ActiveRecord::Base" do
-    ActiveRecord::Base.methods.should include("search_for_ids")
+    ActiveRecord::Base.should respond_to("search_for_ids")
   end
   
   it "should add search_for_ids to ActiveRecord::Base" do
-    ActiveRecord::Base.methods.should include("search")
+    ActiveRecord::Base.should respond_to("search")
   end
   
   it "should add search_count to ActiveRecord::Base" do
-    ActiveRecord::Base.methods.should include("search_count")
+    ActiveRecord::Base.should respond_to("search_count")
   end
 
   it "should add search_for_id to ActiveRecord::Base" do
-    ActiveRecord::Base.methods.should include("search_for_id")
+    ActiveRecord::Base.should respond_to("search_for_id")
   end
   
   describe "search_for_ids method" do

data/spec/unit/thinking_sphinx/active_record_spec.rb

@@ -3,7 +3,7 @@ require 'spec/spec_helper'
 describe "ThinkingSphinx::ActiveRecord" do
   describe "define_index method" do
     before :each do
-      module TestModule
+      module ::TestModule
         class TestModel < ActiveRecord::Base; end
       end
       
@@ -14,7 +14,7 @@ describe "ThinkingSphinx::ActiveRecord" do
       )
       
       @index = ThinkingSphinx::Index.stub_instance(:delta? => false)
-      ThinkingSphinx::Index.stub_method(:new => @index)
+      ThinkingSphinx::Index::Builder.stub_method(:generate => @index)
     end
     
     after :each do
@@ -24,17 +24,17 @@ describe "ThinkingSphinx::ActiveRecord" do
       ThinkingSphinx.indexed_models.delete "TestModule::TestModel"
     end
     
-    it "should return nil and do nothing if indexes are disabled" do
+    it "should do nothing if indexes are disabled" do
       ThinkingSphinx.stub_method(:define_indexes? => false)
       
-      TestModule::TestModel.define_index {}.should be_nil
+      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 do; end
+      TestModule::TestModel.define_index {}
       
       TestModule::TestModel.sphinx_indexes.length.should == 1
     end
@@ -92,6 +92,22 @@ describe "ThinkingSphinx::ActiveRecord" do
     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
@@ -144,7 +160,7 @@ describe "ThinkingSphinx::ActiveRecord" do
     end
 
     it "should return the parent if model inherits an index" do
-      Parent.source_of_sphinx_index.should == Person
+      Admin::Person.source_of_sphinx_index.should == Person
     end
   end
   
@@ -169,7 +185,8 @@ describe "ThinkingSphinx::ActiveRecord" do
         :address  => "an address",
         :port     => 123
       )
-      @client = Riddle::Client.stub_instance(:update => true)
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
       @person = Person.find(:first)
       
       Riddle::Client.stub_method(:new => @client)
@@ -186,87 +203,82 @@ describe "ThinkingSphinx::ActiveRecord" do
     end
     
     it "should update the core index's deleted flag if in core index" do
-      @person.toggle_deleted
-      
-      @client.should have_received(:update).with(
+      @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)
-      
-      @person.toggle_deleted
-      
-      @client.should_not have_received(:update).with(
+      @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?)
-      @client.should_not have_received(:update)
     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
-      
-      @person.toggle_deleted
-      
-      @client.should have_received(:update).with(
+      @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
-      
-      @person.toggle_deleted
-      
-      @client.should_not have_received(:update).with(
+      @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
-
-      @person.toggle_deleted
-
-      @client.should_not have_received(:update).with(
+      @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)
-      @person.toggle_deleted
-      
-      @client.should_not have_received(:update).with(
+      @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
-      
-      @person.toggle_deleted
-      
-      @client.should_not have_received(:update).with(
+      @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
@@ -276,10 +288,9 @@ describe "ThinkingSphinx::ActiveRecord" do
       )
       Person.sphinx_indexes.each { |index| index.stub_method(:delta? => true) }
       @person.delta = true
+      @client.should_not_receive(:update)
       
       @person.toggle_deleted
-      
-      @client.should_not have_received(:update)
     end
   end
 
@@ -289,10 +300,12 @@ describe "ThinkingSphinx::ActiveRecord" do
     end
 
     it "should allow associations to other STI models" do
-      Child.sphinx_indexes.last.link!
-      sql = Child.sphinx_indexes.last.to_riddle_for_core(0, 0).sql_query
+      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)
+      lambda {
+        Child.connection.execute(sql)
+      }.should_not raise_error(ActiveRecord::StatementInvalid)
     end
   end