ultrasphinx 1.5.3 → 1.6

data/test/integration/app/test/fixtures/users.yml

@@ -5,7 +5,7 @@
   crypted_password: "2fdefe5c83d80a03a828dd65e90cfff65f0fb42d043a254ca2cad6af968d0e15" #password
   email: <%= "user#{num}@test.com" %>
   salt: "1000"
-  created_at: <%= (Time.now - 30).to_s :db %>
-  updated_at: <%= Time.now.to_s :db %>
+  updated_at: <%= (time = Time.parse("Tue Oct 23 04:28:11")).to_s(:db) %>
+  created_at: <%= (time - 180).to_s(:db) %>
   deleted: <%= num == 41 ? true : false %>
 <% end %>

data/test/integration/search_test.rb

@@ -14,22 +14,42 @@ class SearchTest < Test::Unit::TestCase
     assert_equal 20, @s.results.size
   end  
   
-  def test_query_must_be_run
-    @s = S.new
-    assert_raises(E) { @s.total_entries }
-    assert_raises(E) { @s.response }
-    assert_raises(E) { @s.facets }
-    assert_raises(E) { @s.results }
-  end
-  
-  def test_subtotals
+  def test_with_subtotals_option
+    S.client_options['with_subtotals'] = true
     @s = S.new.run
     assert_equal @s.total_entries, @s.subtotals.values._sum
+    S.client_options['with_subtotals'] = false
+  end
+  
+  def test_ignore_missing_records_option
+    @s = S.new(:per_page => 1).run
+    @record = @s.first
+    assert_equal 1, @s.size
+    
+    @record.destroy
+
+    assert_raises(ActiveRecord::RecordNotFound) do
+      @s = S.new(:per_page => 1).run
+    end    
+    
+    S.client_options['ignore_missing_records'] = true
+    assert_nothing_raised do
+      @s = S.new(:per_page => 1).run
+    end 
+    assert_equal 0, @s.size
+    assert_equal 1, @s.per_page
+
+    S.client_options['ignore_missing_records'] = false
+    
+    # Re-insert the record... ugh
+    @new_record = @record.class.new(@record.attributes)
+    @new_record.id = @record.id
+    @new_record.save!
   end
   
   def test_query_retries_and_fails
     system("cd #{RAILS_ROOT}; rake ultrasphinx:daemon:stop &> /dev/null")
-    assert_raises(Sphinx::SphinxConnectError) do
+    assert_raises(Ultrasphinx::DaemonError) do
       S.new.run
     end
     system("cd #{RAILS_ROOT}; rake ultrasphinx:daemon:start &> /dev/null")
@@ -77,11 +97,10 @@ class SearchTest < Test::Unit::TestCase
   end
   
   def test_sort_by_string
-    # XXX waiting for feedback from Andrew; this seems like a Sphinx bug
-#    assert_equal(
-#      Seller.find(:all, :limit => 5, :order => 'mission_statement DESC').map(&:mission_statement),
-#      S.new(:class_names => 'Seller', :sort_by => 'mission_statement', :sort_mode => 'descending', :per_page => 5).run.map(&:mission_statement)
-#    )
+    assert_equal(
+      Seller.find(:all, :limit => 5, :order => 'mission_statement ASC').map(&:mission_statement),
+      S.new(:class_names => 'Seller', :sort_by => 'mission_statement', :sort_mode => 'ascending', :per_page => 5).run.map(&:mission_statement)
+    )
   end
  
   def test_filter
@@ -104,20 +123,19 @@ class SearchTest < Test::Unit::TestCase
   end
 
   def test_date_range_filter
-    # XXX some strange boundary error in this one
     @first, @last = Seller.find(5).created_at, Seller.find(10).created_at
-    @items = Seller.find(:all, :conditions => ['created_at => ? AND created_at <= ?', @last, @first]).sort_by(&:id)
+    @items = Seller.find(:all, :conditions => ['created_at >= ? AND created_at <= ?', @last, @first]).sort_by(&:id)
     @count = @items.size
     
     @search = S.new(:class_names => 'Seller', :filters => {'created_at' => @first..@last}).run.sort_by(&:id)
     assert_equal(@count, @search.size)
-    assert_equal(@items.first, @search.first)
-    assert_equal(@items.last, @search.last)
+    assert_equal(@items.first.created_at, @search.first.created_at)
+    assert_equal(@items.last.created_at, @search.last.created_at)
     
     assert_equal(@count,
       S.new(:class_names => 'Seller', :filters => {'created_at' => @last..@first}).run.size)
     assert_equal(@count,
-      S.new(:class_names => 'Seller', :filters => {'created_at' => @last.strftime(STRFTIME)...@first.strftime(STRFTIME)}).run.size)
+      S.new(:class_names => 'Seller', :filters => {'created_at' => @last.strftime(STRFTIME)..@first.strftime(STRFTIME)}).run.size)
 
     assert_raises(Ultrasphinx::UsageError) do
       S.new(:class_names => 'Seller', :filters => {'created_at' => "bogus".."sugob"}).run.size
@@ -132,7 +150,7 @@ class SearchTest < Test::Unit::TestCase
   end
   
   def test_invalid_filter
-    assert_raises(Sphinx::SphinxArgumentError) do
+    assert_raises(Ultrasphinx::UsageError) do
       S.new(:class_names => 'Seller', :filters => {'bogus' => 17}).run
     end
   end
@@ -140,14 +158,16 @@ class SearchTest < Test::Unit::TestCase
   def test_conditions
     @deleted_count = User.count(:conditions => {:deleted => true })
     assert_equal 1, @deleted_count
-    assert_equal User.count - @deleted_count, S.new(:class_name => 'User').run.total_entries 
+    assert_equal User.count - @deleted_count, S.new(:class_names => 'User').run.total_entries 
   end
   
-#  def test_mismatched_facet_configuration
-#    assert_raises(Ultrasphinx::ConfigurationError) do 
-#      Ultrasphinx::Search.new(:facets => 'company_name').run
-#    end
-#  end
+  #  def test_mismatched_facet_configuration
+  #    # XXX Should be caught at configuration time. For now it's your own fault 
+  #    # if you do it and get confused.
+  #    assert_raises(Ultrasphinx::ConfigurationError) do 
+  #      Ultrasphinx::Search.new(:facets => 'company_name').run
+  #    end
+  #  end
   
   def test_bogus_facet_name
     assert_raises(Ultrasphinx::UsageError) do
@@ -156,14 +176,21 @@ class SearchTest < Test::Unit::TestCase
   end  
   
   def test_unconfigured_sortable_name
-    assert_raises(Sphinx::SphinxInternalError) do
-      S.new(:class_names => 'Seller', :sort_by => 'company_name',:per_page => 5).run
+    assert_raises(Ultrasphinx::UsageError) do
+      S.new(:class_names => 'Seller', :sort_by => 'company_name', :sort_mode => 'ascending', :per_page => 5).run
     end
   end
   
+  def test_sorting_by_field_with_relevance_order
+    assert_raises(Ultrasphinx::UsageError) do
+      # Defaults to :sort_mode => 'relevance'
+      S.new(:class_names => 'Seller', :sort_by => 'created_at', :per_page => 5).run 
+    end  
+  end
+  
   def test_nonexistent_sortable_name
-    assert_raises(Sphinx::SphinxInternalError) do
-      S.new(:class_names => 'Seller', :sort_by => 'bogus',:per_page => 5).run
+    assert_raises(Ultrasphinx::UsageError) do
+      S.new(:class_names => 'Seller', :sort_by => 'bogus', :per_page => 5).run
     end  
   end
   
@@ -175,7 +202,7 @@ class SearchTest < Test::Unit::TestCase
   def test_numeric_facet
     @user_id_count = Seller.find(:all).map(&:user_id).uniq.size
 
-    @s = Ultrasphinx::Search.new(:class_name => 'Seller', :facets => 'user_id').run
+    @s = Ultrasphinx::Search.new(:class_names => 'Seller', :facets => 'user_id').run
     assert_equal @user_id_count, @s.facets['user_id'].size
 
     @s = Ultrasphinx::Search.new(:facets => 'user_id').run
@@ -193,25 +220,25 @@ class SearchTest < Test::Unit::TestCase
   end
   
   def test_float_facet
-    @s = Ultrasphinx::Search.new(:class_name => 'Seller', :facets => 'capitalization').run
+    @s = Ultrasphinx::Search.new(:class_names => 'Seller', :facets => 'capitalization').run
     @s.facets['capitalization'].keys.each do |key|
-      # XXX Requires full Sphinx 0.9.8 compatibility      
+      # XXX http://www.sphinxsearch.com/forum/view.html?id=963
       # assert key.is_a?(Float)
     end
   end
   
-  def test_association_sql
-    # XXX
+  def test_table_aliasing_and_association_sql
+    assert_equal 2, Ultrasphinx::Search.new(:class_names => 'User', :query => 'company_two:replacement').run.size
   end
     
   def test_weights
-    @unweighted = Ultrasphinx::Search.new(:query => 'seller1', :per_page => 1).run.first
-    @weighted = Ultrasphinx::Search.new(:query => 'seller1', :weights => {'company' => 2}, :per_page => 1).run.first
-    assert_not_equal @unweighted.class, @weighted.class
+    @unweighted = Ultrasphinx::Search.new(:query => 'seller16', :per_page => 1).run.first
+    @weighted = Ultrasphinx::Search.new(:query => 'seller16', :weights => {'company' => 2}, :per_page => 1).run.first
+    assert_not_equal @unweighted, @weighted
   end
   
   def test_excerpts
-    @s = Ultrasphinx::Search.new(:query => 'seller10')
+    @s = Ultrasphinx::Search.new(:class_names => 'Seller', :query => 'seller10')
     @excerpted_item = @s.excerpt.first
     @item = @s.run.first
     assert_not_equal @item.name, @excerpted_item.name

data/test/setup.rb

@@ -5,6 +5,9 @@ puts ["Please make sure that test/integration/app/vendor/rails is symlinked",
   "to a Rails trunk checkout in order for the rake tasks to run properly."]
 
 Dir.chdir "#{File.dirname(__FILE__)}/integration/app/" do
+  Dir.chdir "vendor/plugins" do
+    system("rm ultrasphinx; ln -s ../../../../../ ultrasphinx")
+  end
   system("rake db:create")
   system("rake db:migrate db:fixtures:load")
   system("rake us:boot")

data/ultrasphinx.gemspec

@@ -1,21 +1,28 @@
 
-# Gem::Specification for Ultrasphinx-1.5.3
+# Gem::Specification for Ultrasphinx-1.6
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{ultrasphinx}
-  s.version = "1.5.3"
-  s.date = %q{2007-10-11}
-  s.summary = %q{Ruby on Rails configurator and client to the Sphinx fulltext search engine.}
+  s.version = "1.6"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [""]
+  s.date = %q{2007-11-14}
+  s.description = %q{Ruby on Rails configurator and client to the Sphinx fulltext search engine.}
   s.email = %q{}
+  s.files = ["CHANGELOG", "examples/ap.multi", "examples/default.base", "init.rb", "lib/ultrasphinx/autoload.rb", "lib/ultrasphinx/configure.rb", "lib/ultrasphinx/core_extensions.rb", "lib/ultrasphinx/fields.rb", "lib/ultrasphinx/hex_to_int.sql", "lib/ultrasphinx/is_indexed.rb", "lib/ultrasphinx/search/internals.rb", "lib/ultrasphinx/search/parser.rb", "lib/ultrasphinx/search.rb", "lib/ultrasphinx/spell.rb", "lib/ultrasphinx/ultrasphinx.rb", "lib/ultrasphinx.rb", "LICENSE", "Manifest", "README", "tasks/ultrasphinx.rake", "test/config/ultrasphinx/test.base", "test/integration/app/app/controllers/addresses_controller.rb", "test/integration/app/app/controllers/application.rb", "test/integration/app/app/controllers/sellers_controller.rb", "test/integration/app/app/controllers/states_controller.rb", "test/integration/app/app/controllers/users_controller.rb", "test/integration/app/app/helpers/addresses_helper.rb", "test/integration/app/app/helpers/application_helper.rb", "test/integration/app/app/helpers/sellers_helper.rb", "test/integration/app/app/helpers/states_helper.rb", "test/integration/app/app/helpers/users_helper.rb", "test/integration/app/app/models/geo/address.rb", "test/integration/app/app/models/geo/state.rb", "test/integration/app/app/models/person/user.rb", "test/integration/app/app/models/seller.rb", "test/integration/app/app/views/addresses/edit.html.erb", "test/integration/app/app/views/addresses/index.html.erb", "test/integration/app/app/views/addresses/new.html.erb", "test/integration/app/app/views/addresses/show.html.erb", "test/integration/app/app/views/layouts/addresses.html.erb", "test/integration/app/app/views/layouts/sellers.html.erb", "test/integration/app/app/views/layouts/states.html.erb", "test/integration/app/app/views/layouts/users.html.erb", "test/integration/app/app/views/sellers/edit.html.erb", "test/integration/app/app/views/sellers/index.html.erb", "test/integration/app/app/views/sellers/new.html.erb", "test/integration/app/app/views/sellers/show.html.erb", "test/integration/app/app/views/states/edit.html.erb", "test/integration/app/app/views/states/index.html.erb", "test/integration/app/app/views/states/new.html.erb", "test/integration/app/app/views/states/show.html.erb", "test/integration/app/app/views/users/edit.html.erb", "test/integration/app/app/views/users/index.html.erb", "test/integration/app/app/views/users/new.html.erb", "test/integration/app/app/views/users/show.html.erb", "test/integration/app/config/boot.rb", "test/integration/app/config/database.yml", "test/integration/app/config/environment.rb", "test/integration/app/config/environments/development.rb", "test/integration/app/config/environments/production.rb", "test/integration/app/config/environments/test.rb", "test/integration/app/config/locomotive.yml", "test/integration/app/config/routes.rb", "test/integration/app/config/ultrasphinx/default.base", "test/integration/app/config/ultrasphinx/development.conf", "test/integration/app/config/ultrasphinx/development.conf.canonical", "test/integration/app/db/migrate/001_create_users.rb", "test/integration/app/db/migrate/002_create_sellers.rb", "test/integration/app/db/migrate/003_create_addresses.rb", "test/integration/app/db/migrate/004_create_states.rb", "test/integration/app/db/migrate/005_add_capitalization_to_seller.rb", "test/integration/app/db/migrate/006_add_deleted_to_user.rb", "test/integration/app/db/migrate/007_add_lat_and_long_to_address.rb", "test/integration/app/db/migrate/008_add_mission_statement_to_seller.rb", "test/integration/app/db/schema.rb", "test/integration/app/doc/README_FOR_APP", "test/integration/app/public/404.html", "test/integration/app/public/500.html", "test/integration/app/public/dispatch.cgi", "test/integration/app/public/dispatch.fcgi", "test/integration/app/public/dispatch.rb", "test/integration/app/public/favicon.ico", "test/integration/app/public/images/rails.png", "test/integration/app/public/index.html", "test/integration/app/public/javascripts/application.js", "test/integration/app/public/javascripts/controls.js", "test/integration/app/public/javascripts/dragdrop.js", "test/integration/app/public/javascripts/effects.js", "test/integration/app/public/javascripts/prototype.js", "test/integration/app/public/robots.txt", "test/integration/app/public/stylesheets/scaffold.css", "test/integration/app/Rakefile", "test/integration/app/README", "test/integration/app/script/about", "test/integration/app/script/breakpointer", "test/integration/app/script/console", "test/integration/app/script/destroy", "test/integration/app/script/generate", "test/integration/app/script/performance/benchmarker", "test/integration/app/script/performance/profiler", "test/integration/app/script/plugin", "test/integration/app/script/process/inspector", "test/integration/app/script/process/reaper", "test/integration/app/script/process/spawner", "test/integration/app/script/runner", "test/integration/app/script/server", "test/integration/app/test/fixtures/addresses.yml", "test/integration/app/test/fixtures/sellers.yml", "test/integration/app/test/fixtures/states.yml", "test/integration/app/test/fixtures/users.yml", "test/integration/app/test/functional/addresses_controller_test.rb", "test/integration/app/test/functional/sellers_controller_test.rb", "test/integration/app/test/functional/states_controller_test.rb", "test/integration/app/test/functional/users_controller_test.rb", "test/integration/app/test/test_helper.rb", "test/integration/app/test/unit/address_test.rb", "test/integration/app/test/unit/seller_test.rb", "test/integration/app/test/unit/state_test.rb", "test/integration/app/test/unit/user_test.rb", "test/integration/configure_test.rb", "test/integration/search_test.rb", "test/integration/server_test.rb", "test/integration/spell_test.rb", "test/setup.rb", "test/test_all.rb", "test/test_helper.rb", "test/unit/parser_test.rb", "TODO", "vendor/riddle/MIT-LICENSE", "vendor/riddle/riddle/client/filter.rb", "vendor/riddle/riddle/client/message.rb", "vendor/riddle/riddle/client/response.rb", "vendor/riddle/riddle/client.rb", "vendor/riddle/riddle.rb", "vendor/will_paginate/LICENSE", "ultrasphinx.gemspec"]
+  s.has_rdoc = true
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/ultrasphinx/}
+  s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.description = %q{Ruby on Rails configurator and client to the Sphinx fulltext search engine.}
-  s.has_rdoc = true
-  s.authors = [""]
-  s.files = ["CHANGELOG", "examples/ap.multi", "examples/default.base", "init.rb", "lib/ultrasphinx/autoload.rb", "lib/ultrasphinx/configure.rb", "lib/ultrasphinx/core_extensions.rb", "lib/ultrasphinx/fields.rb", "lib/ultrasphinx/hex_to_int.sql", "lib/ultrasphinx/is_indexed.rb", "lib/ultrasphinx/search/internals.rb", "lib/ultrasphinx/search/parser.rb", "lib/ultrasphinx/search.rb", "lib/ultrasphinx/spell.rb", "lib/ultrasphinx/ultrasphinx.rb", "lib/ultrasphinx.rb", "LICENSE", "Manifest", "README", "tasks/ultrasphinx.rake", "test/config/ultrasphinx/test.base", "test/integration/app/app/controllers/addresses_controller.rb", "test/integration/app/app/controllers/application.rb", "test/integration/app/app/controllers/sellers_controller.rb", "test/integration/app/app/controllers/states_controller.rb", "test/integration/app/app/controllers/users_controller.rb", "test/integration/app/app/helpers/addresses_helper.rb", "test/integration/app/app/helpers/application_helper.rb", "test/integration/app/app/helpers/sellers_helper.rb", "test/integration/app/app/helpers/states_helper.rb", "test/integration/app/app/helpers/users_helper.rb", "test/integration/app/app/models/geo/address.rb", "test/integration/app/app/models/geo/state.rb", "test/integration/app/app/models/person/user.rb", "test/integration/app/app/models/seller.rb", "test/integration/app/app/views/addresses/edit.html.erb", "test/integration/app/app/views/addresses/index.html.erb", "test/integration/app/app/views/addresses/new.html.erb", "test/integration/app/app/views/addresses/show.html.erb", "test/integration/app/app/views/layouts/addresses.html.erb", "test/integration/app/app/views/layouts/sellers.html.erb", "test/integration/app/app/views/layouts/states.html.erb", "test/integration/app/app/views/layouts/users.html.erb", "test/integration/app/app/views/sellers/edit.html.erb", "test/integration/app/app/views/sellers/index.html.erb", "test/integration/app/app/views/sellers/new.html.erb", "test/integration/app/app/views/sellers/show.html.erb", "test/integration/app/app/views/states/edit.html.erb", "test/integration/app/app/views/states/index.html.erb", "test/integration/app/app/views/states/new.html.erb", "test/integration/app/app/views/states/show.html.erb", "test/integration/app/app/views/users/edit.html.erb", "test/integration/app/app/views/users/index.html.erb", "test/integration/app/app/views/users/new.html.erb", "test/integration/app/app/views/users/show.html.erb", "test/integration/app/config/boot.rb", "test/integration/app/config/database.yml", "test/integration/app/config/environment.rb", "test/integration/app/config/environments/development.rb", "test/integration/app/config/environments/production.rb", "test/integration/app/config/environments/test.rb", "test/integration/app/config/locomotive.yml", "test/integration/app/config/routes.rb", "test/integration/app/config/ultrasphinx/default.base", "test/integration/app/config/ultrasphinx/development.conf", "test/integration/app/config/ultrasphinx/development.conf.canonical", "test/integration/app/db/migrate/001_create_users.rb", "test/integration/app/db/migrate/002_create_sellers.rb", "test/integration/app/db/migrate/003_create_addresses.rb", "test/integration/app/db/migrate/004_create_states.rb", "test/integration/app/db/migrate/005_add_capitalization_to_seller.rb", "test/integration/app/db/migrate/006_add_deleted_to_user.rb", "test/integration/app/db/migrate/007_add_lat_and_long_to_address.rb", "test/integration/app/db/migrate/008_add_mission_statement_to_seller.rb", "test/integration/app/db/schema.rb", "test/integration/app/doc/README_FOR_APP", "test/integration/app/public/404.html", "test/integration/app/public/500.html", "test/integration/app/public/dispatch.cgi", "test/integration/app/public/dispatch.fcgi", "test/integration/app/public/dispatch.rb", "test/integration/app/public/favicon.ico", "test/integration/app/public/images/rails.png", "test/integration/app/public/index.html", "test/integration/app/public/javascripts/application.js", "test/integration/app/public/javascripts/controls.js", "test/integration/app/public/javascripts/dragdrop.js", "test/integration/app/public/javascripts/effects.js", "test/integration/app/public/javascripts/prototype.js", "test/integration/app/public/robots.txt", "test/integration/app/public/stylesheets/scaffold.css", "test/integration/app/Rakefile", "test/integration/app/README", "test/integration/app/script/about", "test/integration/app/script/breakpointer", "test/integration/app/script/console", "test/integration/app/script/destroy", "test/integration/app/script/generate", "test/integration/app/script/performance/benchmarker", "test/integration/app/script/performance/profiler", "test/integration/app/script/plugin", "test/integration/app/script/process/inspector", "test/integration/app/script/process/reaper", "test/integration/app/script/process/spawner", "test/integration/app/script/runner", "test/integration/app/script/server", "test/integration/app/test/fixtures/addresses.yml", "test/integration/app/test/fixtures/sellers.yml", "test/integration/app/test/fixtures/states.yml", "test/integration/app/test/fixtures/users.yml", "test/integration/app/test/functional/addresses_controller_test.rb", "test/integration/app/test/functional/sellers_controller_test.rb", "test/integration/app/test/functional/states_controller_test.rb", "test/integration/app/test/functional/users_controller_test.rb", "test/integration/app/test/test_helper.rb", "test/integration/app/test/unit/address_test.rb", "test/integration/app/test/unit/seller_test.rb", "test/integration/app/test/unit/state_test.rb", "test/integration/app/test/unit/user_test.rb", "test/integration/configure_test.rb", "test/integration/search_test.rb", "test/integration/server_test.rb", "test/integration/spell_test.rb", "test/setup.rb", "test/test_all.rb", "test/test_helper.rb", "test/ts.multi", "test/unit/parser_test.rb", "TODO", "vendor/sphinx/init.rb", "vendor/sphinx/lib/client.rb", "vendor/sphinx/LICENSE", "vendor/sphinx/Rakefile", "vendor/sphinx/README", "vendor/will_paginate/LICENSE", "ultrasphinx.gemspec"]
+  s.rubygems_version = %q{0.9.4.6}
+  s.summary = %q{Ruby on Rails configurator and client to the Sphinx fulltext search engine.}
   s.test_files = ["test/test_all.rb"]
-  s.add_dependency(%q<chronic>, ["> 0.0.0"])
+
+  s.add_dependency(%q<chronic>, [">= 0"])
 end
 
 
@@ -31,12 +38,6 @@ end
 #   p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"  
 #   p.rdoc_pattern = /is_indexed.rb|search.rb|spell.rb|ultrasphinx.rb|^README|TODO|CHANGELOG|^LICENSE/
 #   p.dependencies = "chronic"
-# end
-# 
-# require 'rcov/rcovtask'
-# 
-# Rcov::RcovTask.new(:coverage) do |t|
-#   t.test_files = FileList['test/integration/*.rb', 'test/unit/*.rb']
-#   t.rcov_opts << '--include-file test\/integration\/app\/vendor\/plugins\/ultrasphinx\/lib\/.*\.rb'
-#   t.verbose = true
+#   p.test_pattern = ["test/integration/*.rb", "test/unit/*.rb"]
+#   p.rcov_options << '--include-file test\/integration\/app\/vendor\/plugins\/ultrasphinx\/lib\/.*\.rb'
 # end

data/vendor/riddle/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 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/vendor/riddle/riddle.rb

@@ -0,0 +1,15 @@
+require 'riddle/client'
+require 'riddle/client/filter'
+require 'riddle/client/message'
+require 'riddle/client/response'
+
+module Riddle #:nodoc:
+  module Version #:nodoc:
+    Major = 0
+    Minor = 9
+    Tiny  = 8
+    Rev   = 871
+    
+    String = [Major, Minor, Tiny].join('.') + "r#{Rev}"
+  end
+end

data/vendor/riddle/riddle/client.rb

@@ -0,0 +1,409 @@
+module Riddle
+  class VersionError < StandardError;  end
+  class ResponseError < 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
+  # used a few helper classes, just to neaten things up.
+  #
+  # I do plan to release this part of the plugin as a standalone library at
+  # some point - if you're interested in using it, and are feeling impatient,
+  # feel free to hassle me.
+  #
+  class Client
+    Commands = {
+      :search  => 0, # SEARCHD_COMMAND_SEARCH
+      :excerpt => 1, # SEARCHD_COMMAND_EXCERPT
+      :update  => 2  # SEARCHD_COMMAND_UPDATE
+    }
+    
+    Versions = {
+      :search  => 0x10F, # VER_COMMAND_SEARCH
+      :excerpt => 0x100, # VER_COMMAND_EXCERPT
+      :update  => 0x100  # VER_COMMAND_UPDATE
+    }
+    
+    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
+      :phrase   => 2, # SPH_MATCH_PHRASE
+      :boolean  => 3, # SPH_MATCH_BOOLEAN
+      :extended => 4  # SPH_MATCH_EXTENDED
+    }
+    
+    SortModes = {
+      :relevance     => 0, # SPH_SORT_RELEVANCE
+      :attr_desc     => 1, # SPH_SORT_ATTR_DESC
+      :attr_asc      => 2, # SPH_SORT_ATTR_ASC
+      :time_segments => 3, # SPH_SORT_TIME_SEGMENTS
+      :extended      => 4  # SPH_SORT_EXTENDED
+    }
+    
+    AttributeTypes = {
+      :integer    => 1, # SPH_ATTR_INTEGER
+      :timestamp  => 2, # SPH_ATTR_TIMESTAMP
+      :ordinal    => 3, # SPH_ATTR_ORDINAL
+      :bool       => 4, # SPH_ATTR_BOOL
+      :float      => 5, # SPH_ATTR_FLOAT
+      :multi      => 0x40000000 # SPH_ATTR_MULTI
+    }
+    
+    GroupFunctions = {
+      :day      => 0, # SPH_GROUPBY_DAY
+      :week     => 1, # SPH_GROUPBY_WEEK
+      :month    => 2, # SPH_GROUPBY_MONTH
+      :year     => 3, # SPH_GROUPBY_YEAR
+      :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 :server, :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,
+      :retry_count, :retry_delay, :anchor
+    attr_reader :queue
+    
+    # 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(server=nil, port=nil)
+      @server = server || "localhost"
+      @port   = port   || 3312
+      
+      # defaults
+      @offset         = 0
+      @limit          = 20
+      @max_matches    = 1000
+      @match_mode     = :all
+      @sort_mode      = :relevance
+      @sort_by        = ''
+      @weights        = []
+      @id_range       = 0..0
+      @filters        = []
+      @group_by       = ''
+      @group_function = :day
+      @group_clause   = '@group desc'
+      @group_distinct = ''
+      @cut_off        = 0
+      @retry_count    = 0
+      @retry_delay    = 0
+      @anchor         = {}
+      # string keys are index names, integer values are weightings
+      @index_weights  = {}
+      
+      @queue = []
+    end
+    
+    def set_anchor(lat_attr, lat, long_attr, long)
+      @anchor = {
+        :latitude_attribute   => lat_attr,
+        :latitude             => lat,
+        :longtitude_attribute => long_attr,
+        :longtitude           => long
+      }
+    end
+    
+    def append_query(search, index = '*')
+      @queue << query_message(search, index)
+    end
+    
+    def run
+      response = Response.new request(:search, @queue)
+      
+      results = @queue.collect do
+        result = {
+          :matches         => [],
+          :fields          => [],
+          :attributes      => {},
+          :attribute_names => [],
+          :words           => {}
+        }
+
+        result[:status] = response.next_int
+        case result[:status]
+        when Statuses[:warning]
+          result[:warning] = response.next
+        when Statuses[:error]
+          result[:error] = response.next
+          next result
+        end
+        
+        result[:fields] = response.next_array
+
+        attributes = response.next_int
+        for i in 0...attributes
+          attribute_name = response.next
+          type           = response.next_int
+
+          result[:attributes][attribute_name] = type
+          result[:attribute_names] << attribute_name
+        end
+
+        matches   = response.next_int
+        is_64_bit = response.next_int
+        for i in 0...matches
+          doc = is_64_bit > 0 ? (response.next_int() << 32) + response.next_int : response.next_int
+          weight = response.next_int
+
+          result[:matches] << {:doc => doc, :weight => weight, :index => i, :attributes => {}}
+          result[:attribute_names].each do |attr|
+            case result[:attributes][attr]
+            when AttributeTypes[:float]
+              result[:matches].last[:attributes][attr] = response.next_float
+            when AttributeTypes[:multi]
+              result[:matches].last[:attributes][attr] = response.next_int_array
+            else
+              result[:matches].last[:attributes][attr] = response.next_int
+            end
+          end
+        end
+
+        result[:total] = response.next_int.to_i || 0
+        result[:total_found] = response.next_int.to_i || 0
+        result[:time] = ('%.3f' % (response.next_int / 1000.0)).to_f || 0.0
+
+        words = response.next_int
+        for i in 0...words
+          word = response.next
+          docs = response.next_int
+          hits = response.next_int
+          result[:words][word] = {:docs => docs, :hits => hits}
+        end
+
+        result
+      end
+      
+      @queue.clear
+      results
+    end
+    
+    # Query the Sphinx daemon - defaulting to all indexes, but you can specify
+    # a specific one if you wish. The search parameter should be a string
+    # following Sphinx's expectations.
+    def query(search, index = '*')      
+      @queue << query_message(search, index)
+      self.run.first
+    end
+    
+    # Grab excerpts from the indexes. As part of the options, you will need to
+    # define:
+    # * :docs
+    # * :words
+    # * :index
+    #
+    # Optional settings include:
+    # * :before_match (defaults to <span class="match">)
+    # * :after_match (defaults to </span>)
+    # * :chunk_separator (defaults to ' &#8230; ' - which is an HTML ellipsis)
+    # * :limit (defaults to 256)
+    # * :around (defaults to 5)
+    #
+    # The defaults differ from the official PHP client, as I've opted for
+    # semantic HTML markup.
+    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
+      
+      response = Response.new request(:excerpt, excerpts_message(options))
+      
+      options[:docs].collect { response.next }
+    end
+    
+    # Update attributes
+    def update(index, attributes, values_by_doc)
+      response = Response.new request(
+        :update,
+        update_message(index, attributes, values_by_doc)
+      )
+      
+      response.next_int
+    end
+    
+    private
+    
+    # Connects to the Sphinx daemon, and yields a socket to use. The socket is
+    # closed at the end of the block.
+    def connect(&block)
+      socket = TCPSocket.new @server, @port
+      
+      # 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
+      
+      begin
+        yield socket
+      ensure
+        socket.close
+      end
+    end
+    
+    # Send a collection of messages, for a command type (eg, search, excerpts,
+    # update), to the Sphinx daemon.
+    def request(command, messages)
+      response = ""
+      status   = -1
+      version  = 0
+      length   = 0
+      message  = Array(messages).join("")
+      
+      connect do |socket|
+        case command
+        when :search
+          # Message length is +4 to account for the following count value for
+          # the number of messages (well, that's what I'm assuming).
+          socket.send [
+            Commands[command], Versions[command],
+            4+message.length,  messages.length
+          ].pack("nnNN") + message, 0
+        else
+          socket.send [
+            Commands[command], Versions[command], message.length
+          ].pack("nnN") + message, 0
+        end
+        
+        header = socket.recv(8)
+        status, version, length = header.unpack('n2N')
+        
+        while response.length < length
+          part = socket.recv(length - response.length)
+          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]
+          puts format("searchd command v.%d.%d older than client (v.%d.%d)",
+            version >> 8, version & 0xff,
+            Versions[command] >> 8, Versions[command] & 0xff)
+        end
+        response
+      when Statuses[:warning]
+        length = response[0, 4].unpack('N*').first
+        puts response[4, length]
+        response[4 + length, response.length - 4 - length]
+      when Statuses[:error], Statuses[:retry]
+        raise ResponseError, "searchd error (status: #{status}): #{response[4, response.length - 4]}"
+      else
+        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)
+      message = Message.new
+      
+      # Mode, Limits, Sort Mode
+      message.append_ints @offset, @limit, MatchModes[@match_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_ints 0, @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
+      message.append_int @max_matches
+      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
+      else
+        message.append_int 1
+        message.append_string @anchor[:latitude_attribute]
+        message.append_string @anchor[:longtitude_attribute]
+        message.append_floats @anchor[:latitude], @anchor[:longtitude]
+      end
+      
+      # Per Index Weights
+      message.append_int @index_weights.length
+      @index_weights.each do |key,val|
+        message.append_string key
+        message.append_int val
+      end
+      
+      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, 1].pack('N2') # mode = 0, flags = 1
+      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_int key # document ID
+        message.append_ints *values # array of new values (integers)
+      end
+      
+      message.to_s
+    end
+  end
+end