ultrasphinx 1.9 → 1.11

data/test/integration/delta_test.rb

@@ -36,4 +36,17 @@ class DeltaTest < Test::Unit::TestCase
 
     assert_equal @count, S.new.total_entries
   end
+  
+  def test_merge
+    Dir.chdir "#{HERE}/integration/app" do    
+      Echoe.silence do
+        system("rake ultrasphinx:daemon:start")
+      end
+
+      output = `rake ultrasphinx:index:merge 2>&1`
+      assert_match /merged 0.1 Kwords/, output
+      assert_match /Index rotated ok/, output
+    end
+  end  
+  
 end

data/test/integration/search_test.rb

@@ -11,7 +11,7 @@ class SearchTest < Test::Unit::TestCase
     assert_nothing_raised do
       @s = S.new(:query => 'seller').run
     end
-    assert_equal 20, @s.results.size
+    assert_equal 20, @s.size
   end  
   
   def test_with_subtotals_option
@@ -34,6 +34,7 @@ class SearchTest < Test::Unit::TestCase
   end
   
   def test_ignore_missing_records_option
+    S.client_options['distance'] = false # must disable geodistance or line 57 will bomb
     @s = S.new(:per_page => 1).run
     @record = @s.first
     assert_equal 1, @s.size
@@ -50,9 +51,8 @@ class SearchTest < Test::Unit::TestCase
     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
@@ -198,6 +198,17 @@ class SearchTest < Test::Unit::TestCase
       S.new(:class_names => 'Seller', :filters => {'company_name' => 'seller17'}).run.size
     )  
   end
+
+  def test_exclusion_filter
+    assert_equal(
+      Seller.count(:conditions => 'user_id = 17'),
+      S.new(:class_names => 'Seller', :filters => { 'user_id' => { 'value' => 17, 'exclude' => false } }).run.size
+    )
+    assert_equal(
+      Seller.count(:conditions => 'user_id != 17'),
+      S.new(:class_names => 'Seller', :filters => { 'user_id' => { 'value' => 17, 'exclude' => true } }).run.size
+    )
+  end
   
   def test_invalid_filter
     assert_raises(Ultrasphinx::UsageError) do
@@ -227,7 +238,7 @@ class SearchTest < Test::Unit::TestCase
   
   def test_unconfigured_sortable_name
     assert_raises(Ultrasphinx::UsageError) do
-      S.new(:class_names => 'Seller', :sort_by => 'company_name', :sort_mode => 'ascending', :per_page => 5).run
+      S.new(:class_names => 'User', :sort_by => 'company', :sort_mode => 'ascending', :per_page => 5).run
     end
   end
   
@@ -253,7 +264,7 @@ class SearchTest < Test::Unit::TestCase
   end
 
   def test_included_text_facet_without_association_sql
-    # there are 40 users, but only 20 sellers. So you get 20 facets + 1 nil with 20 items
+    # There are 40 users, but only 20 sellers. So you get 20 facets + 1 nil with 20 items
     @s = Ultrasphinx::Search.new(:class_names => 'User', :facets => ['company']).run
     assert_equal(
       (Seller.count + 1), 
@@ -262,8 +273,9 @@ class SearchTest < Test::Unit::TestCase
   end
 
   def test_included_text_facet_with_association_sql
-    # XXX there are 40 users but only 20 sellers, but the replace function from user deletes 
-    # User #6 and 16 (why?). There is also a nil facet that gets added for a total of 19 objects
+    # XXX there are 40 users but only 20 sellers, but the replace function from User deletes 
+    # User #6 and 16 (why? Hash collision?). There is also a nil facet that gets added for a 
+    # total of 19 objects
     @s = Ultrasphinx::Search.new(:class_names => 'User', :facets => ['company_two']).run
     assert_equal(
       (Seller.count - 1), 
@@ -317,4 +329,64 @@ class SearchTest < Test::Unit::TestCase
     assert_match /strong/, @excerpted_item.name
   end
   
-end
+  def test_distance_ascending
+    # (21.289453, -157.842783) is Ala Moana Shopping Center, 1450 Ala Moana Blvd, Honolulu HI 96814
+    @s = Ultrasphinx::Search.new(:class_names => 'Geo::Address', 
+          :query => 'Honolulu',
+          :per_page => 40,
+          :sort_mode => 'extended',
+          :sort_by => 'distance',
+          :location => {
+            :lat => 21.289453,
+            :long => -157.842783
+          })
+    @s.run
+    # This should return all items in the database, sorted in increasing distance
+    assert_equal 40, @s.size
+    assert_match /Waikiki Aquarium/, @s.first.name
+    assert_match /Waikiki Aquarium/, @s[1].name
+    assert_in_delta 3439, @s.first.distance, 10
+  end
+  
+  def test_distance_filter
+    # (21.289453, -157.842783) is Ala Moana Shopping Center, 1450 Ala Moana Blvd, Honolulu HI 96814
+    @s = Ultrasphinx::Search.new(:class_names => 'Geo::Address', 
+          :query => 'Honolulu',
+          :per_page => 40,
+          :sort_mode => 'extended',
+          :sort_by => 'distance',
+          :filters => {'distance' => 0..5000},
+          :location => {
+            :lat => 21.289453,
+            :long => -157.842783
+          })
+    @s.run
+
+    @s.each do |obj|
+      # This should return only those items within 5000 meters of Ala Moana, which 
+      # is only Waikiki Aquarium and Diamond Head.
+      assert_match /Waikiki Aquarium|Diamond Head/, obj.name
+    end
+        
+    assert_in_delta 3439, @s.first.distance, 10 # Closest item should be Waikiki at 3439 meters
+  end
+  
+  def test_distance_decending
+    # (21.289453, -157.842783) is Ala Moana Shopping Center, 1450 Ala Moana Blvd, Honolulu HI 96814
+    @s = Ultrasphinx::Search.new(:class_names => 'Geo::Address', 
+          :query => 'Honolulu',
+          :per_page => 40,
+          :sort_mode => 'extended',
+          :sort_by => 'distance desc',
+          :location => {
+            :lat => 21.289453,
+            :long => -157.842783
+          })
+    @s.run
+    
+    # Ids should come back in reverse order because the fixtures have the farther locations later in the file
+    assert_equal 40, @s.size
+    assert_match /Kailua Beach Park/, @s.first.name 
+    assert_in_delta 16940, @s.first.distance, 40
+  end
+end

data/test/setup.rb

@@ -2,15 +2,33 @@
 # Setup integration system for the integration suite
 
 Dir.chdir "#{File.dirname(__FILE__)}/integration/app/" do
-  system("killall searchd")
-  system("rm -rf /tmp/sphinx")
+
+  pid_file = '/tmp/sphinx/searchd.pid'
+  if File.exist? pid_file
+    pid = File.read(pid_file).to_i
+    system("kill #{pid}"); sleep(2); system("kill -9 #{pid}")  
+  end
+  
+  system("rm -rf /tmp/sphinx")  
   system("rm -rf config/ultrasphinx/development.conf")
+
   Dir.chdir "vendor/plugins" do
-    system("rm ultrasphinx; ln -s ../../../../../ ultrasphinx")
+    system("rm ultrasphinx")
+    system("ln -s ../../../../../ ultrasphinx")
   end
-  system("rake db:create")
-  system("rake db:migrate db:fixtures:load")
-  system("rake us:boot")
+  
+  if ENV['DB'] == 'postgresql'
+    # http://dev.rubyonrails.org/ticket/10559
+    system("echo 'DROP DATABASE ultrasphinx_development;' | psql template1") 
+  else
+    system("rake db:drop --trace")
+  end
+  
+  system("rake db:create --trace")
+  system("script/generate ultrasphinx_migration --svn") if ENV['DB'] == 'postgresql'
+  system("rake db:migrate db:fixtures:load --trace")
+
+  system("rake us:boot --trace")
   system("rm /tmp/ultrasphinx-stopwords.txt")
-  system("rake ultrasphinx:spelling:build")
+  system("rake ultrasphinx:spelling:build --trace")
 end

data/test/teardown.rb

@@ -0,0 +1,13 @@
+
+# Tear down integration system for the integration suite
+
+Dir.chdir "#{File.dirname(__FILE__)}/integration/app/" do  
+  # Remove the symlink created by the setup method, for people with tools
+  # that can't handle recursive directories (Textmate).
+  system("rm vendor/plugins/ultrasphinx") unless ENV['USER'] == 'eweaver'
+  
+  # Remove the generated Postgres migration, if it exists
+  Dir["db/migrate/*_install_ultrasphinx_stored_procedures.rb"].each do |file|
+    system("svn del --force #{file}")
+  end  
+end

data/test/test_helper.rb

@@ -21,6 +21,6 @@ end
 
 require 'integration/app/config/environment'
 
-Dir.chdir "#{HERE}/integration/app" do
-  system("rake us:start")
-end
+#Dir.chdir "#{HERE}/integration/app" do
+#  system("rake us:start")
+#end

data/ultrasphinx.gemspec

@@ -1,57 +1,36 @@
-
-# Gem::Specification for Ultrasphinx-1.9
-# Originally generated by Echoe
+# -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{ultrasphinx}
-  s.version = "1.9"
-
-  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.version = "1.11"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [""]
-  s.date = %q{2008-03-08}
+  s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
+  s.date = %q{2009-11-18}
   s.description = %q{Ruby on Rails configurator and client to the Sphinx fulltext search engine.}
   s.email = %q{}
-  s.files = ["CHANGELOG", "DEPLOYMENT_NOTES", "examples/ap.multi", "examples/default.base", "init.rb", "lib/ultrasphinx/associations.rb", "lib/ultrasphinx/autoload.rb", "lib/ultrasphinx/configure.rb", "lib/ultrasphinx/core_extensions.rb", "lib/ultrasphinx/fields.rb", "lib/ultrasphinx/is_indexed.rb", "lib/ultrasphinx/postgresql/concat_ws.sql", "lib/ultrasphinx/postgresql/crc32.sql", "lib/ultrasphinx/postgresql/group_concat.sql", "lib/ultrasphinx/postgresql/hex_to_int.sql", "lib/ultrasphinx/postgresql/language.sql", "lib/ultrasphinx/postgresql/unix_timestamp.sql", "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", "RAKE_TASKS", "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/country.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/migrate/009_create_countries.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/countries.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/country_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/delta_test.rb", "test/integration/search_test.rb", "test/integration/server_test.rb", "test/integration/spell_test.rb", "test/profile/benchmark.rb", "test/setup.rb", "test/teardown.rb", "test/test_all.rb", "test/test_helper.rb", "test/ts.multi", "test/unit/parser_test.rb", "TODO", "vendor/riddle/lib/riddle/client/filter.rb", "vendor/riddle/lib/riddle/client/message.rb", "vendor/riddle/lib/riddle/client/response.rb", "vendor/riddle/lib/riddle/client.rb", "vendor/riddle/lib/riddle.rb", "vendor/riddle/MIT-LICENCE", "vendor/riddle/Rakefile", "vendor/riddle/README", "vendor/riddle/spec/fixtures/data/anchor.bin", "vendor/riddle/spec/fixtures/data/any.bin", "vendor/riddle/spec/fixtures/data/boolean.bin", "vendor/riddle/spec/fixtures/data/distinct.bin", "vendor/riddle/spec/fixtures/data/field_weights.bin", "vendor/riddle/spec/fixtures/data/filter.bin", "vendor/riddle/spec/fixtures/data/filter_array.bin", "vendor/riddle/spec/fixtures/data/filter_array_exclude.bin", "vendor/riddle/spec/fixtures/data/filter_floats.bin", "vendor/riddle/spec/fixtures/data/filter_floats_exclude.bin", "vendor/riddle/spec/fixtures/data/filter_floats_range.bin", "vendor/riddle/spec/fixtures/data/filter_range.bin", "vendor/riddle/spec/fixtures/data/filter_range_exclude.bin", "vendor/riddle/spec/fixtures/data/group.bin", "vendor/riddle/spec/fixtures/data/index.bin", "vendor/riddle/spec/fixtures/data/index_weights.bin", "vendor/riddle/spec/fixtures/data/phrase.bin", "vendor/riddle/spec/fixtures/data/rank_mode.bin", "vendor/riddle/spec/fixtures/data/simple.bin", "vendor/riddle/spec/fixtures/data/sort.bin", "vendor/riddle/spec/fixtures/data/update_simple.bin", "vendor/riddle/spec/fixtures/data/weights.bin", "vendor/riddle/spec/fixtures/data_generator.php", "vendor/riddle/spec/fixtures/sphinx/configuration.erb", "vendor/riddle/spec/fixtures/sphinxapi.php", "vendor/riddle/spec/fixtures/sql/conf.example.yml", "vendor/riddle/spec/fixtures/sql/data.sql", "vendor/riddle/spec/fixtures/sql/structure.sql", "vendor/riddle/spec/functional/excerpt_spec.rb", "vendor/riddle/spec/functional/search_spec.rb", "vendor/riddle/spec/functional/update_spec.rb", "vendor/riddle/spec/spec_helper.rb", "vendor/riddle/spec/sphinx_helper.rb", "vendor/riddle/spec/unit/client_spec.rb", "vendor/riddle/spec/unit/filter_spec.rb", "vendor/riddle/spec/unit/message_spec.rb", "vendor/riddle/spec/unit/response_spec.rb", "vendor/will_paginate/LICENSE", "ultrasphinx.gemspec"]
-  s.has_rdoc = true
+  s.extra_rdoc_files = ["CHANGELOG", "DEPLOYMENT_NOTES", "lib/ultrasphinx/is_indexed.rb", "lib/ultrasphinx/search.rb", "lib/ultrasphinx/spell.rb", "lib/ultrasphinx/ultrasphinx.rb", "lib/ultrasphinx.rb", "LICENSE", "RAKE_TASKS", "README", "TODO"]
+  s.files = ["CHANGELOG", "DEPLOYMENT_NOTES", "examples/ap.multi", "examples/default.base", "init.rb", "lib/ultrasphinx/associations.rb", "lib/ultrasphinx/autoload.rb", "lib/ultrasphinx/configure.rb", "lib/ultrasphinx/core_extensions.rb", "lib/ultrasphinx/fields.rb", "lib/ultrasphinx/is_indexed.rb", "lib/ultrasphinx/postgresql/concat_ws.sql", "lib/ultrasphinx/postgresql/crc32.sql", "lib/ultrasphinx/postgresql/group_concat.sql", "lib/ultrasphinx/postgresql/hex_to_int.sql", "lib/ultrasphinx/postgresql/language.sql", "lib/ultrasphinx/postgresql/unix_timestamp.sql", "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", "RAKE_TASKS", "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/category.rb", "test/integration/app/app/models/geo/address.rb", "test/integration/app/app/models/geo/country.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.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/migrate/009_create_countries.rb", "test/integration/app/db/migrate/010_create_categories.rb", "test/integration/app/db/migrate/011_categories_sellers.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/categories.yml", "test/integration/app/test/fixtures/categories_sellers.yml", "test/integration/app/test/fixtures/countries.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/category_test.rb", "test/integration/app/test/unit/country_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/delta_test.rb", "test/integration/search_test.rb", "test/integration/server_test.rb", "test/integration/spell_test.rb", "test/profile/benchmark.rb", "test/setup.rb", "test/teardown.rb", "test/test_all.rb", "test/test_helper.rb", "test/ts.multi", "test/unit/parser_test.rb", "TODO", "vendor/riddle/lib/riddle/client/filter.rb", "vendor/riddle/lib/riddle/client/message.rb", "vendor/riddle/lib/riddle/client/response.rb", "vendor/riddle/lib/riddle/client.rb", "vendor/riddle/lib/riddle.rb", "vendor/riddle/MIT-LICENCE", "vendor/riddle/Rakefile", "vendor/riddle/README", "vendor/riddle/spec/fixtures/data/anchor.bin", "vendor/riddle/spec/fixtures/data/any.bin", "vendor/riddle/spec/fixtures/data/boolean.bin", "vendor/riddle/spec/fixtures/data/comment.bin", "vendor/riddle/spec/fixtures/data/distinct.bin", "vendor/riddle/spec/fixtures/data/field_weights.bin", "vendor/riddle/spec/fixtures/data/filter.bin", "vendor/riddle/spec/fixtures/data/filter_array.bin", "vendor/riddle/spec/fixtures/data/filter_array_exclude.bin", "vendor/riddle/spec/fixtures/data/filter_floats.bin", "vendor/riddle/spec/fixtures/data/filter_floats_exclude.bin", "vendor/riddle/spec/fixtures/data/filter_floats_range.bin", "vendor/riddle/spec/fixtures/data/filter_range.bin", "vendor/riddle/spec/fixtures/data/filter_range_exclude.bin", "vendor/riddle/spec/fixtures/data/group.bin", "vendor/riddle/spec/fixtures/data/index.bin", "vendor/riddle/spec/fixtures/data/index_weights.bin", "vendor/riddle/spec/fixtures/data/keywords_with_hits.bin", "vendor/riddle/spec/fixtures/data/keywords_without_hits.bin", "vendor/riddle/spec/fixtures/data/phrase.bin", "vendor/riddle/spec/fixtures/data/rank_mode.bin", "vendor/riddle/spec/fixtures/data/simple.bin", "vendor/riddle/spec/fixtures/data/sort.bin", "vendor/riddle/spec/fixtures/data/update_simple.bin", "vendor/riddle/spec/fixtures/data/weights.bin", "vendor/riddle/spec/fixtures/data_generator.php", "vendor/riddle/spec/fixtures/sphinx/configuration.erb", "vendor/riddle/spec/fixtures/sphinxapi.php", "vendor/riddle/spec/fixtures/sql/conf.example.yml", "vendor/riddle/spec/fixtures/sql/data.sql", "vendor/riddle/spec/fixtures/sql/structure.sql", "vendor/riddle/spec/functional/excerpt_spec.rb", "vendor/riddle/spec/functional/keywords_spec.rb", "vendor/riddle/spec/functional/search_spec.rb", "vendor/riddle/spec/functional/update_spec.rb", "vendor/riddle/spec/spec_helper.rb", "vendor/riddle/spec/sphinx_helper.rb", "vendor/riddle/spec/unit/client_spec.rb", "vendor/riddle/spec/unit/filter_spec.rb", "vendor/riddle/spec/unit/message_spec.rb", "vendor/riddle/spec/unit/response_spec.rb", "vendor/will_paginate/LICENSE", "ultrasphinx.gemspec", "Rakefile"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/ultrasphinx/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ultrasphinx", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.0.1}
+  s.rubygems_version = %q{1.3.5}
+  s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
   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"])
-end
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
-
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# 
-# require 'echoe'
-# 
-# Echoe.new("ultrasphinx") do |p|
-#   p.project = "fauna"
-#   p.summary = "Ruby on Rails configurator and client to the Sphinx fulltext search engine."
-#   p.url = "http://blog.evanweaver.com/files/doc/fauna/ultrasphinx/"  
-#   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|DEPLOY|RAKE_TASKS|CHANGELOG|^LICENSE/
-#   p.dependencies = "chronic"
-#   p.test_pattern = ["test/integration/*.rb", "test/unit/*.rb"]
-#   p.rcov_options << '--include-file test\/integration\/app\/vendor\/plugins\/ultrasphinx\/lib\/.*\.rb --include-file '
-# end
-# 
-# desc "Run all the tests for every database adapter" 
-# task "test_all" do
-#   ['mysql', 'postgresql'].each do |adapter|
-#     ENV['DB'] = adapter
-#     ENV['PRODUCTION'] = nil
-#     STDERR.puts "#{'='*80}\nDevelopment mode for #{adapter}\n#{'='*80}"
-#     system("rake test:multi_rails:all")
-#   
-#     ENV['PRODUCTION'] = '1'
-#     STDERR.puts "#{'='*80}\nProduction mode for #{adapter}\n#{'='*80}"
-#     system("rake test:multi_rails:all")    
-#   end
-# end
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chronic>, [">= 0"])
+    else
+      s.add_dependency(%q<chronic>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<chronic>, [">= 0"])
+  end
+end

data/vendor/riddle/README

@@ -5,16 +5,28 @@ 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-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, 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: 0.9.8.1198)
+* 0.9.8-rc2 (gem version: 0.9.8.1231)
 
 To get started, just instantiate a Client object:
 
@@ -57,4 +69,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/vendor/riddle/Rakefile

@@ -1,4 +1,5 @@
 require 'rake'
+require 'rake/packagetask'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 require 'rdoc/rdoc'

data/vendor/riddle/lib/riddle.rb

@@ -9,11 +9,17 @@ module Riddle #:nodoc:
   end
   
   module Version #:nodoc:
-    Major = 0
-    Minor = 9
-    Tiny  = 8
-    Rev   = 1112
+    Major   = 0
+    Minor   = 9
+    Tiny    = 8
+    # Revision number for RubyForge's sake, taken from what Sphinx
+    # outputs to the command line.
+    Rev     = 1231
+    # Release number to mark my own fixes, beyond feature parity with
+    # Sphinx itself.
+    Release = 0
     
-    String = [Major, Minor, Tiny].join('.') + "r#{Rev}"
+    String      = [Major, Minor, Tiny].join('.') + "rc2"
+    GemVersion  = [Major, Minor, Tiny, Rev, Release].join('.')
   end
 end

data/vendor/riddle/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
@@ -204,14 +206,9 @@ module Riddle
 
           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
+            result[:matches].last[:attributes][attr] = attribute_from_type(
+              result[:attributes][attr], response
+            )
           end
         end
 
@@ -275,8 +272,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 +355,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 +460,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 +521,8 @@ module Riddle
         message.append_int val
       end
       
+      message.append_string comments
+      
       message.to_s
     end
     
@@ -544,5 +567,27 @@ 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
+    
+    def attribute_from_type(type, response)
+      type -= AttributeTypes[:multi] if is_multi = type > AttributeTypes[:multi]
+      
+      case type
+      when AttributeTypes[:float]
+        is_multi ? response.next_float_array : response.next_float
+      else
+        is_multi ? response.next_int_array   : response.next_int
+      end
+    end
   end
 end