riddle 1.4.0 → 1.5.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+coverage
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,16 @@
+rvm:
+  - 1.8.6
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - rbx-2.0
+  - ree
+  - jruby
+  - ruby-head
+env:
+  - SPHINX_BIN=/usr/local/sphinx-0.9.9/bin SPHINX_VERSION=0.9.9
+  - SPHINX_BIN=/usr/local/sphinx-1.10/bin SPHINX_VERSION=1.10
+  - SPHINX_BIN=/usr/local/sphinx-2.0.1/bin SPHINX_VERSION=2.0.1
+before_script: killall searchd; echo ''
+after_script:  killall searchd; echo ''

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'mysql2',     '0.3.2',    :platform => :ruby
+gem 'jdbc-mysql', '>= 5.1.13', :platform => :jruby

data/HISTORY

@@ -0,0 +1,45 @@
+1.5.0 - November 4th 2011
+- Handle exclusive filters in SphinxQL SELECT commands.
+- Allow for native Ruby objects in SphinxQL UPDATE commands.
+- Handle options of hashes in SphinxQL SELECT commands.
+- Allow for SphinxQL select clauses.
+- Improving SphinxQL filter handling of native Ruby objects.
+- Switch plural index references from indexes to indices, to distinguish beside indexes (the action).
+- Rescue against timeouts and connection resets.
+- Fixing reference to TCPSocket.
+- Handle port numbers as integers for listen setting (Ngan Pham).
+- Provide the option to start searchd with the nodetach flag (Aaron Gilbralter).
+- Don't shuffle servers (if there's more than one) - let developers (or Thinking Sphinx) manage that (Ngan Pham).
+
+1.4.0 - August 2nd 2011
+- Checking against both Windows platforms for Ruby (Paul Gibler)
+- Encoding improvements (Alexey Artamonov)
+- More Rubyish syntax (James Cook)
+- Handling Ruby encodings (James Cook)
+- Coreseek support (saberma)
+- Section restructure for better inheritance (Alexey Artamonov)
+- MySQL41 connection support
+- requiring 'thread' for Mutex use
+
+1.3.3 - May 25th 2011
+- Using MySQL2 library for SphinxQL interface
+- Adding Sphinx 2.0.x settings
+- SphinxQL support
+- Speed improvements for hash lookups (Enrico Thierbach)
+- Handle race conditions of segfaults while returning responses (Jason Lambert)
+- 2.0.x support
+
+1.3.2 - May 12th 2011
+- client_key support
+
+1.3.1 - May 9th 2011
+- Don't output warnings or exit when version isn't detected - presume Thinking Sphinx will handle that.
+- Confirm configuration file exists before attempting to start/stop Sphinx.
+- Use a Mutex instead of the current Thread.
+
+1.3.0 - May 7th 2011
+- Attempts at untested 2.0.x and client_key support
+- Using Bundler, MySQL2 and Ruby 1.9.2 in development
+- Allow for Sphinx versions compiled from source and SVN (Greg Weber)
+
+1.2.2 - December 22nd 2011

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Pat Allan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -22,12 +22,12 @@ To get started, just instantiate a Client object:
 
   client = Riddle::Client.new # defaults to localhost and port 3312
   client = Riddle::Client.new "sphinxserver.domain.tld", 3333 # custom settings
-  
+
 And then set the parameters to what you want, before running a query:
 
   client.match_mode = :extended
   client.query "Pat Allan @state Victoria"
-  
+
 The results from a query are similar to the other clients - but here's the details. It's a hash with
 the following keys:
 
@@ -53,7 +53,7 @@ documents. The key @:attributes@ will return a hash of attribute name and type p
 documents and hits for each, along the lines of:
 
   results[:words]["Pat"] #=> {:docs => 12, :hits => 15}
-  
+
 @:total@, @:total_found@ and @:time@ return the number of matches available, the
 total number of matches (which may be greater than the maximum available), and the time in milliseconds
 that the query took to run.
@@ -91,3 +91,5 @@ Thanks to the following people who have contributed to Riddle in some shape or f
 * James Cook
 * Alexey Artamonov
 * Paul Gibler
+* Ngan Pham
+* Aaron Gilbralter

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+Bundler.require :default, :development
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
+  spec.rcov      = true
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :spec
+
+task :fixtures do
+  require './spec/spec_helper'
+  BinaryFixtures.build_fixtures
+end

data/lib/riddle.rb

@@ -70,6 +70,7 @@ require 'riddle/client'
 require 'riddle/configuration'
 require 'riddle/controller'
 require 'riddle/query'
+require 'riddle/version'
 
 Riddle.loaded_version = nil
 Riddle::AutoVersion.configure

data/lib/riddle/0.9.9/configuration/searchd.rb

@@ -4,29 +4,31 @@ module Riddle
       def valid?
         set_listen
         clear_deprecated
-        
+
         !( @listen.nil? || @listen.empty? || @pid_file.nil? )
       end
-      
+
       private
-      
+
       def set_listen
+        @listen = @listen.to_s if @listen.is_a?(Fixnum)
+
         return unless @listen.nil? || @listen.empty?
-        
+
         @listen = []
         @listen << @port.to_s if @port
         @listen << "9306:mysql41" if @mysql41.is_a?(TrueClass)
         @listen << "#{@mysql41}:mysql41" if @mysql41.is_a?(Fixnum)
-        
+
         @listen.each { |l| l.insert(0, "#{@address}:") } if @address
       end
-      
+
       def clear_deprecated
         return if @listen.nil?
-        
+
         @address  = nil
         @port     = nil
       end
     end
   end
-end
+end

data/lib/riddle/auto_version.rb

@@ -1,8 +1,8 @@
 class Riddle::AutoVersion
   def self.configure
     controller = Riddle::Controller.new nil, ''
-    version    = controller.sphinx_version
-    
+    version    = ENV['SPHINX_VERSION'] || controller.sphinx_version
+
     case version
     when '0.9.8', '0.9.9'
       require "riddle/#{version}"

data/lib/riddle/client.rb

@@ -6,7 +6,7 @@ module Riddle
   class VersionError < StandardError;  end
   class ResponseError < StandardError; end
   class OutOfBoundsError < StandardError; end
-  
+
   # This class was heavily based on the existing Client API by Dmytro Shteflyuk
   # and Alexy Kovyrin. Their code worked fine, I just wanted something a bit
   # more Ruby-ish (ie. lowercase and underscored method names). I also have
@@ -40,7 +40,7 @@ module Riddle
       :query      => 6, # SEARCHD_COMMAND_QUERY
       :flushattrs => 7  # SEARCHD_COMMAND_FLUSHATTRS
     }
-    
+
     Versions = {
       :search     => 0x113, # VER_COMMAND_SEARCH
       :excerpt    => 0x100, # VER_COMMAND_EXCERPT
@@ -50,14 +50,14 @@ module Riddle
       :query      => 0x100, # VER_COMMAND_QUERY
       :flushattrs => 0x100  # VER_COMMAND_FLUSHATTRS
     }
-    
+
     Statuses = {
       :ok      => 0, # SEARCHD_OK
       :error   => 1, # SEARCHD_ERROR
       :retry   => 2, # SEARCHD_RETRY
       :warning => 3  # SEARCHD_WARNING
     }
-    
+
     MatchModes = {
       :all        => 0, # SPH_MATCH_ALL
       :any        => 1, # SPH_MATCH_ANY
@@ -67,7 +67,7 @@ module Riddle
       :fullscan   => 5, # SPH_MATCH_FULLSCAN
       :extended2  => 6  # SPH_MATCH_EXTENDED2
     }
-    
+
     RankModes = {
       :proximity_bm25 => 0, # SPH_RANK_PROXIMITY_BM25
       :bm25           => 1, # SPH_RANK_BM25
@@ -79,7 +79,7 @@ module Riddle
       :sph04          => 7, # SPH_RANK_SPH04
       :total          => 8  # SPH_RANK_TOTAL
     }
-    
+
     SortModes = {
       :relevance     => 0, # SPH_SORT_RELEVANCE
       :attr_desc     => 1, # SPH_SORT_ATTR_DESC
@@ -88,7 +88,7 @@ module Riddle
       :extended      => 4, # SPH_SORT_EXTENDED
       :expr          => 5  # SPH_SORT_EXPR
     }
-    
+
     AttributeTypes = {
       :integer    => 1, # SPH_ATTR_INTEGER
       :timestamp  => 2, # SPH_ATTR_TIMESTAMP
@@ -99,7 +99,7 @@ module Riddle
       :string     => 7, # SPH_ATTR_STRING
       :multi      => 0x40000000 # SPH_ATTR_MULTI
     }
-    
+
     GroupFunctions = {
       :day      => 0, # SPH_GROUPBY_DAY
       :week     => 1, # SPH_GROUPBY_WEEK
@@ -108,13 +108,13 @@ module Riddle
       :attr     => 4, # SPH_GROUPBY_ATTR
       :attrpair => 5  # SPH_GROUPBY_ATTRPAIR
     }
-    
+
     FilterTypes = {
       :values       => 0, # SPH_FILTER_VALUES
       :range        => 1, # SPH_FILTER_RANGE
       :float_range  => 2  # SPH_FILTER_FLOATRANGE
     }
-    
+
     attr_accessor :servers, :port, :offset, :limit, :max_matches,
       :match_mode, :sort_mode, :sort_by, :weights, :id_range, :filters,
       :group_by, :group_function, :group_clause, :group_distinct, :cut_off,
@@ -122,9 +122,9 @@ module Riddle
       :max_query_time, :field_weights, :timeout, :overrides, :select,
       :connection, :key
     attr_reader :queue
-    
+
     @@connection = nil
-    
+
     def self.connection=(value)
       Riddle.mutex.synchronize do
         @@connection = value
@@ -134,24 +134,23 @@ module Riddle
     def self.connection
       @@connection
     end
-    
+
     # Can instantiate with a specific server and port - otherwise it assumes
     # defaults of localhost and 3312 respectively. All other settings can be
     # accessed and changed via the attribute accessors.
     def initialize(servers = nil, port = nil, key = nil)
       Riddle.version_warning
 
-      servers = Array(servers || "localhost")
-      @servers = servers.respond_to?(:shuffle) ? servers.shuffle : servers.sort_by{ rand }
-      @port   = port     || 9312
+      @servers = Array(servers || "localhost")
+      @port   = port || 9312
       @socket = nil
       @key    = key
-      
+
       reset
-      
+
       @queue = []
     end
-    
+
     # Reset attributes and settings to defaults.
     def reset
       # defaults
@@ -182,7 +181,7 @@ module Riddle
       @overrides      = {}
       @select         = "*"
     end
-    
+
     # The searchd server to query.  Servers are removed from @server after a
     # Timeout::Error is hit to allow for fail-over.
     def server
@@ -213,18 +212,18 @@ module Riddle
         :longitude            => long
       }
     end
-    
+
     # Append a query to the queue. This uses the same parameters as the query
     # method.
     def append_query(search, index = '*', comments = '')
       @queue << query_message(search, index, comments)
     end
-    
+
     # Run all the queries currently in the queue. This will return an array of
     # results hashes.
     def run
       response = Response.new request(:search, @queue)
-      
+
       results = @queue.collect do
         result = {
           :matches         => [],
@@ -242,7 +241,7 @@ module Riddle
           result[:error] = response.next
           next result
         end
-        
+
         result[:fields] = response.next_array
 
         attributes = response.next_int
@@ -259,7 +258,7 @@ module Riddle
 
         matches   = response.next_int
         is_64_bit = response.next_int
-        
+
         result[:matches] = (0...matches).map do |i|
           doc = is_64_bit > 0 ? response.next_64bit_int : response.next_int
           weight = response.next_int
@@ -269,7 +268,7 @@ module Riddle
           result_attribute_names_and_types.each do |attr, type|
             current_match_attributes[attr] = attribute_from_type(type, response)
           end
-          
+
           {:doc => doc, :weight => weight, :index => i, :attributes => current_match_attributes}
         end
 
@@ -287,17 +286,17 @@ module Riddle
 
         result
       end
-      
+
       @queue.clear
       results
     end
-    
-    # Query the Sphinx daemon - defaulting to all indexes, but you can specify
+
+    # Query the Sphinx daemon - defaulting to all indices, but you can specify
     # a specific one if you wish. The search parameter should be a string
     # following Sphinx's expectations.
     #
     # The object returned from this method is a hash with the following keys:
-    # 
+    #
     # * :matches
     # * :fields
     # * :attributes
@@ -311,24 +310,24 @@ module Riddle
     # * :error (if appropriate)
     #
     # The key <tt>:matches</tt> returns an array of hashes - the actual search
-    # results. Each hash has the document id (<tt>:doc</tt>), the result 
+    # results. Each hash has the document id (<tt>:doc</tt>), the result
     # weighting (<tt>:weight</tt>), and a hash of the attributes for the
     # document (<tt>:attributes</tt>).
-    # 
+    #
     # The <tt>:fields</tt> and <tt>:attribute_names</tt> keys return list of
     # fields and attributes for the documents. The key <tt>:attributes</tt>
     # will return a hash of attribute name and type pairs, and <tt>:words</tt>
     # returns a hash of hashes representing the words from the search, with the
     # number of documents and hits for each, along the lines of:
-    # 
+    #
     #   results[:words]["Pat"] #=> {:docs => 12, :hits => 15}
-    # 
+    #
     # <tt>:total</tt>, <tt>:total_found</tt> and <tt>:time</tt> return the
     # number of matches available, the total number of matches (which may be
     # greater than the maximum available, depending on the number of matches
     # and your sphinx configuration), and the time in milliseconds that the
     # query took to run.
-    # 
+    #
     # <tt>:status</tt> is the error code for the query - and if there was a
     # related warning, it will be under the <tt>:warning</tt> key. Fatal errors
     # will be described under <tt>:error</tt>.
@@ -337,7 +336,7 @@ module Riddle
       @queue << query_message(search, index, comments)
       self.run.first
     end
-    
+
     # Build excerpts from search terms (the +words+) and the text of documents. Excerpts are bodies of text that have the +words+ highlighted.
     # They may also be abbreviated to fit within a word limit.
     #
@@ -368,13 +367,13 @@ module Riddle
     #
     #   client.excerpts(:docs => ["Pat Allan, #{lorem_lipsum} Pat Cash"], :words => 'Pat', :index => 'pats')
     #   #=> ["<span class=\"match\">Pat</span> Allan, Lorem ipsum dolor sit amet, consectetur adipisicing
-    #          elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua &#8230; . Excepteur 
-    #          sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est 
-    #          laborum. <span class=\"match\">Pat</span> Cash"]  
+    #          elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua &#8230; . Excepteur
+    #          sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est
+    #          laborum. <span class=\"match\">Pat</span> Cash"]
     #
     # Workflow:
     #
-    # Excerpt creation is completely isolated from searching the index. The nominated index is only used to 
+    # Excerpt creation is completely isolated from searching the index. The nominated index is only used to
     # discover encoding and charset information.
     #
     # Therefore, the workflow goes:
@@ -402,30 +401,30 @@ module Riddle
       options[:allow_empty]      ||= false
       options[:passage_boundary] ||= 'none'
       options[:emit_zones]       ||= false
-      
+
       response = Response.new request(:excerpt, excerpts_message(options))
-      
+
       options[:docs].collect { response.next }
     end
-    
+
     # Update attributes - first parameter is the relevant index, second is an
     # array of attributes to be updated, and the third is a hash, where the
     # keys are the document ids, and the values are arrays with the attribute
     # values - in the same order as the second parameter.
     #
     # Example:
-    # 
+    #
     #   client.update('people', ['birthday'], {1 => [Time.at(1982, 20, 8).to_i]})
-    # 
+    #
     def update(index, attributes, values_by_doc)
       response = Response.new request(
         :update,
         update_message(index, attributes, values_by_doc)
       )
-      
+
       response.next_int
     end
-    
+
     # Generates a keyword list for a given query. Each keyword is represented
     # by a hash, with keys :tokenised and :normalised. If return_hits is set to
     # true it will also report on the number of hits and documents for each
@@ -435,65 +434,65 @@ module Riddle
         :keywords,
         keywords_message(query, index, return_hits)
       )
-      
+
       (0...response.next_int).collect do
         hash = {}
         hash[:tokenised]  = response.next
         hash[:normalised] = response.next
-        
+
         if return_hits
           hash[:docs] = response.next_int
           hash[:hits] = response.next_int
         end
-        
+
         hash
       end
     end
-    
+
     def status
       response = Response.new request(
         :status, Message.new
       )
-      
+
       rows, cols = response.next_int, response.next_int
-      
+
       (0...rows).inject({}) do |hash, row|
         hash[response.next.to_sym] = response.next
         hash
       end
     end
-    
+
     def flush_attributes
       response = Response.new request(
         :flushattrs, Message.new
       )
-      
+
       response.next_int
     end
-    
+
     def add_override(attribute, type, values)
       @overrides[attribute] = {:type => type, :values => values}
     end
-    
+
     def open
       open_socket
-      
+
       return if Versions[:search] < 0x116
-      
+
       @socket.send [
         Commands[:persist], 0, 4, 1
       ].pack("nnNN"), 0
     end
-    
+
     def close
       close_socket
     end
-    
+
     private
-    
+
     def open_socket
       raise "Already Connected" unless @socket.nil?
-      
+
       if @timeout == 0
         @socket = initialise_connection
       else
@@ -513,19 +512,19 @@ module Riddle
           end
         end
       end
-      
+
       true
     end
-    
+
     def close_socket
       raise "Not Connected" if @socket.nil?
-      
+
       @socket.close
       @socket = nil
-      
+
       true
     end
-    
+
     # If there's an active connection to the Sphinx daemon, this will yield the
     # socket. If there's no active connection, then it will connect, yield the
     # new socket, then close it.
@@ -542,23 +541,23 @@ module Riddle
         yield @socket
       end
     end
-    
+
     def initialise_connection
       socket = initialise_socket
-      
+
       # Checking version
       version = socket.recv(4).unpack('N*').first
       if version < 1
         socket.close
         raise VersionError, "Can only connect to searchd version 1.0 or better, not version #{version}"
       end
-      
+
       # Send version
       socket.send [1].pack('N'), 0
-      
+
       socket
     end
-    
+
     def initialise_socket
       tries = 0
       begin
@@ -571,15 +570,15 @@ module Riddle
         else
           TCPSocket.new server, @port
         end
-      rescue Errno::ECONNREFUSED => e
+      rescue Errno::ETIMEDOUT, Errno::ECONNRESET, Errno::ECONNREFUSED => e
         retry if (tries += 1) < 5
         raise Riddle::ConnectionError,
           "Connection to #{server} on #{@port} failed. #{e.message}"
       end
-      
+
       socket
     end
-    
+
     def request_header(command, length = 0)
       length += key_message.length if key
       core_header = case command
@@ -596,10 +595,10 @@ module Riddle
       else
         [Commands[command], Versions[command], length].pack("nnN")
       end
-      
+
       key ? core_header + key_message : core_header
     end
-    
+
     def key_message
       @key_message ||= begin
         message = Message.new
@@ -607,7 +606,7 @@ module Riddle
         message.to_s
       end
     end
-    
+
     # Send a collection of messages, for a command type (eg, search, excerpts,
     # update), to the Sphinx daemon.
     def request(command, messages)
@@ -616,12 +615,12 @@ module Riddle
       version  = 0
       length   = 0
       message  = Riddle.encode(Array(messages).join(""), 'ASCII-8BIT')
-      
+
       connect do |socket|
         case command
         when :search
           if Versions[command] >= 0x118
-            socket.send request_header(command, message.length) + 
+            socket.send request_header(command, message.length) +
               [0, messages.length].pack('NN') + message, 0
           else
             socket.send request_header(command, message.length) +
@@ -632,24 +631,24 @@ module Riddle
         else
           socket.send request_header(command, message.length) + message, 0
         end
-        
+
         header = socket.recv(8)
         status, version, length = header.unpack('n2N')
-        
+
         while response.length < (length || 0)
           part = socket.recv(length - response.length)
 
           # will return 0 bytes if remote side closed TCP connection, e.g, searchd segfaulted.
-          break if part.length == 0 && socket.is_a?(TcpSocket)
+          break if part.length == 0 && socket.is_a?(TCPSocket)
 
           response << part if part
         end
       end
-      
+
       if response.empty? || response.length != length
         raise ResponseError, "No response from searchd (status: #{status}, version: #{version})"
       end
-      
+
       case status
       when Statuses[:ok]
         if version < Versions[command]
@@ -670,34 +669,34 @@ module Riddle
         raise ResponseError, "Unknown searchd error (status: #{status})"
       end
     end
-    
+
     # Generation of the message to send to Sphinx for a search.
     def query_message(search, index, comments = '')
       message = Message.new
-      
+
       # Mode, Limits, Sort Mode
       message.append_ints @offset, @limit, MatchModes[@match_mode],
         RankModes[@rank_mode], SortModes[@sort_mode]
       message.append_string @sort_by
-      
+
       # Query
       message.append_string search
-      
+
       # Weights
       message.append_int @weights.length
       message.append_ints *@weights
-      
+
       # Index
       message.append_string index
-      
+
       # ID Range
       message.append_int 1
       message.append_64bit_ints @id_range.first, @id_range.last
-      
+
       # Filters
       message.append_int @filters.length
       @filters.each { |filter| message.append filter.query_message }
-      
+
       # Grouping
       message.append_int GroupFunctions[@group_function]
       message.append_string @group_by
@@ -705,7 +704,7 @@ module Riddle
       message.append_string @group_clause
       message.append_ints @cut_off, @retry_count, @retry_delay
       message.append_string @group_distinct
-      
+
       # Anchor Point
       if @anchor.empty?
         message.append_int 0
@@ -715,29 +714,29 @@ module Riddle
         message.append_string @anchor[:longitude_attribute]
         message.append_floats @anchor[:latitude], @anchor[:longitude]
       end
-      
+
       # Per Index Weights
       message.append_int @index_weights.length
       @index_weights.each do |key,val|
         message.append_string key.to_s
         message.append_int val
       end
-      
+
       # Max Query Time
       message.append_int @max_query_time
-      
+
       # Per Field Weights
       message.append_int @field_weights.length
       @field_weights.each do |key,val|
         message.append_string key.to_s
         message.append_int val
       end
-      
+
       message.append_string comments
-      
+
       return message.to_s if Versions[:search] < 0x116
-      
-      # Overrides  
+
+      # Overrides
       message.append_int @overrides.length
       @overrides.each do |key,val|
         message.append_string key.to_s
@@ -756,56 +755,56 @@ module Riddle
           message.send method, map
         end
       end
-      
+
       message.append_string @select
-      
+
       message.to_s
     end
-    
+
     # Generation of the message to send to Sphinx for an excerpts request.
     def excerpts_message(options)
       message = Message.new
-      
+
       message.append [0, excerpt_flags(options)].pack('N2') # 0 = mode
       message.append_string options[:index]
       message.append_string options[:words]
-      
+
       # options
       message.append_string options[:before_match]
       message.append_string options[:after_match]
       message.append_string options[:chunk_separator]
       message.append_ints options[:limit], options[:around]
-      
+
       message.append_array options[:docs]
-      
+
       message.to_s
     end
-    
+
     # Generation of the message to send to Sphinx to update attributes of a
     # document.
     def update_message(index, attributes, values_by_doc)
       message = Message.new
-      
+
       message.append_string index
       message.append_array attributes
-      
+
       message.append_int values_by_doc.length
       values_by_doc.each do |key,values|
         message.append_64bit_int key # document ID
         message.append_ints *values # array of new values (integers)
       end
-      
+
       message.to_s
     end
-    
+
     # Generates the simple message to send to the daemon for a keywords request.
     def keywords_message(query, index, return_hits)
       message = Message.new
-      
+
       message.append_string query
       message.append_string index
       message.append_int return_hits ? 1 : 0
-      
+
       message.to_s
     end
 
@@ -826,12 +825,12 @@ module Riddle
       AttributeTypes[:multi] + AttributeTypes[:bigint]    => :next_64bit_int_array,
       AttributeTypes[:multi] + AttributeTypes[:string]    => :next_array
     }
-    
+
     def attribute_from_type(type, response)
       handler = AttributeHandlers[type]
       response.send handler
     end
-    
+
     def excerpt_flags(options)
       flags = 1
       flags |= 2   if options[:exact_phrase]