thinking-sphinx 2.0.2 → 2.0.3

data/README.textile

@@ -197,3 +197,9 @@ Since I first released this library, there's been quite a few people who have su
 * Robert Glaser
 * Brenton Fletcher
 * Paul Schyska
+* Kirill Maximov
+* Hans Hasselberg
+* Robert Stern
+* George Anderson
+* Greg Weber
+* Javier Ramírez

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.0.3

data/features/attribute_updates.feature

@@ -36,7 +36,7 @@ Feature: Update attributes directly to Sphinx
     And I filter by 18 on value
     Then I should get 1 result
     
-    When I search for the document id of beta eight in the beta_delta index
+    When I search for the document id of beta eight in the secondary_beta_delta index
     Then it should not exist
   
   Scenario: Updating attributes in a delta index
@@ -48,7 +48,7 @@ Feature: Update attributes directly to Sphinx
     And I wait for Sphinx to catch up
     
     When I filter by 19 on value
-    And I use index beta_delta
+    And I use index secondary_beta_delta
     Then I should get 1 result
     
   Scenario: Updating attributes in a delta index with deltas disabled
@@ -61,7 +61,7 @@ Feature: Update attributes directly to Sphinx
     And I wait for Sphinx to catch up
   
     When I filter by 21 on value
-    And I use index beta_delta
+    And I use index secondary_beta_delta
     Then I should get 1 result
     And I enable delta updates
   

data/features/handling_edits.feature

@@ -31,12 +31,12 @@ Feature: Keeping Sphinx in line with model changes when requested
     When I search for one
     Then I should get 1 result
   
-    When I change the name of beta one to eleven
+    When I change the name of beta one to eleventeen
     And I wait for Sphinx to catch up
     And I search for one
     Then I should get 0 results
     
-    When I search for eleven
+    When I search for eleventeen
     Then I should get 1 result
   
   Scenario: Returning new records if there's a delta
@@ -63,7 +63,9 @@ Feature: Keeping Sphinx in line with model changes when requested
     
     When I search for the document id of beta five in the beta_core index
     Then it should exist if using Rails 2.1 or newer
-    When I search for the document id of beta five in the beta_delta index
+    When I search for the document id of beta five in the secondary_beta_core index
+    Then it should exist if using Rails 2.1 or newer
+    When I search for the document id of beta five in the secondary_beta_delta index
     Then it should not exist if using Rails 2.1 or newer
   
   Scenario: Handling edits with a delta when Sphinx isn't running

data/features/thinking_sphinx/models/beta.rb

@@ -2,6 +2,11 @@ class Beta < ActiveRecord::Base
   define_index do
     indexes :name, :sortable => true, :facet => true
     has value
+  end
+  
+  define_index 'secondary_beta' do
+    indexes :name, :sortable => true, :facet => true
+    has value
     
     set_property :delta => true
   end

data/features/thinking_sphinx/models/developer.rb

@@ -17,4 +17,15 @@ class Developer < ActiveRecord::Base
     
     group_by 'city'
   end
+  
+  define_index 'alternate' do
+    indexes "'foo'",     :as => :foo
+    
+    has age,                              :facet => true
+    has tags(:id),       :as => :tag_ids,  :facet => true
+    
+    facet "LOWER(city)", :as => :city, :type => :string, :value => :city
+    
+    group_by 'city'
+  end
 end

data/lib/thinking_sphinx.rb

@@ -1,3 +1,4 @@
+require 'thread'
 require 'active_record'
 require 'yaml'
 require 'riddle'

data/lib/thinking_sphinx/active_record.rb

@@ -2,6 +2,7 @@ require 'thinking_sphinx/active_record/attribute_updates'
 require 'thinking_sphinx/active_record/delta'
 require 'thinking_sphinx/active_record/has_many_association'
 require 'thinking_sphinx/active_record/log_subscriber'
+require 'thinking_sphinx/active_record/has_many_association_with_scopes'
 require 'thinking_sphinx/active_record/scopes'
 
 module ThinkingSphinx
@@ -24,7 +25,18 @@ module ThinkingSphinx
           end
           
           def primary_key_for_sphinx
-            @sphinx_primary_key_attribute || primary_key
+            if custom_primary_key_for_sphinx?
+              @sphinx_primary_key_attribute || superclass.primary_key_for_sphinx
+            else
+              primary_key
+            end
+          end
+          
+          def custom_primary_key_for_sphinx?
+            (
+              superclass.respond_to?(:custom_primary_key_for_sphinx?) &&
+              superclass.custom_primary_key_for_sphinx?
+            ) || !@sphinx_primary_key_attribute.nil?
           end
           
           def sphinx_index_options
@@ -46,8 +58,7 @@ module ThinkingSphinx
           end
           
           def sphinx_database_adapter
-            @sphinx_database_adapter ||=
-              ThinkingSphinx::AbstractAdapter.detect(self)
+            ThinkingSphinx::AbstractAdapter.detect(self)
           end
           
           def sphinx_name
@@ -315,22 +326,12 @@ module ThinkingSphinx
     attr_accessor :sphinx_attributes
     attr_accessor :matching_fields
     
-    def in_index?(suffix)
-      self.class.search_for_id self.sphinx_document_id, sphinx_index_name(suffix)
-    end
-    
-    def in_core_index?
-      in_index? "core"
-    end
-    
-    def in_delta_index?
-      in_index? "delta"
-    end
-    
-    def in_both_indexes?
-      in_core_index? && in_delta_index?
+    def in_index?(index)
+      self.class.search_for_id self.sphinx_document_id, index
+    rescue Riddle::ResponseError
+      true
     end
-    
+        
     def toggle_deleted
       return unless ThinkingSphinx.updates_enabled?
       

data/lib/thinking_sphinx/active_record/attribute_updates.rb

@@ -43,7 +43,7 @@ module ThinkingSphinx
         config = ThinkingSphinx::Configuration.instance
         config.client.update index_name, attribute_names, {
           sphinx_document_id => attribute_values
-        } if self.class.search_for_id(sphinx_document_id, index_name)
+        } if in_index?(index_name)
       rescue Riddle::ConnectionError, ThinkingSphinx::SphinxError
         # Not the end of the world if Sphinx isn't running.
       end

data/lib/thinking_sphinx/active_record/delta.rb

@@ -16,30 +16,34 @@ module ThinkingSphinx
             # if running in the test environment.
             #
             def index_delta(instance = nil)
-              delta_object.index(self, instance)
+              delta_objects.each { |obj| obj.index(self, instance) }
             end
             
-            def delta_object
-              self.sphinx_indexes.first.delta_object
+            def delta_objects
+              self.sphinx_indexes.collect(&:delta_object).compact
             end
           end
           
           def toggled_delta?
-            self.class.delta_object.toggled(self)
+            self.class.delta_objects.any? { |obj| obj.toggled(self) }
           end
           
           private
           
           # Set the delta value for the model to be true.
           def toggle_delta
-            self.class.delta_object.toggle(self) if should_toggle_delta?
+            self.class.delta_objects.each { |obj|
+              obj.toggle(self)
+            } if should_toggle_delta?
           end
           
           # Build the delta index for the related model. This won't be called
           # if running in the test environment.
           # 
           def index_delta
-            self.class.index_delta(self) if self.class.delta_object.toggled(self)
+            self.class.index_delta(self) if self.class.delta_objects.any? { |obj|
+              obj.toggled(self)
+            }
           end
           
           def should_toggle_delta?

data/lib/thinking_sphinx/active_record/has_many_association.rb

@@ -9,17 +9,7 @@ module ThinkingSphinx
         args << options
         @reflection.klass.search(*args)
       end
-      
-      def method_missing(method, *args, &block)
-        if responds_to_scope(method)
-          @reflection.klass.
-            search(:with => default_filter).
-            send(method, *args, &block)
-        else
-          super
-        end
-      end
-      
+
       private
       
       def attribute_for_foreign_key
@@ -41,11 +31,6 @@ module ThinkingSphinx
       def default_filter
         {attribute_for_foreign_key.unique_name => @owner.id}
       end
-      
-      def responds_to_scope(scope)
-        @reflection.klass.respond_to?(:sphinx_scopes)   &&
-        @reflection.klass.sphinx_scopes.include?(scope)
-      end
     end
   end
 end

data/lib/thinking_sphinx/active_record/has_many_association_with_scopes.rb

@@ -0,0 +1,21 @@
+module ThinkingSphinx
+  module ActiveRecord
+    module HasManyAssociationWithScopes
+      def method_missing(method, *args, &block)
+        if responds_to_scope(method)
+          @reflection.klass.
+            search(:with => default_filter).
+            send(method, *args, &block)
+        else
+          super
+        end
+      end
+      
+      private
+      def responds_to_scope(scope)
+        @reflection.klass.respond_to?(:sphinx_scopes)   &&
+        @reflection.klass.sphinx_scopes.include?(scope)
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -17,6 +17,7 @@ module ThinkingSphinx
         # The scope is automatically applied when the search method is called. It
         # will only be applied if it is an existing sphinx_scope.
         def default_sphinx_scope(sphinx_scope_name)
+          add_sphinx_scopes_support_to_has_many_associations
           @default_sphinx_scope = sphinx_scope_name
         end
 
@@ -43,6 +44,8 @@ module ThinkingSphinx
         #   @articles =  Article.latest_first.search 'pancakes'
         #
         def sphinx_scope(method, &block)
+          add_sphinx_scopes_support_to_has_many_associations
+
           @sphinx_scopes ||= []
           @sphinx_scopes << method
           
@@ -76,6 +79,14 @@ module ThinkingSphinx
           
           sphinx_scopes.clear
         end
+
+        def add_sphinx_scopes_support_to_has_many_associations
+          scope_mixin = ::ThinkingSphinx::ActiveRecord::HasManyAssociationWithScopes
+
+          ::ActiveRecord::Associations::HasManyAssociation.send(:include, scope_mixin)
+          ::ActiveRecord::Associations::HasManyThroughAssociation.send(:include, scope_mixin)
+        end
+
       end
     end
   end

data/lib/thinking_sphinx/adapters/postgresql_adapter.rb

@@ -117,6 +117,7 @@ module ThinkingSphinx
           DECLARE tmp bigint;
           DECLARE i int;
           DECLARE j int;
+          DECLARE byte_length int;
           DECLARE word_array bytea;
           BEGIN
             IF COALESCE(word, '') = '' THEN
@@ -125,6 +126,7 @@ module ThinkingSphinx
           
             i = 0;
             tmp = 4294967295;
+            byte_length = bit_length(word) / 8;
             word_array = decode(replace(word, E'\\\\', E'\\\\\\\\'), 'escape');
             LOOP
               tmp = (tmp # get_byte(word_array, i))::bigint;
@@ -137,7 +139,7 @@ module ThinkingSphinx
                   EXIT;
                 END IF;
               END LOOP;
-              IF i >= char_length(word) THEN
+              IF i >= byte_length THEN
                 EXIT;
               END IF;
             END LOOP;

data/lib/thinking_sphinx/auto_version.rb

@@ -5,9 +5,12 @@ module ThinkingSphinx
       case version
       when '0.9.8', '0.9.9'
         require "riddle/#{version}"
-      when '1.10-beta', '1.10-id64-beta'
+      when '1.10-beta', '1.10-id64-beta', '1.10-dev'
         require 'riddle/1.10'
       else
+        unless version.nil? or version.empty?
+          STDERR.puts "Unsupported version: #{version}"
+        end
         STDERR.puts %Q{
 Sphinx cannot be found on your system. You may need to configure the following
 settings in your config/sphinx.yml file:

data/lib/thinking_sphinx/core/array.rb

@@ -6,7 +6,7 @@ end
 
 module SearchAsArray
   def ===(object)
-    object.is_a?(ThinkingSphinx::Search) || super
+    (ThinkingSphinx::Search === object) || super
   end
 end
 

data/lib/thinking_sphinx/search.rb

@@ -30,31 +30,31 @@ module ThinkingSphinx
     # Deprecated. Use ThinkingSphinx.search
     def self.search(*args)
       warn 'ThinkingSphinx::Search.search is deprecated. Please use ThinkingSphinx.search instead.'
-      ThinkingSphinx.search *args
+      ThinkingSphinx.search(*args)
     end
     
     # Deprecated. Use ThinkingSphinx.search_for_ids
     def self.search_for_ids(*args)
       warn 'ThinkingSphinx::Search.search_for_ids is deprecated. Please use ThinkingSphinx.search_for_ids instead.'
-      ThinkingSphinx.search_for_ids *args
+      ThinkingSphinx.search_for_ids(*args)
     end
     
     # Deprecated. Use ThinkingSphinx.search_for_ids
     def self.search_for_id(*args)
       warn 'ThinkingSphinx::Search.search_for_id is deprecated. Please use ThinkingSphinx.search_for_id instead.'
-      ThinkingSphinx.search_for_id *args
+      ThinkingSphinx.search_for_id(*args)
     end
     
     # Deprecated. Use ThinkingSphinx.count
     def self.count(*args)
       warn 'ThinkingSphinx::Search.count is deprecated. Please use ThinkingSphinx.count instead.'
-      ThinkingSphinx.count *args
+      ThinkingSphinx.count(*args)
     end
     
     # Deprecated. Use ThinkingSphinx.facets
     def self.facets(*args)
       warn 'ThinkingSphinx::Search.facets is deprecated. Please use ThinkingSphinx.facets instead.'
-      ThinkingSphinx.facets *args
+      ThinkingSphinx.facets(*args)
     end
 
     def self.warn(message)
@@ -202,6 +202,12 @@ module ThinkingSphinx
       @options[:page].blank? ? 1 : @options[:page].to_i
     end
     
+    # Kaminari support
+    def page(page_number)
+      @options[:page] = page_number
+      self
+    end
+    
     # The next page number of the result set. If there are no more pages
     # available, nil is returned.
     # 
@@ -230,6 +236,14 @@ module ThinkingSphinx
       @options[:limit] ||= 20
       @options[:limit].to_i
     end
+    # Kaminari support
+    alias_method :limit_value, :per_page
+    
+    # Kaminari support
+    def per(limit)
+      @options[:limit] = limit
+      self
+    end
     
     # The total number of pages available if the results are paginated.
     # 
@@ -241,8 +255,9 @@ module ThinkingSphinx
       
       @total_pages ||= (@results[:total] / per_page.to_f).ceil
     end
-    # Compatibility with older versions of will_paginate
+    # Compatibility with kaminari and older versions of will_paginate
     alias_method :page_count, :total_pages
+    alias_method :num_pages,  :total_pages
     
     # Query time taken
     # 
@@ -318,7 +333,7 @@ module ThinkingSphinx
         {
           :docs   => [string.to_s],
           :words  => results[:words].keys.join(' '),
-          :index  => options[:index] || "#{model.source_of_sphinx_index.sphinx_name}_core"
+          :index  => options[:index] || "#{model.core_index_names.first}"
         }.merge(options[:excerpt_options] || {})
       ).first
     end
@@ -343,7 +358,7 @@ module ThinkingSphinx
       merge_search self, args, options
       args << options
       
-      ThinkingSphinx::FacetSearch.new *args
+      ThinkingSphinx::FacetSearch.new(*args)
     end
     
     def client
@@ -363,16 +378,7 @@ module ThinkingSphinx
       @populated = true
       @results   = results
       
-      if options[:ids_only]
-        replace @results[:matches].collect { |match|
-          match[:attributes]["sphinx_internal_id"]
-        }
-      else
-        replace instances_from_matches
-        add_excerpter
-        add_sphinx_attributes
-        add_matching_fields if client.rank_mode == :fieldmask
-      end
+      compose_results
     end
     
     private
@@ -403,18 +409,44 @@ module ThinkingSphinx
           raise ThinkingSphinx::ConnectionError,
             'Connection to Sphinx Daemon (searchd) failed.'
         end
-      
-        if options[:ids_only]
-          replace @results[:matches].collect { |match|
-            match[:attributes]["sphinx_internal_id"]
-          }
+        
+        compose_results
+      end
+    end
+
+    def compose_results
+      if options[:ids_only]
+        compose_ids_results
+      elsif options[:only]
+        compose_only_results
+      else
+        replace instances_from_matches
+        add_excerpter
+        add_sphinx_attributes
+        add_matching_fields if client.rank_mode == :fieldmask
+      end
+    end
+    
+    def compose_ids_results
+      replace @results[:matches].collect { |match|
+        match[:attributes]['sphinx_internal_id']
+      }
+    end
+    
+    def compose_only_results
+      replace @results[:matches].collect { |match|
+        case only = options[:only]
+        when String, Symbol
+          match[:attributes][only.to_s]
+        when Array
+          only.inject({}) do |hash, attribute|
+            hash[attribute.to_sym] = match[:attributes][attribute.to_s]
+            hash
+          end
         else
-          replace instances_from_matches
-          add_excerpter
-          add_sphinx_attributes
-          add_matching_fields if client.rank_mode == :fieldmask
+          raise "Unexpected object for :only argument. String or Array is expected, #{only.class} was received."
         end
-      end
+      }
     end
     
     def add_excerpter
@@ -908,7 +940,7 @@ module ThinkingSphinx
     end
     
     def scoped_count
-      return self.total_entries if @options[:ids_only]
+      return self.total_entries if(@options[:ids_only] || @options[:only])
       
       @options[:ids_only] = true
       results_count = self.total_entries

data/spec/thinking_sphinx/active_record/delta_spec.rb

@@ -70,7 +70,7 @@ describe "ThinkingSphinx::ActiveRecord::Delta" do
       ThinkingSphinx.deltas_enabled   = true
       ThinkingSphinx.updates_enabled  = true
       ThinkingSphinx.stub!(:sphinx_running? => true)
-      Person.delta_object.stub!(:` => "", :toggled => true)
+      Person.delta_objects.first.stub!(:` => "", :toggled => true)
       
       @person = Person.new
       Person.stub!(:search_for_id => false)

data/spec/thinking_sphinx/active_record_spec.rb

@@ -234,50 +234,6 @@ describe ThinkingSphinx::ActiveRecord do
       Beta.sphinx_indexes.length.should == 1
     end
   end
-  
-  describe "index methods" do
-    before(:all) do
-      @person = Person.find(:first)
-    end
-
-    describe "in_both_indexes?" do
-      it "should return true if in core and delta indexes" do
-        @person.should_receive(:in_core_index?).and_return(true)
-        @person.should_receive(:in_delta_index?).and_return(true)
-        @person.in_both_indexes?.should be_true
-      end
-      
-      it "should return false if in one index and not the other" do
-        @person.should_receive(:in_core_index?).and_return(true)
-        @person.should_receive(:in_delta_index?).and_return(false)
-        @person.in_both_indexes?.should be_false
-      end
-    end
-
-    describe "in_core_index?" do
-      it "should call in_index? with core" do
-        @person.should_receive(:in_index?).with('core')
-        @person.in_core_index?
-      end
-    end
-
-    describe "in_delta_index?" do
-      it "should call in_index? with delta" do
-        @person.should_receive(:in_index?).with('delta')
-        @person.in_delta_index?
-      end
-    end
-
-    describe "in_index?" do
-      it "should return true if in the specified index" do
-        @person.should_receive(:sphinx_document_id).and_return(1)
-        @person.should_receive(:sphinx_index_name).and_return('person_core')
-        Person.should_receive(:search_for_id).with(1, 'person_core').and_return(true)
-      
-        @person.in_index?('core').should be_true
-      end
-    end
-  end
 
   describe '.source_of_sphinx_index' do
     it "should return self if model defines an index" do
@@ -450,6 +406,12 @@ describe ThinkingSphinx::ActiveRecord do
       @person.stub!(:id => 'unique_hash')
       @person.primary_key_for_sphinx.should == id
     end
+    
+    it "should be inherited by subclasses" do
+      Person.set_sphinx_primary_key :first_name
+      Parent.superclass.custom_primary_key_for_sphinx?
+      Parent.primary_key_for_sphinx.should == Person.primary_key_for_sphinx
+    end
   end
   
   describe '.sphinx_index_names' do

data/spec/thinking_sphinx/auto_version_spec.rb

@@ -39,7 +39,7 @@ describe ThinkingSphinx::AutoVersion do
     end
     
     it "should output a warning if the detected version is something else" do
-      STDERR.should_receive(:puts)
+      STDERR.should_receive(:puts).twice
       
       @config.stub!(:version => '0.9.7')
       ThinkingSphinx::AutoVersion.detect

data/spec/thinking_sphinx/facet_search_spec.rb

@@ -98,6 +98,14 @@ describe ThinkingSphinx::FacetSearch do
           :classes => [Person], :facets => :state
         )
       end
+      
+      it "should handle multiple facets" do
+        ThinkingSphinx.should_receive(:search).twice.and_return(search)
+        
+        ThinkingSphinx::FacetSearch.new(
+          :classes => [Person], :facets => [:state, :city]
+        )
+      end
     end
     
     describe "empty result set for attributes" do

data/spec/thinking_sphinx/search_spec.rb

@@ -877,6 +877,36 @@ describe ThinkingSphinx::Search do
       end
     end
     
+    describe ':only option' do
+      it "returns the requested attribute as an array" do
+        ThinkingSphinx::Search.new(:only => :class_crc).first.
+          should == Alpha.to_crc32
+      end
+      
+      it "returns multiple attributes as hashes with values" do
+        ThinkingSphinx::Search.new(
+          :only => [:class_crc, :sphinx_internal_id]
+        ).first.should == {
+          :class_crc          => Alpha.to_crc32,
+          :sphinx_internal_id => @alpha_a.id
+        }
+      end
+      
+      it "handles strings for a single attribute name" do
+        ThinkingSphinx::Search.new(:only => 'class_crc').first.
+          should == Alpha.to_crc32
+      end
+      
+      it "handles strings for multiple attribute names" do
+        ThinkingSphinx::Search.new(
+          :only => ['class_crc', 'sphinx_internal_id']
+        ).first.should == {
+          :class_crc          => Alpha.to_crc32,
+          :sphinx_internal_id => @alpha_a.id
+        }
+      end
+    end
+    
     context 'result objects' do
       describe '#excerpts' do
         before :each do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 2
   - 0
-  - 2
-  version: 2.0.2
+  - 3
+  version: 2.0.3
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +11:00
+date: 2011-04-03 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -296,6 +296,7 @@ files:
 - lib/thinking_sphinx/active_record/attribute_updates.rb
 - lib/thinking_sphinx/active_record/delta.rb
 - lib/thinking_sphinx/active_record/has_many_association.rb
+- lib/thinking_sphinx/active_record/has_many_association_with_scopes.rb
 - lib/thinking_sphinx/active_record/log_subscriber.rb
 - lib/thinking_sphinx/active_record/scopes.rb
 - lib/thinking_sphinx/adapters/abstract_adapter.rb