riddle 0.9.8.1231.0 → 0.9.8.1533.10

data/spec/unit/configuration/indexer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration::Indexer do
+  it "should always be valid" do
+    indexer = Riddle::Configuration::Indexer.new
+    indexer.should be_valid
+  end
+  
+  it "should support Sphinx's indexer settings" do
+    settings = %w( mem_limit max_iops max_iosize )
+    indexer = Riddle::Configuration::Indexer.new
+    
+    settings.each do |setting|
+      indexer.should respond_to(setting.to_sym)
+      indexer.should respond_to("#{setting}=".to_sym)
+    end
+  end
+  
+  it "should render a correct configuration" do
+    indexer = Riddle::Configuration::Indexer.new
+    
+    indexer.render.should == <<-INDEXER
+indexer
+{
+}
+    INDEXER
+    
+    indexer.mem_limit = "32M"
+    indexer.render.should == <<-INDEXER
+indexer
+{
+  mem_limit = 32M
+}
+    INDEXER
+  end
+end

data/spec/unit/configuration/searchd_spec.rb

@@ -0,0 +1,48 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration::Searchd do
+  it "should be invalid without a port or pid_file" do
+    searchd = Riddle::Configuration::Searchd.new
+    searchd.should_not be_valid
+    
+    searchd.port = 3312
+    searchd.should_not be_valid
+    
+    searchd.pid_file = "file.pid"
+    searchd.should be_valid
+    
+    searchd.port = nil
+    searchd.should_not be_valid
+  end
+  
+  it "should raise a ConfigurationError if rendering but not valid" do
+    searchd = Riddle::Configuration::Searchd.new
+    searchd.should_not be_valid
+    lambda { searchd.render }.should raise_error(Riddle::Configuration::ConfigurationError)
+  end
+  
+  it "should support Sphinx's searchd settings" do
+    settings = %w( address port log query_log read_timeout max_children
+      pid_file max_matches seamless_rotate preopen_indexes unlink_old )
+    searchd = Riddle::Configuration::Searchd.new
+    
+    settings.each do |setting|
+      searchd.should respond_to(setting.to_sym)
+      searchd.should respond_to("#{setting}=".to_sym)
+    end
+  end
+  
+  it "should render a correct configuration with valid settings" do
+    searchd = Riddle::Configuration::Searchd.new
+    searchd.port      = 3312
+    searchd.pid_file  = "file.pid"
+    
+    searchd.render.should == <<-SEARCHD
+searchd
+{
+  port = 3312
+  pid_file = file.pid
+}
+    SEARCHD
+  end
+end

data/spec/unit/configuration/source_spec.rb

@@ -0,0 +1,5 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration::Source do
+  #
+end

data/spec/unit/configuration/sql_source_spec.rb

@@ -0,0 +1,100 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration::SQLSource do
+  it "should be invalid without a host, user, database, and query if there's no parent" do
+    source = Riddle::Configuration::SQLSource.new("src1", "mysql")
+    source.should_not be_valid
+    
+    source.sql_host   = "localhost"
+    source.sql_user   = "test"
+    source.sql_db     = "test"
+    source.sql_query  = "SELECT * FROM tables"
+    source.should be_valid
+    
+    [:name, :type, :sql_host, :sql_user, :sql_db, :sql_query].each do |setting|
+      value = source.send(setting)
+      source.send("#{setting}=".to_sym, nil)
+      source.should_not be_nil
+      source.send("#{setting}=".to_sym, value)
+    end
+  end
+  
+  it "should be invalid without only a name and type if there is a parent" do
+    source = Riddle::Configuration::SQLSource.new("src1", "mysql")
+    source.should_not be_valid
+
+    source.parent = "sqlparent"
+    source.should be_valid
+
+    source.name = nil
+    source.should_not be_valid
+
+    source.name = "src1"
+    source.type = nil
+    source.should_not be_valid
+  end
+
+  it "should raise a ConfigurationError if rendering when not valid" do
+    source = Riddle::Configuration::SQLSource.new("src1", "mysql")
+    lambda { source.render }.should raise_error(Riddle::Configuration::ConfigurationError)
+  end
+
+  it "should render correctly when valid" do
+    source = Riddle::Configuration::SQLSource.new("src1", "mysql")
+    source.sql_host = "localhost"
+    source.sql_user = "test"
+    source.sql_pass = ""
+    source.sql_db = "test"
+    source.sql_port = 3306
+    source.sql_sock = "/tmp/mysql.sock"
+    source.mysql_connect_flags = 32
+    source.sql_query_pre << "SET NAMES utf8" << "SET SESSION query_cache_type=OFF"
+    source.sql_query = "SELECT id, group_id, UNIX_TIMESTAMP(date_added) AS date_added, title, content FROM documents WHERE id >= $start AND id <= $end"
+    source.sql_query_range = "SELECT MIN(id), MAX(id) FROM documents"
+    source.sql_range_step = 1000
+    source.sql_attr_uint << "author_id" << "forum_id:9" << "group_id"
+    source.sql_attr_bool << "is_deleted"
+    source.sql_attr_timestamp << "posted_ts" << "last_edited_ts" << "date_added"
+    source.sql_attr_str2ordinal << "author_name"
+    source.sql_attr_float << "lat_radians" << "long_radians"
+    source.sql_attr_multi << "uint tag from query; select id, tag FROM tags"
+    source.sql_query_post = ""
+    source.sql_query_post_index = "REPLACE INTO counters (id, val) VALUES ('max_indexed_id', $maxid)"
+    source.sql_ranged_throttle = 0
+    source.sql_query_info = "SELECT * FROM documents WHERE id = $id"
+
+    source.render.should == <<-SQLSOURCE
+source src1
+{
+  type = mysql
+  sql_host = localhost
+  sql_user = test
+  sql_pass = 
+  sql_db = test
+  sql_port = 3306
+  sql_sock = /tmp/mysql.sock
+  mysql_connect_flags = 32
+  sql_query_pre = SET NAMES utf8
+  sql_query_pre = SET SESSION query_cache_type=OFF
+  sql_query = SELECT id, group_id, UNIX_TIMESTAMP(date_added) AS date_added, title, content FROM documents WHERE id >= $start AND id <= $end
+  sql_query_range = SELECT MIN(id), MAX(id) FROM documents
+  sql_range_step = 1000
+  sql_attr_uint = author_id
+  sql_attr_uint = forum_id:9
+  sql_attr_uint = group_id
+  sql_attr_bool = is_deleted
+  sql_attr_timestamp = posted_ts
+  sql_attr_timestamp = last_edited_ts
+  sql_attr_timestamp = date_added
+  sql_attr_str2ordinal = author_name
+  sql_attr_float = lat_radians
+  sql_attr_float = long_radians
+  sql_attr_multi = uint tag from query; select id, tag FROM tags
+  sql_query_post = 
+  sql_query_post_index = REPLACE INTO counters (id, val) VALUES ('max_indexed_id', $maxid)
+  sql_ranged_throttle = 0
+  sql_query_info = SELECT * FROM documents WHERE id = $id
+}
+    SQLSOURCE
+  end
+end

data/spec/unit/configuration/xml_source_spec.rb

@@ -0,0 +1,51 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration::XMLSource do
+  it "should be invalid without an xmlpipe command, name and type if there's no parent" do
+    source = Riddle::Configuration::XMLSource.new("xml1", "xmlpipe")
+    source.should_not be_valid
+    
+    source.xmlpipe_command = "ls /var/null"
+    source.should be_valid
+    
+    source.name = nil
+    source.should_not be_valid
+    
+    source.name = "xml1"
+    source.type = nil
+    source.should_not be_valid
+  end
+  
+  it "should be invalid without only a name and type if there is a parent" do
+    source = Riddle::Configuration::XMLSource.new("xml1", "xmlpipe")
+    source.should_not be_valid
+    
+    source.parent = "xmlparent"
+    source.should be_valid
+    
+    source.name = nil
+    source.should_not be_valid
+    
+    source.name = "xml1"
+    source.type = nil
+    source.should_not be_valid
+  end
+  
+  it "should raise a ConfigurationError if rendering when not valid" do
+    source = Riddle::Configuration::XMLSource.new("xml1", "xmlpipe")
+    lambda { source.render }.should raise_error(Riddle::Configuration::ConfigurationError)
+  end
+  
+  it "should render correctly when valid" do
+    source = Riddle::Configuration::XMLSource.new("xml1", "xmlpipe")
+    source.xmlpipe_command = "ls /var/null"
+    
+    source.render.should == <<-XMLSOURCE
+source xml1
+{
+  type = xmlpipe
+  xmlpipe_command = ls /var/null
+}
+    XMLSOURCE
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec/spec_helper'
+
+describe Riddle::Configuration do
+  it "should render all given indexes and sources, plus the indexer and search sections" do
+    config = Riddle::Configuration.new
+    
+    config.searchd.port = 3312
+    config.searchd.pid_file = "file.pid"
+    
+    source = Riddle::Configuration::XMLSource.new("src1", "xmlpipe")
+    source.xmlpipe_command = "ls /dev/null"
+    
+    index = Riddle::Configuration::Index.new("index1")
+    index.path = "/path/to/index1"
+    index.sources << source
+    
+    config.indexes << index
+    generated_conf = config.render
+    
+    generated_conf.should match(/index index1/)
+    generated_conf.should match(/source src1/)
+    generated_conf.should match(/indexer/)
+    generated_conf.should match(/searchd/)
+  end
+end

data/spec/unit/filter_spec.rb

@@ -30,4 +30,9 @@ describe Riddle::Client::Filter do
     filter = Riddle::Client::Filter.new("field", 5.4..13.5, true)
     filter.query_message.should == query_contents(:filter_floats_exclude)
   end
+  
+  it "should render a filter that is an array of boolean values correctly" do
+    filter = Riddle::Client::Filter.new("field", [false, true])
+    filter.query_message.should == query_contents(:filter_boolean)
+  end
 end

data/spec/unit/riddle_spec.rb

@@ -0,0 +1,17 @@
+require 'spec/spec_helper'
+
+describe "Riddle" do
+  it "should escape characters correctly" do
+    invalid_chars = ['(', ')', '|', '-', '!', '@', '~', '"', '/']
+    invalid_chars.each do |char|
+      base = "string with '#{char}' character"
+      Riddle.escape(base).should == base.gsub(char, "\\#{char}")
+    end
+    
+    # Not sure why this doesn't work within the loop...
+    Riddle.escape("string with & character").should == "string with \\& character"
+    
+    all_chars = invalid_chars.join('') + '&'
+    Riddle.escape(all_chars).should == "\\(\\)\\|\\-\\!\\@\\~\\\"\\/\\&"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riddle
 version: !ruby/object:Gem::Version 
-  version: 0.9.8.1231.0
+  version: 0.9.8.1533.10
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-29 00:00:00 +11:00
+date: 2009-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -26,11 +26,42 @@ files:
 - lib/riddle/client/message.rb
 - lib/riddle/client/response.rb
 - lib/riddle/client.rb
+- lib/riddle/configuration/distributed_index.rb
+- lib/riddle/configuration/index.rb
+- lib/riddle/configuration/indexer.rb
+- lib/riddle/configuration/remote_index.rb
+- lib/riddle/configuration/searchd.rb
+- lib/riddle/configuration/section.rb
+- lib/riddle/configuration/source.rb
+- lib/riddle/configuration/sql_source.rb
+- lib/riddle/configuration/xml_source.rb
+- lib/riddle/configuration.rb
+- lib/riddle/controller.rb
 - lib/riddle.rb
+- lib/tabtab_definitions.rb
 - MIT-LICENCE
-- README
+- README.textile
+- 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
+- spec/unit/configuration/distributed_index_spec.rb
+- spec/unit/configuration/index_spec.rb
+- spec/unit/configuration/indexer_spec.rb
+- spec/unit/configuration/searchd_spec.rb
+- spec/unit/configuration/source_spec.rb
+- spec/unit/configuration/sql_source_spec.rb
+- spec/unit/configuration/xml_source_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/filter_spec.rb
+- spec/unit/message_spec.rb
+- spec/unit/response_spec.rb
+- spec/unit/riddle_spec.rb
 has_rdoc: true
 homepage: http://riddle.freelancing-gods.com
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -55,9 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: riddle
-rubygems_version: 1.0.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: API for Sphinx, written in and for Ruby.
 test_files: 
 - spec/functional/excerpt_spec.rb
@@ -65,6 +96,15 @@ test_files:
 - spec/functional/search_spec.rb
 - spec/functional/update_spec.rb
 - spec/unit/client_spec.rb
+- spec/unit/configuration/distributed_index_spec.rb
+- spec/unit/configuration/index_spec.rb
+- spec/unit/configuration/indexer_spec.rb
+- spec/unit/configuration/searchd_spec.rb
+- spec/unit/configuration/source_spec.rb
+- spec/unit/configuration/sql_source_spec.rb
+- spec/unit/configuration/xml_source_spec.rb
+- spec/unit/configuration_spec.rb
 - spec/unit/filter_spec.rb
 - spec/unit/message_spec.rb
 - spec/unit/response_spec.rb
+- spec/unit/riddle_spec.rb

data/README

@@ -1,74 +0,0 @@
-This client has been written to interface with Sphinx[http://sphinxsearch.com/]. It is written by
-{Pat Allan}[http://freelancing-gods.com], and has been influenced by both Dmytro Shteflyuk's Ruby
-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.
-
-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-rc2 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, 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: 0.9.8.1198)
-* 0.9.8-rc2 (gem version: 0.9.8.1231)
-
-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:
-
-* :matches
-* :fields
-* :attributes
-* :attribute_names
-* :words
-* :total
-* :total_found
-* :time
-* :status
-* :warning (if appropriate)
-* :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 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), 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>.
-
-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.