riddle 1.0.11 → 1.0.12

data/lib/riddle.rb

@@ -37,6 +37,8 @@ lines after "require 'riddle'" to avoid this warning.
   require 'riddle/0.9.8'
   # or
   require 'riddle/0.9.9'
+  # or
+  require 'riddle/1.10'
 
     }
   end

data/lib/riddle/1.10.rb

@@ -0,0 +1,5 @@
+require 'riddle/0.9.9'
+
+Riddle.loaded_version = '1.10'
+
+require 'riddle/1.10/client'

data/lib/riddle/1.10/client.rb

@@ -0,0 +1,28 @@
+Riddle::Client::Versions[:search]  = 0x117
+Riddle::Client::Versions[:excerpt] = 0x102
+
+class Riddle::Client
+  private
+  
+  # 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_ints options[:limit_passages], options[:limit_words]
+    message.append_ints options[:start_passage_id]
+    message.append_string options[:html_strip_mode]
+    
+    message.append_array options[:docs]
+    
+    message.to_s
+  end
+end

data/lib/riddle/auto_version.rb

@@ -6,6 +6,8 @@ class Riddle::AutoVersion
     case version
     when '0.9.8', '0.9.9'
       require "riddle/#{version}"
+    when '1.10-beta'
+      require 'riddle/1.10'
     end
   end
 end

data/lib/riddle/client.rb

@@ -30,22 +30,24 @@ module Riddle
   #
   class Client
     Commands = {
-      :search   => 0, # SEARCHD_COMMAND_SEARCH
-      :excerpt  => 1, # SEARCHD_COMMAND_EXCERPT
-      :update   => 2, # SEARCHD_COMMAND_UPDATE
-      :keywords => 3, # SEARCHD_COMMAND_KEYWORDS
-      :persist  => 4, # SEARCHD_COMMAND_PERSIST
-      :status   => 5, # SEARCHD_COMMAND_STATUS
-      :query    => 6  # SEARCHD_COMMAND_QUERY
+      :search     => 0, # SEARCHD_COMMAND_SEARCH
+      :excerpt    => 1, # SEARCHD_COMMAND_EXCERPT
+      :update     => 2, # SEARCHD_COMMAND_UPDATE
+      :keywords   => 3, # SEARCHD_COMMAND_KEYWORDS
+      :persist    => 4, # SEARCHD_COMMAND_PERSIST
+      :status     => 5, # SEARCHD_COMMAND_STATUS
+      :query      => 6, # SEARCHD_COMMAND_QUERY
+      :flushattrs => 7  # SEARCHD_COMMAND_FLUSHATTRS
     }
     
     Versions = {
-      :search   => 0x113, # VER_COMMAND_SEARCH
-      :excerpt  => 0x100, # VER_COMMAND_EXCERPT
-      :update   => 0x101, # VER_COMMAND_UPDATE
-      :keywords => 0x100, # VER_COMMAND_KEYWORDS
-      :status   => 0x100, # VER_COMMAND_STATUS
-      :query    => 0x100  # VER_COMMAND_QUERY
+      :search     => 0x113, # VER_COMMAND_SEARCH
+      :excerpt    => 0x100, # VER_COMMAND_EXCERPT
+      :update     => 0x101, # VER_COMMAND_UPDATE
+      :keywords   => 0x100, # VER_COMMAND_KEYWORDS
+      :status     => 0x100, # VER_COMMAND_STATUS
+      :query      => 0x100, # VER_COMMAND_QUERY
+      :flushattrs => 0x100  # VER_COMMAND_FLUSHATTRS
     }
     
     Statuses = {
@@ -72,7 +74,9 @@ module Riddle
       :wordcount      => 3, # SPH_RANK_WORDCOUNT
       :proximity      => 4, # SPH_RANK_PROXIMITY
       :match_any      => 5, # SPH_RANK_MATCHANY
-      :fieldmask      => 6  # SPH_RANK_FIELDMASK
+      :fieldmask      => 6, # SPH_RANK_FIELDMASK
+      :sph04          => 7, # SPH_RANK_SPH04
+      :total          => 8  # SPH_RANK_TOTAL
     }
     
     SortModes = {
@@ -91,6 +95,7 @@ module Riddle
       :bool       => 4, # SPH_ATTR_BOOL
       :float      => 5, # SPH_ATTR_FLOAT
       :bigint     => 6, # SPH_ATTR_BIGINT
+      :string     => 7, # SPH_ATTR_STRING
       :multi      => 0x40000000 # SPH_ATTR_MULTI
     }
     
@@ -356,14 +361,22 @@ module Riddle
     # 3. Pass the documents' text to +excerpts+ for marking up of matched terms.
     #
     def excerpts(options = {})
-      options[:index]           ||= '*'
-      options[:before_match]    ||= '<span class="match">'
-      options[:after_match]     ||= '</span>'
-      options[:chunk_separator] ||= ' &#8230; ' # ellipsis
-      options[:limit]           ||= 256
-      options[:around]          ||= 5
-      options[:exact_phrase]    ||= false
-      options[:single_passage]  ||= false
+      options[:index]            ||= '*'
+      options[:before_match]     ||= '<span class="match">'
+      options[:after_match]      ||= '</span>'
+      options[:chunk_separator]  ||= ' &#8230; ' # ellipsis
+      options[:limit]            ||= 256
+      options[:limit_passages]   ||= 0
+      options[:limit_words]      ||= 0
+      options[:around]           ||= 5
+      options[:exact_phrase]     ||= false
+      options[:single_passage]   ||= false
+      options[:query_mode]       ||= false
+      options[:force_all_words]  ||= false
+      options[:start_passage_id] ||= 1
+      options[:load_files]       ||= false
+      options[:html_strip_mode]  ||= 'index'
+      options[:allow_empty]      ||= false
       
       response = Response.new request(:excerpt, excerpts_message(options))
       
@@ -425,6 +438,14 @@ module Riddle
       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
@@ -678,13 +699,7 @@ module Riddle
     def excerpts_message(options)
       message = Message.new
       
-      flags = 1
-      flags |= 2  if options[:exact_phrase]
-      flags |= 4  if options[:single_passage]
-      flags |= 8  if options[:use_boundaries]
-      flags |= 16 if options[:weight_order]
-      
-      message.append [0, flags].pack('N2') # 0 = mode
+      message.append [0, excerpt_flags(options)].pack('N2') # 0 = mode
       message.append_string options[:index]
       message.append_string options[:words]
       
@@ -735,9 +750,24 @@ module Riddle
         is_multi ? response.next_float_array    : response.next_float
       when AttributeTypes[:bigint]
         is_multi ? response.next_64bit_int_arry : response.next_64bit_int
+      when AttributeTypes[:string]
+        is_multi ? response.next_array          : response.next
       else
         is_multi ? response.next_int_array      : response.next_int
       end
     end
+    
+    def excerpt_flags(options)
+      flags = 1
+      flags |= 2   if options[:exact_phrase]
+      flags |= 4   if options[:single_passage]
+      flags |= 8   if options[:use_boundaries]
+      flags |= 16  if options[:weight_order]
+      flags |= 32  if options[:query_mode]
+      flags |= 64  if options[:force_all_words]
+      flags |= 128 if options[:load_files]
+      flags |= 256 if options[:allow_empty]
+      flags
+    end
   end
 end

data/lib/riddle/controller.rb

@@ -12,7 +12,7 @@ module Riddle
     end
     
     def sphinx_version
-      `#{indexer} 2>&1`[/^Sphinx (\d\.\d\.\d)/, 1]
+      `#{indexer} 2>&1`[/^Sphinx (\d+\.\d+(\.\d+|\-beta))/, 1]
     rescue
       nil
     end
@@ -21,7 +21,7 @@ module Riddle
       options = indexes.last.is_a?(Hash) ? indexes.pop : {}
       indexes << '--all' if indexes.empty?
       
-      cmd = "#{indexer} --config '#{@path}' #{indexes.join(' ')}"
+      cmd = "#{indexer} --config \"#{@path}\" #{indexes.join(' ')}"
       cmd << " --rotate" if running?
       options[:verbose] ? system(cmd) : `#{cmd}`
     end
@@ -29,7 +29,7 @@ module Riddle
     def start
       return if running?
       
-      cmd = "#{searchd} --pidfile --config '#{@path}'"
+      cmd = "#{searchd} --pidfile --config \"#{@path}\""
       
       if RUBY_PLATFORM =~ /mswin/
         system("start /B #{cmd} 1> NUL 2>&1")

data/spec/functional/excerpt_spec.rb

@@ -48,7 +48,8 @@ not. It's just my name: Pat.
     )
     
     
-    if Riddle.loaded_version == '0.9.9'
+    case Riddle.loaded_version
+    when '0.9.9'
       excerpts.should == [
         <<-SENTENCE
 This is a really long sentence written by <em>Pat</em>. It has to be over 256
@@ -57,6 +58,8 @@ yeah? Excerpts are particularly riveting. This keyword, however, is
 not. It's just my name: <em>Pat</em>.
         SENTENCE
       ]
+    when '1.10'
+      excerpts.should == [" &#8230;  really long sentence written by <em>Pat</em>. It has to be over &#8230; . This keyword, however, is\nnot. It's just my name: <em>Pat</em> &#8230; "]
     else
       excerpts.should == [
         <<-SENTENCE
@@ -90,7 +93,8 @@ not. It's just my name: Pat.
       :chunk_separator => " --- "
     )
     
-    if Riddle.loaded_version == '0.9.9'
+    case Riddle.loaded_version
+    when '0.9.9'
       excerpts.should == [
         <<-SENTENCE
 This is a really long sentence written by <em>Pat</em>. It has to be over 256
@@ -99,6 +103,8 @@ yeah? Excerpts are particularly riveting. This keyword, however, is
 not. It's just my name: <em>Pat</em>.
         SENTENCE
       ]
+    when '1.10'
+      excerpts.should == [" ---  really long sentence written by <em>Pat</em>. It has to be over --- . This keyword, however, is\nnot. It's just my name: <em>Pat</em> --- "]
     else
       excerpts.should == [
         <<-SENTENCE

data/spec/functional/status_spec.rb

@@ -1,6 +1,6 @@
 require 'spec/spec_helper'
 
-if Riddle.loaded_version == '0.9.9'
+if Riddle.loaded_version == '0.9.9' || Riddle.loaded_version == '1.10'
   describe "Sphinx Status" do
     before :each do
       @client = Riddle::Client.new("localhost", 9313)

data/spec/riddle/auto_version_spec.rb

@@ -20,5 +20,12 @@ describe Riddle::AutoVersion do
       @controller.stub!(:sphinx_version => '0.9.9')
       Riddle::AutoVersion.configure
     end
+    
+    it "should require 1.10 if that is the known version" do
+      Riddle::AutoVersion.should_receive(:require).with('riddle/1.10')
+      
+      @controller.stub!(:sphinx_version => '1.10-beta')
+      Riddle::AutoVersion.configure
+    end
   end
 end

data/spec/riddle/controller_spec.rb

@@ -6,6 +6,11 @@ describe Riddle::Controller do
       @controller = Riddle::Controller.new stub('controller'), 'sphinx.conf'
     end
     
+    it "should return 1.10 if using 1.10-beta" do
+      @controller.stub!(:` => 'Sphinx 1.10-beta (r2420)')
+      @controller.sphinx_version.should == '1.10-beta'
+    end
+    
     it "should return 0.9.9 if using 0.9.9" do
       @controller.stub!(:` => 'Sphinx 0.9.9-release (r2117)')
       @controller.sphinx_version.should == '0.9.9'

data/spec/unit/client_spec.rb

@@ -130,7 +130,7 @@ describe Riddle::Client do
     client.queue.first.should == query_contents(:comment)
   end
   
-  if Riddle.loaded_version == '0.9.9'
+  if Riddle.loaded_version == '0.9.9' || Riddle.loaded_version == '1.10'
     it "should build a message with overrides correctly" do
       client = Riddle::Client.new
       client.add_override("rating", :float, {1 => 10.0})

data/spec/unit/configuration/searchd_spec.rb

@@ -1,7 +1,7 @@
 require 'spec/spec_helper'
 
 describe Riddle::Configuration::Searchd do
-  if Riddle.loaded_version == '0.9.9'
+  if Riddle.loaded_version == '0.9.9' || Riddle.loaded_version == '1.10'
     it "should be invalid without a listen or pid_file" do
       searchd = Riddle::Configuration::Searchd.new
       searchd.should_not be_valid
@@ -60,7 +60,7 @@ describe Riddle::Configuration::Searchd do
     searchd.port      = 3312
     searchd.pid_file  = "file.pid"
     
-    if Riddle.loaded_version == '0.9.9'
+    if Riddle.loaded_version == '0.9.9' || Riddle.loaded_version == '1.10'
       searchd.render.should == <<-SEARCHD
 searchd
 {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: riddle
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 1
   - 0
-  - 11
-  version: 1.0.11
+  - 12
+  version: 1.0.12
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +10:00
+date: 2010-07-27 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,8 @@ files:
 - lib/riddle/0.9.9/client.rb
 - lib/riddle/0.9.9/client/filter.rb
 - lib/riddle/0.9.9/configuration/searchd.rb
+- lib/riddle/1.10.rb
+- lib/riddle/1.10/client.rb
 - lib/riddle/auto_version.rb
 - lib/riddle/client.rb
 - lib/riddle/client/filter.rb