thinking-sphinx 3.2.0 → 3.3.0

data/lib/thinking_sphinx/middlewares/active_record_translator.rb

@@ -1,6 +1,8 @@
 class ThinkingSphinx::Middlewares::ActiveRecordTranslator <
   ThinkingSphinx::Middlewares::Middleware
 
+  NO_MODEL = Struct.new(:primary_key).new(:id).freeze
+
   def call(contexts)
     contexts.each do |context|
       Inner.new(context).call
@@ -42,6 +44,16 @@ class ThinkingSphinx::Middlewares::ActiveRecordTranslator <
       }.uniq
     end
 
+    def primary_key
+      @primary_key ||= primary_key_for NO_MODEL
+    end
+
+    def primary_key_for(model)
+      model = NO_MODEL unless model.respond_to?(:primary_key)
+
+      context.configuration.settings['primary_key'] || model.primary_key || :id
+    end
+
     def reset_memos
       @model_names        = nil
       @results_for_models = nil
@@ -49,7 +61,7 @@ class ThinkingSphinx::Middlewares::ActiveRecordTranslator <
 
     def result_for(row)
       results_for_models[row['sphinx_internal_class']].detect { |record|
-        record.id == row['sphinx_internal_id']
+        record.public_send(primary_key) == row['sphinx_internal_id']
       }
     end
 
@@ -57,7 +69,7 @@ class ThinkingSphinx::Middlewares::ActiveRecordTranslator <
       @results_for_models ||= model_names.inject({}) do |hash, name|
         model = name.constantize
         hash[name] = model_relation_with_sql_options(model.unscoped).where(
-          (context.configuration.settings[:primary_key] || model.primary_key || :id) => ids_for_model(name)
+          primary_key_for(model) => ids_for_model(name)
         )
 
         hash

data/lib/thinking_sphinx/railtie.rb

@@ -1,6 +1,6 @@
 class ThinkingSphinx::Railtie < Rails::Railtie
   initializer 'thinking_sphinx.initialisation' do
-    if defined?(ActiveRecord::Base)
+    ActiveSupport.on_load(:active_record) do
       ActiveRecord::Base.send :include, ThinkingSphinx::ActiveRecord::Base
     end
   end

data/lib/thinking_sphinx/rake_interface.rb

@@ -1,4 +1,9 @@
 class ThinkingSphinx::RakeInterface
+  def initialize(options = {})
+    @options           = options
+    @options[:verbose] = false if @options[:silent]
+  end
+
   def clear_all
     [
       configuration.indices_location,
@@ -9,6 +14,7 @@ class ThinkingSphinx::RakeInterface
   end
 
   def clear_real_time
+    configuration.preload_indices
     indices = configuration.indices.select { |index| index.type == 'rt' }
     indices.each do |index|
       index.render
@@ -20,7 +26,7 @@ class ThinkingSphinx::RakeInterface
   end
 
   def configure
-    puts "Generating configuration to #{configuration.configuration_file}"
+    log "Generating configuration to #{configuration.configuration_file}"
     configuration.render_to_file
   end
 
@@ -36,6 +42,8 @@ class ThinkingSphinx::RakeInterface
     FileUtils.mkdir_p configuration.indices_location
     ThinkingSphinx.before_index_hooks.each { |hook| hook.call }
     controller.index :verbose => verbose
+  rescue Riddle::CommandFailedError => error
+    handle_command_failure 'indexing', error.command_result
   end
 
   def prepare
@@ -45,30 +53,18 @@ class ThinkingSphinx::RakeInterface
     FileUtils.mkdir_p configuration.indices_location
   end
 
-  def start(options={})
-    raise RuntimeError, 'searchd is already running' if controller.running?
+  def start
+    if running?
+      raise ThinkingSphinx::SphinxAlreadyRunning, 'searchd is already running'
+    end
 
     FileUtils.mkdir_p configuration.indices_location
 
-    if options[:nodetach]
-      unless pid = fork
-        controller.start(options)
-      end
-      Signal.trap('TERM') { Process.kill(:TERM, pid); }
-      Signal.trap('INT')  { Process.kill(:TERM, pid); }
-      Process.wait(pid)
-    else
-      controller.start(options)
-      if controller.running?
-        puts "Started searchd successfully (pid: #{controller.pid})."
-      else
-        puts "Failed to start searchd. Check the log files for more information."
-      end
-    end
+    options[:nodetach] ? start_attached : start_detached
   end
 
   def status
-    if controller.running?
+    if running?
       puts "The Sphinx daemon searchd is currently running."
     else
       puts "The Sphinx daemon searchd is not currently running."
@@ -76,23 +72,75 @@ class ThinkingSphinx::RakeInterface
   end
 
   def stop
-    unless controller.running?
-      puts 'searchd is not currently running.' and return
+    unless running?
+      log 'searchd is not currently running.' and return
     end
 
     pid = controller.pid
-    until controller.stop do
+    until !running? do
+      controller.stop options
       sleep(0.5)
     end
 
-    puts "Stopped searchd daemon (pid: #{pid})."
+    log "Stopped searchd daemon (pid: #{pid})."
+  rescue Riddle::CommandFailedError => error
+    handle_command_failure 'stop', error.command_result
   end
 
   private
 
+  attr_reader :options
+
   delegate :controller, :to => :configuration
+  delegate :running?,   :to => :controller
+
+  def command_output(output)
+    return "See above\n" if output.nil?
+
+    "\n\t" + output.gsub("\n", "\n\t")
+  end
 
   def configuration
     ThinkingSphinx::Configuration.instance
   end
+
+  def handle_command_failure(type, result)
+    puts <<-TXT
+
+The Sphinx #{type} command failed:
+  Command: #{result.command}
+  Status:  #{result.status}
+  Output:  #{command_output result.output}
+There may be more information about the failure in #{configuration.searchd.log}.
+    TXT
+    exit result.status
+  end
+
+  def log(message)
+    return if options[:silent]
+
+    puts message
+  end
+
+  def start_attached
+    unless pid = fork
+      controller.start :verbose => options[:verbose]
+    end
+
+    Signal.trap('TERM') { Process.kill(:TERM, pid); }
+    Signal.trap('INT')  { Process.kill(:TERM, pid); }
+    Process.wait(pid)
+  end
+
+  def start_detached
+    result = controller.start :verbose => options[:verbose]
+
+    if running?
+      log "Started searchd successfully (pid: #{controller.pid})."
+    else
+      handle_command_failure 'start', result
+    end
+  rescue Riddle::CommandFailedError => error
+    handle_command_failure 'start', error.command_result
+  end
 end

data/lib/thinking_sphinx/real_time/callbacks/real_time_callbacks.rb

@@ -3,14 +3,12 @@ class ThinkingSphinx::RealTime::Callbacks::RealTimeCallbacks
     @reference, @path, @block = reference, path, block
   end
 
-  def after_save(instance)
-    return unless real_time_indices? && callbacks_enabled?
+  def after_commit(instance)
+    persist_changes instance
+  end
 
-    real_time_indices.each do |index|
-      objects_for(instance).each do |object|
-        ThinkingSphinx::RealTime::Transcriber.new(index).copy object
-      end
-    end
+  def after_save(instance)
+    persist_changes instance
   end
 
   private
@@ -40,6 +38,16 @@ class ThinkingSphinx::RealTime::Callbacks::RealTimeCallbacks
     Array results
   end
 
+  def persist_changes(instance)
+    return unless real_time_indices? && callbacks_enabled?
+
+    real_time_indices.each do |index|
+      objects_for(instance).each do |object|
+        ThinkingSphinx::RealTime::Transcriber.new(index).copy object
+      end
+    end
+  end
+
   def real_time_indices?
     real_time_indices.any?
   end

data/lib/thinking_sphinx/real_time/populator.rb

@@ -12,7 +12,7 @@ class ThinkingSphinx::RealTime::Populator
 
     remove_files
 
-    scope.find_in_batches do |instances|
+    scope.find_in_batches(:batch_size => batch_size) do |instances|
       transcriber.copy *instances
       instrument 'populated', :instances => instances
     end
@@ -25,8 +25,8 @@ class ThinkingSphinx::RealTime::Populator
 
   attr_reader :index
 
-  delegate :controller, :to => :configuration
-  delegate :scope,      :to => :index
+  delegate :controller, :batch_size, :to => :configuration
+  delegate :scope,                   :to => :index
 
   def configuration
     ThinkingSphinx::Configuration.instance

data/lib/thinking_sphinx/tasks.rb

@@ -6,10 +6,7 @@ namespace :ts do
 
   desc 'Generate the Sphinx configuration file and process all indices'
   task :index => :environment do
-    interface.index(
-      ENV['INDEX_ONLY'] != 'true',
-      !Rake.application.options.silent
-    )
+    interface.index(ENV['INDEX_ONLY'] != 'true')
   end
 
   desc 'Clear out Sphinx files'
@@ -39,9 +36,7 @@ namespace :ts do
 
   desc 'Start the Sphinx daemon'
   task :start => :environment do
-    options = {}
-    options[:nodetach] = true  if ENV['NODETACH'] == 'true'
-    interface.start(options)
+    interface.start
   end
 
   desc 'Stop the Sphinx daemon'
@@ -55,6 +50,10 @@ namespace :ts do
   end
 
   def interface
-    @interface ||= ThinkingSphinx::RakeInterface.new
+    @interface ||= ThinkingSphinx::RakeInterface.new(
+      :verbose  => Rake::FileUtilsExt.verbose_flag,
+      :silent   => Rake.application.options.silent,
+      :nodetach => (ENV['NODETACH'] == 'true')
+    )
   end
 end

data/lib/thinking_sphinx/wildcard.rb

@@ -14,7 +14,7 @@ class ThinkingSphinx::Wildcard
     query.gsub(extended_pattern) do
       pre, proper, post = $`, $&, $'
       # E.g. "@foo", "/2", "~3", but not as part of a token pattern
-      is_operator = pre == '@' ||
+      is_operator = pre.match(%r{@$}) ||
                     pre.match(%r{([^\\]+|\A)[~/]\Z}) ||
                     pre.match(%r{(\W|^)@\([^\)]*$})
       # E.g. "foo bar", with quotes

data/spec/acceptance/association_scoping_spec.rb

@@ -9,7 +9,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       dublin    = Article.create :title => 'Guide to Dublin',    :user => paul
       index
 
-      pat.articles.search('Guide').to_a.should == [melbourne]
+      expect(pat.articles.search('Guide').to_a).to eq([melbourne])
     end
 
     it "limits id-only results to those matching the foreign key" do
@@ -19,7 +19,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       dublin    = Article.create :title => 'Guide to Dublin',    :user => paul
       index
 
-      pat.articles.search_for_ids('Guide').to_a.should == [melbourne.id]
+      expect(pat.articles.search_for_ids('Guide').to_a).to eq([melbourne.id])
     end
   end
 
@@ -31,7 +31,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       audi = Manufacturer.create :name => 'Audi'
       r_eight = Car.create :name => 'R8 Spyder', :manufacturer => audi
 
-      porsche.cars.search('Spyder').to_a.should == [spyder]
+      expect(porsche.cars.search('Spyder').to_a).to eq([spyder])
     end
 
     it "limits id-only results to those matching the foreign key" do
@@ -41,7 +41,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       audi = Manufacturer.create :name => 'Audi'
       r_eight = Car.create :name => 'R8 Spyder', :manufacturer => audi
 
-      porsche.cars.search_for_ids('Spyder').to_a.should == [spyder.id]
+      expect(porsche.cars.search_for_ids('Spyder').to_a).to eq([spyder.id])
     end
   end
 
@@ -57,7 +57,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       pancakes.categories << flat
       waffles.categories  << food
 
-      flat.products.search('Low').to_a.should == [pancakes]
+      expect(flat.products.search('Low').to_a).to eq([pancakes])
     end
   end
 end

data/spec/acceptance/attribute_access_spec.rb

@@ -8,7 +8,7 @@ describe 'Accessing attributes directly via search results', :live => true do
     search = Book.search('gods')
     search.context[:panes] << ThinkingSphinx::Panes::AttributesPane
 
-    search.first.sphinx_attributes['year'].should == 2001
+    expect(search.first.sphinx_attributes['year']).to eq(2001)
   end
 
   it "provides direct access to the search weight/relevance scores" do
@@ -19,7 +19,7 @@ describe 'Accessing attributes directly via search results', :live => true do
       :select => "*, #{ThinkingSphinx::SphinxQL.weight[:select]}"
     search.context[:panes] << ThinkingSphinx::Panes::WeightPane
 
-    search.first.weight.should == 2500
+    expect(search.first.weight).to eq(2500)
   end
 
   it "can enumerate with the weight" do
@@ -34,8 +34,8 @@ describe 'Accessing attributes directly via search results', :live => true do
     search.each_with_weight do |result, weight|
       expectation = expectations.shift
 
-      result.should == expectation.first
-      weight.should == expectation.last
+      expect(result).to eq(expectation.first)
+      expect(weight).to eq(expectation.last)
     end
   end
 end

data/spec/acceptance/attribute_updates_spec.rb

@@ -5,12 +5,12 @@ describe 'Update attributes automatically where possible', :live => true do
     article = Article.create :title => 'Pancakes', :published => false
     index
 
-    Article.search('pancakes', :with => {:published => true}).should be_empty
+    expect(Article.search('pancakes', :with => {:published => true})).to be_empty
 
     article.published = true
     article.save
 
-    Article.search('pancakes', :with => {:published => true}).to_a
-      .should == [article]
+    expect(Article.search('pancakes', :with => {:published => true}).to_a)
+      .to eq([article])
   end
 end

data/spec/acceptance/batch_searching_spec.rb

@@ -12,10 +12,10 @@ describe 'Executing multiple searches in one Sphinx call', :live => true do
 
     batch.populate
 
-    batch.searches.first.should include(pancakes)
-    batch.searches.first.should_not include(waffles)
+    expect(batch.searches.first).to include(pancakes)
+    expect(batch.searches.first).not_to include(waffles)
 
-    batch.searches.last.should include(waffles)
-    batch.searches.last.should_not include(pancakes)
+    expect(batch.searches.last).to include(waffles)
+    expect(batch.searches.last).not_to include(pancakes)
   end
 end

data/spec/acceptance/big_integers_spec.rb

@@ -21,17 +21,17 @@ describe '64 bit integer support' do
       [small_index, large_index, real_time_index]
     ).reconcile
 
-    large_index.sources.first.attributes.detect { |attribute|
+    expect(large_index.sources.first.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
 
-    small_index.sources.first.attributes.detect { |attribute|
+    expect(small_index.sources.first.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
 
-    real_time_index.attributes.detect { |attribute|
+    expect(real_time_index.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
   end
 end
 

data/spec/acceptance/connection_spec.rb

@@ -0,0 +1,23 @@
+require 'acceptance/spec_helper'
+
+RSpec.describe 'Connections', :live => true do
+  let(:maximum)    { (2 ** 23) - 1 }
+  let(:query)      { "SELECT * FROM book_core WHERE MATCH('')" }
+  let(:difference) { maximum - query.length }
+
+  it 'allows normal length queries through' do
+    expect {
+      ThinkingSphinx::Connection.take do |connection|
+        connection.execute query.insert(-3, 'a' * difference)
+      end
+    }.to_not raise_error#(ThinkingSphinx::QueryLengthError)
+  end
+
+  it 'does not allow overly long queries' do
+    expect {
+      ThinkingSphinx::Connection.take do |connection|
+        connection.execute query.insert(-3, 'a' * (difference + 1))
+      end
+    }.to raise_error(ThinkingSphinx::QueryLengthError)
+  end
+end