thinking-sphinx 1.2.12

data/lib/thinking_sphinx/core/array.rb

@@ -0,0 +1,7 @@
+module SearchAsArray
+  def ===(object)
+    object.is_a?(ThinkingSphinx::Search) || super
+  end
+end
+
+Array.extend SearchAsArray

data/lib/thinking_sphinx/core/string.rb

@@ -0,0 +1,15 @@
+require 'zlib'
+
+module ThinkingSphinx
+  module Core
+    module String
+      def to_crc32
+        Zlib.crc32 self
+      end
+    end
+  end
+end
+
+class String
+  include ThinkingSphinx::Core::String
+end

data/lib/thinking_sphinx/deltas.rb

@@ -0,0 +1,30 @@
+require 'thinking_sphinx/deltas/default_delta'
+require 'thinking_sphinx/deltas/delayed_delta'
+require 'thinking_sphinx/deltas/datetime_delta'
+
+module ThinkingSphinx
+  module Deltas
+    def self.parse(index)
+      delta_option = index.local_options.delete(:delta)
+      case delta_option
+      when TrueClass, :default
+        DefaultDelta.new index, index.local_options
+      when :delayed
+        DelayedDelta.new index, index.local_options
+      when :datetime
+        DatetimeDelta.new index, index.local_options
+      when FalseClass, nil
+        nil
+      else
+        if delta_option.is_a?(String)
+          delta_option = Kernel.const_get(delta_option)
+        end
+        if delta_option.ancestors.include?(ThinkingSphinx::Deltas::DefaultDelta)
+          delta_option.new index, index.local_options
+        else
+          raise "Unknown delta type"
+        end
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/datetime_delta.rb

@@ -0,0 +1,50 @@
+module ThinkingSphinx
+  module Deltas
+    class DatetimeDelta < ThinkingSphinx::Deltas::DefaultDelta
+      attr_accessor :column, :threshold
+      
+      def initialize(index, options)
+        @index      = index
+        @column     = options.delete(:delta_column) || :updated_at
+        @threshold  = options.delete(:threshold)    || 1.day
+      end
+      
+      def index(model, instance = nil)
+        # do nothing
+        true
+      end
+      
+      def delayed_index(model)
+        config = ThinkingSphinx::Configuration.instance
+        rotate = ThinkingSphinx.sphinx_running? ? "--rotate" : ""
+        
+        output = `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} #{rotate} #{delta_index_name model}`
+        output += `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} #{rotate} --merge #{core_index_name model} #{delta_index_name model} --merge-dst-range sphinx_deleted 0 0`
+        puts output unless ThinkingSphinx.suppress_delta_output?
+        
+        true
+      end
+            
+      def toggle(instance)
+        # do nothing
+      end
+      
+      def toggled(instance)
+        instance.send(@column) > @threshold.ago
+      end
+      
+      def reset_query(model)
+        nil
+      end
+      
+      def clause(model, toggled)
+        if toggled
+          "#{model.quoted_table_name}.#{model.connection.quote_column_name(@column.to_s)}" +
+          " > #{adapter.time_difference(@threshold)}"
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/default_delta.rb

@@ -0,0 +1,68 @@
+module ThinkingSphinx
+  module Deltas
+    class DefaultDelta
+      attr_accessor :column
+      
+      def initialize(index, options)
+        @index  = index
+        @column = options.delete(:delta_column) || :delta
+      end
+      
+      def index(model, instance = nil)
+        return true unless ThinkingSphinx.updates_enabled? &&
+          ThinkingSphinx.deltas_enabled?
+        return true if instance && !toggled(instance)
+        
+        config = ThinkingSphinx::Configuration.instance
+        client = Riddle::Client.new config.address, config.port
+        rotate = ThinkingSphinx.sphinx_running? ? "--rotate" : ""
+        
+        output = `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} #{rotate} #{delta_index_name model}`
+        puts(output) unless ThinkingSphinx.suppress_delta_output?
+        
+        client.update(
+          core_index_name(model),
+          ['sphinx_deleted'],
+          {instance.sphinx_document_id => [1]}
+        ) if instance && ThinkingSphinx.sphinx_running? && instance.in_both_indexes?
+        
+        true
+      end
+      
+      def toggle(instance)
+        instance.delta = true
+      end
+      
+      def toggled(instance)
+        instance.delta
+      end
+      
+      def reset_query(model)
+        "UPDATE #{model.quoted_table_name} SET " +
+        "#{model.connection.quote_column_name(@column.to_s)} = #{adapter.boolean(false)} " +
+        "WHERE #{model.connection.quote_column_name(@column.to_s)} = #{adapter.boolean(true)}"
+      end
+      
+      def clause(model, toggled)
+        "#{model.quoted_table_name}.#{model.connection.quote_column_name(@column.to_s)}" +
+        " = #{adapter.boolean(toggled)}"
+      end
+      
+      protected
+      
+      def core_index_name(model)
+        "#{model.source_of_sphinx_index.name.underscore.tr(':/\\', '_')}_core"
+      end
+      
+      def delta_index_name(model)
+        "#{model.source_of_sphinx_index.name.underscore.tr(':/\\', '_')}_delta"
+      end  
+      
+      private
+      
+      def adapter
+        @adapter = @index.model.sphinx_database_adapter
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/delayed_delta.rb

@@ -0,0 +1,30 @@
+require 'delayed/job'
+
+require 'thinking_sphinx/deltas/delayed_delta/delta_job'
+require 'thinking_sphinx/deltas/delayed_delta/flag_as_deleted_job'
+require 'thinking_sphinx/deltas/delayed_delta/job'
+
+module ThinkingSphinx
+  module Deltas
+    class DelayedDelta < ThinkingSphinx::Deltas::DefaultDelta
+      def index(model, instance = nil)
+        return true unless ThinkingSphinx.updates_enabled? && ThinkingSphinx.deltas_enabled?
+        return true if instance && !toggled(instance)
+      
+        ThinkingSphinx::Deltas::Job.enqueue(
+          ThinkingSphinx::Deltas::DeltaJob.new(delta_index_name(model)),
+          ThinkingSphinx::Configuration.instance.delayed_job_priority
+        )
+        
+        Delayed::Job.enqueue(
+          ThinkingSphinx::Deltas::FlagAsDeletedJob.new(
+            core_index_name(model), instance.sphinx_document_id
+          ),
+          ThinkingSphinx::Configuration.instance.delayed_job_priority
+        ) if instance
+        
+        true
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/delayed_delta/delta_job.rb

@@ -0,0 +1,24 @@
+module ThinkingSphinx
+  module Deltas
+    class DeltaJob
+      attr_accessor :index
+      
+      def initialize(index)
+        @index = index
+      end
+      
+      def perform
+        return true unless ThinkingSphinx.updates_enabled? &&
+          ThinkingSphinx.deltas_enabled?
+        
+        config = ThinkingSphinx::Configuration.instance
+        client = Riddle::Client.new config.address, config.port
+        
+        output = `#{config.bin_path}#{config.indexer_binary_name} --config #{config.config_file} --rotate #{index}`
+        puts output unless ThinkingSphinx.suppress_delta_output?
+        
+        true
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/delayed_delta/flag_as_deleted_job.rb

@@ -0,0 +1,27 @@
+module ThinkingSphinx
+  module Deltas
+    class FlagAsDeletedJob
+      attr_accessor :index, :document_id
+      
+      def initialize(index, document_id)
+        @index, @document_id = index, document_id
+      end
+      
+      def perform
+        return true unless ThinkingSphinx.updates_enabled?
+        
+        config = ThinkingSphinx::Configuration.instance
+        client = Riddle::Client.new config.address, config.port
+        
+        client.update(
+          @index,
+          ['sphinx_deleted'],
+          {@document_id => [1]}
+        ) if ThinkingSphinx.sphinx_running? &&
+          ThinkingSphinx::Search.search_for_id(@document_id, @index)
+        
+        true
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deltas/delayed_delta/job.rb

@@ -0,0 +1,26 @@
+module ThinkingSphinx
+  module Deltas
+    class Job < Delayed::Job
+      def self.enqueue(object, priority = 0)
+        super unless duplicates_exist(object)
+      end
+      
+      def self.cancel_thinking_sphinx_jobs
+        if connection.tables.include?("delayed_jobs")
+          delete_all("handler LIKE '--- !ruby/object:ThinkingSphinx::Deltas::%'")
+        end
+      end
+
+      private
+
+      def self.duplicates_exist(object)
+        count(
+          :conditions => {
+            :handler    => object.to_yaml,
+            :locked_at  => nil
+          }
+        ) > 0
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/deploy/capistrano.rb

@@ -0,0 +1,100 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :thinking_sphinx do
+    namespace :install do
+      desc <<-DESC
+        Install Sphinx by source
+        
+        If Postgres is available, Sphinx will use it.
+        
+        If the variable :thinking_sphinx_configure_args is set, it will
+        be passed to the Sphinx configure script. You can use this to
+        install Sphinx in a non-standard location:
+        
+          set :thinking_sphinx_configure_args, "--prefix=$HOME/software"
+DESC
+
+      task :sphinx do
+        with_postgres = false
+        begin
+          run "which pg_config" do |channel, stream, data|
+            with_postgres = !(data.nil? || data == "")
+          end
+        rescue Capistrano::CommandError => e
+          puts "Continuing despite error: #{e.message}"
+        end
+      
+        args = []
+        if with_postgres
+          run "pg_config --pkgincludedir" do |channel, stream, data|
+            args << "--with-pgsql=#{data}"
+          end
+        end
+        args << fetch(:thinking_sphinx_configure_args, '')
+        
+        commands = <<-CMD
+        wget -q http://www.sphinxsearch.com/downloads/sphinx-0.9.8.1.tar.gz >> sphinx.log
+        tar xzvf sphinx-0.9.8.1.tar.gz
+        cd sphinx-0.9.8.1
+        ./configure #{args.join(" ")}
+        make
+        #{try_sudo} make install
+        rm -rf sphinx-0.9.8.1 sphinx-0.9.8.1.tar.gz
+        CMD
+        run commands.split(/\n\s+/).join(" && ")
+      end
+    
+      desc "Install Thinking Sphinx as a gem from GitHub"
+      task :ts do
+        run "#{try_sudo} gem install thinking-sphinx --source http://gemcutter.org"
+      end
+    end
+  
+    desc "Generate the Sphinx configuration file"
+    task :configure do
+      rake "thinking_sphinx:configure"
+    end
+  
+    desc "Index data"
+    task :index do
+      rake "thinking_sphinx:index"
+    end
+  
+    desc "Start the Sphinx daemon"
+    task :start do
+      configure
+      rake "thinking_sphinx:start"
+    end
+  
+    desc "Stop the Sphinx daemon"
+    task :stop do
+      configure
+      rake "thinking_sphinx:stop"
+    end
+  
+    desc "Stop and then start the Sphinx daemon"
+    task :restart do
+      stop
+      start
+    end
+  
+    desc "Stop, re-index and then start the Sphinx daemon"
+    task :rebuild do
+      stop
+      index
+      start
+    end
+  
+    desc "Add the shared folder for sphinx files for the production environment"
+    task :shared_sphinx_folder, :roles => :web do
+      run "mkdir -p #{shared_path}/db/sphinx/production"
+    end
+
+    def rake(*tasks)
+      rails_env = fetch(:rails_env, "production")
+      rake = fetch(:rake, "rake")
+      tasks.each do |t|
+        run "cd #{current_path}; #{rake} RAILS_ENV=#{rails_env} #{t}"
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/excerpter.rb

@@ -0,0 +1,22 @@
+module ThinkingSphinx
+  class Excerpter
+    CoreMethods = %w( kind_of? object_id respond_to? should should_not stub! )
+    # Hide most methods, to allow them to be passed through to the instance.
+    instance_methods.select { |method|
+      method.to_s[/^__/].nil? && !CoreMethods.include?(method.to_s)
+    }.each { |method|
+      undef_method method
+    }
+    
+    def initialize(search, instance)
+      @search   = search
+      @instance = instance
+    end
+    
+    def method_missing(method, *args, &block)
+      string = @instance.send(method, *args, &block).to_s
+      
+      @search.excerpt_for(string, @instance.class)
+    end
+  end
+end

data/lib/thinking_sphinx/facet.rb

@@ -0,0 +1,125 @@
+module ThinkingSphinx
+  class Facet
+    attr_reader :property
+    
+    def initialize(property)
+      @property = property
+      
+      if property.columns.length != 1
+        raise "Can't translate Facets on multiple-column field or attribute"
+      end
+    end
+
+    def self.name_for(facet)
+      case facet
+      when Facet
+        facet.name
+      when String, Symbol
+        facet.to_s.gsub(/(_facet|_crc)$/,'').to_sym
+      end
+    end
+    
+    def self.attribute_name_for(name)
+      name.to_s == 'class' ? 'class_crc' : "#{name}_facet"
+    end
+    
+    def self.attribute_name_from_value(name, value)
+      case value
+      when String
+        attribute_name_for(name)
+      when Array
+        if value.all? { |val| val.is_a?(Integer) }
+          name
+        else
+          attribute_name_for(name)
+        end
+      else
+        name
+      end
+    end
+    
+    def self.translate?(property)
+      return true if property.is_a?(Field)
+      
+      case property.type
+      when :string
+        true
+      when :integer, :boolean, :datetime, :float
+        false
+      when :multi
+        !property.all_ints?
+      end
+    end
+    
+    def name
+      property.unique_name
+    end
+    
+    def attribute_name
+      if translate?
+        Facet.attribute_name_for(@property.unique_name)
+      else
+        @property.unique_name.to_s
+      end
+    end
+    
+    def translate?
+      Facet.translate?(@property)
+    end
+    
+    def type
+      @property.is_a?(Field) ? :string : @property.type
+    end
+    
+    def value(object, attribute_value)
+      return translate(object, attribute_value) if translate? || float?
+      
+      case @property.type
+      when :datetime
+        Time.at(attribute_value)
+      when :boolean
+        attribute_value > 0
+      else
+        attribute_value
+      end
+    end
+    
+    def to_s
+      name
+    end
+    
+    private
+    
+    def translate(object, attribute_value)
+      objects = source_objects(object)
+      return nil if objects.nil? || objects.empty?
+      
+      if objects.length > 1
+        objects.collect { |item| item.send(column.__name) }.detect { |item|
+          item.to_crc32 == attribute_value
+        }
+      else
+        objects.first.send(column.__name)
+      end
+    end
+    
+    def source_objects(object)
+      column.__stack.each { |method|
+        object = Array(object).collect { |item|
+          item.send(method)
+        }.flatten.compact
+        
+        return nil if object.empty?
+      }
+      Array(object)
+    end
+    
+    def column
+      @property.columns.first
+    end
+    
+    def float?
+      @property.type == :float
+    end
+  end
+end