thinking-sphinx 1.4.0 → 1.4.1

data/README.textile

@@ -175,3 +175,5 @@ Since I first released this library, there's been quite a few people who have su
 * Keith Pitt
 * Lee Capps
 * Sam Goldstein
+* Matt Todd
+* Paco Guzmán

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

data/lib/thinking-sphinx.rb

@@ -0,0 +1 @@
+require 'thinking_sphinx'

data/lib/thinking_sphinx.rb

@@ -53,6 +53,16 @@ module ThinkingSphinx
     end
   end
   
+  # A SphinxError occurs when Sphinx responds with an error due to problematic
+  # queries or indexes.
+  class SphinxError < RuntimeError
+    attr_accessor :results
+    def initialize(message = nil, results = nil)
+      super(message)
+      self.results = results
+    end
+  end
+  
   # The current version of Thinking Sphinx.
   # 
   # @return [String] The version number as a string

data/lib/thinking_sphinx/auto_version.rb

@@ -5,7 +5,7 @@ module ThinkingSphinx
       case version
       when '0.9.8', '0.9.9'
         require "riddle/#{version}"
-      when '1.10-beta'
+      when '1.10-beta', '1.10-id64-beta'
         require 'riddle/1.10'
       else
         STDERR.puts %Q{

data/lib/thinking_sphinx/configuration.rb

@@ -140,13 +140,7 @@ module ThinkingSphinx
       self.class.environment
     end
     
-    # Generate the config file for Sphinx by using all the settings defined and
-    # looping through all the models with indexes to build the relevant
-    # indexer and searchd configuration, and sources and indexes details.
-    #
-    def build(file_path=nil)
-      file_path ||= "#{self.config_file}"
-      
+    def generate
       @configuration.indexes.clear
       
       ThinkingSphinx.context.indexed_models.each do |model|
@@ -154,6 +148,16 @@ module ThinkingSphinx
         model.define_indexes
         @configuration.indexes.concat model.to_riddle
       end
+    end
+    
+    # Generate the config file for Sphinx by using all the settings defined and
+    # looping through all the models with indexes to build the relevant
+    # indexer and searchd configuration, and sources and indexes details.
+    #
+    def build(file_path=nil)
+      file_path ||= "#{self.config_file}"
+      
+      generate
       
       open(file_path, "w") do |file|
         file.write @configuration.render

data/lib/thinking_sphinx/search.rb

@@ -111,6 +111,40 @@ module ThinkingSphinx
       !!@populated
     end
     
+    # Indication of whether the request resulted in an error from Sphinx.
+    # 
+    # @return [Boolean] true if Sphinx reports query error
+    # 
+    def error?
+      !!error
+    end
+    
+    # The Sphinx-reported error, if any.
+    # 
+    # @return [String, nil]
+    # 
+    def error
+      populate
+      @results[:error]
+    end
+    
+    # Indication of whether the request resulted in a warning from Sphinx.
+    # 
+    # @return [Boolean] true if Sphinx reports query warning
+    # 
+    def warning?
+      !!warning
+    end
+    
+    # The Sphinx-reported warning, if any.
+    # 
+    # @return [String, nil]
+    # 
+    def warning
+      populate
+      @results[:warning]
+    end
+    
     # The query result hash from Riddle.
     # 
     # @return [Hash] Raw Sphinx results
@@ -350,6 +384,13 @@ module ThinkingSphinx
           }
           log "Found #{@results[:total_found]} results", :debug,
             "Sphinx (#{sprintf("%f", runtime)}s)"
+          
+          log "Sphinx Daemon returned warning: #{warning}", :error if warning?
+          
+          if error?
+            log "Sphinx Daemon returned error: #{error}", :error
+            raise SphinxError.new(error, @results) unless options[:ignore_errors]
+          end
         rescue Errno::ECONNREFUSED => err
           raise ThinkingSphinx::ConnectionError,
             'Connection to Sphinx Daemon (searchd) failed.'
@@ -501,12 +542,7 @@ module ThinkingSphinx
     def conditions_as_query
       return '' if @options[:conditions].blank?
       
-      # Soon to be deprecated.
-      keys = @options[:conditions].keys.reject { |key|
-        attributes.include?(key.to_sym)
-      }
-      
-      ' ' + keys.collect { |key|
+      ' ' + @options[:conditions].keys.collect { |key|
         "@#{key} #{options[:conditions][key]}"
       }.join(' ')
     end
@@ -561,7 +597,7 @@ module ThinkingSphinx
     def sort_by
       case @sort_by = (options[:sort_by] || options[:order])
       when String
-        sorted_fields_to_attributes(@sort_by)
+        sorted_fields_to_attributes(@sort_by.clone)
       when Symbol
         field_names.include?(@sort_by) ?
           @sort_by.to_s.concat('_sort') : @sort_by.to_s
@@ -728,13 +764,37 @@ module ThinkingSphinx
       when NilClass
         nil
       when Array
-        includes.select { |inc| klass.reflections[inc] }
+        include_from_array includes, klass
       when Symbol
         klass.reflections[includes].nil? ? nil : includes
+      when Hash
+        include_from_hash includes, klass
       else
         includes
       end
     end
+
+    def include_from_array(array, klass)
+      scoped_array = []
+      array.each do |value|
+        case value
+        when Hash
+          scoped_hash = include_from_hash(value, klass)
+          scoped_array << scoped_hash unless scoped_hash.nil?
+        else
+          scoped_array << value unless klass.reflections[value].nil?
+        end
+      end
+      scoped_array.empty? ? nil : scoped_array
+    end
+    
+    def include_from_hash(hash, klass)
+      scoped_hash = {}
+      hash.keys.each do |key|
+        scoped_hash[key] = hash[key] unless klass.reflections[key].nil?
+      end
+      scoped_hash.empty? ? nil : scoped_hash
+    end
     
     def instances_from_class(klass, matches)
       index_options = klass.sphinx_index_options

data/spec/thinking_sphinx/auto_version_spec.rb

@@ -30,6 +30,14 @@ describe ThinkingSphinx::AutoVersion do
       ThinkingSphinx::AutoVersion.detect
     end
     
+    it "should require 1.10-beta if that is the detected version" do
+      ThinkingSphinx::AutoVersion.should_receive(:require).
+        with('riddle/1.10')
+      
+      @config.stub!(:version => '1.10-id64-beta')
+      ThinkingSphinx::AutoVersion.detect
+    end
+    
     it "should output a warning if the detected version is something else" do
       STDERR.should_receive(:puts)
       

data/spec/thinking_sphinx/search_spec.rb

@@ -52,6 +52,38 @@ describe ThinkingSphinx::Search do
     end
   end
   
+  describe '#error?' do
+    before :each do
+      @search = ThinkingSphinx::Search.new
+    end
+    
+    it "should be false if client requests have not resulted in an error" do
+      @search.should_receive(:error).and_return(nil)
+      @search.error?.should_not be_true
+    end
+    
+    it "should be true when client requests result in an error" do
+      @search.should_receive(:error).and_return("error message")
+      @search.error?.should be_true
+    end
+  end
+  
+  describe '#warning?' do
+    before :each do
+      @search = ThinkingSphinx::Search.new
+    end
+    
+    it "should be false if client requests have not resulted in a warning" do
+      @search.should_receive(:warning).and_return(nil)
+      @search.warning?.should_not be_true
+    end
+    
+    it "should be true when client requests result in an error" do
+      @search.should_receive(:warning).and_return("warning message")
+      @search.warning?.should be_true
+    end
+  end
+  
   describe '#results' do
     it "should populate search results before returning" do
       @search = ThinkingSphinx::Search.new
@@ -245,6 +277,46 @@ describe ThinkingSphinx::Search do
       
       ThinkingSphinx::Search.new(:include => :betas).first
     end
+
+    it "should respect complex includes" do
+      Alpha.should_receive(:find) do |type, options|
+        options[:include].should == [:thetas, {:betas => :gammas}]
+        [@alpha_a, @alpha_b]
+      end
+
+      Beta.should_receive(:find) do |type, options|
+        options[:include].should be_nil
+        [@beta_a, @beta_b]
+      end
+
+      ThinkingSphinx::Search.new(:include => [:thetas, {:betas => :gammas}]).first
+    end
+    
+    it "should respect hash includes" do
+      Alpha.should_receive(:find) do |type, options|
+        options[:include].should == {:betas => :gammas}
+        [@alpha_a, @alpha_b]
+      end
+      
+      Beta.should_receive(:find) do |type, options|
+        options[:include].should be_nil
+        [@beta_a, @beta_b]
+      end
+      
+      ThinkingSphinx::Search.new(:include => {:betas => :gammas}).first
+    end
+    
+    it "should respect includes for single class searches" do
+      Alpha.should_receive(:find) do |type, options|
+        options[:include].should == {:betas => :gammas}
+        [@alpha_a, @alpha_b]
+      end
+      
+      ThinkingSphinx::Search.new(
+        :include => {:betas => :gammas},
+        :classes => [Alpha]
+      ).first
+    end
     
     describe 'query' do
       it "should concatenate arguments with spaces" do
@@ -868,6 +940,27 @@ describe ThinkingSphinx::Search do
         end
       end
     end
+    
+    context 'Sphinx errors' do
+      describe '#error?' do
+        before :each do
+          @client.stub! :query => {
+            :error => @warning = "Not good"
+          }
+          # @search.should_receive(:error).and_return(nil)
+        end
+        it "should raise an error" do
+          lambda{
+            ThinkingSphinx::Search.new.first
+          }.should raise_error(ThinkingSphinx::SphinxError)
+        end
+        it "should not raise an error when ignore_errors is true" do
+          lambda{
+            ThinkingSphinx::Search.new(:ignore_errors => true).first
+          }.should_not raise_error(ThinkingSphinx::SphinxError)
+        end
+      end
+    end
   end
   
   describe '#current_page' do

data/tasks/testing.rb

@@ -6,7 +6,6 @@ desc "Run the specs under spec"
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
-task :spec => :check_dependencies
 
 desc "Run all feature-set configurations"
 task :features do |t|
@@ -26,9 +25,6 @@ namespace :features do
   
   add_task :mysql,      "Run feature-set against MySQL"
   add_task :postgresql, "Run feature-set against PostgreSQL"
-  
-  task :mysql      => :check_dependencies
-  task :postgresql => :check_dependencies
 end
 
 namespace :rcov do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-15 00:00:00 +08:00
+date: 2010-12-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -115,13 +115,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: -1876988220
+        hash: 1
         segments: 
         - 1
         - 5
-        - 0
-        - pre5
-        version: 1.5.0.pre5
+        - 1
+        version: 1.5.1
   requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -298,6 +297,7 @@ files:
 - lib/cucumber/thinking_sphinx/external_world.rb
 - lib/cucumber/thinking_sphinx/internal_world.rb
 - lib/cucumber/thinking_sphinx/sql_logger.rb
+- lib/thinking-sphinx.rb
 - lib/thinking_sphinx.rb
 - lib/thinking_sphinx/active_record.rb
 - lib/thinking_sphinx/active_record/attribute_updates.rb