sayso-thinking-sphinx 2.0.3.001

data/lib/thinking_sphinx/action_controller.rb

@@ -0,0 +1,31 @@
+module ThinkingSphinx
+  module ActionController
+    extend ActiveSupport::Concern
+
+    protected
+
+    attr_internal :query_runtime
+
+    def cleanup_view_runtime
+      log_subscriber = ThinkingSphinx::ActiveRecord::LogSubscriber
+      query_runtime_pre_render = log_subscriber.reset_runtime
+      runtime = super
+      query_runtime_post_render = log_subscriber.reset_runtime
+      self.query_runtime = query_runtime_pre_render + query_runtime_post_render
+      runtime - query_runtime_post_render
+    end
+
+    def append_info_to_payload(payload)
+      super
+      payload[:query_runtime] = query_runtime
+    end
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages, query_runtime = super, payload[:query_runtime]
+        messages << ("Sphinx: %.1fms" % query_runtime.to_f) if query_runtime
+        messages
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/active_record.rb

@@ -0,0 +1,352 @@
+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
+  # Core additions to ActiveRecord models - define_index for creating indexes
+  # for models. If you want to interrogate the index objects created for the
+  # model, you can use the class-level accessor :sphinx_indexes.
+  #
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        class_inheritable_array :sphinx_indexes, :sphinx_facets
+
+        extend ThinkingSphinx::ActiveRecord::ClassMethods
+
+        class << self
+          attr_accessor :sphinx_index_blocks
+
+          def set_sphinx_primary_key(attribute)
+            @sphinx_primary_key_attribute = attribute
+          end
+
+          def primary_key_for_sphinx
+            @primary_key_for_sphinx ||= begin
+              if custom_primary_key_for_sphinx?
+                @sphinx_primary_key_attribute ||
+                superclass.primary_key_for_sphinx
+              else
+                primary_key
+              end
+            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 clear_primary_key_for_sphinx
+            @primary_key_for_sphinx = nil
+          end
+
+          def sphinx_index_options
+            sphinx_indexes.last.options
+          end
+
+          # Generate a unique CRC value for the model's name, to use to
+          # determine which Sphinx documents belong to which AR records.
+          #
+          # Really only written for internal use - but hey, if it's useful to
+          # you in some other way, awesome.
+          #
+          def to_crc32
+            self.name.to_crc32
+          end
+
+          def to_crc32s
+            (descendants << self).collect { |klass| klass.to_crc32 }
+          end
+
+          def sphinx_database_adapter
+            ThinkingSphinx::AbstractAdapter.detect(self)
+          end
+
+          def sphinx_name
+            self.name.underscore.tr(':/\\', '_')
+          end
+
+          private
+
+          def defined_indexes?
+            @defined_indexes
+          end
+
+          def defined_indexes=(value)
+            @defined_indexes = value
+          end
+
+          def sphinx_delta?
+            self.sphinx_indexes.any? { |index| index.delta? }
+          end
+        end
+      end
+
+      ::ActiveRecord::Associations::HasManyAssociation.send(
+        :include, ThinkingSphinx::ActiveRecord::HasManyAssociation
+      )
+      ::ActiveRecord::Associations::HasManyThroughAssociation.send(
+        :include, ThinkingSphinx::ActiveRecord::HasManyAssociation
+      )
+    end
+
+    module ClassMethods
+      # 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).
+      #
+      # An example or two:
+      #
+      #   define_index
+      #     indexes :id, :as => :model_id
+      #     indexes name
+      #   end
+      #
+      # You can also grab fields from associations - multiple levels deep
+      # if necessary.
+      #
+      #   define_index do
+      #     indexes tags.name, :as => :tag
+      #     indexes articles.content
+      #     indexes orders.line_items.product.name, :as => :product
+      #   end
+      #
+      # And it will automatically concatenate multiple fields:
+      #
+      #   define_index do
+      #     indexes [author.first_name, author.last_name], :as => :author
+      #   end
+      #
+      # The #indexes method is for fields - if you want attributes, use
+      # #has instead. All the same rules apply - but keep in mind that
+      # attributes are for sorting, grouping and filtering, not searching.
+      #
+      #   define_index do
+      #     # fields ...
+      #
+      #     has created_at, updated_at
+      #   end
+      #
+      # One last feature is the delta index. This requires the model to
+      # have a boolean field named 'delta', and is enabled as follows:
+      #
+      #   define_index do
+      #     # fields ...
+      #     # attributes ...
+      #
+      #     set_property :delta => true
+      #   end
+      #
+      # Check out the more detailed documentation for each of these methods
+      # at ThinkingSphinx::Index::Builder.
+      #
+      def define_index(name = nil, &block)
+        self.sphinx_index_blocks ||= []
+        self.sphinx_indexes      ||= []
+        self.sphinx_facets       ||= []
+
+        ThinkingSphinx.context.add_indexed_model self
+
+        if sphinx_index_blocks.empty?
+          before_validation :define_indexes
+          before_destroy    :define_indexes
+        end
+
+        self.sphinx_index_blocks << lambda {
+          add_sphinx_index name, &block
+        }
+
+        #include ThinkingSphinx::ActiveRecord::Scopes
+        #include ThinkingSphinx::SearchMethods
+      end
+
+      def define_indexes
+        superclass.define_indexes unless superclass == ::ActiveRecord::Base
+
+        return if sphinx_index_blocks.nil? ||
+          defined_indexes?                 ||
+          !ThinkingSphinx.define_indexes?
+
+        sphinx_index_blocks.each do |block|
+          block.call
+        end
+
+        self.defined_indexes = true
+
+        # 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
+
+      def add_sphinx_index(name, &block)
+        index = ThinkingSphinx::Index::Builder.generate self, name, &block
+
+        unless sphinx_indexes.any? { |i| i.name == index.name }
+          add_sphinx_callbacks_and_extend(index.delta?)
+          insert_sphinx_index index
+        end
+      end
+
+      def insert_sphinx_index(index)
+        self.sphinx_indexes << index
+        descendants.each { |klass| klass.insert_sphinx_index(index) }
+      end
+
+      def has_sphinx_indexes?
+        sphinx_indexes      &&
+        sphinx_index_blocks &&
+        (sphinx_indexes.length > 0 || sphinx_index_blocks.length > 0)
+      end
+
+      def indexed_by_sphinx?
+        sphinx_indexes && sphinx_indexes.length > 0
+      end
+
+      def delta_indexed_by_sphinx?
+        sphinx_indexes && sphinx_indexes.any? { |index| index.delta? }
+      end
+
+      def sphinx_index_names
+        define_indexes
+        sphinx_indexes.collect(&:all_names).flatten
+      end
+
+      def core_index_names
+        define_indexes
+        sphinx_indexes.collect(&:core_name)
+      end
+
+      def delta_index_names
+        define_indexes
+        sphinx_indexes.select(&:delta?).collect(&:delta_name)
+      end
+
+      def to_riddle
+        define_indexes
+        sphinx_database_adapter.setup
+
+        local_sphinx_indexes.collect { |index|
+          index.to_riddle(sphinx_offset)
+        }.flatten
+      end
+
+      def source_of_sphinx_index
+        define_indexes
+        possible_models = self.sphinx_indexes.collect { |index| index.model }
+        return self if possible_models.include?(self)
+
+        parent = self.superclass
+        while !possible_models.include?(parent) && parent != ::ActiveRecord::Base
+          parent = parent.superclass
+        end
+
+        return parent
+      end
+
+      def delete_in_index(index, document_id)
+        return unless ThinkingSphinx.sphinx_running? &&
+          search_for_id(document_id, index)
+
+        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
+        ThinkingSphinx.context.superclass_indexed_models.
+          index eldest_indexed_ancestor
+      end
+
+      private
+
+      def local_sphinx_indexes
+        sphinx_indexes.select { |index|
+          index.model == self
+        }
+      end
+
+      def add_sphinx_callbacks_and_extend(delta = false)
+        unless indexed_by_sphinx?
+          after_destroy :toggle_deleted
+          #include ThinkingSphinx::ActiveRecord::AttributeUpdates
+        end
+
+        if delta && !delta_indexed_by_sphinx?
+          #include ThinkingSphinx::ActiveRecord::Delta
+          before_save :toggle_delta
+          after_commit :index_delta
+        end
+      end
+
+      def eldest_indexed_ancestor
+        ancestors.reverse.detect { |ancestor|
+          ThinkingSphinx.context.indexed_models.include?(ancestor.name)
+        }.name
+      end
+    end
+
+    attr_accessor :excerpts
+    attr_accessor :sphinx_attributes
+    attr_accessor :matching_fields
+
+    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?
+
+      self.class.core_index_names.each do |index_name|
+        self.class.delete_in_index index_name, self.sphinx_document_id
+      end
+      self.class.delta_index_names.each do |index_name|
+        self.class.delete_in_index index_name, self.sphinx_document_id
+      end if self.class.delta_indexed_by_sphinx? && toggled_delta?
+
+    rescue ::ThinkingSphinx::ConnectionError
+      # 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
+      read_attribute(self.class.primary_key_for_sphinx)
+    end
+
+    def sphinx_document_id
+      primary_key_for_sphinx * ThinkingSphinx.context.indexed_models.size +
+        self.class.sphinx_offset
+    end
+
+    private
+
+    def sphinx_index_name(suffix)
+      "#{self.class.source_of_sphinx_index.name.underscore.tr(':/\\', '_')}_#{suffix}"
+    end
+
+    def define_indexes
+      self.class.define_indexes
+    end
+  end
+end

data/lib/thinking_sphinx/active_record/attribute_updates.rb

@@ -0,0 +1,52 @@
+module ThinkingSphinx
+  module ActiveRecord
+    module AttributeUpdates
+      def self.included(base)
+        base.class_eval do
+          after_save :update_attribute_values
+        end
+      end
+      
+      private
+            
+      def update_attribute_values
+        return true unless ThinkingSphinx.updates_enabled? &&
+          ThinkingSphinx.sphinx_running?
+        
+        self.class.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]
+          }
+          
+          update_index index.core_name, attribute_names, attribute_values
+          next unless index.delta?
+          update_index index.delta_name, attribute_names, attribute_values
+        end
+        
+        true
+      end
+      
+      def updatable_attributes(index)
+        index.attributes.select { |attrib| attrib.updatable? }
+      end
+      
+      def attribute_values_for_index(index)
+        updatable_attributes(index).inject({}) { |hash, attrib|
+          hash[attrib.unique_name.to_s] = attrib.live_value self
+          hash
+        }
+      end
+      
+      def update_index(index_name, attribute_names, attribute_values)
+        config = ThinkingSphinx::Configuration.instance
+        config.client.update index_name, attribute_names, {
+          sphinx_document_id => attribute_values
+        } if in_index?(index_name)
+      rescue Riddle::ConnectionError, ThinkingSphinx::SphinxError
+        # Not the end of the world if Sphinx isn't running.
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/active_record/delta.rb

@@ -0,0 +1,92 @@
+module ThinkingSphinx
+  module ActiveRecord
+    # This module contains all the delta-related code for models. There isn't
+    # really anything you need to call manually in here - except perhaps
+    # index_delta, but not sure what reason why.
+    # 
+    module Delta
+      # Code for after_commit callback is written by Eli Miller:
+      # http://elimiller.blogspot.com/2007/06/proper-cache-expiry-with-aftercommit.html
+      # with slight modification from Joost Hietbrink.
+      #
+      def self.included(base)
+        base.class_eval do
+          class << self
+            # Build the delta index for the related model. This won't be called
+            # if running in the test environment.
+            #
+            def index_delta(instance = nil)
+              delta_objects.each { |obj| obj.index(self, instance) }
+            end
+            
+            def delta_objects
+              self.sphinx_indexes.collect(&:delta_object).compact
+            end
+            
+            # Temporarily disable delta indexing inside a block, then perform a
+            # single rebuild of index at the end.
+            #
+            # Useful when performing updates to batches of models to prevent
+            # the delta index being rebuilt after each individual update.
+            #
+            # In the following example, the delta index will only be rebuilt
+            # once, not 10 times.
+            #
+            #   SomeModel.suspended_delta do
+            #     10.times do
+            #       SomeModel.create( ... )
+            #     end
+            #   end
+            #
+            def suspended_delta(reindex_after = true, &block)
+              define_indexes
+              original_setting = ThinkingSphinx.deltas_suspended?
+              ThinkingSphinx.deltas_suspended = true
+              begin
+                yield
+              ensure
+                ThinkingSphinx.deltas_suspended = original_setting
+                self.index_delta if reindex_after
+              end
+            end
+          end
+          
+          def toggled_delta?
+            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_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_objects.any? { |obj|
+              obj.toggled(self)
+            }
+          end
+          
+          def should_toggle_delta?
+            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
+    end
+  end
+end