jaikoo-thinking-sphinx 0.9.10

data/lib/thinking_sphinx/collection.rb

@@ -0,0 +1,105 @@
+module ThinkingSphinx
+  class Collection < ::Array
+    attr_reader :total_entries, :total_pages, :current_page
+    attr_accessor :results
+    
+    def initialize(page, per_page, entries, total_entries)
+      @current_page, @per_page, @total_entries = page, per_page, total_entries
+      
+      @total_pages = (entries / @per_page.to_f).ceil
+    end
+    
+    def self.ids_from_results(results, page, limit, options)
+      collection = self.new(page, limit,
+        results[:total] || 0, results[:total_found] || 0
+      )
+      collection.results = results
+      collection.replace results[:matches].collect { |match|
+        match[:attributes]["sphinx_internal_id"]
+      }
+      return collection
+    end
+    
+    def self.create_from_results(results, page, limit, options)
+      collection = self.new(page, limit,
+        results[:total] || 0, results[:total_found] || 0
+      )
+      collection.results = results
+      collection.replace instances_from_matches(results[:matches], options)
+      return collection
+    end
+    
+    def self.instances_from_matches(matches, options = {})
+      return matches.collect { |match|
+        instance_from_match match, options
+      } unless klass = options[:class]
+      
+      ids = matches.collect { |match| match[:attributes]["sphinx_internal_id"] }
+      instances = ids.length > 0 ? klass.find(
+        :all,
+        :conditions => {klass.primary_key.to_sym => ids},
+        :include    => options[:include],
+        :select     => options[:select]
+      ) : []
+      ids.collect { |obj_id|
+        instances.detect { |obj| obj.id == obj_id }
+      }
+    end
+    
+    def self.instance_from_match(match, options)
+      # puts "ARGS: #{match[:attributes]["sphinx_internal_id"].inspect}, {:include => #{options[:include].inspect}, :select => #{options[:select].inspect}}"
+      class_from_crc(match[:attributes]["class_crc"]).find(
+        match[:attributes]["sphinx_internal_id"],
+        :include => options[:include],
+        :select  => options[:select]
+      )
+    end
+    
+    def self.class_from_crc(crc)
+      @@models_by_crc ||= ThinkingSphinx.indexed_models.inject({}) do |hash, model|
+        hash[model.constantize.to_crc32] = model
+        model.constantize.subclasses.each { |subclass|
+          hash[subclass.to_crc32] = subclass.name
+        }
+        hash
+      end
+      @@models_by_crc[crc].constantize
+    end
+    
+    def previous_page
+      current_page > 1 ? (current_page - 1) : nil
+    end
+    
+    def next_page
+      current_page < total_pages ? (current_page + 1): nil
+    end
+    
+    def offset
+      (current_page - 1) * @per_page
+    end
+    
+    def method_missing(method, *args, &block)
+      super unless method.to_s[/^each_with_.*/]
+      
+      each_with_attribute method.to_s.gsub(/^each_with_/, ''), &block
+    end
+    
+    def each_with_group_and_count(&block)
+      results[:matches].each_with_index do |match, index|
+        yield self[index], match[:attributes]["@group"], match[:attributes]["@count"]
+      end
+    end
+    
+    def each_with_attribute(attribute, &block)
+      results[:matches].each_with_index do |match, index|
+        yield self[index], (match[:attributes][attribute] || match[:attributes]["@#{attribute}"])
+      end
+    end
+    
+    def each_with_weighting(&block)
+      results[:matches].each_with_index do |match, index|
+        yield self[index], match[:weight]
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/configuration.rb

@@ -0,0 +1,314 @@
+require 'erb'
+require 'singleton'
+
+module ThinkingSphinx
+  # This class both keeps track of the configuration settings for Sphinx and
+  # also generates the resulting file for Sphinx to use.
+  # 
+  # Here are the default settings, relative to RAILS_ROOT where relevant:
+  #
+  # config file::           config/#{environment}.sphinx.conf
+  # searchd log file::      log/searchd.log
+  # query log file::        log/searchd.query.log
+  # pid file::              log/searchd.#{environment}.pid
+  # searchd files::         db/sphinx/#{environment}/
+  # address::               127.0.0.1
+  # port::                  3312
+  # allow star::            false
+  # min prefix length::     1
+  # min infix length::      1
+  # mem limit::             64M
+  # max matches::           1000
+  # morphology::            stem_en
+  # charset type::          utf-8
+  # charset table::         nil
+  # ignore chars::          nil
+  # html strip::            false
+  # html remove elements::  ''
+  #
+  # If you want to change these settings, create a YAML file at
+  # config/sphinx.yml with settings for each environment, in a similar
+  # fashion to database.yml - using the following keys: config_file,
+  # searchd_log_file, query_log_file, pid_file, searchd_file_path, port,
+  # allow_star, enable_star, min_prefix_len, min_infix_len, mem_limit,
+  # max_matches, # morphology, charset_type, charset_table, ignore_chars,
+  # html_strip, # html_remove_elements. I think you've got the idea.
+  # 
+  # Each setting in the YAML file is optional - so only put in the ones you
+  # want to change.
+  #
+  # Keep in mind, if for some particular reason you're using a version of
+  # Sphinx older than 0.9.8 r871 (that's prior to the proper 0.9.8 release),
+  # don't set allow_star to true.
+  # 
+  class Configuration
+    include Singleton
+    
+    SourceOptions = %w( mysql_connect_flags sql_range_step sql_query_pre
+      sql_query_post sql_ranged_throttle sql_query_post_index )
+    
+    IndexOptions  = %w( charset_table charset_type docinfo enable_star
+      exceptions html_index_attrs html_remove_elements html_strip ignore_chars
+      min_infix_len min_prefix_len min_word_len mlock morphology ngram_chars
+      ngram_len phrase_boundary phrase_boundary_step preopen stopwords
+      wordforms )
+    
+    IndexerOptions = %w( max_iops max_iosize mem_limit )
+    
+    SearchdOptions = %w( read_timeout max_children max_matches seamless_rotate
+      preopen_indexes unlink_old )
+    
+    attr_accessor :config_file, :searchd_log_file, :query_log_file,
+      :pid_file, :searchd_file_path, :address, :port, :allow_star,
+      :database_yml_file, :app_root, :bin_path
+    
+    attr_accessor :source_options, :index_options, :indexer_options,
+      :searchd_options
+    
+    attr_reader :environment
+    
+    # Load in the configuration settings - this will look for config/sphinx.yml
+    # and parse it according to the current environment.
+    # 
+    def initialize(app_root = Dir.pwd)
+      self.reset
+    end
+    
+    def reset
+      self.app_root          = RAILS_ROOT if defined?(RAILS_ROOT)
+      self.app_root          = Merb.root  if defined?(Merb)
+      self.app_root        ||= app_root
+      
+      self.database_yml_file    = "#{self.app_root}/config/database.yml"
+      self.config_file          = "#{self.app_root}/config/#{environment}.sphinx.conf"
+      self.searchd_log_file     = "#{self.app_root}/log/searchd.log"
+      self.query_log_file       = "#{self.app_root}/log/searchd.query.log"
+      self.pid_file             = "#{self.app_root}/log/searchd.#{environment}.pid"
+      self.searchd_file_path    = "#{self.app_root}/db/sphinx/#{environment}"
+      self.address              = "127.0.0.1"
+      self.port                 = 3312
+      self.allow_star           = false
+      self.bin_path             = ""
+      
+      self.source_options  = {}
+      self.index_options   = {
+        :charset_type => "utf-8",
+        :morphology   => "stem_en"
+      }
+      self.indexer_options = {}
+      self.searchd_options = {}
+      
+      parse_config
+      
+      self
+    end
+    
+    def self.environment
+      @@environment ||= (
+        defined?(Merb) ? Merb.environment : ENV['RAILS_ENV']
+      ) || "development"
+    end
+    
+    def environment
+      self.class.environment
+    end
+    
+    # Generate the config file for Sphinx by using all the settings defined and
+    # looping through all the models with indexes to build the relevant
+    # indexer and searchd configuration, and sources and indexes details.
+    #
+    def build(file_path=nil)
+      load_models
+      file_path ||= "#{self.config_file}"
+      database_confs = YAML::load(ERB.new(IO.read("#{self.database_yml_file}")).result)
+      database_confs.symbolize_keys!
+      database_conf  = database_confs[environment.to_sym]
+      database_conf.symbolize_keys!
+      
+      open(file_path, "w") do |file|
+        file.write <<-CONFIG
+indexer
+{
+#{hash_to_config(self.indexer_options)}
+}
+
+searchd
+{
+  address = #{self.address}
+  port = #{self.port}
+  log = #{self.searchd_log_file}
+  query_log = #{self.query_log_file}
+  pid_file = #{self.pid_file}
+#{hash_to_config(self.searchd_options)}
+}
+        CONFIG
+        
+        ThinkingSphinx.indexed_models.each_with_index do |model, model_index|
+          model           = model.constantize
+          sources         = []
+          delta_sources   = []
+          prefixed_fields = []
+          infixed_fields  = []
+          
+          model.sphinx_indexes.select { |index| index.model == model }.each_with_index do |index, i|
+            file.write index.to_config(model, i, database_conf, model_index)
+            
+            index.adapter_object.setup
+            
+            sources << "#{ThinkingSphinx::Index.name(model)}_#{i}_core"
+            delta_sources << "#{ThinkingSphinx::Index.name(model)}_#{i}_delta" if index.delta?
+          end
+          
+          next if sources.empty?
+          
+          source_list = sources.collect       { |s| "source = #{s}" }.join("\n")
+          delta_list  = delta_sources.collect { |s| "source = #{s}" }.join("\n")
+          
+          file.write core_index_for_model(model, source_list)
+          unless delta_list.blank?
+            file.write delta_index_for_model(model, delta_list)
+          end
+          
+          file.write distributed_index_for_model(model)
+        end
+      end
+    end
+    
+    # Make sure all models are loaded - without reloading any that
+    # ActiveRecord::Base is already aware of (otherwise we start to hit some
+    # messy dependencies issues).
+    # 
+    def load_models
+      base = "#{app_root}/app/models/"
+      Dir["#{base}**/*.rb"].each do |file|
+        model_name = file.gsub(/^#{base}([\w_\/\\]+)\.rb/, '\1')
+        
+        next if model_name.nil?
+        next if ::ActiveRecord::Base.send(:subclasses).detect { |model|
+          model.name == model_name
+        }
+        
+        begin
+          model_name.camelize.constantize
+        rescue LoadError
+          model_name.gsub!(/.*[\/\\]/, '').nil? ? next : retry
+        rescue NameError
+          next
+        end
+      end
+    end
+    
+    def hash_to_config(hash)
+      hash.collect { |key, value|
+        translated_value = case value
+        when TrueClass
+          "1"
+        when FalseClass
+          "0"
+        when NilClass, ""
+          next
+        else
+          value
+        end
+        "  #{key} = #{translated_value}"
+      }.join("\n")
+    end
+    
+    def self.options_merge(base, extra)
+      base = base.clone
+      extra.each do |key, value|
+        next if value.nil? || value == ""
+        base[key] = value
+      end
+      base
+    end
+    
+    private
+    
+    # Parse the config/sphinx.yml file - if it exists - then use the attribute
+    # accessors to set the appropriate values. Nothing too clever.
+    # 
+    def parse_config
+      path = "#{app_root}/config/sphinx.yml"
+      return unless File.exists?(path)
+      
+      conf = YAML::load(ERB.new(IO.read(path)).result)[environment]
+      
+      conf.each do |key,value|
+        self.send("#{key}=", value) if self.methods.include?("#{key}=")
+        
+        self.source_options[key.to_sym] = value  if SourceOptions.include?(key.to_s)
+        self.index_options[key.to_sym] = value   if IndexOptions.include?(key.to_s)
+        self.indexer_options[key.to_sym] = value if IndexerOptions.include?(key.to_s)
+        self.searchd_options[key.to_sym] = value if SearchdOptions.include?(key.to_s)
+      end unless conf.nil?
+      
+      self.bin_path += '/' unless self.bin_path.blank?
+    end
+    
+    def core_index_for_model(model, sources)
+      output = <<-INDEX
+
+index #{ThinkingSphinx::Index.name(model)}_core
+{
+#{sources}
+path = #{self.searchd_file_path}/#{ThinkingSphinx::Index.name(model)}_core
+INDEX
+      
+      unless combined_index_options(model).empty?
+        output += hash_to_config(combined_index_options(model))
+      end
+      
+      if self.allow_star
+        # Ye Olde way of turning on enable_star
+        output += "  enable_star    = 1\n"
+        output += "  min_prefix_len = #{self.combined_index_options[:min_prefix_len]}\n"
+      end
+      
+      unless model.sphinx_indexes.collect(&:prefix_fields).flatten.empty?
+        output += "  prefix_fields = #{model.sphinx_indexes.collect(&:prefix_fields).flatten.map(&:unique_name).join(', ')}\n"
+      else
+        output += " prefix_fields = _\n" unless model.sphinx_indexes.collect(&:infix_fields).flatten.empty?
+      end
+      
+      unless model.sphinx_indexes.collect(&:infix_fields).flatten.empty?
+        output += "  infix_fields  = #{model.sphinx_indexes.collect(&:infix_fields).flatten.map(&:unique_name).join(', ')}\n"
+      else
+        output += " infix_fields = -\n" unless model.sphinx_indexes.collect(&:prefix_fields).flatten.empty?
+      end
+      
+      output + "\n}\n"
+    end
+    
+    def delta_index_for_model(model, sources)
+      <<-INDEX
+index #{ThinkingSphinx::Index.name(model)}_delta : #{ThinkingSphinx::Index.name(model)}_core
+{
+  #{sources}
+  path = #{self.searchd_file_path}/#{ThinkingSphinx::Index.name(model)}_delta
+}
+      INDEX
+    end
+    
+    def distributed_index_for_model(model)
+      sources = ["local = #{ThinkingSphinx::Index.name(model)}_core"]
+      if model.sphinx_indexes.any? { |index| index.delta? }
+        sources << "local = #{ThinkingSphinx::Index.name(model)}_delta"
+      end
+      
+      <<-INDEX
+index #{ThinkingSphinx::Index.name(model)}
+{
+  type = distributed
+  #{ sources.join("\n  ") }
+}
+      INDEX
+    end
+    
+    def combined_index_options(model)
+      model.sphinx_indexes.inject(self.index_options) do |options, index|
+        self.class.options_merge(options, index.local_index_options)
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/field.rb

@@ -0,0 +1,206 @@
+module ThinkingSphinx
+  # Fields - holding the string data which Sphinx indexes for your searches.
+  # This class isn't really useful to you unless you're hacking around with the
+  # internals of Thinking Sphinx - but hey, don't let that stop you.
+  #
+  # One key thing to remember - if you're using the field manually to
+  # generate SQL statements, you'll need to set the base model, and all the
+  # associations. Which can get messy. Use Index.link!, it really helps.
+  # 
+  class Field
+    attr_accessor :alias, :columns, :sortable, :associations, :model, :infixes, :prefixes
+    
+    # To create a new field, you'll need to pass in either a single Column
+    # or an array of them, and some (optional) options. The columns are
+    # references to the data that will make up the field.
+    #
+    # Valid options are:
+    # - :as       => :alias_name 
+    # - :sortable => true
+    # - :infixes  => true
+    # - :prefixes => true
+    #
+    # Alias is only required in three circumstances: when there's
+    # another attribute or field with the same name, when the column name is
+    # 'id', or when there's more than one column.
+    # 
+    # Sortable defaults to false - but is quite useful when set to true, as
+    # it creates an attribute with the same string value (which Sphinx converts
+    # to an integer value), which can be sorted by. Thinking Sphinx is smart
+    # enough to realise that when you specify fields in sort statements, you
+    # mean their respective attributes.
+    # 
+    # If you have partial matching enabled (ie: enable_star), then you can
+    # specify certain fields to have their prefixes and infixes indexed. Keep
+    # in mind, though, that Sphinx's default is _all_ fields - so once you
+    # highlight a particular field, no other fields in the index will have
+    # these partial indexes.
+    #
+    # Here's some examples:
+    #
+    #   Field.new(
+    #     Column.new(:name)
+    #   )
+    #
+    #   Field.new(
+    #     [Column.new(:first_name), Column.new(:last_name)],
+    #     :as => :name, :sortable => true
+    #   )
+    # 
+    #   Field.new(
+    #     [Column.new(:posts, :subject), Column.new(:posts, :content)],
+    #     :as => :posts, :prefixes => true
+    #   )
+    # 
+    def initialize(columns, options = {})
+      @columns      = Array(columns)
+      @associations = {}
+
+      raise "Cannot define a field with no columns. Maybe you are trying to index a field with a reserved name (id, name). You can fix this error by using a symbol rather than a bare name (:id instead of id)." if @columns.empty? || @columns.any? { |column| !column.respond_to?(:__stack) }
+      
+      @alias        = options[:as]
+      @sortable     = options[:sortable] || false
+      @infixes      = options[:infixes]  || false
+      @prefixes     = options[:prefixes] || false
+    end
+    
+    # Get the part of the SELECT clause related to this field. Don't forget
+    # to set your model and associations first though.
+    #
+    # This will concatenate strings if there's more than one data source or
+    # multiple data values (has_many or has_and_belongs_to_many associations).
+    # 
+    def to_select_sql
+      clause = @columns.collect { |column|
+        column_with_prefix(column)
+      }.join(', ')
+      
+      clause = concatenate(clause) if concat_ws?
+      clause = group_concatenate(clause) if is_many?
+      
+      "#{cast_to_string clause } AS #{quote_column(unique_name)}"
+    end
+    
+    # Get the part of the GROUP BY clause related to this field - if one is
+    # needed. If not, all you'll get back is nil. The latter will happen if
+    # there's multiple data values (read: a has_many or has_and_belongs_to_many
+    # association).
+    #
+    def to_group_sql
+      case
+      when is_many?, ThinkingSphinx.use_group_by_shortcut?
+        nil
+      else
+        @columns.collect { |column|
+          column_with_prefix(column)
+        }
+      end
+    end
+    
+    # Returns the unique name of the field - which is either the alias of
+    # the field, or the name of the only column - if there is only one. If
+    # there isn't, there should be an alias. Else things probably won't work.
+    # Consider yourself warned.
+    #
+    def unique_name
+      if @columns.length == 1
+        @alias || @columns.first.__name
+      else
+        @alias
+      end
+    end
+    
+    private
+    
+    def concatenate(clause)
+      case @model.connection.class.name
+      when "ActiveRecord::ConnectionAdapters::MysqlAdapter"
+        "CONCAT_WS(' ', #{clause})"
+      when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+        clause.split(', ').join(" || ' ' || ")
+      else
+        clause
+      end
+    end
+    
+    def group_concatenate(clause)
+      case @model.connection.class.name
+      when "ActiveRecord::ConnectionAdapters::MysqlAdapter"
+        "GROUP_CONCAT(#{clause} SEPARATOR ' ')"
+      when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+        "array_to_string(array_accum(#{clause}), ' ')"
+      else
+        clause
+      end
+    end
+    
+    def cast_to_string(clause)
+      case @model.connection.class.name
+      when "ActiveRecord::ConnectionAdapters::MysqlAdapter"
+        "CAST(#{clause} AS CHAR)"
+      when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+        clause
+      else
+        clause
+      end
+    end
+    
+    def quote_column(column)
+      @model.connection.quote_column_name(column)
+    end
+    
+    # Indication of whether the columns should be concatenated with a space
+    # between each value. True if there's either multiple sources or multiple
+    # associations.
+    # 
+    def concat_ws?
+      @columns.length > 1 || multiple_associations?
+    end
+    
+    # Checks the association tree for each column - if they're all the same,
+    # returns false.
+    # 
+    def multiple_sources?
+      first = associations[@columns.first]
+      
+      !@columns.all? { |col| associations[col] == first }
+    end
+    
+    # Checks whether any column requires multiple associations (which only
+    # happens for polymorphic situations).
+    # 
+    def multiple_associations?
+      associations.any? { |col,assocs| assocs.length > 1 }
+    end
+    
+    # Builds a column reference tied to the appropriate associations. This
+    # dives into the associations hash and their corresponding joins to
+    # figure out how to correctly reference a column in SQL.
+    #
+    def column_with_prefix(column)
+      if column.is_string?
+        column.__name
+      elsif associations[column].empty?
+        "#{@model.quoted_table_name}.#{quote_column(column.__name)}"
+      else
+        associations[column].collect { |assoc|
+          assoc.has_column?(column.__name) ?
+          "#{@model.connection.quote_table_name(assoc.join.aliased_table_name)}" + 
+          ".#{quote_column(column.__name)}" :
+          nil
+        }.compact.join(', ')
+      end
+    end
+    
+    # Could there be more than one value related to the parent record? If so,
+    # then this will return true. If not, false. It's that simple.
+    #
+    def is_many?
+      associations.values.flatten.any? { |assoc| assoc.is_many? }
+    end
+    
+    def is_string?
+      columns.all? { |col| col.is_string? }
+    end
+  end
+end