warp-thinking-sphinx 1.2.12

data/lib/thinking_sphinx/source/internal_properties.rb

@@ -0,0 +1,46 @@
+module ThinkingSphinx
+  class Source
+    module InternalProperties
+      def add_internal_attributes_and_facets
+        add_internal_attribute :sphinx_internal_id, :integer, @model.primary_key_for_sphinx.to_sym
+        add_internal_attribute :class_crc,          :integer, crc_column, true
+        add_internal_attribute :subclass_crcs,      :multi,   subclasses_to_s
+        add_internal_attribute :sphinx_deleted,     :integer, "0"
+
+        add_internal_facet :class_crc
+      end
+
+      def add_internal_attribute(name, type, contents, facet = false)
+        return unless attribute_by_alias(name).nil?
+
+        Attribute.new(self,
+          ThinkingSphinx::Index::FauxColumn.new(contents),
+          :type   => type,
+          :as     => name,
+          :facet  => facet,
+          :admin  => true
+        )
+      end
+
+      def add_internal_facet(name)
+        return unless facet_by_alias(name).nil?
+
+        @model.sphinx_facets << ClassFacet.new(attribute_by_alias(name))
+      end
+
+      def attribute_by_alias(attr_alias)
+        @attributes.detect { |attrib| attrib.alias == attr_alias }
+      end
+
+      def facet_by_alias(name)
+        @model.sphinx_facets.detect { |facet| facet.name == name }
+      end
+
+      def subclasses_to_s
+        "'" + (@model.send(:subclasses).collect { |klass|
+          klass.to_crc32.to_s
+        } << @model.to_crc32.to_s).join(",") + "'"
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/source/sql.rb

@@ -0,0 +1,127 @@
+module ThinkingSphinx
+  class Source
+    module SQL
+      # Generates the big SQL statement to get the data back for all the fields
+      # and attributes, using all the relevant association joins. If you want
+      # the version filtered for delta values, send through :delta => true in the
+      # options. Won't do much though if the index isn't set up to support a
+      # delta sibling.
+      #
+      # Examples:
+      #
+      #   source.to_sql
+      #   source.to_sql(:delta => true)
+      #
+      def to_sql(options={})
+        sql = <<-SQL
+SELECT #{ sql_select_clause options[:offset] }
+FROM #{ @model.quoted_table_name }
+  #{ all_associations.collect { |assoc| assoc.to_sql }.join(' ') }
+#{ sql_where_clause(options) }
+        SQL
+
+        sql += " ORDER BY NULL" if adapter.sphinx_identifier == "mysql"
+        sql
+      end
+
+      # Simple helper method for the query range SQL - which is a statement that
+      # returns minimum and maximum id values. These can be filtered by delta -
+      # so pass in :delta => true to get the delta version of the SQL.
+      #
+      def to_sql_query_range(options={})
+        return nil if @index.options[:disable_range]
+
+        min_statement = adapter.convert_nulls(
+          "MIN(#{quote_column(@model.primary_key_for_sphinx)})", 1
+        )
+        max_statement = adapter.convert_nulls(
+          "MAX(#{quote_column(@model.primary_key_for_sphinx)})", 1
+        )
+
+        sql = "SELECT #{min_statement}, #{max_statement} " +
+              "FROM #{@model.quoted_table_name} "
+        if self.delta? && !@index.delta_object.clause(@model, options[:delta]).blank?
+          sql << "WHERE #{@index.delta_object.clause(@model, options[:delta])}"
+        end
+
+        sql
+      end
+
+      # Simple helper method for the query info SQL - which is a statement that
+      # returns the single row for a corresponding id.
+      #
+      def to_sql_query_info(offset)
+        "SELECT * FROM #{@model.quoted_table_name} WHERE " +
+        "#{quote_column(@model.primary_key_for_sphinx)} = (($id - #{offset}) / #{ThinkingSphinx.indexed_models.size})"
+      end
+
+      def sql_select_clause(offset)
+        unique_id_expr = ThinkingSphinx.unique_id_expression(offset)
+
+        (
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} #{unique_id_expr} AS #{quote_column(@model.primary_key_for_sphinx)} "] +
+          @fields.collect     { |field|     field.to_select_sql     } +
+          @attributes.collect { |attribute| attribute.to_select_sql }
+        ).compact.join(", ")
+      end
+
+      def sql_where_clause(options)
+        logic = []
+        logic += [
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} >= $start",
+          "#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)} <= $end"
+        ] unless @index.options[:disable_range]
+
+        if self.delta? && !@index.delta_object.clause(@model, options[:delta]).blank?
+          logic << "#{@index.delta_object.clause(@model, options[:delta])}"
+        end
+
+        logic += (@conditions || [])
+        logic.empty? ? "" : "WHERE #{logic.join(' AND ')}"
+      end
+
+      def sql_group_clause
+        internal_groupings = []
+        if @model.column_names.include?(@model.inheritance_column)
+           internal_groupings << "#{@model.quoted_table_name}.#{quote_column(@model.inheritance_column)}"
+        end
+
+        (
+          ["#{@model.quoted_table_name}.#{quote_column(@model.primary_key_for_sphinx)}"] +
+          @fields.collect     { |field|     field.to_group_sql     }.compact +
+          @attributes.collect { |attribute| attribute.to_group_sql }.compact +
+          @groupings + internal_groupings
+        ).join(", ")
+      end
+
+      def sql_query_pre_for_core
+        if self.delta? && !@index.delta_object.reset_query(@model).blank?
+          [@index.delta_object.reset_query(@model)]
+        else
+          []
+        end
+      end
+
+      def sql_query_pre_for_delta
+        [""]
+      end
+
+      def quote_column(column)
+        @model.connection.quote_column_name(column)
+      end
+
+      def crc_column
+        if @model.table_exists? &&
+          @model.column_names.include?(@model.inheritance_column)
+
+          adapter.cast_to_unsigned(adapter.convert_nulls(
+            adapter.crc(adapter.quote_with_table(@model.inheritance_column), true),
+            @model.to_crc32
+          ))
+        else
+          @model.to_crc32.to_s
+        end
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/tasks.rb

@@ -0,0 +1,165 @@
+require 'fileutils'
+
+namespace :thinking_sphinx do
+  task :app_env do
+    if defined?(RAILS_ROOT)
+      Rake::Task[:environment].invoke
+      Rails.configuration.cache_classes = false
+    end
+    
+    Rake::Task[:merb_env].invoke    if defined?(Merb)
+  end
+  
+  desc "Output the current Thinking Sphinx version"
+  task :version => :app_env do
+    puts "Thinking Sphinx v" + ThinkingSphinx.version
+  end
+  
+  desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :running_start => :app_env do
+    Rake::Task["thinking_sphinx:stop"].invoke if sphinx_running?
+    Rake::Task["thinking_sphinx:start"].invoke
+  end
+  
+  desc "Start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :start => :app_env do
+    config = ThinkingSphinx::Configuration.instance
+    
+    FileUtils.mkdir_p config.searchd_file_path
+    raise RuntimeError, "searchd is already running." if sphinx_running?
+    
+    Dir["#{config.searchd_file_path}/*.spl"].each { |file| File.delete(file) }
+
+    system! "#{config.bin_path}#{config.searchd_binary_name} --pidfile --config \"#{config.config_file}\""
+    
+    sleep(2)
+    
+    if sphinx_running?
+      puts "Started successfully (pid #{sphinx_pid})."
+    else
+      puts "Failed to start searchd daemon. Check #{config.searchd_log_file}"
+    end
+  end
+  
+  desc "Stop Sphinx using Thinking Sphinx's settings"
+  task :stop => :app_env do
+    unless sphinx_running?
+      puts "searchd is not running"
+    else
+      config = ThinkingSphinx::Configuration.instance
+      pid    = sphinx_pid
+      system! "#{config.bin_path}#{config.searchd_binary_name} --stop --config \"#{config.config_file}\""
+      puts "Stopped search daemon (pid #{pid})."
+    end
+  end
+  
+  desc "Restart Sphinx"
+  task :restart => [:app_env, :stop, :start]
+  
+  desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
+  task :configure => :app_env do
+    config = ThinkingSphinx::Configuration.instance
+    puts "Generating Configuration to #{config.config_file}"
+    config.build
+  end
+  
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :index => :app_env do
+    ThinkingSphinx::Deltas::Job.cancel_thinking_sphinx_jobs
+    
+    config = ThinkingSphinx::Configuration.instance
+    unless ENV["INDEX_ONLY"] == "true"
+      puts "Generating Configuration to #{config.config_file}"
+      config.build
+    end
+        
+    FileUtils.mkdir_p config.searchd_file_path
+    cmd = "#{config.bin_path}#{config.indexer_binary_name} --config \"#{config.config_file}\" --all"
+    cmd << " --rotate" if sphinx_running?
+    
+    system! cmd
+  end
+  
+  desc "Stop Sphinx (if it's running), rebuild the indexes, and start Sphinx"
+  task :rebuild => :app_env do
+    Rake::Task["thinking_sphinx:stop"].invoke if sphinx_running?
+    Rake::Task["thinking_sphinx:index"].invoke
+    Rake::Task["thinking_sphinx:start"].invoke
+  end
+  
+  namespace :index do
+    task :delta => :app_env do
+      ThinkingSphinx.indexed_models.select { |model|
+        model.constantize.sphinx_indexes.any? { |index| index.delta? }
+      }.each do |model|
+        model.constantize.sphinx_indexes.select { |index|
+          index.delta? && index.delta_object.respond_to?(:delayed_index)
+        }.each { |index|
+          index.delta_object.delayed_index(index.model)
+        }
+      end
+    end
+  end
+  
+  desc "Process stored delta index requests"
+  task :delayed_delta => :app_env do
+    require 'delayed/worker'
+    
+    Delayed::Worker.new(
+      :min_priority => ENV['MIN_PRIORITY'],
+      :max_priority => ENV['MAX_PRIORITY']
+    ).start
+  end
+end
+
+namespace :ts do
+  desc "Output the current Thinking Sphinx version"
+  task :version => "thinking_sphinx:version"
+  desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :run     => "thinking_sphinx:running_start"
+  desc "Start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :start   => "thinking_sphinx:start"
+  desc "Stop Sphinx using Thinking Sphinx's settings"
+  task :stop    => "thinking_sphinx:stop"
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :in      => "thinking_sphinx:index"
+  namespace :in do
+    desc "Index Thinking Sphinx datetime delta indexes"
+    task :delta => "thinking_sphinx:index:delta"
+  end
+  task :index   => "thinking_sphinx:index"
+  desc "Restart Sphinx"
+  task :restart => "thinking_sphinx:restart"
+  desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
+  task :conf    => "thinking_sphinx:configure"
+  desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
+  task :config  => "thinking_sphinx:configure"
+  desc "Stop Sphinx (if it's running), rebuild the indexes, and start Sphinx"
+  task :rebuild => "thinking_sphinx:rebuild"
+  desc "Process stored delta index requests"
+  task :dd      => "thinking_sphinx:delayed_delta"
+end
+
+def sphinx_pid
+  ThinkingSphinx.sphinx_pid
+end
+
+def sphinx_running?
+  ThinkingSphinx.sphinx_running?
+end
+
+# a fail-fast, hopefully helpful version of system
+def system!(cmd)
+  unless system(cmd)
+    raise <<-SYSTEM_CALL_FAILED
+The following command failed:
+  #{cmd}
+
+This could be caused by a PATH issue in the environment of cron/passenger/etc. Your current PATH:
+  #{ENV['PATH']}
+You can set the path to your indexer and searchd binaries using the bin_path property in config/sphinx.yml:
+  production:
+    bin_path: '/usr/local/bin'
+SYSTEM_CALL_FAILED
+  end
+end

data/rails/init.rb

@@ -0,0 +1,14 @@
+require 'thinking_sphinx'
+require 'action_controller/dispatcher'
+
+ActionController::Dispatcher.to_prepare :thinking_sphinx do
+  # Force internationalisation to be loaded.
+  if Rails::VERSION::STRING.to_f > 2.2
+    I18n.backend.reload!
+    I18n.backend.available_locales
+  elsif Rails::VERSION::STRING.to_f > 2.1
+    I18n.backend.load_translations(*I18n.load_path)
+  end
+  
+  ThinkingSphinx::Configuration.instance.load_models
+end

data/spec/lib/thinking_sphinx/active_record/delta_spec.rb

@@ -0,0 +1,130 @@
+require 'spec/spec_helper'
+
+describe "ThinkingSphinx::ActiveRecord::Delta" do
+  it "should call the toggle_delta method after a save" do
+    @beta = Beta.new(:name => 'beta')
+    @beta.should_receive(:toggle_delta).and_return(true)
+    
+    @beta.save
+  end
+  
+  it "should call the toggle_delta method after a save!" do
+    @beta = Beta.new(:name => 'beta')
+    @beta.should_receive(:toggle_delta).and_return(true)
+    
+    @beta.save!
+  end
+  
+  describe "suspended_delta method" do
+    before :each do
+      ThinkingSphinx.deltas_enabled = true
+      Person.sphinx_indexes.first.delta_object.stub!(:` => "")
+    end
+
+    it "should execute the argument block with deltas disabled" do
+      ThinkingSphinx.should_receive(:deltas_enabled=).once.with(false)
+      ThinkingSphinx.should_receive(:deltas_enabled=).once.with(true)
+      lambda { Person.suspended_delta { raise 'i was called' } }.should(
+        raise_error(Exception)
+      )
+    end
+
+    it "should restore deltas_enabled to its original setting" do
+      ThinkingSphinx.deltas_enabled = false
+      ThinkingSphinx.should_receive(:deltas_enabled=).twice.with(false)
+      Person.suspended_delta { 'no-op' }
+    end
+
+    it "should restore deltas_enabled to its original setting even if there was an exception" do
+      ThinkingSphinx.deltas_enabled = false
+      ThinkingSphinx.should_receive(:deltas_enabled=).twice.with(false)
+      lambda { Person.suspended_delta { raise 'bad error' } }.should(
+        raise_error(Exception)
+      )
+    end
+
+    it "should reindex by default after the code block is run" do
+      Person.should_receive(:index_delta)
+      Person.suspended_delta { 'no-op' }
+    end
+    
+    it "should not reindex after the code block if false is passed in" do
+      Person.should_not_receive(:index_delta)
+      Person.suspended_delta(false) { 'no-op' }
+    end
+  end
+  
+  describe "toggle_delta method" do
+    it "should set the delta value to true" do
+      @person = Person.new
+      
+      @person.delta.should be_false
+      @person.send(:toggle_delta)
+      @person.delta.should be_true
+    end
+  end
+  
+  describe "index_delta method" do
+    before :each do
+      ThinkingSphinx::Configuration.stub!(:environment => "spec")
+      ThinkingSphinx.deltas_enabled   = true
+      ThinkingSphinx.updates_enabled  = true
+      ThinkingSphinx.stub!(:sphinx_running? => true)
+      Person.delta_object.stub!(:` => "", :toggled => true)
+      
+      @person = Person.new
+      @person.stub!(
+        :in_both_indexes?     => false,
+        :sphinx_document_id => 1
+      )
+      
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
+      Riddle::Client.stub!(:new => @client)
+    end
+    
+    it "shouldn't index if delta indexing is disabled" do
+      ThinkingSphinx.deltas_enabled = false
+      Person.sphinx_indexes.first.delta_object.should_not_receive(:`)
+      @client.should_not_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+    
+    it "shouldn't index if index updating is disabled" do
+      ThinkingSphinx.updates_enabled = false
+      Person.sphinx_indexes.first.delta_object.should_not_receive(:`)
+      
+      @person.send(:index_delta)
+    end
+    
+    it "shouldn't index if the environment is 'test'" do
+      ThinkingSphinx.deltas_enabled = nil
+      ThinkingSphinx::Configuration.stub!(:environment => "test")
+      Person.sphinx_indexes.first.delta_object.should_not_receive(:`)
+      
+      @person.send(:index_delta)
+    end
+    
+    it "should call indexer for the delta index" do
+      Person.sphinx_indexes.first.delta_object.should_receive(:`).with(
+        "#{ThinkingSphinx::Configuration.instance.bin_path}indexer --config #{ThinkingSphinx::Configuration.instance.config_file} --rotate person_delta"
+      )
+      
+      @person.send(:index_delta)
+    end
+    
+    it "shouldn't update the deleted attribute if not in the index" do
+      @client.should_not_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+    
+    it "should update the deleted attribute if in the core index" do
+      @person.stub!(:in_both_indexes? => true)
+      @client.should_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+  end
+end