thinking-sphinx 1.3.11 → 1.3.12

data/VERSION

@@ -1 +1 @@
-1.3.11
+1.3.12

data/lib/thinking_sphinx/attribute.rb

@@ -179,7 +179,11 @@ module ThinkingSphinx
     def live_value(instance)
       object = instance
       column = @columns.first
-      column.__stack.each { |method| object = object.send(method) }
+      column.__stack.each { |method|
+        object = object.send(method)
+        return nil if object.nil?
+      }
+      
       sphinx_value object.send(column.__name)
     end
     

data/lib/thinking_sphinx/index/builder.rb

@@ -32,15 +32,11 @@ module ThinkingSphinx
       
       def initialize(index, &block)
         @index  = index
-        @source = ThinkingSphinx::Source.new(@index)
-        @index.sources << @source
         @explicit_source = false
         
         self.instance_eval &block
         
-        if @index.sources.any? { |source|
-          source.fields.length == 0
-        }
+        if no_fields?
           raise "At least one field is necessary for an index"
         end
       end
@@ -105,7 +101,7 @@ module ThinkingSphinx
       def indexes(*args)
         options = args.extract_options!
         args.each do |columns|
-          field = Field.new(@source, FauxColumn.coerce(columns), options)
+          field = Field.new(source, FauxColumn.coerce(columns), options)
           
           add_sort_attribute  field, options   if field.sortable
           add_facet_attribute field, options   if field.faceted
@@ -151,7 +147,7 @@ module ThinkingSphinx
       def has(*args)
         options = args.extract_options!
         args.each do |columns|
-          attribute = Attribute.new(@source, FauxColumn.coerce(columns), options)
+          attribute = Attribute.new(source, FauxColumn.coerce(columns), options)
           
           add_facet_attribute attribute, options if attribute.faceted
         end
@@ -162,7 +158,7 @@ module ThinkingSphinx
         options[:facet] = true
         
         args.each do |columns|
-          attribute = Attribute.new(@source, FauxColumn.coerce(columns), options)
+          attribute = Attribute.new(source, FauxColumn.coerce(columns), options)
           
           add_facet_attribute attribute, options
         end
@@ -176,7 +172,7 @@ module ThinkingSphinx
       #   where "parent_type = 'Article'", "created_at < NOW()"
       # 
       def where(*args)
-        @source.conditions += args
+        source.conditions += args
       end
       
       # Use this method to add some manual SQL strings to the GROUP BY
@@ -186,7 +182,7 @@ module ThinkingSphinx
       #   group_by "lat", "lng"
       # 
       def group_by(*args)
-        @source.groupings += args
+        source.groupings += args
       end
       
       # This is what to use to set properties on the index. Chief amongst
@@ -251,10 +247,18 @@ module ThinkingSphinx
       
       private
       
+      def source
+        @source ||= begin
+          source = ThinkingSphinx::Source.new(@index)
+          @index.sources << source
+          source
+        end
+      end
+      
       def set_single_property(key, value)
         source_options = ThinkingSphinx::Configuration::SourceOptions
         if source_options.include?(key.to_s)
-          @source.options.merge! key => value
+          source.options.merge! key => value
         else
           @index.local_options.merge!  key => value
         end
@@ -272,7 +276,7 @@ module ThinkingSphinx
       def add_internal_attribute(property, options, suffix, crc = false)
         return unless ThinkingSphinx::Facet.translate?(property)
         
-        Attribute.new(@source,
+        Attribute.new(source,
           property.columns.collect { |col| col.clone },
           options.merge(
             :type => property.is_a?(Field) ? :string : options[:type],
@@ -281,6 +285,12 @@ module ThinkingSphinx
           ).except(:facet)
         )
       end
+      
+      def no_fields?
+        @index.sources.empty? || @index.sources.any? { |source|
+          source.fields.length == 0
+        }
+      end
     end
   end
 end

data/lib/thinking_sphinx/search.rb

@@ -57,6 +57,16 @@ module ThinkingSphinx
       ThinkingSphinx.facets *args
     end
     
+    def self.matching_fields(fields, bitmask)
+      matches   = []
+      bitstring = bitmask.to_s(2).rjust(32, '0').reverse
+      
+      fields.each_with_index do |field, index|
+        matches << field if bitstring[index, 1] == '1'
+      end
+      matches
+    end
+    
     def initialize(*args)
       ThinkingSphinx.context.define_indexes
       
@@ -262,6 +272,7 @@ module ThinkingSphinx
           replace instances_from_matches
           add_excerpter
           add_sphinx_attributes
+          add_matching_fields if client.rank_mode == :fieldmask
         end
       end
     end
@@ -283,11 +294,7 @@ module ThinkingSphinx
       each do |object|
         next if object.nil? || object.respond_to?(:sphinx_attributes)
         
-        match = @results[:matches].detect { |match|
-          match[:attributes]['sphinx_internal_id'] == object.
-            primary_key_for_sphinx &&
-          match[:attributes]['class_crc'] == object.class.to_crc32
-        }
+        match = match_hash object
         next if match.nil?
         
         object.metaclass.instance_eval do
@@ -296,6 +303,30 @@ module ThinkingSphinx
       end
     end
     
+    def add_matching_fields
+      each do |object|
+        next if object.nil? || object.respond_to?(:matching_fields)
+        
+        match = match_hash object
+        next if match.nil?
+        fields = ThinkingSphinx::Search.matching_fields(
+          @results[:fields], match[:weight]
+        )
+        
+        object.metaclass.instance_eval do
+          define_method(:matching_fields) { fields }
+        end
+      end
+    end
+    
+    def match_hash(object)
+      @results[:matches].detect { |match|
+        match[:attributes]['sphinx_internal_id'] == object.
+          primary_key_for_sphinx &&
+        match[:attributes]['class_crc'] == object.class.to_crc32
+      }
+    end
+    
     def self.log(message, method = :debug, identifier = 'Sphinx')
       return if ::ActiveRecord::Base.logger.nil?
       identifier_color, message_color = "4;32;1", "0" # 0;1 = Bold
@@ -319,9 +350,7 @@ module ThinkingSphinx
         :group_distinct, :id_range, :cut_off, :retry_count, :retry_delay,
         :rank_mode, :max_query_time, :field_weights
       ].each do |key|
-        # puts "key: #{key}"
         value = options[key] || index_options[key]
-        # puts "value: #{value.inspect}"
         client.send("#{key}=", value) if value
       end
 

data/lib/thinking_sphinx/source.rb

@@ -8,7 +8,7 @@ module ThinkingSphinx
     
     attr_accessor :model, :fields, :attributes, :conditions, :groupings,
       :options
-    attr_reader :base, :index
+    attr_reader :base, :index, :database_configuration
     
     def initialize(index, options = {})
       @index        = index
@@ -19,6 +19,8 @@ module ThinkingSphinx
       @groupings    = []
       @options      = options
       @associations = {}
+      @database_configuration = @model.connection.
+        instance_variable_get(:@config).clone
       
       @base = ::ActiveRecord::Associations::ClassMethods::JoinDependency.new(
         @model, [], nil
@@ -80,7 +82,7 @@ module ThinkingSphinx
     end
     
     def set_source_database_settings(source)
-      config = @model.connection.instance_variable_get(:@config)
+      config = @database_configuration
       
       source.sql_host = config[:host]           || "localhost"
       source.sql_user = config[:username]       || config[:user] || 'root'

data/spec/thinking_sphinx/attribute_spec.rb

@@ -542,5 +542,21 @@ describe ThinkingSphinx::Attribute do
       @instance.stub!(:col_name => 42)
       @attribute.live_value(@instance).should == 42
     end
+    
+    it "should handle nils in the association chain" do
+      @attribute = ThinkingSphinx::Attribute.new @source, [
+        stub('column', :__stack => [:assoc_name], :__name => :id)
+      ]
+      @instance.stub!(:assoc_name => nil)
+      @attribute.live_value(@instance).should be_nil
+    end
+    
+    it "should handle association chains" do
+      @attribute = ThinkingSphinx::Attribute.new @source, [
+        stub('column', :__stack => [:assoc_name], :__name => :id)
+      ]
+      @instance.stub!(:assoc_name => stub('object', :id => 42))
+      @attribute.live_value(@instance).should == 42
+    end
   end
 end

data/spec/thinking_sphinx/search_spec.rb

@@ -153,6 +153,17 @@ describe ThinkingSphinx::Search do
     end
   end
   
+  describe '.matching_fields' do
+    it "should return objects with indexes matching 1's in the bitmask" do
+      fields = ['alpha', 'beta', 'gamma', 'delta', 'epsilon', 'zeta', 'eta']
+      ThinkingSphinx::Search.matching_fields(fields, 85).
+        should == ['alpha', 'gamma', 'epsilon', 'eta']
+      
+      ThinkingSphinx::Search.matching_fields(fields, 42).
+        should == ['beta', 'delta', 'zeta']
+    end
+  end
+  
   describe '#populate' do
     before :each do
       @alpha_a, @alpha_b  = Alpha.new,  Alpha.new
@@ -164,7 +175,8 @@ describe ThinkingSphinx::Search do
       @beta_b.stub!  :id => 2, :read_attribute => 2
       
       @client.stub! :query => {
-        :matches => minimal_result_hashes(@alpha_a, @beta_b, @alpha_b, @beta_a)
+        :matches => minimal_result_hashes(@alpha_a, @beta_b, @alpha_b, @beta_a),
+        :fields  => ["one", "two", "three", "four", "five"]
       }
       Alpha.stub! :find => [@alpha_a, @alpha_b]
       Beta.stub!  :find => [@beta_a, @beta_b]
@@ -798,6 +810,33 @@ describe ThinkingSphinx::Search do
           hash['class_crc'].should == @search.last.class.to_crc32
         end
       end
+      
+      describe '#matching_fields' do
+        it "should add matching_fields method if using fieldmask ranking mode" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.should respond_to(:matching_fields)
+        end
+        
+        it "should not add matching_fields method if using a different ranking mode" do
+          search = ThinkingSphinx::Search.new :rank_mode => :bm25
+          search.first.should_not respond_to(:matching_fields)
+        end
+        
+        it "should not add matching_fields method if object already have one" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.last.matching_fields.should_not be_an(Array)
+        end
+        
+        it "should return an array" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.matching_fields.should be_an(Array)
+        end
+        
+        it "should return the fields that the bitmask match" do
+          search = ThinkingSphinx::Search.new :rank_mode => :fieldmask
+          search.first.matching_fields.should == ['one', 'three', 'five']
+        end
+      end
     end
   end
   

data/spec/thinking_sphinx/source_spec.rb

@@ -6,6 +6,13 @@ describe ThinkingSphinx::Source do
     @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
@@ -77,6 +84,7 @@ describe ThinkingSphinx::Source do
         :user     => nil,
         :username => nil
       })
+      @source = ThinkingSphinx::Source.new(@index)
       
       riddle = @source.to_riddle_for_core(1, 0)
       riddle.sql_user.should == 'root'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx
 version: !ruby/object:Gem::Version 
-  version: 1.3.11
+  version: 1.3.12
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-12 00:00:00 +11:00
+date: 2009-12-14 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency