thinking-sphinx 3.4.2 → 4.0.0

data/lib/thinking_sphinx/commands.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ThinkingSphinx::Commands
+  #
+end
+
+require 'thinking_sphinx/commands/base'
+require 'thinking_sphinx/commands/clear_real_time'
+require 'thinking_sphinx/commands/clear_sql'
+require 'thinking_sphinx/commands/configure'
+require 'thinking_sphinx/commands/index_sql'
+require 'thinking_sphinx/commands/index_real_time'
+require 'thinking_sphinx/commands/merge'
+require 'thinking_sphinx/commands/merge_and_update'
+require 'thinking_sphinx/commands/prepare'
+require 'thinking_sphinx/commands/rotate'
+require 'thinking_sphinx/commands/running'
+require 'thinking_sphinx/commands/start_attached'
+require 'thinking_sphinx/commands/start_detached'
+require 'thinking_sphinx/commands/stop'

data/lib/thinking_sphinx/commands/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Commands::Base
   include ThinkingSphinx::WithOutput
 
@@ -15,6 +17,12 @@ class ThinkingSphinx::Commands::Base
 
   delegate :controller, :to => :configuration
 
+  def command(command, extra_options = {})
+    ThinkingSphinx::Commander.call(
+      command, configuration, options.merge(extra_options), stream
+    )
+  end
+
   def command_output(output)
     return "See above\n" if output.nil?
 
@@ -30,7 +38,7 @@ The Sphinx #{type} command failed:
   Output:  #{command_output result.output}
 There may be more information about the failure in #{configuration.searchd.log}.
     TXT
-    exit result.status
+    exit(result.status || 1)
   end
 
   def log(message)

data/lib/thinking_sphinx/commands/clear_real_time.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::ClearRealTime < ThinkingSphinx::Commands::Base
+  def call
+    options[:indices].each do |index|
+      index.render
+      Dir["#{index.path}.*"].each { |path| FileUtils.rm path }
+    end
+
+    FileUtils.rm_r(binlog_path) if File.exists?(binlog_path)
+  end
+
+  private
+
+  def binlog_path
+    configuration.searchd.binlog_path
+  end
+
+  def type
+    'clear_realtime'
+  end
+end

data/lib/thinking_sphinx/commands/clear_sql.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::ClearSQL < ThinkingSphinx::Commands::Base
+  def call
+    options[:indices].each do |index|
+      index.render
+      Dir["#{index.path}.*"].each { |path| FileUtils.rm path }
+    end
+
+    FileUtils.rm_r Dir["#{configuration.indices_location}/ts-*.tmp"]
+  end
+
+  private
+
+  def type
+    'clear_sql'
+  end
+end

data/lib/thinking_sphinx/commands/configure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Commands::Configure < ThinkingSphinx::Commands::Base
   def call
     log "Generating configuration to #{configuration.configuration_file}"

data/lib/thinking_sphinx/commands/index_real_time.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::IndexRealTime < ThinkingSphinx::Commands::Base
+  def call
+    options[:indices].each do |index|
+      ThinkingSphinx::RealTime::Populator.populate index
+
+      command :rotate
+    end
+  end
+
+  private
+
+  def type
+    'indexing'
+  end
+end

data/lib/thinking_sphinx/commands/index_sql.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::IndexSQL < ThinkingSphinx::Commands::Base
+  def call
+    if indices.empty?
+      ThinkingSphinx.before_index_hooks.each { |hook| hook.call }
+    end
+
+    configuration.indexing_strategy.call(indices) do |index_names|
+      configuration.guarding_strategy.call(index_names) do |names|
+        controller.index *names, :verbose => options[:verbose]
+      end
+    end
+  end
+
+  private
+
+  def indices
+    options[:indices] || []
+  end
+
+  def type
+    'indexing'
+  end
+end

data/lib/thinking_sphinx/commands/merge.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::Merge < ThinkingSphinx::Commands::Base
+  def call
+    return unless indices_exist?
+
+    controller.merge(
+      options[:core_index].name,
+      options[:delta_index].name,
+      :filters => options[:filters],
+      :verbose => options[:verbose]
+    )
+  end
+
+  private
+
+  delegate :controller, :to => :configuration
+
+  def indices_exist?
+    File.exist?("#{options[:core_index].path}.spi") &&
+    File.exist?("#{options[:delta_index].path}.spi")
+  end
+
+  def type
+    'merging'
+  end
+end

data/lib/thinking_sphinx/commands/merge_and_update.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::MergeAndUpdate < ThinkingSphinx::Commands::Base
+  def call
+    configuration.preload_indices
+    configuration.render
+
+    index_pairs.each do |(core_index, delta_index)|
+      command :merge,
+        :core_index  => core_index,
+        :delta_index => delta_index,
+        :filters     => {:sphinx_deleted => 0}
+
+      core_index.model.where(:delta => true).update_all(:delta => false)
+    end
+  end
+
+  private
+
+  delegate :controller, :to => :configuration
+
+  def core_indices
+    indices.select { |index| !index.delta? }.select do |index|
+      name_filters.empty? ||
+      name_filters.include?(index.name.gsub(/_core$/, ''))
+    end
+  end
+
+  def delta_for(core_index)
+    name = core_index.name.gsub(/_core$/, "_delta")
+    indices.detect { |index| index.name == name }
+  end
+
+  def index_pairs
+    core_indices.collect { |core_index|
+      [core_index, delta_for(core_index)]
+    }
+  end
+
+  def indices
+    @indices ||= configuration.indices.select { |index|
+      index.type == "plain" && index.options[:delta_processor]
+    }
+  end
+
+  def indices_exist?(*indices)
+    indices.all? { |index| File.exist?("#{index.path}.spi") }
+  end
+
+  def name_filters
+    @name_filters ||= options[:index_names] || []
+  end
+
+  def type
+    'merging_and_updating'
+  end
+end

data/lib/thinking_sphinx/commands/prepare.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::Prepare < ThinkingSphinx::Commands::Base
+  def call
+    FileUtils.mkdir_p configuration.indices_location
+  end
+
+  private
+
+  def type
+    'prepare'
+  end
+end

data/lib/thinking_sphinx/commands/rotate.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::Rotate < ThinkingSphinx::Commands::Base
+  def call
+    controller.rotate
+  end
+
+  private
+
+  def type
+    'rotate'
+  end
+end

data/lib/thinking_sphinx/commands/running.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Commands::Running < ThinkingSphinx::Commands::Base
+  def call
+    controller.running?
+  end
+
+  private
+
+  def type
+    'running'
+  end
+end

data/lib/thinking_sphinx/commands/start_attached.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Commands::StartAttached < ThinkingSphinx::Commands::Base
   def call
     FileUtils.mkdir_p configuration.indices_location

data/lib/thinking_sphinx/commands/start_detached.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Commands::StartDetached < ThinkingSphinx::Commands::Base
   def call
     FileUtils.mkdir_p configuration.indices_location
 
     result = controller.start :verbose => options[:verbose]
 
-    if controller.running?
+    if command :running
       log "Started searchd successfully (pid: #{controller.pid})."
     else
       handle_failure result

data/lib/thinking_sphinx/commands/stop.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Commands::Stop < ThinkingSphinx::Commands::Base
   def call
-    unless controller.running?
+    unless command :running
       log 'searchd is not currently running.'
       return
     end
 
     pid = controller.pid
-    until !controller.running? do
+    until !command :running do
       controller.stop options
       sleep(0.5)
     end

data/lib/thinking_sphinx/configuration.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 class ThinkingSphinx::Configuration < Riddle::Configuration
   attr_accessor :configuration_file, :indices_location, :version, :batch_size
   attr_reader :index_paths
-  attr_writer :controller, :index_set_class, :indexing_strategy
+  attr_writer :controller, :index_set_class, :indexing_strategy,
+    :guarding_strategy
 
   delegate :environment, :to => :framework
 
@@ -29,7 +32,7 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
 
   def controller
     @controller ||= begin
-      rc = ThinkingSphinx::Controller.new self, configuration_file
+      rc = Riddle::Controller.new self, configuration_file
       rc.bin_path = bin_path.gsub(/([^\/])$/, '\1/') if bin_path.present?
       rc
     end
@@ -58,6 +61,10 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
     end
   end
 
+  def guarding_strategy
+    @guarding_strategy ||= ThinkingSphinx::Guard::Files
+  end
+
   def index_set_class
     @index_set_class ||= ThinkingSphinx::IndexSet
   end
@@ -104,18 +111,15 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
   end
 
   def settings
-    @settings ||= File.exists?(settings_file) ? settings_to_hash : {}
+    @settings ||= ThinkingSphinx::Settings.call self
   end
 
   def setup
-    @configuration_file = settings['configuration_file'] || framework_root.join(
-      'config', "#{environment}.sphinx.conf"
-    ).to_s
-    @index_paths = engine_index_paths + [framework_root.join('app', 'indices').to_s]
-    @indices_location = settings['indices_location'] || framework_root.join(
-      'db', 'sphinx', environment
-    ).to_s
-    @version = settings['version'] || '2.1.4'
+    @configuration_file = settings['configuration_file']
+    @index_paths = engine_index_paths +
+      [Pathname.new(framework.root).join('app', 'indices').to_s]
+    @indices_location = settings['indices_location']
+    @version = settings['version'] || '2.2.11'
     @batch_size = settings['batch_size'] || 1000
 
     if settings['common_sphinx_configuration']
@@ -143,27 +147,14 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
   end
 
   def configure_searchd
-    configure_searchd_log_files
-
-    searchd.binlog_path = tmp_path.join('binlog', environment).to_s
-    searchd.address = settings['address'].presence || Defaults::ADDRESS
-    searchd.mysql41 = settings['mysql41'] || settings['port'] || Defaults::PORT
-    searchd.workers = 'threads'
-    searchd.mysql_version_string = '5.5.21' if RUBY_PLATFORM == 'java'
-  end
-
-  def configure_searchd_log_files
-    searchd.pid_file = log_root.join("#{environment}.sphinx.pid").to_s
-    searchd.log = log_root.join("#{environment}.searchd.log").to_s
-    searchd.query_log = log_root.join("#{environment}.searchd.query.log").to_s
-  end
+    searchd.socket = "#{settings["socket"]}:mysql41" if socket?
 
-  def framework_root
-    Pathname.new(framework.root)
-  end
+    if tcp?
+      searchd.address = settings['address'].presence || Defaults::ADDRESS
+      searchd.mysql41 = settings['mysql41'] || settings['port'] || Defaults::PORT
+    end
 
-  def log_root
-    real_path 'log'
+    searchd.mysql_version_string = '5.5.21' if RUBY_PLATFORM == 'java'
   end
 
   def normalise
@@ -175,26 +166,13 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
     ThinkingSphinx::Configuration::MinimumFields.new(indices).reconcile
   end
 
-  def real_path(*arguments)
-    path = framework_root.join(*arguments)
-    path.exist? ? path.realpath : path
-  end
-
   def reset
     @settings = nil
     setup
   end
 
-  def settings_file
-    framework_root.join 'config', 'thinking_sphinx.yml'
-  end
-
-  def settings_to_hash
-    input    = File.read settings_file
-    input    = ERB.new(input).result if defined?(ERB)
-
-    contents = YAML.load input
-    contents && contents[environment] || {}
+  def socket?
+    settings["socket"].present?
   end
 
   def sphinx_sections
@@ -203,8 +181,11 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
     sections
   end
 
-  def tmp_path
-    real_path 'tmp'
+  def tcp?
+    settings["socket"].nil?      ||
+    settings["address"].present? ||
+    settings["mysql41"].present? ||
+    settings["port"].present?
   end
 
   def verify