pixeltrix-thinking-sphinx 1.1.5 → 1.2.1

data/README.textile

@@ -0,0 +1,147 @@
+h1. Thinking Sphinx
+
+h2. Usage
+
+First, if you haven't done so already, check out the main "usage":http://ts.freelancing-gods.com/usage.html page. Once you've done that, the next place to look for information is the specific method docs - ThinkingSphinx::Search and ThinkingSphinx::Index::Builder in particular.
+
+Keep in mind that while Thinking Sphinx works for ActiveRecord with Merb, it doesn't yet support DataMapper (although that is planned).
+
+h2. Contributing
+
+Fork on GitHub and after you've committed tested patches, send a pull request.
+
+To quickly see if your system is ready to run the thinking sphinx specs, run the contribute.rb script found in the project root directory. Use the following instructions to install any missing requirements.
+
+To get the spec suite running, you will need to install the not-a-mock gem if you don't already have it:
+
+  git clone git://github.com/freelancing-god/not-a-mock.git
+  cd not-a-mock
+  rake gem
+  gem install pkg/not_a_mock-1.1.0.gem
+  
+Then install the ginger gem. The steps are the same, except that you might need to sudo the gem install:
+
+  git clone git://github.com/freelancing-god/ginger.git
+  cd ginger
+  rake gem
+  sudo gem install pkg/ginger-1.1.0.gem
+  
+Alternatively, install the ginger gem directly from the freelancing-god github repository
+
+  sudo gem sources -a http://gems.github.com
+  sudo gem install freelancing-god-ginger
+
+Then set up your database:
+
+  cp spec/fixtures/database.yml.default spec/fixtures/database.yml
+  mysqladmin -u root create thinking_sphinx
+  
+This last step can be done automatically by the contribute.rb script if all dependencies are met.
+
+Make sure you don't have another Sphinx daemon (searchd) running. If you do, quit it with "rake ts:stop"
+in the app root.
+
+You should now have a passing test suite from which to build your patch on.
+
+  rake spec
+
+If you get the message "Failed to start searchd daemon", run the spec with sudo:
+
+  sudo rake spec
+
+If you quit the spec suite before it's completed, you may be left with data in the test
+database, causing the next run to have failures. Let that run complete and then try again.
+
+h2. Contributors
+
+Since I first released this library, there's been quite a few people who have submitted patches, to my immense gratitude. Others have suggested syntax changes and general improvements. So my thanks to the following people:
+
+* Joost Hietbrink
+* Jonathan Conway
+* Gregory Mirzayantz
+* Tung Nguyen
+* Sean Cribbs
+* Benoit Caccinolo
+* John Barton
+* Oliver Beddows
+* Arthur Zapparoli
+* Dusty Doris
+* Marcus Crafter
+* Patrick Lenz
+* Björn Andreasson
+* James Healy
+* Jae-Jun Hwang
+* Xavier Shay
+* Jason Rust
+* Gopal Patel
+* Chris Heald
+* Peter Vandenberk
+* Josh French
+* Andrew Bennett
+* Jordan Fowler
+* Seth Walker
+* Joe Noon
+* Wolfgang Postler
+* Rick Olson
+* Killian Murphy
+* Morten Primdahl
+* Ryan Bates
+* David Eisinger
+* Shay Arnett
+* Minh Tran
+* Jeremy Durham
+* Piotr Sarnacki
+* Matt Johnson
+* Nicolas Blanco
+* Max Lapshin
+* Josh Natanson
+* Philip Hallstrom
+* Christian Rishøj
+* Mike Flester
+* Jim Remsik
+* Kennon Ballou
+* Henrik Nyh
+* Emil Tin
+* Doug Cole
+* Ed Hickey
+* Evan Weaver
+* Thibaut Barrere
+* Kristopher Chambers
+* Dmitrij Smalko
+* Aleksey Yeschenko
+* Lachie Cox
+* Lourens Naude
+* Tom Davies
+* Dan Pickett
+* Alex Caudill
+* Jim Benton
+* John Aughey
+* Keith Pitty
+* Jeff Talbot
+* Dana Contreras
+* Menno van der Sman
+* Bill Harding
+* Isaac Feliu
+* Andrei Bocan
+* László Bácsi
+* Peter Wagenet
+* Max Lapshin
+* Martin Emde
+* David Wennergren
+* Mark Lane
+* Eric Lindvall
+* Lawrence Pit
+* Mike Bailey
+* Bill Leeper
+* Michael Reinsch
+* Anderson Dias
+* Jerome Riga
+* Tien Dung
+* Johannes Kaefer
+* Paul Campbell
+* Matthew Beale
+* Tom Simnett
+* Erik Ostrom
+* Ole Riesenberg
+* Josh Kalderimis
+* J.D. Hollis

data/lib/thinking_sphinx/active_record/attribute_updates.rb

@@ -0,0 +1,48 @@
+module ThinkingSphinx
+  module ActiveRecord
+    module AttributeUpdates
+      def self.included(base)
+        base.class_eval do
+          after_commit :update_attribute_values
+        end
+      end
+      
+      private
+            
+      def update_attribute_values
+        return unless ThinkingSphinx.updates_enabled? && ThinkingSphinx.sphinx_running?
+        
+        config = ThinkingSphinx::Configuration.instance
+        client = Riddle::Client.new config.address, config.port
+        
+        self.sphinx_indexes.each do |index|
+          attribute_pairs  = attribute_values_for_index(index)
+          attribute_names  = attribute_pairs.keys
+          attribute_values = attribute_names.collect { |key|
+            attribute_pairs[key]
+          }
+          
+          client.update "#{index.name}_core", attribute_names, {
+            sphinx_document_id => attribute_values
+          } if in_core_index?
+        end
+      end
+      
+      def updatable_attributes(index)
+        index.attributes.select { |attrib| attrib.updatable? }
+      end
+      
+      def attribute_values_for_index(index)
+        updatable_attributes(index).inject({}) { |hash, attrib|
+          if attrib.type == :datetime
+            hash[attrib.unique_name.to_s] = attrib.live_value(self).to_time.to_i
+          else
+            hash[attrib.unique_name.to_s] = attrib.live_value self
+          end
+          
+          hash
+        }
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/active_record/delta.rb

@@ -50,6 +50,10 @@ module ThinkingSphinx
             end
           end
           
+          def toggled_delta?
+            self.class.delta_object.toggled(self)
+          end
+          
           private
           
           # Set the delta value for the model to be true.
@@ -65,7 +69,16 @@ module ThinkingSphinx
           end
           
           def should_toggle_delta?
-            !self.respond_to?(:changed?) || self.changed? || self.new_record?
+            self.new_record? || indexed_data_changed?
+          end
+          
+          def indexed_data_changed?
+            sphinx_indexes.any? { |index|
+              index.fields.any? { |field| field.changed?(self) } ||
+              index.attributes.any? { |attrib|
+                attrib.public? && attrib.changed?(self) && !attrib.updatable?
+              }
+            }
           end
         end
       end

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -0,0 +1,37 @@
+module ThinkingSphinx
+  module ActiveRecord
+    module Scopes
+      def self.included(base)
+        base.class_eval do
+          extend ThinkingSphinx::ActiveRecord::Scopes::ClassMethods
+        end
+      end
+    
+      module ClassMethods
+        def sphinx_scope(method, &block)
+          @sphinx_scopes ||= []
+          @sphinx_scopes << method
+          
+          metaclass.instance_eval do
+            define_method(method) do |*args|
+              options = block.call(*args)
+              ThinkingSphinx::Search.new(options)
+            end
+          end
+        end
+        
+        def sphinx_scopes
+          @sphinx_scopes || []
+        end
+        
+        def remove_sphinx_scopes
+          sphinx_scopes.each do |scope|
+            metaclass.send(:undef_method, scope)
+          end
+          
+          sphinx_scopes.clear
+        end
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/active_record.rb

@@ -1,6 +1,7 @@
+require 'thinking_sphinx/active_record/attribute_updates'
 require 'thinking_sphinx/active_record/delta'
-require 'thinking_sphinx/active_record/search'
 require 'thinking_sphinx/active_record/has_many_association'
+require 'thinking_sphinx/active_record/scopes'
 
 module ThinkingSphinx
   # Core additions to ActiveRecord models - define_index for creating indexes
@@ -65,7 +66,7 @@ module ThinkingSphinx
             return unless ThinkingSphinx.define_indexes?
             
             self.sphinx_indexes ||= []
-            index = Index.new(self, &block)
+            index = ThinkingSphinx::Index::Builder.generate(self, &block)
             
             self.sphinx_indexes << index
             unless ThinkingSphinx.indexed_models.include?(self.name)
@@ -79,7 +80,22 @@ module ThinkingSphinx
             
             after_destroy :toggle_deleted
             
+            include ThinkingSphinx::SearchMethods
+            include ThinkingSphinx::ActiveRecord::AttributeUpdates
+            include ThinkingSphinx::ActiveRecord::Scopes
+            
             index
+            
+            # We want to make sure that if the database doesn't exist, then Thinking
+            # Sphinx doesn't mind when running non-TS tasks (like db:create, db:drop
+            # and db:migrate). It's a bit hacky, but I can't think of a better way.
+          rescue StandardError => err
+            case err.class.name
+            when "Mysql::Error", "Java::JavaSql::SQLException", "ActiveRecord::StatementInvalid"
+              return
+            else
+              raise err
+            end
           end
           alias_method :sphinx_index, :define_index
           
@@ -126,12 +142,12 @@ module ThinkingSphinx
               ThinkingSphinx::AbstractAdapter.detect(self)
           end
           
-          private
-          
           def sphinx_name
             self.name.underscore.tr(':/\\', '_')
           end
           
+          private
+          
           def sphinx_delta?
             self.sphinx_indexes.any? { |index| index.delta? }
           end
@@ -148,7 +164,9 @@ module ThinkingSphinx
             self.sphinx_indexes.select { |ts_index|
               ts_index.model == self
             }.each_with_index do |ts_index, i|
-              index.sources << ts_index.to_riddle_for_core(offset, i)
+              index.sources += ts_index.sources.collect { |source|
+                source.to_riddle_for_core(offset, i)
+              }
             end
             
             index
@@ -160,7 +178,9 @@ module ThinkingSphinx
             index.path = File.join(ThinkingSphinx::Configuration.instance.searchd_file_path, index.name)
             
             self.sphinx_indexes.each_with_index do |ts_index, i|
-              index.sources << ts_index.to_riddle_for_delta(offset, i) if ts_index.delta?
+              index.sources += ts_index.sources.collect { |source|
+                source.to_riddle_for_delta(offset, i)
+              } if ts_index.delta?
             end
             
             index
@@ -197,7 +217,6 @@ module ThinkingSphinx
       end
       
       base.send(:include, ThinkingSphinx::ActiveRecord::Delta)
-      base.send(:include, ThinkingSphinx::ActiveRecord::Search)
       
       ::ActiveRecord::Associations::HasManyAssociation.send(
         :include, ThinkingSphinx::ActiveRecord::HasManyAssociation
@@ -207,11 +226,20 @@ module ThinkingSphinx
       )
     end
     
+    def in_index?(suffix)
+      self.class.search_for_id self.sphinx_document_id, sphinx_index_name(suffix)
+    end
+    
     def in_core_index?
-      self.class.search_for_id(
-        self.sphinx_document_id,
-        "#{self.class.source_of_sphinx_index.name.underscore.tr(':/\\', '_')}_core"
-      )
+      in_index? "core"
+    end
+    
+    def in_delta_index?
+      in_index? "delta"
+    end
+    
+    def in_both_indexes?
+      in_core_index? && in_delta_index?
     end
     
     def toggle_deleted
@@ -232,7 +260,7 @@ module ThinkingSphinx
         {self.sphinx_document_id => 1}
       ) if ThinkingSphinx.deltas_enabled? &&
         self.class.sphinx_indexes.any? { |index| index.delta? } &&
-        self.delta
+        self.toggled_delta?
     rescue ::ThinkingSphinx::ConnectionError
       # nothing
     end
@@ -241,5 +269,11 @@ module ThinkingSphinx
       (self.id * ThinkingSphinx.indexed_models.size) +
         ThinkingSphinx.indexed_models.index(self.class.source_of_sphinx_index.name)
     end
+    
+    private
+    
+    def sphinx_index_name(suffix)
+      "#{self.class.source_of_sphinx_index.name.underscore.tr(':/\\', '_')}_#{suffix}"
+    end
   end
 end

data/lib/thinking_sphinx/adapters/abstract_adapter.rb

@@ -16,8 +16,16 @@ module ThinkingSphinx
         ThinkingSphinx::MysqlAdapter.new model
       when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
         ThinkingSphinx::PostgreSQLAdapter.new model
+      when "ActiveRecord::ConnectionAdapters::JdbcAdapter"
+        if model.connection.config[:adapter] == "jdbcmysql"
+          ThinkingSphinx::MysqlAdapter.new model
+        elsif model.connection.config[:adapter] == "jdbcpostgresql"
+          ThinkingSphinx::PostgreSQLAdapter.new model
+        else
+          raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL"
+        end
       else
-        raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL"
+        raise "Invalid Database Adapter: Sphinx only supports MySQL and PostgreSQL, not #{model.connection.class.name}"
       end
     end
     

data/lib/thinking_sphinx/adapters/mysql_adapter.rb

@@ -13,7 +13,7 @@ module ThinkingSphinx
     end
     
     def group_concatenate(clause, separator = ' ')
-      "GROUP_CONCAT(#{clause} SEPARATOR '#{separator}')"
+      "GROUP_CONCAT(DISTINCT #{clause} SEPARATOR '#{separator}')"
     end
     
     def cast_to_string(clause)
@@ -38,7 +38,8 @@ module ThinkingSphinx
       value ? 1 : 0
     end
     
-    def crc(clause)
+    def crc(clause, blank_to_null = false)
+      clause = "NULLIF(#{clause},'')" if blank_to_null
       "CRC32(#{clause})"
     end
     

data/lib/thinking_sphinx/adapters/postgresql_adapter.rb

@@ -11,7 +11,12 @@ module ThinkingSphinx
     
     def concatenate(clause, separator = ' ')
       clause.split(', ').collect { |field|
-        "COALESCE(CAST(#{field} as varchar), '')"
+        case field
+        when /COALESCE/, "'')"
+          field
+        else
+          "COALESCE(CAST(#{field} as varchar), '')"
+        end
       }.join(" || '#{separator}' || ")
     end
     
@@ -32,7 +37,8 @@ module ThinkingSphinx
     end
     
     def convert_nulls(clause, default = '')
-      default = "'#{default}'" if default.is_a?(String)
+      default = "'#{default}'"  if default.is_a?(String)
+      default = 'NULL'          if default.nil?
       
       "COALESCE(#{clause}, #{default})"
     end
@@ -41,7 +47,8 @@ module ThinkingSphinx
       value ? 'TRUE' : 'FALSE'
     end
     
-    def crc(clause)
+    def crc(clause, blank_to_null = false)
+      clause = "NULLIF(#{clause},'')" if blank_to_null
       "crc32(#{clause})"
     end
     
@@ -69,7 +76,7 @@ module ThinkingSphinx
     end
     
     def create_array_accum_function
-      if connection.raw_connection.server_version > 80200
+      if connection.raw_connection.respond_to?(:server_version) && connection.raw_connection.server_version > 80200
         execute <<-SQL
           CREATE AGGREGATE array_accum (anyelement)
           (
@@ -126,4 +133,4 @@ module ThinkingSphinx
       execute function, true
     end
   end
-end
+end

data/lib/thinking_sphinx/association.rb

@@ -99,6 +99,26 @@ module ThinkingSphinx
       @reflection.klass.column_names.include?(column.to_s)
     end
     
+    def primary_key_from_reflection
+      if @reflection.options[:through]
+        @reflection.source_reflection.options[:foreign_key] ||
+        @reflection.source_reflection.primary_key_name
+      elsif @reflection.macro == :has_and_belongs_to_many
+        @reflection.association_foreign_key
+      else
+        nil
+      end
+    end
+    
+    def table
+      if @reflection.options[:through] ||
+        @reflection.macro == :has_and_belongs_to_many
+        @join.aliased_join_table_name
+      else
+        @join.aliased_table_name
+      end
+    end
+    
     private
     
     # Returns all the objects that could be currently instantiated from a