thinking-sphinx 2.0.0.rc2 → 2.0.0

data/README.textile

@@ -183,3 +183,9 @@ Since I first released this library, there's been quite a few people who have su
 * Ben Hutton
 * Alfonso Jiménez
 * Szymon Nowak
+* Matthew Higgins
+* Anton Sozontov
+* Keith Pitt
+* Lee Capps
+* Sam Goldstein
+* Artem Orlov

data/VERSION

@@ -1 +1 @@
-2.0.0.rc2
+2.0.0

data/features/excerpts.feature

@@ -11,3 +11,11 @@ Feature: Generate excerpts for search results
     And I am searching on comments
     And I search for "lorem"
     Then calling content on the first result excerpts object should return "de un sitio mientras que mira su diseño. El punto de usar <span class="match">Lorem</span> Ipsum es que tiene una distribución"
+
+  Scenario: Excerpt Options
+    Given Sphinx is running
+    And I am searching on comments
+    And I search for "lorem"
+    And I provide excerpt option "before_match" with value "<em>"
+    And I provide excerpt option "after_match" with value "</em>"
+    Then calling content on the first result excerpts object should return "de un sitio mientras que mira su diseño. El punto de usar <em>Lorem</em> Ipsum es que tiene una distribución"

data/features/field_sorting.feature

@@ -0,0 +1,18 @@
+Feature: Field Sorting
+  In order to sort by strings
+  As a developer
+  I want to enable sorting by existing fields
+  
+  Background:
+    Given Sphinx is running
+    And I am searching on people
+    
+  Scenario: Searching with ordering on a sortable field
+    When I order by first_name
+    Then I should get 20 results
+    And the first_name of each result should indicate order
+  
+  Scenario: Sort on a case insensitive sortable field
+    When I order by last_name
+    Then the first result's "last_name" should be "abbott"
+  

data/features/searching_across_models.feature

@@ -7,7 +7,7 @@ Feature: Searching across multiple model
     Given Sphinx is running
     When I search for James
     And I am retrieving the result count
-    Then I should get a value of 3
+    Then I should get a value of 6
   
   Scenario: Confirming existance of a document id in a given index
     Given Sphinx is running

data/features/searching_by_model.feature

@@ -97,13 +97,6 @@ Feature: Searching on a single model
     Then I should get 10 results
     And the value of each result should indicate order
   
-  Scenario: Searching with ordering on a sortable field
-    Given Sphinx is running
-    And I am searching on people
-    And I order by first_name
-    Then I should get 20 results
-    And the first_name of each result should indicate order
-  
   Scenario: Intepreting Sphinx Internal Identifiers
     Given Sphinx is running
     And I am searching on people

data/features/sphinx_scopes.feature

@@ -48,3 +48,21 @@ Feature: Sphinx Scopes
     And I am retrieving the scoped result count for "Byrne"
     Then I should get a value of 1
   
+  Scenario: Default Scope
+    Given Sphinx is running
+    And I am searching on andrews
+    Then I should get 7 results
+  
+  Scenario: Default Scope and additional query terms
+    Given Sphinx is running
+    And I am searching on andrews
+    When I search for "Byrne"
+    Then I should get 1 result
+  
+  Scenario: Explicit scope plus search over a default scope
+    Given Sphinx is running
+    And I am searching on andrews
+    When I use the locked_last_name scope
+    And I search for "Cecil"
+    Then I should get 1 result
+  

data/features/step_definitions/common_steps.rb

@@ -155,6 +155,10 @@ Then /^the (\w+) of each result should indicate order$/ do |attribute|
   end
 end
 
+Then /^the first result's "([^"]*)" should be "([^"]*)"$/ do |attribute, value|
+  results.first.send(attribute.to_sym).should == value
+end
+
 Then /^I can iterate by result and (\w+)$/ do |attribute|
   iteration = lambda { |result, attr_value|
     result.should be_kind_of(@model)

data/features/step_definitions/search_steps.rb

@@ -87,3 +87,8 @@ end
 Then /^the first result should have a (\w+\s?\w*) of (\d+)$/ do |attribute, value|
   results.first.sphinx_attributes[attribute.gsub(/\s+/, '_')].should == value.to_i
 end
+
+Given /^I provide excerpt option "([a-z_]*)" with value "([^"]*)"$/ do |k, v|
+  @options[:excerpt_options] ||= {}
+  @options[:excerpt_options][k.to_sym] = v
+end

data/features/support/env.rb

@@ -1,16 +1,15 @@
 require 'rubygems'
-require 'cucumber'
-require 'rspec'
 require 'fileutils'
-require 'ginger'
-require 'will_paginate'
-require 'active_record'
+require 'bundler'
+
+Bundler.require :default, :development
 
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 Dir[File.join(File.dirname(__FILE__), '../../vendor/*/lib')].each do |path|
   $:.unshift path
 end
 
+require 'active_record'
 require 'cucumber/thinking_sphinx/internal_world'
 
 world = Cucumber::ThinkingSphinx::InternalWorld.new

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

@@ -18,7 +18,7 @@ Person.create :gender => "male", :first_name => "Peter", :middle_initial => "C",
 Person.create :gender => "female", :first_name => "Hollie", :middle_initial => "C", :last_name => "Hunter", :street_address => "34 Cornish Street", :city => "Kensington", :state => "VIC", :postcode => "3031", :email => "Hollie.C.Hunter@mailinator.com", :birthday => "1954/2/16 00:00:00"
 Person.create :gender => "male", :first_name => "Jonathan", :middle_initial => "C", :last_name => "Turner", :street_address => "2 Kopkes Road", :city => "Carngham", :state => "VIC", :postcode => "3351", :email => "Jonathan.C.Turner@trashymail.com", :birthday => "1963/8/26 00:00:00"
 Person.create :gender => "female", :first_name => "Kate", :middle_initial => "S", :last_name => "Doyle", :street_address => "42 Gregory Way", :city => "Mungalup", :state => "WA", :postcode => "6225", :email => "Kate.S.Doyle@mailinator.com", :birthday => "1974/1/5 00:00:00"
-Person.create :gender => "male", :first_name => "Harley", :middle_initial => "M", :last_name => "Abbott", :street_address => "39 Faulkner Street", :city => "Tilbuster", :state => "NSW", :postcode => "2350", :email => "Harley.M.Abbott@trashymail.com", :birthday => "1953/10/4 00:00:00"
+Person.create :gender => "male", :first_name => "Harley", :middle_initial => "M", :last_name => "abbott", :street_address => "39 Faulkner Street", :city => "Tilbuster", :state => "NSW", :postcode => "2350", :email => "Harley.M.Abbott@trashymail.com", :birthday => "1953/10/4 00:00:00"
 Person.create :gender => "male", :first_name => "Morgan", :middle_initial => "E", :last_name => "Iqbal", :street_address => "64 Carlisle Street", :city => "Dysart", :state => "VIC", :postcode => "3660", :email => "Morgan.E.Iqbal@spambob.com", :birthday => "1954/7/6 00:00:00"
 Person.create :gender => "female", :first_name => "Phoebe", :middle_initial => "T", :last_name => "Wells", :street_address => "10 Mnimbah Road", :city => "Eccleston", :state => "NSW", :postcode => "2311", :email => "Phoebe.T.Wells@trashymail.com", :birthday => "1949/5/27 00:00:00"
 Person.create :gender => "male", :first_name => "Finley", :middle_initial => "I", :last_name => "Martin", :street_address => "15 Thomas Lane", :city => "Epping", :state => "VIC", :postcode => "3076", :email => "Finley.I.Martin@dodgit.com", :birthday => "1983/3/12 00:00:00"

data/features/thinking_sphinx/models/alpha.rb

@@ -14,6 +14,7 @@ class Alpha < ActiveRecord::Base
     
     has value, created_at, created_on
     has cost, :facet => true
+    has active
     
     set_property :field_weights => {'alternative_name' => 10}
     

data/features/thinking_sphinx/models/andrew.rb

@@ -0,0 +1,17 @@
+require "#{File.dirname(__FILE__)}/person"
+
+class Andrew < ActiveRecord::Base
+  set_table_name 'people'
+  
+  define_index do
+    indexes first_name, last_name, street_address
+  end
+  
+  sphinx_scope(:locked_first_name) {
+    {:conditions => {:first_name => 'Andrew'}}
+  }
+  sphinx_scope(:locked_last_name) {
+    {:conditions => {:last_name => 'Byrne'}}
+  }
+  default_sphinx_scope :locked_first_name
+end

data/features/thinking_sphinx/models/person.rb

@@ -1,6 +1,7 @@
 class Person < ActiveRecord::Base
   define_index do
-    indexes first_name, last_name, :sortable => true
+    indexes first_name, :sortable => true
+    indexes last_name,  :sortable => :insensitive
     
     has [first_name, middle_initial, last_name], :as => :name_sort
     has birthday

data/lib/thinking_sphinx.rb

@@ -9,6 +9,7 @@ require 'thinking_sphinx/property'
 require 'thinking_sphinx/active_record'
 require 'thinking_sphinx/association'
 require 'thinking_sphinx/attribute'
+require 'thinking_sphinx/bundled_search'
 require 'thinking_sphinx/configuration'
 require 'thinking_sphinx/context'
 require 'thinking_sphinx/excerpter'
@@ -30,6 +31,8 @@ require 'thinking_sphinx/adapters/postgresql_adapter'
 require 'thinking_sphinx/railtie' if defined?(Rails)
 
 module ThinkingSphinx
+  mattr_accessor :database_adapter
+  
   # A ConnectionError will get thrown when a connection to Sphinx can't be
   # made.
   class ConnectionError < StandardError

data/lib/thinking_sphinx/active_record.rb

@@ -349,7 +349,7 @@ module ThinkingSphinx
     # @return [Integer] Unique record id for the purposes of Sphinx.
     # 
     def primary_key_for_sphinx
-      @primary_key_for_sphinx ||= read_attribute(self.class.primary_key_for_sphinx)
+      read_attribute(self.class.primary_key_for_sphinx)
     end
     
     def sphinx_document_id

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -53,6 +53,13 @@ module ThinkingSphinx
               
               ThinkingSphinx::Search.new(options)
             end
+            
+            define_method("#{method}_without_default".to_sym) do |*args|
+              options = {:classes => classes_option, :ignore_default => true}
+              options.merge! block.call(*args)
+              
+              ThinkingSphinx::Search.new(options)
+            end
           end
         end
 

data/lib/thinking_sphinx/adapters/abstract_adapter.rb

@@ -10,24 +10,50 @@ module ThinkingSphinx
     end
       
     def self.detect(model)
+      adapter = adapter_for_model model
+      case adapter
+      when :mysql
+        ThinkingSphinx::MysqlAdapter.new model
+      when :postgresql
+        ThinkingSphinx::PostgreSQLAdapter.new model
+      else
+        raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL, not #{adapter}"
+      end
+    end
+    
+    def self.adapter_for_model(model)
+      case ThinkingSphinx.database_adapter
+      when String
+        ThinkingSphinx.database_adapter.to_sym
+      when NilClass
+        standard_adapter_for_model model
+      when Proc
+        ThinkingSphinx.database_adapter.call model
+      else
+        ThinkingSphinx.database_adapter
+      end
+    end
+    
+    def self.standard_adapter_for_model(model)
       case model.connection.class.name
       when "ActiveRecord::ConnectionAdapters::MysqlAdapter",
            "ActiveRecord::ConnectionAdapters::MysqlplusAdapter",
            "ActiveRecord::ConnectionAdapters::Mysql2Adapter",
            "ActiveRecord::ConnectionAdapters::NullDBAdapter"
-        ThinkingSphinx::MysqlAdapter.new model
+        :mysql
       when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
-        ThinkingSphinx::PostgreSQLAdapter.new model
+        :postgresql
       when "ActiveRecord::ConnectionAdapters::JdbcAdapter"
-        if model.connection.config[:adapter] == "jdbcmysql"
-          ThinkingSphinx::MysqlAdapter.new model
-        elsif model.connection.config[:adapter] == "jdbcpostgresql"
-          ThinkingSphinx::PostgreSQLAdapter.new model
+        case model.connection.config[:adapter]
+        when "jdbcmysql"
+          :mysql
+        when "jdbcpostgresql"
+          :postgresql
         else
-          raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL"
+          model.connection.config[:adapter]
         end
       else
-        raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL, not #{model.connection.class.name}"
+        model.connection.class.name
       end
     end
     
@@ -39,6 +65,10 @@ module ThinkingSphinx
       /bigint/i
     end
     
+    def downcase(clause)
+      "LOWER(#{clause})"
+    end
+    
     protected
     
     def connection

data/lib/thinking_sphinx/adapters/postgresql_adapter.rb

@@ -68,7 +68,7 @@ module ThinkingSphinx
     end
     
     def utc_query_pre
-      'SET TIME ZONE UTC'
+      "SET TIME ZONE 'UTC'"
     end
     
     private
@@ -119,6 +119,10 @@ module ThinkingSphinx
           DECLARE j int;
           DECLARE word_array bytea;
           BEGIN
+            IF COALESCE(word, '') = '' THEN
+              return 0;
+            END IF;
+          
             i = 0;
             tmp = 4294967295;
             word_array = decode(replace(word, E'\\\\', E'\\\\\\\\'), 'escape');
@@ -139,7 +143,7 @@ module ThinkingSphinx
             END LOOP;
             return (tmp # 4294967295);
           END
-        $$ IMMUTABLE STRICT LANGUAGE plpgsql;
+        $$ IMMUTABLE LANGUAGE plpgsql;
       SQL
       execute function, true
     end

data/lib/thinking_sphinx/association.rb

@@ -45,13 +45,10 @@ module ThinkingSphinx
       
       # association is polymorphic - create associations for each
       # non-polymorphic reflection.
-      polymorphic_classes(ref).collect { |klass|
-        Association.new parent, ::ActiveRecord::Reflection::AssociationReflection.new(
-          ref.macro,
-          "#{ref.name}_#{klass.name}".to_sym,
-          casted_options(klass, ref),
-          ref.active_record
-        )
+      polymorphic_classes(ref).collect { |poly_class|
+        reflection = depolymorphic_reflection(ref, poly_class)
+        klass.reflections[reflection.name] = reflection
+        Association.new parent, reflection
       }
     end
     
@@ -66,14 +63,13 @@ module ThinkingSphinx
       )
     end
     
-    # Returns the association's join SQL statements - and it replaces
-    # ::ts_join_alias:: with the aliased table name so the generated reflection
-    # join conditions avoid column name collisions.
-    # 
-    def to_sql
-      @join.to_sql.gsub(/::ts_join_alias::/,
+    def arel_join
+      arel_join = @join.with_join_class(Arel::OuterJoin)
+      arel_join.options[:conditions].gsub!(/::ts_join_alias::/,
         "#{@reflection.klass.connection.quote_table_name(@join.parent.aliased_table_name)}"
-      )
+      ) if arel_join.options[:conditions].is_a?(String)
+      
+      arel_join
     end
     
     # Returns true if the association - or a parent - is a has_many or
@@ -121,6 +117,15 @@ module ThinkingSphinx
     
     private
     
+    def self.depolymorphic_reflection(reflection, klass)
+      ::ActiveRecord::Reflection::AssociationReflection.new(
+        reflection.macro,
+        "#{reflection.name}_#{klass.name}".to_sym,
+        casted_options(klass, reflection),
+        reflection.active_record
+      )
+    end
+    
     # Returns all the objects that could be currently instantiated from a
     # polymorphic association. This is pretty damn fast if there's an index on
     # the foreign type column - but if there isn't, it can take a while if you

data/lib/thinking_sphinx/attribute.rb

@@ -111,6 +111,7 @@ module ThinkingSphinx
       clause = adapter.crc(clause)                          if @crc
       clause = adapter.concatenate(clause, separator)       if concat_ws?
       clause = adapter.group_concatenate(clause, separator) if is_many?
+      clause = adapter.downcase(clause)                     if insensitive?
       
       "#{clause} AS #{quote_column(unique_name)}"
     end
@@ -380,5 +381,9 @@ block:
         value
       end
     end
+    
+    def insensitive?
+      @sortable == :insensitive
+    end
   end
 end

data/lib/thinking_sphinx/auto_version.rb

@@ -5,6 +5,8 @@ module ThinkingSphinx
       case version
       when '0.9.8', '0.9.9'
         require "riddle/#{version}"
+      when '1.10-beta'
+        require 'riddle/1.10'
       else
         STDERR.puts %Q{
 Sphinx cannot be found on your system. You may need to configure the following

data/lib/thinking_sphinx/bundled_search.rb

@@ -0,0 +1,44 @@
+module ThinkingSphinx
+  class BundledSearch
+    attr_reader :client
+    
+    def initialize
+      @searches = []
+    end
+    
+    def search(*args)
+      @searches << ThinkingSphinx.search(*args)
+      @searches.last.append_to client
+    end
+    
+    def search_for_ids(*args)
+      @searches << ThinkingSphinx.search_for_ids(*args)
+      @searches.last.append_to client
+    end
+    
+    def searches
+      populate
+      @searches
+    end
+    
+    private
+    
+    def client
+      @client ||= ThinkingSphinx::Configuration.instance.client
+    end
+    
+    def populated?
+      @populated
+    end
+    
+    def populate
+      return if populated?
+      
+      @populated = true
+      
+      client.run.each_with_index do |results, index|
+        searches[index].populate_from_queue results
+      end
+    end
+  end
+end