ebeigarts-thinking-sphinx 1.1.22 → 1.2.10

data/lib/thinking_sphinx/source/internal_properties.rb

@@ -2,7 +2,7 @@ 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 :sphinx_internal_id, :integer, @model.primary_key_for_sphinx.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"

data/lib/thinking_sphinx/source/sql.rb

@@ -33,10 +33,10 @@ GROUP BY #{ sql_group_clause }
         return nil if @index.options[:disable_range]
         
         min_statement = adapter.convert_nulls(
-          "MIN(#{quote_column(@model.primary_key)})", 1
+          "MIN(#{quote_column(@model.primary_key_for_sphinx)})", 1
         )
         max_statement = adapter.convert_nulls(
-          "MAX(#{quote_column(@model.primary_key)})", 1
+          "MAX(#{quote_column(@model.primary_key_for_sphinx)})", 1
         )
 
         sql = "SELECT #{min_statement}, #{max_statement} " +
@@ -53,14 +53,14 @@ GROUP BY #{ sql_group_clause }
       # 
       def to_sql_query_info(offset)
         "SELECT * FROM #{@model.quoted_table_name} WHERE " +
-        "#{quote_column(@model.primary_key)} = (($id - #{offset}) / #{ThinkingSphinx.indexed_models.size})"
+        "#{quote_column(@model.primary_key_for_sphinx)} = (($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)} "] + 
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} #{unique_id_expr} AS #{quote_column(@model.primary_key_for_sphinx)} "] + 
           @fields.collect     { |field|     field.to_select_sql     } +
           @attributes.collect { |attribute| attribute.to_select_sql }
         ).compact.join(", ")
@@ -69,8 +69,8 @@ GROUP BY #{ sql_group_clause }
       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"
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} >= $start",
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} <= $end"
         ] unless @index.options[:disable_range]
 
         if self.delta? && !@index.delta_object.clause(@model, options[:delta]).blank?
@@ -88,7 +88,7 @@ GROUP BY #{ sql_group_clause }
         end
 
         (
-          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key)}"] + 
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)}"] + 
           @fields.collect     { |field|     field.to_group_sql     }.compact +
           @attributes.collect { |attribute| attribute.to_group_sql }.compact +
           @groupings + internal_groupings
@@ -112,7 +112,9 @@ GROUP BY #{ sql_group_clause }
       end
 
       def crc_column
-        if @model.column_names.include?(@model.inheritance_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

data/lib/thinking_sphinx/tasks.rb

@@ -12,7 +12,7 @@ namespace :thinking_sphinx do
   
   desc "Output the current Thinking Sphinx version"
   task :version => :app_env do
-    puts "Thinking Sphinx v" + ThinkingSphinx::Version::String
+    puts "Thinking Sphinx v" + ThinkingSphinx.version
   end
   
   desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
@@ -30,7 +30,7 @@ namespace :thinking_sphinx do
     
     Dir["#{config.searchd_file_path}/*.spl"].each { |file| File.delete(file) }
 
-    system! "#{config.bin_path}#{config.searchd_binary_name} --pidfile --config #{config.config_file}"
+    system! "#{config.bin_path}#{config.searchd_binary_name} --pidfile --config \"#{config.config_file}\""
     
     sleep(2)
     
@@ -43,11 +43,14 @@ namespace :thinking_sphinx do
   
   desc "Stop Sphinx using Thinking Sphinx's settings"
   task :stop => :app_env do
-    raise RuntimeError, "searchd is not running." unless sphinx_running?
-    config = ThinkingSphinx::Configuration.instance
-    pid    = sphinx_pid
-    system! "#{config.bin_path}#{config.searchd_binary_name} --stop --config #{config.config_file}"
-    puts "Stopped search daemon (pid #{pid})."
+    unless sphinx_running?
+      puts "searchd is not running"
+    else
+      config = ThinkingSphinx::Configuration.instance
+      pid    = sphinx_pid
+      system! "#{config.bin_path}#{config.searchd_binary_name} --stop --config \"#{config.config_file}\""
+      puts "Stopped search daemon (pid #{pid})."
+    end
   end
   
   desc "Restart Sphinx"
@@ -71,7 +74,7 @@ namespace :thinking_sphinx do
     end
         
     FileUtils.mkdir_p config.searchd_file_path
-    cmd = "#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} --all"
+    cmd = "#{config.bin_path}#{config.indexer_binary_name} --config \"#{config.config_file}\" --all"
     cmd << " --rotate" if sphinx_running?
     
     system! cmd
@@ -111,6 +114,7 @@ namespace :thinking_sphinx do
   # http://www.sphinxsearch.com/docs/current.html#xmlpipe2
   desc "Streams XML data to STDOUT"
   task :xml => :app_env do
+    ThinkingSphinx::Configuration.instance.load_models
     source_name = ENV["NAME"]
     # STDERR.puts "Source name: #{source_name}"
     source_name =~ /^(.+)_(delta|core)_(\d+)$/
@@ -141,7 +145,8 @@ namespace :thinking_sphinx do
     # STDERR.puts "fetching #{start_id}.. "
     # STDERR.puts query
     model_klass.sphinx_database_adapter.select_each(query) do |values|
-      id = values.delete "id"
+      pk_name = model_klass.primary_key_for_sphinx.to_s
+      id = values.delete(pk_name)
       puts %{<sphinx:document id="#{id.to_i}">}
       values.each do |k, v|
         if source.sql_attr_bool.include?(k.to_sym)

data/spec/{unit → lib}/thinking_sphinx/active_record/delta_spec.rb

@@ -18,7 +18,7 @@ describe "ThinkingSphinx::ActiveRecord::Delta" do
     
     @beta.should have_received(:toggle_delta)
   end
-
+  
   describe "suspended_delta method" do
     before :each do
       ThinkingSphinx.stub_method(:deltas_enabled? => true)

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

@@ -0,0 +1,96 @@
+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::Search object" do
+      Alpha.by_name('foo').should be_a(ThinkingSphinx::Search)
+    end
+    
+    it "should set the classes option" do
+      Alpha.by_name('foo').options[:classes].should == [Alpha]
+    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/active_record_spec.rb

@@ -1,7 +1,7 @@
 require 'spec/spec_helper'
 
-describe "ThinkingSphinx::ActiveRecord" do
-  describe "define_index method" do
+describe ThinkingSphinx::ActiveRecord do
+  describe '.define_index' do
     before :each do
       module ::TestModule
         class TestModel < ActiveRecord::Base; end
@@ -154,7 +154,7 @@ describe "ThinkingSphinx::ActiveRecord" do
     end
   end
 
-  describe "source_of_sphinx_index method" do
+  describe '.source_of_sphinx_index' do
     it "should return self if model defines an index" do
       Person.source_of_sphinx_index.should == Person
     end
@@ -164,13 +164,13 @@ describe "ThinkingSphinx::ActiveRecord" do
     end
   end
   
-  describe "to_crc32 method" do
+  describe '.to_crc32' do
     it "should return an integer" do
       Person.to_crc32.should be_a_kind_of(Integer)
     end
   end
     
-  describe "to_crc32s method" do
+  describe '.to_crc32s' do
     it "should return an array" do
       Person.to_crc32s.should be_a_kind_of(Array)
     end
@@ -326,4 +326,43 @@ describe "ThinkingSphinx::ActiveRecord" do
     
     (beta.id * model_count + offset).should == beta.sphinx_document_id
   end
+  
+  describe '#primary_key_for_sphinx' do
+    before :each do
+      @person = Person.find(:first)
+    end
+    
+    after :each do
+      Person.set_sphinx_primary_key nil
+    end
+    
+    it "should return the id by default" do
+      @person.primary_key_for_sphinx.should == @person.id
+    end
+    
+    it "should use the sphinx primary key to determine the value" do
+      Person.set_sphinx_primary_key :first_name
+      @person.primary_key_for_sphinx.should == @person.first_name
+    end
+    
+    it "should not use accessor methods but the attributes hash" do
+      id = @person.id
+      @person.stub!(:id => 'unique_hash')
+      @person.primary_key_for_sphinx.should == id
+    end
+  end
+  
+  describe '.sphinx_index_names' do
+    it "should return the core index" do
+      Alpha.sphinx_index_names.should == ['alpha_core']
+    end
+    
+    it "should return the delta index if enabled" do
+      Beta.sphinx_index_names.should == ['beta_core', 'beta_delta']
+    end
+    
+    it "should return the superclass with an index definition" do
+      Parent.sphinx_index_names.should == ['person_core', 'person_delta']
+    end
+  end
 end

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

@@ -4,6 +4,8 @@ describe ThinkingSphinx::Attribute do
   before :each do
     @index  = ThinkingSphinx::Index.new(Person)
     @source = ThinkingSphinx::Source.new(@index)
+    
+    @index.delta_object = ThinkingSphinx::Deltas::DefaultDelta.new @index, @index.local_options
   end
   
   describe '#initialize' do
@@ -86,6 +88,19 @@ describe ThinkingSphinx::Attribute do
     end
   end
   
+  describe '#to_select_sql' do
+    it "should convert a mixture of dates and datetimes to timestamps" do
+      attribute = ThinkingSphinx::Attribute.new(@source,
+        [ ThinkingSphinx::Index::FauxColumn.new(:created_at),
+          ThinkingSphinx::Index::FauxColumn.new(:created_on) ],
+        :as => :times
+      )
+      attribute.model = Friendship
+      
+      attribute.to_select_sql.should == "CONCAT_WS(',', UNIX_TIMESTAMP(`friendships`.`created_at`), UNIX_TIMESTAMP(`friendships`.`created_on`)) AS `times`"
+    end
+  end
+  
   describe "is_many? method" do
     before :each do
       @assoc_a = Object.stub_instance(:is_many? => true)
@@ -189,7 +204,7 @@ describe ThinkingSphinx::Attribute do
       attribute.model = Person
       attribute.columns.each { |col| attribute.associations[col] = [] }
       
-      attribute.send(:all_ints?).should be_true
+      attribute.should be_all_ints
     end
     
     it "should return false if only some columns are integers" do
@@ -200,7 +215,7 @@ describe ThinkingSphinx::Attribute do
       attribute.model = Person
       attribute.columns.each { |col| attribute.associations[col] = [] }
       
-      attribute.send(:all_ints?).should be_false
+      attribute.should_not be_all_ints
     end
     
     it "should return false if no columns are integers" do
@@ -211,7 +226,42 @@ describe ThinkingSphinx::Attribute do
       attribute.model = Person
       attribute.columns.each { |col| attribute.associations[col] = [] }
       
-      attribute.send(:all_ints?).should be_false
+      attribute.should_not be_all_ints
+    end
+  end
+  
+  describe "all_datetimes? method" do
+    it "should return true if all columns are datetimes" do
+      attribute = ThinkingSphinx::Attribute.new(@source,
+        [ ThinkingSphinx::Index::FauxColumn.new(:created_at),
+          ThinkingSphinx::Index::FauxColumn.new(:updated_at) ]
+      )
+      attribute.model = Friendship
+      attribute.columns.each { |col| attribute.associations[col] = [] }
+      
+      attribute.should be_all_datetimes
+    end
+    
+    it "should return false if only some columns are datetimes" do
+      attribute = ThinkingSphinx::Attribute.new(@source,
+        [ ThinkingSphinx::Index::FauxColumn.new(:id),
+          ThinkingSphinx::Index::FauxColumn.new(:created_at) ]
+      )
+      attribute.model = Friendship
+      attribute.columns.each { |col| attribute.associations[col] = [] }
+      
+      attribute.should_not be_all_datetimes
+    end
+    
+    it "should return true if all columns can be " do
+      attribute = ThinkingSphinx::Attribute.new(@source,
+        [ ThinkingSphinx::Index::FauxColumn.new(:created_at),
+          ThinkingSphinx::Index::FauxColumn.new(:created_on) ]
+      )
+      attribute.model = Friendship
+      attribute.columns.each { |col| attribute.associations[col] = [] }
+      
+      attribute.should be_all_datetimes
     end
   end
   
@@ -232,6 +282,23 @@ describe ThinkingSphinx::Attribute do
     end
   end
   
+  describe "MVA with source query for a delta source" do
+    before :each do
+      @attribute = ThinkingSphinx::Attribute.new(@source,
+        [ThinkingSphinx::Index::FauxColumn.new(:tags, :id)],
+        :as => :tag_ids, :source => :query
+      )
+    end
+    
+    it "should use a query" do
+      @attribute.type_to_config.should == :sql_attr_multi
+      
+      declaration, query = @attribute.config_value(nil, true).split('; ')
+      declaration.should == "uint tag_ids from query"
+      query.should       == "SELECT `tags`.`person_id` #{ThinkingSphinx.unique_id_expression} AS `id`, `tags`.`id` AS `tag_ids` FROM `tags` WHERE `tags`.`person_id` IN (SELECT `id` FROM `people` WHERE `people`.`delta` = 1)"
+    end
+  end
+  
   describe "MVA via a HABTM association with a source query" do
     before :each do
       @attribute = ThinkingSphinx::Attribute.new(@source,
@@ -267,6 +334,24 @@ describe ThinkingSphinx::Attribute do
     end
   end
   
+  describe "MVA with ranged source query for a delta source" do
+    before :each do
+      @attribute = ThinkingSphinx::Attribute.new(@source,
+        [ThinkingSphinx::Index::FauxColumn.new(:tags, :id)],
+        :as => :tag_ids, :source => :ranged_query
+      )
+    end
+    
+    it "should use a ranged query" do
+      @attribute.type_to_config.should == :sql_attr_multi
+      
+      declaration, query, range_query = @attribute.config_value(nil, true).split('; ')
+      declaration.should == "uint tag_ids from ranged-query"
+      query.should       == "SELECT `tags`.`person_id` #{ThinkingSphinx.unique_id_expression} AS `id`, `tags`.`id` AS `tag_ids` FROM `tags` WHERE `tags`.`person_id` >= $start AND `tags`.`person_id` <= $end AND `tags`.`person_id` IN (SELECT `id` FROM `people` WHERE `people`.`delta` = 1)"
+      range_query.should == "SELECT MIN(`tags`.`person_id`), MAX(`tags`.`person_id`) FROM `tags`"
+    end
+  end
+  
   describe "MVA via a has-many :through with a ranged source query" do
     before :each do
       @attribute = ThinkingSphinx::Attribute.new(@source,
@@ -341,6 +426,28 @@ describe ThinkingSphinx::Attribute do
     end
   end
   
+  describe "MVA via two has-many associations with a ranged source query for a delta source" do
+    before :each do
+      @index  = ThinkingSphinx::Index.new(Alpha)
+      @source = ThinkingSphinx::Source.new(@index)
+      @attribute = ThinkingSphinx::Attribute.new(@source,
+        [ThinkingSphinx::Index::FauxColumn.new(:betas, :gammas, :value)],
+        :as => :gamma_values, :source => :ranged_query
+      )
+      
+      @index.delta_object = ThinkingSphinx::Deltas::DefaultDelta.new @index, @index.local_options
+    end
+    
+    it "should use a ranged query" do
+      @attribute.type_to_config.should == :sql_attr_multi
+      
+      declaration, query, range_query = @attribute.config_value(nil, true).split('; ')
+      declaration.should == "uint gamma_values from ranged-query"
+      query.should       == "SELECT `betas`.`alpha_id` #{ThinkingSphinx.unique_id_expression} AS `id`, `gammas`.`value` AS `gamma_values` FROM `betas` LEFT OUTER JOIN `gammas` ON gammas.beta_id = betas.id WHERE `betas`.`alpha_id` >= $start AND `betas`.`alpha_id` <= $end AND `betas`.`alpha_id` IN (SELECT `id` FROM `alphas` WHERE `alphas`.`delta` = 1)"
+      range_query.should == "SELECT MIN(`betas`.`alpha_id`), MAX(`betas`.`alpha_id`) FROM `betas`"
+    end
+  end
+  
   describe "with custom queries" do
     before :each do
       index = CricketTeam.sphinx_indexes.first