thinking-sphinx 1.4.1 → 1.4.2

data/README.textile

@@ -177,3 +177,6 @@ Since I first released this library, there's been quite a few people who have su
 * Sam Goldstein
 * Matt Todd
 * Paco Guzmán
+* Marcin Stecki
+* Robert Glaser
+* Paul Schyska

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.4.2

data/features/facets.feature

@@ -1,8 +1,10 @@
 Feature: Search and browse models by their defined facets
   
-  Scenario: Requesting facets
+  Background:
     Given Sphinx is running
-    And I am searching on developers
+  
+  Scenario: Requesting facets
+    Given I am searching on developers
     When I am requesting facet results
     Then I should have valid facet results
     And I should have 6 facets
@@ -14,8 +16,7 @@ Feature: Search and browse models by their defined facets
     And I should have the facet Tags
   
   Scenario: Requesting specific facets
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     And I am requesting just the facet State
     Then I should have valid facet results
@@ -28,29 +29,25 @@ Feature: Search and browse models by their defined facets
     And I should have the facet Age
   
   Scenario: Requesting float facets
-    Given Sphinx is running
-    And I am searching on alphas
+    Given I am searching on alphas
     When I am requesting facet results
     Then I should have 1 facet
     And the Cost facet should have a 5.55 key
   
   Scenario: Requesting facet results
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     And I drill down where Country is Australia
     Then I should get 11 results
   
   Scenario: Requesting facet results by multiple facets
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     And I drill down where Country is Australia and Age is 30
     Then I should get 4 results
     
   Scenario: Requesting facets with classes included
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     And I want classes included
     Then I should have valid facet results
@@ -58,8 +55,7 @@ Feature: Search and browse models by their defined facets
     And I should have the facet Class
   
   Scenario: Requesting MVA facets
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     And I drill down where tag_ids includes the id of tag Australia
     Then I should get 11 results
@@ -68,23 +64,25 @@ Feature: Search and browse models by their defined facets
     Then I should get 5 results
   
   Scenario: Requesting MVA string facets
-    Given Sphinx is running
-    And I am searching on developers
+    Given I am searching on developers
     When I am requesting facet results
     Then the Tags facet should have an "Australia" key
     Then the Tags facet should have an "Melbourne" key
     Then the Tags facet should have an "Victoria" key
 
   Scenario: Requesting MVA facets from source queries
-    Given Sphinx is running
-    And I am searching on posts
+    Given I am searching on posts
     When I am requesting facet results
     Then the Comment Ids facet should have 9 keys
   
   Scenario: Requesting facets from a subclass
-    Given Sphinx is running
-    And I am searching on animals
+    Given I am searching on animals
     When I am requesting facet results
     And I want classes included
     Then I should have the facet Class
   
+  Scenario: Requesting facets with explicit value sources
+    Given I am searching on developers
+    When I am requesting facet results
+    Then the City facet should have a "Melbourne" key
+  

data/features/thinking_sphinx/db/fixtures/cats.rb

@@ -1,3 +1,3 @@
 %w( rogue nat molly jasper moggy ).each do |name|
-  Cat.create :name => name
+  Cat.new(:name => name).save(false)
 end

data/features/thinking_sphinx/db/fixtures/dogs.rb

@@ -1,3 +1,3 @@
 %w( rover lassie gaspode ).each do |name|
-  Dog.create :name => name
+  Dog.new(:name => name).save(false)
 end

data/features/thinking_sphinx/db/fixtures/foxes.rb

@@ -1,3 +1,3 @@
 %w( fantastic ).each do |name|
-  Fox.create :name => name
+  Fox.new(:name => name).save(false)
 end

data/features/thinking_sphinx/models/developer.rb

@@ -9,8 +9,12 @@ class Developer < ActiveRecord::Base
     indexes country,                      :facet => true
     indexes state,                        :facet => true
     indexes tags.text,  :as => :tags,     :facet => true
+    
     has age,                              :facet => true
     has tags(:id),      :as => :tag_ids,  :facet => true
-    facet city
+    
+    facet "LOWER(city)", :as => :city, :type => :string, :value => :city
+    
+    group_by 'city'
   end
 end

data/lib/thinking_sphinx/active_record.rb

@@ -258,6 +258,8 @@ module ThinkingSphinx
         ThinkingSphinx::Configuration.instance.client.update(
           index, ['sphinx_deleted'], {document_id => [1]}
         )
+      rescue Riddle::ConnectionError, ThinkingSphinx::SphinxError
+        # Not the end of the world if Sphinx isn't running.
       end
       
       def sphinx_offset

data/lib/thinking_sphinx/active_record/attribute_updates.rb

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

data/lib/thinking_sphinx/adapters/abstract_adapter.rb

@@ -16,6 +16,8 @@ module ThinkingSphinx
         ThinkingSphinx::MysqlAdapter.new model
       when :postgresql
         ThinkingSphinx::PostgreSQLAdapter.new model
+      when Class
+        adapter.new model
       else
         raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL, not #{adapter}"
       end
@@ -69,6 +71,13 @@ module ThinkingSphinx
       "LOWER(#{clause})"
     end
     
+    def case(expression, pairs, default)
+      "CASE #{expression} " +
+      pairs.keys.inject('') { |string, key|
+        string + "WHEN '#{key}' THEN #{pairs[key]} "
+      } + "ELSE #{default} END"
+    end
+    
     protected
     
     def connection

data/lib/thinking_sphinx/attribute.rb

@@ -89,7 +89,7 @@ module ThinkingSphinx
     # datetimes to timestamps, as needed.
     # 
     def to_select_sql
-      return nil unless include_as_association?
+      return nil unless include_as_association? && available?
       
       separator = all_ints? || all_datetimes? || @crc ? ',' : ' '
       

data/lib/thinking_sphinx/configuration.rb

@@ -147,6 +147,8 @@ module ThinkingSphinx
         model = model.constantize
         model.define_indexes
         @configuration.indexes.concat model.to_riddle
+        
+        enforce_common_attribute_types
       end
     end
     
@@ -296,5 +298,26 @@ module ThinkingSphinx
         send("#{key}=", value) if self.respond_to?("#{key}")
       end
     end
+    
+    def enforce_common_attribute_types
+      sql_indexes = configuration.indexes.reject { |index|
+        index.is_a? Riddle::Configuration::DistributedIndex
+      }
+      
+      return unless sql_indexes.any? { |index|
+        index.sources.any? { |source|
+          source.sql_attr_bigint.include? :sphinx_internal_id
+        }
+      }
+      
+      sql_indexes.each { |index|
+        index.sources.each { |source|
+          next if source.sql_attr_bigint.include? :sphinx_internal_id
+          
+          source.sql_attr_bigint << :sphinx_internal_id
+          source.sql_attr_uint.delete :sphinx_internal_id
+        }
+      }
+    end
   end
 end

data/lib/thinking_sphinx/deltas/default_delta.rb

@@ -20,13 +20,13 @@ module ThinkingSphinx
       end
       
       def toggle(instance)
-        instance.delta = true
+        instance.send "#{@column}=", true
       end
-      
+
       def toggled(instance)
-        instance.delta
+        instance.send "#{@column}"
       end
-      
+
       def reset_query(model)
         "UPDATE #{model.quoted_table_name} SET " +
         "#{model.connection.quote_column_name(@column.to_s)} = #{adapter.boolean(false)} " +

data/lib/thinking_sphinx/deploy/capistrano.rb

@@ -84,9 +84,10 @@ DESC
       start
     end
   
-    desc "Add the shared folder for sphinx files for the production environment"
+    desc "Add the shared folder for sphinx files"
     task :shared_sphinx_folder, :roles => :web do
-      run "mkdir -p #{shared_path}/db/sphinx/production"
+      rails_env = fetch(:rails_env, "production")
+      run "mkdir -p #{shared_path}/sphinx/#{rails_env}"
     end
 
     def rake(*tasks)

data/lib/thinking_sphinx/facet.rb

@@ -1,9 +1,10 @@
 module ThinkingSphinx
   class Facet
-    attr_reader :property
+    attr_reader :property, :value_source
     
-    def initialize(property)
-      @property = property
+    def initialize(property, value_source = nil)
+      @property     = property
+      @value_source = value_source
       
       if property.columns.length != 1
         raise "Can't translate Facets on multiple-column field or attribute"
@@ -104,7 +105,8 @@ module ThinkingSphinx
           item.to_crc32 == attribute_value
         }
       else
-        objects.first.send(column.__name)
+        method = value_source || column.__name
+        objects.first.send(method)
       end
     end
     

data/lib/thinking_sphinx/facet_search.rb

@@ -44,6 +44,8 @@ module ThinkingSphinx
     end
     
     def populate
+      return if facet_names.empty?
+      
       ThinkingSphinx::Search.bundle_searches(facet_names) { |sphinx, name|
         sphinx.search *(args + [facet_search_options(name)])
       }.each_with_index { |search, index|

data/lib/thinking_sphinx/field.rb

@@ -69,6 +69,8 @@ module ThinkingSphinx
     # multiple data values (has_many or has_and_belongs_to_many associations).
     # 
     def to_select_sql
+      return nil unless available?
+      
       clause = columns_with_prefixes.join(', ')
       
       clause = adapter.concatenate(clause)       if concat_ws?

data/lib/thinking_sphinx/property.rb

@@ -10,10 +10,11 @@ module ThinkingSphinx
 
       raise "Cannot define a field or attribute in #{source.model.name} with no columns. Maybe you are trying to index a field with a reserved name (id, name). You can fix this error by using a symbol rather than a bare name (:id instead of id)." if @columns.empty? || @columns.any? { |column| !column.respond_to?(:__stack) }
       
-      @alias    = options[:as]
-      @faceted  = options[:facet]
-      @admin    = options[:admin]
-      @sortable = options[:sortable] || false
+      @alias        = options[:as]
+      @faceted      = options[:facet]
+      @admin        = options[:admin]
+      @sortable     = options[:sortable] || false
+      @value_source = options[:value]
       
       @alias    = @alias.to_sym unless @alias.blank?
       
@@ -40,7 +41,7 @@ module ThinkingSphinx
     def to_facet
       return nil unless @faceted
       
-      ThinkingSphinx::Facet.new(self)
+      ThinkingSphinx::Facet.new(self, @value_source)
     end
     
     # Get the part of the GROUP BY clause related to this attribute - if one is
@@ -77,6 +78,10 @@ module ThinkingSphinx
       !admin
     end
     
+    def available?
+      columns.any? { |column| column_available?(column) }
+    end
+    
     private
     
     # Could there be more than one value related to the parent record? If so,
@@ -128,9 +133,11 @@ module ThinkingSphinx
     # figure out how to correctly reference a column in SQL.
     # 
     def column_with_prefix(column)
+      return nil unless column_available?(column)
+      
       if column.is_string?
         column.__name
-      elsif associations[column].empty?
+      elsif column.__stack.empty?
         "#{@model.quoted_table_name}.#{quote_column(column.__name)}"
       else
         associations[column].collect { |assoc|
@@ -144,7 +151,17 @@ module ThinkingSphinx
     def columns_with_prefixes
       @columns.collect { |column|
         column_with_prefix column
-      }.flatten
+      }.flatten.compact
+    end
+    
+    def column_available?(column)
+      if column.is_string?
+        true
+      elsif column.__stack.empty?
+        @model.column_names.include?(column.__name.to_s)
+      else
+        associations[column].any? { |assoc| assoc.has_column?(column.__name) }
+      end
     end
     
     # Gets a stack of associations for a specific path.

data/lib/thinking_sphinx/search.rb

@@ -468,8 +468,10 @@ module ThinkingSphinx
     end
     
     def prepare(client)
-      index_options = one_class ?
-        one_class.sphinx_indexes.first.local_options : {}
+      index_options = {}
+      if one_class && one_class.sphinx_indexes && one_class.sphinx_indexes.first
+        index_options = one_class.sphinx_indexes.first.local_options
+      end
       
       [
         :max_matches, :group_by, :group_function, :group_clause,

data/lib/thinking_sphinx/source.rb

@@ -82,6 +82,10 @@ module ThinkingSphinx
       @adapter ||= @model.sphinx_database_adapter
     end
     
+    def available_attributes
+      attributes.select { |attrib| attrib.available? }
+    end
+    
     def set_source_database_settings(source)
       config = @database_configuration
       
@@ -94,7 +98,7 @@ module ThinkingSphinx
     end
     
     def set_source_attributes(source, offset, delta = false)
-      attributes.each do |attrib|
+      available_attributes.each do |attrib|
         source.send(attrib.type_to_config) << attrib.config_value(offset, delta)
       end
     end

data/lib/thinking_sphinx/source/sql.rb

@@ -117,14 +117,30 @@ GROUP BY #{ sql_group_clause }
         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
-          ))
+          types = types_to_crcs
+          return @model.to_crc32.to_s if types.empty?
+          
+          adapter.case(adapter.convert_nulls(
+            adapter.quote_with_table(@model.inheritance_column)),
+            types_to_crcs, @model.to_crc32)
         else
           @model.to_crc32.to_s
         end
       end
+      
+      def type_values
+        @model.connection.select_values <<-SQL
+SELECT DISTINCT #{@model.inheritance_column}
+FROM #{@model.table_name}
+        SQL
+      end
+      
+      def types_to_crcs
+        type_values.compact.inject({}) { |hash, type|
+          hash[type] = type.to_crc32
+          hash
+        }
+      end
     end
   end
 end

data/spec/thinking_sphinx/adapters/abstract_adapter_spec.rb

@@ -1,5 +1,9 @@
 require 'spec_helper'
 
+class CustomAdapter < ThinkingSphinx::AbstractAdapter
+  #
+end
+
 describe ThinkingSphinx::AbstractAdapter do
   describe '.detect' do
     let(:model) { stub('model') }
@@ -18,6 +22,13 @@ describe ThinkingSphinx::AbstractAdapter do
       adapter.should be_a(ThinkingSphinx::PostgreSQLAdapter)
     end
     
+    it "instantiates the provided class if one is provided" do
+      ThinkingSphinx::AbstractAdapter.stub(:adapter_for_model => CustomAdapter)
+      CustomAdapter.should_receive(:new).and_return(stub('adapter'))
+      
+      ThinkingSphinx::AbstractAdapter.detect(model)
+    end
+    
     it "raises an exception for other responses" do
       ThinkingSphinx::AbstractAdapter.stub(:adapter_for_model => :sqlite)
       

data/spec/thinking_sphinx/attribute_spec.rb

@@ -68,6 +68,15 @@ describe ThinkingSphinx::Attribute do
       
       attribute.to_select_sql.should == "CONCAT_WS(' ', IFNULL(`cricket_teams`.`name`, ''), IFNULL(`football_teams`.`name`, ''), IFNULL(`football_teams`.`league`, '')) AS `team`"
     end
+    
+    it "should return nil if polymorphic association data does not exist" do
+      attribute = ThinkingSphinx::Attribute.new(@source,
+        [ThinkingSphinx::Index::FauxColumn.new(:source, :id)],
+        :as => :source_id, :type => :integer
+      )
+      
+      attribute.to_select_sql.should be_nil
+    end
   end
   
   describe '#is_many?' do

data/spec/thinking_sphinx/configuration_spec.rb

@@ -231,6 +231,23 @@ describe ThinkingSphinx::Configuration do
     file.should_not match(/index alpha_core\s+\{\s+[^\}]*prefix_fields\s+=[^\}]*\}/m)
   end
   
+  describe '#generate' do
+    let(:config) { ThinkingSphinx::Configuration.instance }
+    
+    it "should set all sphinx_internal_id attributes to bigints if one is" do
+      config.reset
+      config.generate
+      
+      config.configuration.indexes.each do |index|
+        next if index.is_a? Riddle::Configuration::DistributedIndex
+        
+        index.sources.each do |source|
+          source.sql_attr_bigint.should include(:sphinx_internal_id)
+        end
+      end
+    end
+  end
+  
   describe '#client' do
     before :each do
       @config = ThinkingSphinx::Configuration.instance

data/spec/thinking_sphinx/facet_spec.rb

@@ -329,5 +329,19 @@ describe ThinkingSphinx::Facet do
         @facet.value(alpha, {'cost' => 1093140480}).should == 10.5
       end
     end
+    
+    context 'manual value source' do
+      let(:index)  { ThinkingSphinx::Index.new(Alpha) }
+      let(:source) { ThinkingSphinx::Source.new(index) }
+      let(:column) { ThinkingSphinx::Index::FauxColumn.new('LOWER(name)') }
+      let(:field)  { ThinkingSphinx::Field.new(source, column) }
+      let(:facet)  { ThinkingSphinx::Facet.new(field, :name) }
+      
+      it "should use the given value source to figure out the value" do
+        alpha = Alpha.new(:name => 'Foo')
+        
+        facet.value(alpha, {'foo_facet' => 'foo'.to_crc32}).should == 'Foo'
+      end
+    end
   end
 end

data/spec/thinking_sphinx/field_spec.rb

@@ -44,6 +44,17 @@ describe ThinkingSphinx::Field do
       @field.unique_name.should == "col_name"
     end
   end
+  
+  describe '#to_select_sql' do
+    it "should return nil if polymorphic association data does not exist" do
+      field = ThinkingSphinx::Field.new(@source,
+        [ThinkingSphinx::Index::FauxColumn.new(:source, :name)],
+        :as => :source_name
+      )
+      
+      field.to_select_sql.should be_nil
+    end
+  end
 
   describe "prefixes method" do
     it "should default to false" do

data/spec/thinking_sphinx/source_spec.rb

@@ -48,6 +48,10 @@ describe ThinkingSphinx::Source do
         @source, ThinkingSphinx::Index::FauxColumn.new(:contacts, :id),
         :as => :contact_ids, :source => :query
       )
+      ThinkingSphinx::Attribute.new(
+        @source, ThinkingSphinx::Index::FauxColumn.new(:source, :id),
+        :as => :source_id, :type => :integer
+      )
       
       ThinkingSphinx::Join.new(
         @source, ThinkingSphinx::Index::FauxColumn.new(:links)
@@ -103,6 +107,12 @@ describe ThinkingSphinx::Source do
       @riddle.sql_attr_timestamp.first.should == :birthday
     end
     
+    it "should not include an attribute definition for polymorphic references without data" do
+      @riddle.sql_attr_uint.select { |uint|
+        uint == :source_id
+      }.should be_empty
+    end
+    
     it "should set Sphinx Source options" do
       @riddle.sql_range_step.should      == 1000
       @riddle.sql_ranged_throttle.should == 100

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 1
   - 4
-  - 1
-  version: 1.4.1
+  - 2
+  version: 1.4.2
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 +11:00
+date: 2011-01-13 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,12 +51,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 27
         segments: 
         - 1
         - 2
-        - 0
-        version: 1.2.0
+        - 2
+        version: 1.2.2
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :runtime