ebeigarts-thinking-sphinx 1.1.21

data/lib/thinking_sphinx/tasks.rb

@@ -0,0 +1,245 @@
+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::String
+  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
+    raise RuntimeError, "searchd is not running." unless sphinx_running?
+    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
+  
+  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
+  
+  # http://www.sphinxsearch.com/docs/current.html#xmlpipe2
+  desc "Streams XML data to STDOUT"
+  task :xml => :app_env do
+    source_name = ENV["NAME"]
+    # STDERR.puts "Source name: #{source_name}"
+    source_name =~ /^(.+)_(delta|core)_(\d+)$/
+    sphinx_name = $1
+    index_name  = "#{$1}_#{$2}"
+    offset      = ENV["OFFSET"]
+    model_name  = ThinkingSphinx.indexed_models.detect { |s| s.constantize.send(:sphinx_name) == sphinx_name }
+    # STDERR.puts "Model name: #{model_name}"
+    model_klass = model_name.constantize
+    
+    # Do not use xml type in rake task
+    ThinkingSphinx::Configuration.instance.type = "sql"
+    
+    # Get TS index configuration
+    index_configuration = model_klass.to_riddle(offset).detect { |c| c.name == index_name }
+    source = index_configuration.sources.first
+    
+    # get $start, $end
+    # STDERR.puts source.sql_query_range
+    range_start, range_end = model_klass.connection.select_rows(source.sql_query_range).first.collect(&:to_i)
+    query = source.sql_query.gsub('$start', range_start.to_s).gsub('$end', range_end.to_s)
+    
+    # fetch sql and generate xml
+    puts %{<?xml version="1.0" encoding="utf-8"?>}
+    puts %{<sphinx:docset>}
+    
+    # results = model_klass.connection.select_all(query)
+    # STDERR.puts "fetching #{start_id}.. "
+    # STDERR.puts query
+    model_klass.sphinx_database_adapter.select_each(query) do |values|
+      id = values.delete "id"
+      puts %{<sphinx:document id="#{id.to_i}">}
+      values.each do |k, v|
+        if source.sql_attr_bool.include?(k.to_sym)
+          v = ['Y', 'T', '1', 1, true].include?(v) ? 1 : 0
+        elsif source.sql_attr_uint.include?(k.to_sym) ||
+              source.sql_attr_timestamp.include?(k.to_sym)
+          v = v.to_i
+        elsif source.sql_attr_float.include?(k.to_sym)
+          v = v.to_f
+        else
+          v = value_to_string(v)
+          v = %{<![CDATA[[#{v}]]>}
+        end
+        puts %{<#{k}>#{v}</#{k}>}
+      end
+      # Add MVA attributes (:ranged_query, :query)
+      internal_id = values["sphinx_internal_id"]
+      source.sql_attr_multi.each do |params|
+        # STDERR.puts "MVA_ATTRS: #{params.inspect}"
+        mva_definition, mva_query, mva_query_range = params.split(";")
+        k = mva_definition.split(" ")[1]
+        if mva_query
+          mva_query = mva_query.gsub('$start', internal_id.to_s).gsub('$end', internal_id.to_s)
+          printf %{<#{k}>}
+          not_first = false
+          model_klass.sphinx_database_adapter.select_each(mva_query) do |values|
+            if not_first
+              printf ","
+            else
+              not_first = true
+            end
+            printf values.values.first.to_s
+          end
+          puts %{</#{k}>}
+        end
+      end
+      puts %{</sphinx:document>}
+    end
+    
+    puts %{</sphinx:docset>}
+  end
+  
+  # try to remove invalid xml characters
+  def value_to_string(v)
+    v.is_a?(String) ? v.gsub("\000", '') : v
+  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"
+  desc "Streams XML data to STDOUT"
+  task :xml => "thinking_sphinx:xml"
+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/unit/thinking_sphinx/active_record/delta_spec.rb

@@ -0,0 +1,136 @@
+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.stub_method(:toggle_delta => true)
+    
+    @beta.save
+    
+    @beta.should have_received(:toggle_delta)
+  end
+  
+  it "should call the toggle_delta method after a save!" do
+    @beta = Beta.new(:name => 'beta')
+    @beta.stub_method(:toggle_delta => true)
+    
+    @beta.save!
+    
+    @beta.should have_received(:toggle_delta)
+  end
+
+  describe "suspended_delta method" do
+    before :each do
+      ThinkingSphinx.stub_method(:deltas_enabled? => true)
+      Person.sphinx_indexes.first.delta_object.stub_method(:` => "")
+    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.stub_method(: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.stub_method(: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_method(:environment => "spec")
+      ThinkingSphinx.stub_method(:deltas_enabled? => true, :sphinx_running? => true)
+      Person.delta_object.stub_methods(:` => "", :toggled => true)
+      
+      @person = Person.new
+      @person.stub_method(
+        :in_both_indexes?     => false,
+        :sphinx_document_id => 1
+      )
+      
+      @client = Riddle::Client.new
+      @client.stub!(:update => true)
+      Riddle::Client.stub_method(:new => @client)
+    end
+    
+    it "shouldn't index if delta indexing is disabled" do
+      ThinkingSphinx.stub_method(:deltas_enabled? => false)
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+      @client.should_not have_received(:update)
+    end
+    
+    it "shouldn't index if index updating is disabled" do
+      ThinkingSphinx.stub_method(:updates_enabled? => false)
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+    end
+    
+    it "shouldn't index if the environment is 'test'" do
+      ThinkingSphinx.unstub_method(:deltas_enabled?)
+      ThinkingSphinx.deltas_enabled = nil
+      ThinkingSphinx::Configuration.stub_method(:environment => "test")
+      
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should_not have_received(:`)
+    end
+    
+    it "should call indexer for the delta index" do
+      @person.send(:index_delta)
+      
+      Person.sphinx_indexes.first.delta_object.should have_received(:`).with(
+        "#{ThinkingSphinx::Configuration.instance.bin_path}indexer --config #{ThinkingSphinx::Configuration.instance.config_file} --rotate person_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_method(:in_both_indexes? => true)
+      @client.should_receive(:update)
+      
+      @person.send(:index_delta)
+    end
+  end
+end

data/spec/unit/thinking_sphinx/active_record/has_many_association_spec.rb

@@ -0,0 +1,53 @@
+require 'spec/spec_helper'
+
+describe 'ThinkingSphinx::ActiveRecord::HasManyAssociation' do
+  describe "search method" do
+    before :each do
+      Friendship.stub_method(:search => true)
+      
+      @person = Person.find(:first)
+      @index  = Friendship.sphinx_indexes.first
+    end
+    
+    it "should raise an error if the required attribute doesn't exist" do
+      @index.stub_method(:attributes => [])
+      
+      lambda { @person.friendships.search "test" }.should raise_error(RuntimeError)
+      
+      @index.unstub_method(:attributes)
+    end
+    
+    it "should add a filter for the attribute into a normal search call" do
+      @person.friendships.search "test"
+      
+      Friendship.should have_received(:search).with(
+        "test", :with => {:person_id => @person.id}
+      )
+    end    
+  end
+  
+  describe "search method for has_many :through" do
+    before :each do
+      Person.stub_method(:search => true)
+      
+      @person = Person.find(:first)
+      @index  = Person.sphinx_indexes.first
+    end
+    
+    it "should raise an error if the required attribute doesn't exist" do
+      @index.stub_method(:attributes => [])
+      
+      lambda { @person.friends.search "test" }.should raise_error(RuntimeError)
+      
+      @index.unstub_method(:attributes)
+    end
+    
+    it "should add a filter for the attribute into a normal search call" do
+      @person.friends.search "test"
+      
+      Person.should have_received(:search).with(
+        "test", :with => {:friendly_ids => @person.id}
+      )
+    end
+  end
+end