ultrasphinx 1.8 → 1.9

data/test/integration/app/db/schema.rb

@@ -0,0 +1,56 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of ActiveRecord to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 9) do
+
+  create_table "addresses", :force => true do |t|
+    t.integer "user_id",                         :null => false
+    t.string  "name"
+    t.string  "line_1",          :default => "", :null => false
+    t.string  "line_2"
+    t.string  "city",            :default => "", :null => false
+    t.integer "state_id",                        :null => false
+    t.string  "province_region"
+    t.string  "zip_postal_code"
+    t.integer "country_id",                      :null => false
+    t.float   "lat"
+    t.float   "long"
+  end
+
+  create_table "countries", :force => true do |t|
+    t.string "name", :default => "", :null => false
+  end
+
+  create_table "sellers", :force => true do |t|
+    t.integer  "user_id",                            :null => false
+    t.string   "company_name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.float    "capitalization",    :default => 0.0
+    t.string   "mission_statement"
+  end
+
+  create_table "states", :force => true do |t|
+    t.string "name",         :default => "", :null => false
+    t.string "abbreviation", :default => "", :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "login",            :limit => 64, :default => "",    :null => false
+    t.string   "email",                          :default => "",    :null => false
+    t.string   "crypted_password", :limit => 64, :default => "",    :null => false
+    t.string   "salt",             :limit => 64, :default => "",    :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.boolean  "deleted",                        :default => false
+  end
+
+end

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

@@ -5,7 +5,7 @@
   company_name: <%= "seller#{num}" %>
   capitalization: <%= num * 1.548 %>
   mission_statement: <%= %w(Add value through developing superior products.).sort_by(&:rand).join(" ") %>
-  updated_at: <%= ((time = Time.parse("Tue Oct 23 04:28:11")) - num.days).to_s(:db) %>  
+  updated_at: <%= ((time = Time.parse("Tue Oct 23 04:28:11 2007")) - num.days).to_s(:db) %>  
   created_at: <%= (time - num.weeks).to_s(:db) %>
 <% end %>
 

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

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

data/test/integration/app/test/unit/country_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CountryTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/test/integration/delta_test.rb

@@ -0,0 +1,39 @@
+
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class DeltaTest < Test::Unit::TestCase
+
+  S = Ultrasphinx::Search
+  E = Ultrasphinx::UsageError
+  STRFTIME = "%b %d %Y %H:%M:%S" # Chronic can't parse the default date .to_s
+  
+  def test_delta_update
+  
+    # XXX Not really necessary?
+    Dir.chdir "#{HERE}/integration/app" do    
+      Echoe.silence do
+        system("rake db:fixtures:load")
+        system("rake ultrasphinx:index")
+      end
+    end
+
+    @count = S.new.total_entries
+
+    @new = User.new
+    @new.save!
+    User.find(2).update_attribute(:created_at, Time.now)
+    
+    Dir.chdir "#{HERE}/integration/app" do    
+      Echoe.silence { system("rake ultrasphinx:index:delta") }
+    end
+    
+    assert_equal @count + 1, S.new.total_entries
+    @new.destroy
+
+    Dir.chdir "#{HERE}/integration/app" do    
+      Echoe.silence { system("rake ultrasphinx:index:delta") }
+    end
+
+    assert_equal @count, S.new.total_entries
+  end
+end

data/test/integration/search_test.rb

@@ -16,8 +16,20 @@ class SearchTest < Test::Unit::TestCase
   
   def test_with_subtotals_option
     S.client_options['with_subtotals'] = true
-    @s = S.new.run
+    
+    # No delta index; accurate subtotals sum
+    @s = S.new(:indexes => Ultrasphinx::MAIN_INDEX).run
     assert_equal @s.total_entries, @s.subtotals.values._sum
+    
+    # With delta; subtotals sum not less than total sum
+    @s = S.new.run
+    assert @s.subtotals.values._sum >= @s.total_entries 
+    
+    # With delta and filter; request class gets accurate count regardless
+    @s = S.new(:class_names => 'Seller').run
+    assert_equal @s.total_entries, @s.subtotals['Seller']    
+    assert @s.subtotals.values._sum >= @s.total_entries 
+    
     S.client_options['with_subtotals'] = false
   end
   
@@ -84,6 +96,34 @@ class SearchTest < Test::Unit::TestCase
     )  
   end
   
+  def test_individual_totals_with_pagination
+    Ultrasphinx::MODEL_CONFIGURATION.keys.each do |class_name| 
+      if class_name == "User"
+        assert_equal User.count(:conditions => {:deleted => false }), 
+          S.new(:class_names => class_name, :page => 2).total_entries
+      else
+        assert_equal class_name.constantize.count, 
+          S.new(:class_names => class_name, :page => 2).total_entries
+      end
+    end
+  end
+
+  def test_individual_totals_without_pagination
+    Ultrasphinx::MODEL_CONFIGURATION.keys.each do |class_name| 
+      begin
+        if class_name == "User"
+          assert_equal User.count(:conditions => {:deleted => false }), 
+            S.new(:class_names => class_name).total_entries
+        else
+          assert_equal class_name.constantize.count, 
+            S.new(:class_names => class_name).total_entries
+        end
+      rescue Object
+        raise class_name
+      end
+    end
+  end
+  
   def test_sort_by_date
     assert_equal(
       Seller.find(:all, :limit => 5, :order => 'created_at DESC').map(&:created_at),
@@ -211,6 +251,25 @@ class SearchTest < Test::Unit::TestCase
       @s.facets['company_name'].size
     )
   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
+    @s = Ultrasphinx::Search.new(:class_names => 'User', :facets => ['company']).run
+    assert_equal(
+      (Seller.count + 1), 
+      @s.facets['company'].size
+    )
+  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
+    @s = Ultrasphinx::Search.new(:class_names => 'User', :facets => ['company_two']).run
+    assert_equal(
+      (Seller.count - 1), 
+      @s.facets['company_two'].size
+    )
+  end
   
   def test_numeric_facet
     @user_id_count = Seller.find(:all).map(&:user_id).uniq.size

data/test/integration/spell_test.rb

@@ -8,8 +8,12 @@ class SpellTest < Test::Unit::TestCase
   end
   
   def test_spelling
-    assert_equal nil, Ultrasphinx::Spell.correct("correct words")
-    assert_equal "garbled words", Ultrasphinx::Spell.correct("glarbled words")
+    if defined?(Aspell)
+      assert_equal nil, Ultrasphinx::Spell.correct("correct words")
+      assert_equal "garbled words", Ultrasphinx::Spell.correct("glarbled words")
+    else
+      STDERR.puts "No Aspell found"
+    end
   end  
 
 end

data/test/profile/benchmark.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "#{File.dirname(__FILE__)}/../test_helper"
+require 'benchmark'
+require 'ruby-prof'
+
+#def debugger; end
+# require 'ruby-debug'
+
+PROF = ENV['PROF']
+TIMES = 50
+
+$options = [{:query => 'seller'}]
+
+#$search = Ultrasphinx::Search.new(*$options).run
+#$sellers = Seller.find_all_by_id($search.results.select{|o| o.is_a? Seller}.map(&:id))
+#$users = User.find_all_by_id($search.results.select{|o| o.is_a? User}.map(&:id))
+#
+## Mocha didn't work; don't know why
+#class Riddle::Client
+#  def query(*args); $search.response; end
+#end
+#class Seller
+#  def self.find_all_by_id(*args); $sellers; end
+#end
+#class User
+#  def self.find_all_by_id(*args); $users; end
+#end
+
+Benchmark.bm(20) do |x|
+  x.report("simple") do 
+    TIMES.times do
+       Ultrasphinx::Search.new(*$options).run
+    end
+  end
+  x.report("excerpt") do 
+    RubyProf.start if PROF
+    TIMES.times do
+       Ultrasphinx::Search.new(*$options).excerpt
+    end
+    RubyProf::GraphPrinter.new(RubyProf.stop).print(STDOUT, 0) if PROF  
+  end
+end
+

data/test/test_helper.rb

@@ -2,7 +2,12 @@
 require 'rubygems'
 require 'test/unit'
 require 'echoe'
-require 'multi_rails_init'
+
+begin
+  require 'multi_rails_init'
+rescue LoadError
+  STDERR.puts "No multi_rails found"
+end
 
 if defined? ENV['MULTIRAILS_RAILS_VERSION']
   ENV['RAILS_GEM_VERSION'] = ENV['MULTIRAILS_RAILS_VERSION']

data/test/unit/parser_test.rb

@@ -7,7 +7,7 @@ class ParserTest < Test::Unit::TestCase
     @s = Ultrasphinx::Search.new
   end
 
-  def test_parsing 
+  def test_valid_queries
     [
       'artichokes', 
       'artichokes',
@@ -88,12 +88,31 @@ class ParserTest < Test::Unit::TestCase
       '"traditional"',   
       
       'cuisine:"american (traditional"',
-      '@cuisine "american traditional"'
+      '@cuisine "american traditional"',
+      
+      'title:cats OR user:john',
+      '@title cats | @user john',
+      
+      'user:john OR title:cats',
+      '@title cats | @user john',
       
     ].in_groups_of(2).each do |query, result|
       assert_equal result, @s.send(:parse, query)
     end
   end
+  
+  def test_invalid_queries
+    [
+      "\"", 
+      "(", 
+      ")", 
+      "  \"  "
+    ].each do |query|
+      assert_raises(Ultrasphinx::Search::Parser::Error) do 
+        @s.send(:parse, query)
+      end
+    end
+  end
 
 end
 

data/ultrasphinx.gemspec

@@ -1,19 +1,19 @@
 
-# Gem::Specification for Ultrasphinx-1.8
+# Gem::Specification for Ultrasphinx-1.9
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{ultrasphinx}
-  s.version = "1.8"
+  s.version = "1.9"
 
   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{2008-02-05}
+  s.date = %q{2008-03-08}
   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.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/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/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/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/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/phrase.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/sphinx/configuration.erb", "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.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.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/ultrasphinx/}
   s.require_paths = ["lib"]

data/vendor/riddle/README

@@ -8,13 +8,13 @@ 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
 are after a specific release, use the tag as follows:
 
-  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags/0.9.8-r1065 riddle
+  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags/0.9.8-r1112 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, 0.9.8r909, 0.9.8r985 and 0.9.8r1065 are supported.
+Please note that at the time of writing, only 0.9.8r871 through to 0.9.8r1112 are supported.
 
 To get started, just instantiate a Client object:
 

data/vendor/riddle/lib/riddle.rb

@@ -12,7 +12,7 @@ module Riddle #:nodoc:
     Major = 0
     Minor = 9
     Tiny  = 8
-    Rev   = 1065
+    Rev   = 1112
     
     String = [Major, Minor, Tiny].join('.') + "r#{Rev}"
   end

data/vendor/riddle/lib/riddle/client.rb

@@ -57,7 +57,8 @@ module Riddle
     RankModes = {
       :proximity_bm25 => 0, # SPH_RANK_PROXIMITY_BM25
       :bm25           => 1, # SPH_RANK_BM25
-      :none           => 2  # SPH_RANK_NONE
+      :none           => 2, # SPH_RANK_NONE
+      :wordcount      => 3  # SPH_RANK_WORDCOUNT
     }
     
     SortModes = {
@@ -65,7 +66,8 @@ module Riddle
       :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
+      :extended      => 4, # SPH_SORT_EXTENDED
+      :expr          => 5  # SPH_SORT_EXPR
     }
     
     AttributeTypes = {
@@ -135,17 +137,22 @@ module Riddle
     end
     
     # Set the geo-anchor point - with the names of the attributes that contain
-    # the latitude and longtitude, and the reference position.
+    # the latitude and longitude (in radians), and the reference position.
+    # Note that for geocoding to work properly, you must also set
+    # match_mode to :extended. To sort results by distance, you will
+    # need to set sort_mode to '@geodist asc' for example. Sphinx
+    # expects latitude and longitude to be returned from you SQL source
+    # in radians.
     #
     # Example:
-    #   client.set_anchor('lat', -37.767899, 'lon', 145.002451)
+    #   client.set_anchor('lat', -0.6591741, 'long', 2.530770)
     #
     def set_anchor(lat_attr, lat, long_attr, long)
       @anchor = {
         :latitude_attribute   => lat_attr,
         :latitude             => lat,
-        :longtitude_attribute => long_attr,
-        :longtitude           => long
+        :longitude_attribute  => long_attr,
+        :longitude            => long
       }
     end
     
@@ -273,7 +280,10 @@ module Riddle
       self.run.first
     end
     
-    # Grab excerpts from the indexes. As part of the options, you will need to
+    # Build excerpts from search terms (the +words+) and the text of documents. Excerpts are bodies of text that have the +words+ highlighted.
+    # They may also be abbreviated to fit within a word limit.
+    #
+    # As part of the options hash, you will need to
     # define:
     # * :docs
     # * :words
@@ -290,6 +300,31 @@ module Riddle
     #
     # The defaults differ from the official PHP client, as I've opted for
     # semantic HTML markup.
+    #
+    # Example:
+    #
+    #   client.excerpts(:docs => ["Pat Allan, Pat Cash"], :words => 'Pat', :index => 'pats')
+    #   #=> ["<span class=\"match\">Pat</span> Allan, <span class=\"match\">Pat</span> Cash"]
+    #
+    #   lorem_lipsum = "Lorem ipsum dolor..."
+    #
+    #   client.excerpts(:docs => ["Pat Allan, #{lorem_lipsum} Pat Cash"], :words => 'Pat', :index => 'pats')
+    #   #=> ["<span class=\"match\">Pat</span> Allan, Lorem ipsum dolor sit amet, consectetur adipisicing
+    #          elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua &#8230; . Excepteur 
+    #          sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est 
+    #          laborum. <span class=\"match\">Pat</span> Cash"]  
+    #
+    # Workflow:
+    #
+    # Excerpt creation is completely isolated from searching the index. The nominated index is only used to 
+    # discover encoding and charset information.
+    #
+    # Therefore, the workflow goes:
+    #
+    # 1. Do the sphinx query.
+    # 2. Fetch the documents found by sphinx from their repositories.
+    # 3. Pass the documents' text to +excerpts+ for marking up of matched terms.
+    #
     def excerpts(options = {})
       options[:index]           ||= '*'
       options[:before_match]    ||= '<span class="match">'
@@ -444,8 +479,8 @@ module Riddle
       else
         message.append_int 1
         message.append_string @anchor[:latitude_attribute]
-        message.append_string @anchor[:longtitude_attribute]
-        message.append_floats @anchor[:latitude], @anchor[:longtitude]
+        message.append_string @anchor[:longitude_attribute]
+        message.append_floats @anchor[:latitude], @anchor[:longitude]
       end
       
       # Per Index Weights
@@ -510,4 +545,4 @@ module Riddle
       message.to_s
     end
   end
-end
+end