ebeigarts-thinking-sphinx 1.1.22 → 1.2.10

data/README.textile

@@ -30,6 +30,10 @@ Alternatively, install the ginger gem directly from the freelancing-god github r
 
   sudo gem sources -a http://gems.github.com
   sudo gem install freelancing-god-ginger
+  
+Then install the cucumber, yard, jeweler and rspec gems. Make sure you have a git install version 1.6.0.0 or higher, otherwise the jeweler gem won't install.
+
+  sudo gem install cucumber yard jeweler rspec
 
 Then set up your database:
 
@@ -141,3 +145,13 @@ Since I first released this library, there's been quite a few people who have su
 * Paul Campbell
 * Matthew Beale
 * Tom Simnett
+* Erik Ostrom
+* Ole Riesenberg
+* Josh Kalderimis
+* J.D. Hollis
+* Jeffrey Chupp
+* Rob Anderton
+* Zach Inglis
+* Ward Bekker
+* Brian Terlson
+* Christian Aust

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 2
+:patch: 10

data/lib/thinking_sphinx.rb

@@ -5,22 +5,25 @@ end
 require 'active_record'
 require 'riddle'
 require 'after_commit'
+require 'yaml'
 
+require 'thinking_sphinx/core/array'
 require 'thinking_sphinx/core/string'
 require 'thinking_sphinx/property'
 require 'thinking_sphinx/active_record'
 require 'thinking_sphinx/association'
 require 'thinking_sphinx/attribute'
-require 'thinking_sphinx/collection'
 require 'thinking_sphinx/configuration'
+require 'thinking_sphinx/excerpter'
 require 'thinking_sphinx/facet'
 require 'thinking_sphinx/class_facet'
-require 'thinking_sphinx/facet_collection'
+require 'thinking_sphinx/facet_search'
 require 'thinking_sphinx/field'
 require 'thinking_sphinx/index'
 require 'thinking_sphinx/source'
 require 'thinking_sphinx/rails_additions'
 require 'thinking_sphinx/search'
+require 'thinking_sphinx/search_methods'
 require 'thinking_sphinx/deltas'
 
 require 'thinking_sphinx/adapters/abstract_adapter'
@@ -36,19 +39,11 @@ Merb::Plugins.add_rakefiles(
 ) if defined?(Merb)
 
 module ThinkingSphinx
-  module Version #:nodoc:
-    Major = 1
-    Minor = 1
-    Tiny  = 22
-    
-    String = [Major, Minor, Tiny].join('.')
-  end
-  
   # A ConnectionError will get thrown when a connection to Sphinx can't be
   # made.
   class ConnectionError < StandardError
   end
-  
+
   # A StaleIdsException is thrown by Collection.instances_from_matches if there
   # are records in Sphinx but not in the database, so the search can be retried.
   class StaleIdsException < StandardError
@@ -58,41 +53,50 @@ module ThinkingSphinx
     end
   end
   
+  # The current version of Thinking Sphinx.
+  # 
+  # @return [String] The version number as a string
+  # 
+  def self.version
+    hash = YAML.load_file File.join(File.dirname(__FILE__), '../VERSION.yml')
+    [hash[:major], hash[:minor], hash[:patch]].join('.')
+  end
+  
   # The collection of indexed models. Keep in mind that Rails lazily loads
   # its classes, so this may not actually be populated with _all_ the models
   # that have Sphinx indexes.
   def self.indexed_models
     @@indexed_models ||= []
   end
-  
+
   def self.unique_id_expression(offset = nil)
     "* #{ThinkingSphinx.indexed_models.size} + #{offset || 0}"
   end
-  
+
   # Check if index definition is disabled.
-  # 
+  #
   def self.define_indexes?
     @@define_indexes =  true unless defined?(@@define_indexes)
     @@define_indexes == true
   end
-  
+
   # Enable/disable indexes - you may want to do this while migrating data.
-  # 
+  #
   #   ThinkingSphinx.define_indexes = false
-  # 
+  #
   def self.define_indexes=(value)
     @@define_indexes = value
   end
-  
+
   @@deltas_enabled = nil
 
   # Check if delta indexing is enabled.
-  # 
+  #
   def self.deltas_enabled?
     @@deltas_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@deltas_enabled.nil?
     @@deltas_enabled
   end
-  
+
   # Enable/disable all delta indexing.
   #
   #   ThinkingSphinx.deltas_enabled = false
@@ -100,38 +104,38 @@ module ThinkingSphinx
   def self.deltas_enabled=(value)
     @@deltas_enabled = value
   end
-  
+
   @@updates_enabled = nil
-  
+
   # Check if updates are enabled. True by default, unless within the test
   # environment.
-  # 
+  #
   def self.updates_enabled?
     @@updates_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@updates_enabled.nil?
     @@updates_enabled
   end
-  
+
   # Enable/disable updates to Sphinx
-  # 
+  #
   #   ThinkingSphinx.updates_enabled = false
   #
   def self.updates_enabled=(value)
     @@updates_enabled = value
   end
-  
+
   @@suppress_delta_output = false
-  
+
   def self.suppress_delta_output?
     @@suppress_delta_output
   end
-  
+
   def self.suppress_delta_output=(value)
     @@suppress_delta_output = value
   end
-  
+
   # Checks to see if MySQL will allow simplistic GROUP BY statements. If not,
   # or if not using MySQL, this will return false.
-  # 
+  #
   def self.use_group_by_shortcut?
     !!(
       mysql? && ::ActiveRecord::Base.connection.select_all(
@@ -139,79 +143,71 @@ module ThinkingSphinx
       ).all? { |key,value| value.nil? || value[/ONLY_FULL_GROUP_BY/].nil? }
     )
   end
-  
+
   @@remote_sphinx = false
-  
+
   # An indication of whether Sphinx is running on a remote machine instead of
   # the same machine.
-  # 
+  #
   def self.remote_sphinx?
     @@remote_sphinx
   end
-  
+
   # Tells Thinking Sphinx that Sphinx is running on a different machine, and
-  # thus it can't reliably guess whether it is running or not (ie: the 
+  # thus it can't reliably guess whether it is running or not (ie: the
   # #sphinx_running? method), and so just assumes it is.
-  # 
+  #
   # Useful for multi-machine deployments. Set it in your production.rb file.
-  # 
+  #
   #   ThinkingSphinx.remote_sphinx = true
-  # 
+  #
   def self.remote_sphinx=(value)
     @@remote_sphinx = value
   end
-  
+
   # Check if Sphinx is running. If remote_sphinx is set to true (indicating
   # Sphinx is on a different machine), this will always return true, and you
   # will have to handle any connection errors yourself.
-  # 
+  #
   def self.sphinx_running?
     remote_sphinx? || sphinx_running_by_pid?
   end
-  
+
   # Check if Sphinx is actually running, provided the pid is on the same
   # machine as this code.
-  # 
+  #
   def self.sphinx_running_by_pid?
     !!sphinx_pid && pid_active?(sphinx_pid)
   end
-  
+
   def self.sphinx_pid
-    pid_file    = ThinkingSphinx::Configuration.instance.pid_file
-    cat_command = 'cat'
-    return nil unless File.exists?(pid_file)
-    
-    if microsoft?
-      pid_file.gsub!('/', '\\')
-      cat_command = 'type'
+    if File.exists?(ThinkingSphinx::Configuration.instance.pid_file)
+      File.read(ThinkingSphinx::Configuration.instance.pid_file)[/\d+/]
+    else
+      nil
     end
-    
-    `#{cat_command} #{pid_file}`[/\d+/]
   end
-  
+
   def self.pid_active?(pid)
-    return true if microsoft?
-    
-    begin
-      # In JRuby this returns -1 if the process doesn't exist
-      Process.getpgid(pid.to_i) != -1
-    rescue Exception => e
-      false
-    end
+    !!Process.kill(0, pid.to_i)
+  rescue Exception => e
+    false
   end
-  
+
   def self.microsoft?
     RUBY_PLATFORM =~ /mswin/
   end
-  
+
   def self.jruby?
     defined?(JRUBY_VERSION)
   end
-  
+
   def self.mysql?
     ::ActiveRecord::Base.connection.class.name.demodulize == "MysqlAdapter" ||
     ::ActiveRecord::Base.connection.class.name.demodulize == "MysqlplusAdapter" || (
       jruby? && ::ActiveRecord::Base.connection.config[:adapter] == "jdbcmysql"
     )
   end
+  
+  extend ThinkingSphinx::SearchMethods::ClassMethods
 end

data/lib/thinking_sphinx/active_record.rb

@@ -1,7 +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
@@ -13,6 +13,15 @@ module ThinkingSphinx
       base.class_eval do
         class_inheritable_array :sphinx_indexes, :sphinx_facets
         class << self
+          
+          def set_sphinx_primary_key(attribute)
+            @sphinx_primary_key_attribute = attribute
+          end
+          
+          def primary_key_for_sphinx
+            @sphinx_primary_key_attribute || primary_key
+          end
+          
           # Allows creation of indexes for Sphinx. If you don't do this, there
           # isn't much point trying to search (or using this plugin at all,
           # really).
@@ -80,7 +89,9 @@ module ThinkingSphinx
             
             after_destroy :toggle_deleted
             
+            include ThinkingSphinx::SearchMethods
             include ThinkingSphinx::ActiveRecord::AttributeUpdates
+            include ThinkingSphinx::ActiveRecord::Scopes
             
             index
             
@@ -140,12 +151,20 @@ module ThinkingSphinx
               ThinkingSphinx::AbstractAdapter.detect(self)
           end
           
-          private
-          
           def sphinx_name
             self.name.underscore.tr(':/\\', '_')
           end
           
+          def sphinx_index_names
+            klass = source_of_sphinx_index
+            names = ["#{klass.sphinx_name}_core"]
+            names << "#{klass.sphinx_name}_delta" if sphinx_delta?
+            
+            names
+          end
+          
+          private
+          
           def sphinx_delta?
             self.sphinx_indexes.any? { |index| index.delta? }
           end
@@ -215,7 +234,6 @@ module ThinkingSphinx
       end
       
       base.send(:include, ThinkingSphinx::ActiveRecord::Delta)
-      base.send(:include, ThinkingSphinx::ActiveRecord::Search)
       
       ::ActiveRecord::Associations::HasManyAssociation.send(
         :include, ThinkingSphinx::ActiveRecord::HasManyAssociation
@@ -264,13 +282,23 @@ module ThinkingSphinx
       # nothing
     end
     
+    # Returns the unique integer id for the object. This method uses the
+    # attribute hash to get around ActiveRecord always mapping the #id method
+    # to whatever the real primary key is (which may be a unique string hash).
+    # 
+    # @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)
+    end
+    
     def sphinx_document_id
-      (self.id * ThinkingSphinx.indexed_models.size) +
+      primary_key_for_sphinx * 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

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -0,0 +1,39 @@
+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 = {:classes => classes_option}
+              options.merge! 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/adapters/postgresql_adapter.rb

@@ -37,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
@@ -132,4 +133,4 @@ module ThinkingSphinx
       execute function, true
     end
   end
-end
+end

data/lib/thinking_sphinx/attribute.rb

@@ -75,7 +75,9 @@ module ThinkingSphinx
       @crc            = options[:crc]
       
       @type         ||= :multi    unless @query_source.nil?
-      @type           = :integer  if @type == :string && @crc
+      if @type == :string && @crc
+        @type = is_many? ? :multi : :integer
+      end
       
       source.attributes << self
     end
@@ -89,14 +91,21 @@ module ThinkingSphinx
     def to_select_sql
       return nil unless include_as_association?
       
-      separator = all_ints? || @crc ? ',' : ' '
+      separator = all_ints? || all_datetimes? || @crc ? ',' : ' '
       
       clause = @columns.collect { |column|
         part = column_with_prefix(column)
-        type == :string ? adapter.convert_nulls(part) : part
+        case type
+        when :string
+          adapter.convert_nulls(part)
+        when :datetime
+          adapter.cast_to_datetime(part)
+        else
+          part
+        end
       }.join(', ')
       
-      clause = adapter.cast_to_datetime(clause)             if type == :datetime
+      # clause = adapter.cast_to_datetime(clause)             if type == :datetime
       clause = adapter.crc(clause)                          if @crc
       clause = adapter.concatenate(clause, separator)       if concat_ws?
       clause = adapter.group_concatenate(clause, separator) if is_many?
@@ -125,10 +134,10 @@ module ThinkingSphinx
     # Special case is the multi-valued attribute that needs some
     # extra configuration. 
     # 
-    def config_value(offset = nil)
+    def config_value(offset = nil, delta = false)
       if type == :multi && ThinkingSphinx::Configuration.instance.type != "xml"
         multi_config = include_as_association? ? "field" :
-          source_value(offset).gsub(/\s+/m, " ").strip
+          source_value(offset, delta).gsub(/\s+/m, " ").strip
         "uint #{unique_name} from #{multi_config}"
       else
         unique_name
@@ -143,6 +152,8 @@ module ThinkingSphinx
     def type
       @type ||= begin
         base_type = case
+        when is_many_datetimes?
+          :datetime
         when is_many?, is_many_ints?
           :multi
         when @associations.values.flatten.length > 1
@@ -172,25 +183,29 @@ module ThinkingSphinx
     end
     
     def all_ints?
-      @columns.all? { |col|
-        klasses = @associations[col].empty? ? [@model] :
-          @associations[col].collect { |assoc| assoc.reflection.klass }
-        klasses.all? { |klass|
-          column = klass.columns.detect { |column| column.name == col.__name.to_s }
-          !column.nil? && column.type == :integer
-        }
-      }
+      all_of_type?(:integer)
+    end
+    
+    def all_datetimes?
+      all_of_type?(:datetime, :date, :timestamp)
     end
     
     private
     
-    def source_value(offset)
+    def source_value(offset, delta)
       if is_string?
-        "#{query_source.to_s.dasherize}; #{columns.first.__name}"
-      elsif query_source == :ranged_query
-        "ranged-query; #{query offset} #{query_clause}; #{range_query}"
+        return "#{query_source.to_s.dasherize}; #{columns.first.__name}"
+      end
+      
+      query = query(offset)
+
+      if query_source == :ranged_query
+        query += query_clause
+        query += " AND #{query_delta.strip}" if delta
+        "ranged-query; #{query}; #{range_query}"
       else
-        "query; #{query offset}"
+        query += "WHERE #{query_delta.strip}" if delta
+        "query; #{query}"
       end
     end
     
@@ -212,6 +227,15 @@ FROM #{quote_table_name base_assoc.table} #{association_joins}
       "WHERE #{foreign_key} >= $start AND #{foreign_key} <= $end"
     end
     
+    def query_delta
+      foreign_key = foreign_key_for_mva base_association_for_mva
+      <<-SQL
+#{foreign_key} IN (SELECT #{quote_column model.primary_key}
+FROM #{model.quoted_table_name}
+WHERE #{@source.index.delta_object.clause(model, true)})
+      SQL
+    end
+    
     def range_query
       assoc       = base_association_for_mva
       foreign_key = foreign_key_for_mva assoc
@@ -259,14 +283,19 @@ FROM #{quote_table_name base_assoc.table} #{association_joins}
     def is_many_ints?
       concat_ws? && all_ints?
     end
-        
+    
+    def is_many_datetimes?
+      is_many? && all_datetimes?
+    end
+       
     def type_from_database
       klass = @associations.values.flatten.first ? 
         @associations.values.flatten.first.reflection.klass : @model
       
-      klass.columns.detect { |col|
+      column = klass.columns.detect { |col|
         @columns.collect { |c| c.__name.to_s }.include? col.name
-      }.type
+      }
+      column.nil? ? nil : column.type
     end
     
     def translated_type_from_database
@@ -288,5 +317,16 @@ block:
         MESSAGE
       end
     end
+    
+    def all_of_type?(*column_types)
+      @columns.all? { |col|
+        klasses = @associations[col].empty? ? [@model] :
+          @associations[col].collect { |assoc| assoc.reflection.klass }
+        klasses.all? { |klass|
+          column = klass.columns.detect { |column| column.name == col.__name.to_s }
+          !column.nil? && column_types.include?(column.type)
+        }
+      }
+    end
   end
 end