riddle 0.9.8.1112 → 0.9.8.1198

data/README

@@ -5,16 +5,27 @@ client and the original PHP client - credit where credit's due, after all.
 It does not follow the same syntax as those two, though (not much point writing this otherwise) -
 opting for a more Ruby-like structure.
 
-While it doesn't (yet) exist as a gem, you can obtain the sourcecode via subversion. If you
+The easiest way to install is to grab the gem (available since 0.9.8r1112 only):
+
+  sudo gem install riddle
+
+However, if you're so inclined, you can grab sourcecode via subversion. If you
 are after a specific release, use the tag as follows:
 
-  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags/0.9.8-r1112 riddle
+  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags/0.9.8-rc1 riddle
 
 Or for the most current, just use trunk:
 
   svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/trunk riddle
 
-Please note that at the time of writing, only 0.9.8r871 through to 0.9.8r1112 are supported.
+Please note that at the time of writing, the following versions are supported (if you get the appropriate tag):
+
+* 0.9.8-r871
+* 0.9.8-r909
+* 0.9.8-r985
+* 0.9.8-r1065
+* 0.9.8-r1112
+* 0.9.8-rc1 (gem version is 0.9.8.1198)
 
 To get started, just instantiate a Client object:
 
@@ -57,4 +68,6 @@ total number of matches (which may be greater than the maximum available), and t
 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>.
+the <tt>:warning</tt> key. Fatal errors will be described under <tt>:error</tt>.
+
+If you've installed the gem and wondering why there's no tests - check out the svn version. I've kept the specs out of the gem as I have a decent amount of test data in there, which really isn't needed unless you want to submit patches.

data/lib/riddle.rb

@@ -12,9 +12,11 @@ module Riddle #:nodoc:
     Major = 0
     Minor = 9
     Tiny  = 8
-    Rev   = 1112
+    # Revision number for RubyForge's sake, taken from what Sphinx
+    # outputs to the command line.
+    Rev   = 1198
     
-    String      = [Major, Minor, Tiny].join('.') + "r#{Rev}"
+    String      = [Major, Minor, Tiny].join('.') + "rc1"
     GemVersion  = [Major, Minor, Tiny, Rev].join('.')
   end
 end

data/lib/riddle/client.rb

@@ -26,15 +26,17 @@ module Riddle
   #
   class Client
     Commands = {
-      :search  => 0, # SEARCHD_COMMAND_SEARCH
-      :excerpt => 1, # SEARCHD_COMMAND_EXCERPT
-      :update  => 2  # SEARCHD_COMMAND_UPDATE
+      :search   => 0, # SEARCHD_COMMAND_SEARCH
+      :excerpt  => 1, # SEARCHD_COMMAND_EXCERPT
+      :update   => 2, # SEARCHD_COMMAND_UPDATE
+      :keywords => 3  # SEARCHD_COMMAND_KEYWORDS
     }
     
     Versions = {
-      :search  => 0x112, # VER_COMMAND_SEARCH
-      :excerpt => 0x100, # VER_COMMAND_EXCERPT
-      :update  => 0x101  # VER_COMMAND_UPDATE
+      :search   => 0x113, # VER_COMMAND_SEARCH
+      :excerpt  => 0x100, # VER_COMMAND_EXCERPT
+      :update   => 0x101, # VER_COMMAND_UPDATE
+      :keywords => 0x100  # VER_COMMAND_KEYWORDS
     }
     
     Statuses = {
@@ -50,7 +52,7 @@ module Riddle
       :phrase     => 2, # SPH_MATCH_PHRASE
       :boolean    => 3, # SPH_MATCH_BOOLEAN
       :extended   => 4, # SPH_MATCH_EXTENDED
-      :fullsacn   => 5, # SPH_MATCH_FULLSCAN
+      :fullscan   => 5, # SPH_MATCH_FULLSCAN
       :extended2  => 6  # SPH_MATCH_EXTENDED2
     }
     
@@ -158,8 +160,8 @@ module Riddle
     
     # Append a query to the queue. This uses the same parameters as the query
     # method.
-    def append_query(search, index = '*')
-      @queue << query_message(search, index)
+    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
@@ -275,8 +277,8 @@ module Riddle
     # related warning, it will be under the <tt>:warning</tt> key. Fatal errors
     # will be described under <tt>:error</tt>.
     #
-    def query(search, index = '*')      
-      @queue << query_message(search, index)
+    def query(search, index = '*', comments = '')
+      @queue << query_message(search, index, comments)
       self.run.first
     end
     
@@ -358,6 +360,30 @@ module Riddle
       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
+    # keyword (see :hits and :docs keys respectively).
+    def keywords(query, index, return_hits = false)
+      response = Response.new request(
+        :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
+    
     private
     
     # Connects to the Sphinx daemon, and yields a socket to use. The socket is
@@ -439,7 +465,7 @@ module Riddle
     end
     
     # Generation of the message to send to Sphinx for a search.
-    def query_message(search, index)
+    def query_message(search, index, comments = '')
       message = Message.new
       
       # Mode, Limits, Sort Mode
@@ -500,6 +526,8 @@ module Riddle
         message.append_int val
       end
       
+      message.append_string comments
+      
       message.to_s
     end
     
@@ -544,5 +572,16 @@ module Riddle
       
       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
   end
 end

data/spec/functional/keywords_spec.rb

@@ -0,0 +1,40 @@
+require 'spec/spec_helper'
+
+describe "Sphinx Keywords" do
+  before :each do
+    @client = Riddle::Client.new("localhost", 3313)
+  end
+  
+  it "should return an array of hashes" do
+    results = @client.keywords("pat", "people")
+    results.should be_kind_of(Array)
+    
+    results.each do |result|
+      result.should be_kind_of(Hash)
+    end
+  end
+  
+  it "should have keys for normalised and tokenised versions of the keywords" do
+    results = @client.keywords("pat", "people")
+    results.each do |result|
+      result.keys.should include(:normalised)
+      result.keys.should include(:tokenised)
+    end
+  end
+  
+  it "shouldn't have docs or hits keys if not requested" do
+    results = @client.keywords("pat", "people")
+    results.each do |result|
+      result.keys.should_not include(:docs)
+      result.keys.should_not include(:hits)
+    end
+  end
+  
+  it "should have docs and hits keys if requested" do
+    results = @client.keywords("pat", "people", true)
+    results.each do |result|
+      result.keys.should include(:docs)
+      result.keys.should include(:hits)
+    end
+  end
+end

data/spec/unit/client_spec.rb

@@ -123,6 +123,12 @@ describe Riddle::Client do
     client.queue.first.should == query_contents(:field_weights)
   end
   
+  it "should build a message with acomment correctly" do
+    client = Riddle::Client.new
+    client.append_query "test ", "*", "commenting"
+    client.queue.first.should == query_contents(:comment)
+  end
+  
   it "should keep multiple messages in the queue" do
     client = Riddle::Client.new
     client.weights = [100, 1]
@@ -151,4 +157,24 @@ describe Riddle::Client do
       {1 => [191163600]}
     ).should == query_contents(:update_simple)
   end
+  
+  it "should build a keywords request without hits correctly" do
+    client = Riddle::Client.new
+    client.send(
+      :keywords_message,
+      "pat",
+      "people",
+      false
+    ).should == query_contents(:keywords_without_hits)
+  end
+  
+  it "should build a keywords request with hits correctly" do
+    client = Riddle::Client.new
+    client.send(
+      :keywords_message,
+      "pat",
+      "people",
+      true
+    ).should == query_contents(:keywords_with_hits)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riddle
 version: !ruby/object:Gem::Version 
-  version: 0.9.8.1112
+  version: 0.9.8.1198
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-05 00:00:00 +11:00
+date: 2008-03-21 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -29,65 +29,6 @@ files:
 - lib/riddle.rb
 - MIT-LICENCE
 - README
-- spec/fixtures
-- spec/fixtures/data
-- spec/fixtures/data/anchor.bin
-- spec/fixtures/data/any.bin
-- spec/fixtures/data/boolean.bin
-- spec/fixtures/data/distinct.bin
-- spec/fixtures/data/field_weights.bin
-- spec/fixtures/data/filter.bin
-- spec/fixtures/data/filter_array.bin
-- spec/fixtures/data/filter_array_exclude.bin
-- spec/fixtures/data/filter_floats.bin
-- spec/fixtures/data/filter_floats_exclude.bin
-- spec/fixtures/data/filter_floats_range.bin
-- spec/fixtures/data/filter_range.bin
-- spec/fixtures/data/filter_range_exclude.bin
-- spec/fixtures/data/group.bin
-- spec/fixtures/data/index.bin
-- spec/fixtures/data/index_weights.bin
-- spec/fixtures/data/phrase.bin
-- spec/fixtures/data/rank_mode.bin
-- spec/fixtures/data/simple.bin
-- spec/fixtures/data/sort.bin
-- spec/fixtures/data/update_simple.bin
-- spec/fixtures/data/weights.bin
-- spec/fixtures/data_generator.php
-- spec/fixtures/sphinx
-- spec/fixtures/sphinx/configuration.erb
-- spec/fixtures/sphinx/people.old.spa
-- spec/fixtures/sphinx/people.old.spd
-- spec/fixtures/sphinx/people.old.sph
-- spec/fixtures/sphinx/people.old.spi
-- spec/fixtures/sphinx/people.old.spm
-- spec/fixtures/sphinx/people.old.spp
-- spec/fixtures/sphinx/people.spa
-- spec/fixtures/sphinx/people.spd
-- spec/fixtures/sphinx/people.sph
-- spec/fixtures/sphinx/people.spi
-- spec/fixtures/sphinx/people.spm
-- spec/fixtures/sphinx/people.spp
-- spec/fixtures/sphinx/searchd.log
-- spec/fixtures/sphinx/searchd.query.log
-- spec/fixtures/sphinx/spec.conf
-- spec/fixtures/sphinxapi.php
-- spec/fixtures/sql
-- spec/fixtures/sql/conf.example.yml
-- spec/fixtures/sql/conf.yml
-- spec/fixtures/sql/data.sql
-- spec/fixtures/sql/structure.sql
-- spec/functional
-- spec/functional/excerpt_spec.rb
-- spec/functional/search_spec.rb
-- spec/functional/update_spec.rb
-- spec/spec_helper.rb
-- spec/sphinx_helper.rb
-- spec/unit
-- spec/unit/client_spec.rb
-- spec/unit/filter_spec.rb
-- spec/unit/message_spec.rb
-- spec/unit/response_spec.rb
 has_rdoc: true
 homepage: http://riddle.freelancing-gods.com
 post_install_message: 
@@ -120,6 +61,7 @@ specification_version: 2
 summary: API for Sphinx, written in and for Ruby.
 test_files: 
 - spec/functional/excerpt_spec.rb
+- spec/functional/keywords_spec.rb
 - spec/functional/search_spec.rb
 - spec/functional/update_spec.rb
 - spec/unit/client_spec.rb

data/spec/fixtures/data_generator.php

@@ -1,130 +0,0 @@
-<?php
-include 'sphinxapi.php';
-
-$client = new SphinxClient();
-$client->SetServer("localhost", 3312);
-
-// simple
-$file = fopen("spec/fixtures/data/simple.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-// index
-$file = fopen("spec/fixtures/data/index.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ", "edition")]);
-fclose($file);
-
-// any
-$client->SetMatchMode(SPH_MATCH_ANY);
-
-$file = fopen("spec/fixtures/data/any.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test this ")]);
-fclose($file);
-
-$client->SetMatchMode(SPH_MATCH_ALL);
-
-// sort
-$client->SetSortMode(SPH_SORT_EXTENDED, "id");
-
-$file = fopen("spec/fixtures/data/sort.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("testing ")]);
-fclose($file);
-
-$client->SetSortMode(SPH_SORT_RELEVANCE, "");
-
-// boolean
-$client->SetMatchMode(SPH_MATCH_BOOLEAN);
-
-$file = fopen("spec/fixtures/data/boolean.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->SetMatchMode(SPH_MATCH_ALL);
-
-// phrase
-$client->SetMatchMode(SPH_MATCH_PHRASE);
-
-$file = fopen("spec/fixtures/data/phrase.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("testing this ")]);
-fclose($file);
-
-$client->SetMatchMode(SPH_MATCH_ALL);
-
-// filter
-$client->SetFilter("id", array(10, 100, 1000));
-
-$file = fopen("spec/fixtures/data/filter.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->ResetFilters();
-
-// group
-$client->SetGroupBy("id", SPH_GROUPBY_ATTR, "id");
-
-$file = fopen("spec/fixtures/data/group.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->ResetGroupBy();
-
-// distinct
-$client->SetGroupDistinct("id");
-
-$file = fopen("spec/fixtures/data/distinct.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->ResetGroupBy();
-
-// weights
-$client->SetWeights(array(100, 1));
-
-$file = fopen("spec/fixtures/data/weights.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->SetWeights(array());
-
-// anchor
-$client->SetGeoAnchor("latitude", "longitude", 10.0, 95.0);
-
-$file = fopen("spec/fixtures/data/anchor.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->ResetFilters();
-
-// rank_mode
-$client->SetRankingMode(SPH_RANK_WORDCOUNT);
-
-$file = fopen("spec/fixtures/data/rank_mode.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->SetRankingMode(SPH_RANK_PROXIMITY_BM25);
-
-// index_weights
-$client->SetIndexWeights(array("people" => 101));
-
-$file = fopen("spec/fixtures/data/index_weights.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->SetIndexWeights(array());
-
-// index_weights
-$client->SetFieldWeights(array("city" => 101));
-
-$file = fopen("spec/fixtures/data/field_weights.bin", "w");
-fwrite($file, $client->_reqs[$client->AddQuery("test ")]);
-fclose($file);
-
-$client->SetFieldWeights(array());
-
-// update_simple
-$file = fopen("spec/fixtures/data/update_simple.bin", "w");
-fwrite($file, $client->UpdateAttributes("people", array("birthday"), array(1 => array(191163600))));
-fclose($file);
-
-?>