@@ -1,5 +1,4 @@ -An Ambitious Sphinx Adapter -=========================== += An Ambitious Sphinx Adapter I don't know about you, but I like me some sexy full-text searching. @@ -20,31 +19,49 @@ Cheese in the name, but not grilled? Meal.select {|m| m.name =~ 'bacon' && m.name !~ 'grilled'} -### Big honking disclaimer +== Big honking disclaimer -We're still learning a lot about how sphinx and ambition work, so things are likely to change a lot. +We're still learning a lot about how sphinx and ambition work, so things are likely to change a lot, and features are likely to be missing. -### Getting Started +== Getting Started + + +=== Dependencies You will need the following gems to use ambitious-sphinx: gem install ambition gem install ultrasphinx - - Now install it as ambitious-sphinx: +=== Our stuff + +We don't have a gem yet, so presumably you'll do a clone of our git repo. Then you need to install it: + - sudo rake install + sudo rake install + +=== Add it to your app - Require our files somewhere, like at the end of config/environment.rb +Require our files somewhere, like at the end of config/environment.rb, maybe create config/initializers/sphinx.rb + + require 'ultrasphinx' + require 'ambition/adapters/ambitious_sphinx' - require 'ambition/adapters/ambitious_sphinx' +=== Sphinx and Ultrasphinx - You will also need to go through the motions of setting up ultrasphinx. This includes setting up sphinx itself, and modifying your model to indicate what's to be indexed, and so on. +You will also need to go through the motions of setting up ultrasphinx. + +This includes: + + * Configuring/installing sphinx + * Modifying your model to indicate what's to be indexed + * Bootstrapping ultrasphinx + +All this is discussed in detail in ultrasphinx's README -### Playing with the code base +== Playing with the code base -In addition to the other dependencies, you'll need: +In addition to the other dependencies, you'll need to: gem install echoe redgreen mocha test-spec @@ -53,13 +70,13 @@ Run the tests with: rake test -### More information on Sphinx: +== More information on Sphinx: -> http://www.sphinxsearch.com/ -> http://blog.evanweaver.com/articles/2007/07/09/ultrasphinx-searching-the-world-in-231-seconds/ -> http://blog.evanweaver.com/files/doc/fauna/ultrasphinx/files/README.html -### More information on Ambition: +== More information on Ambition: -> http://ambition.rubyforge.org -> http://groups.google.com/group/ambition-rb/ README @@ -1,9 +1,8 @@ module Ambition #:nodoc: module Adapters #:nodoc: module AmbitiousSphinx #:nodoc: - - # Responsible for taking the clauses that Ambition has generated, and ultimately doing a - # Ultrasphinx::Search based on them + # Responsible for taking the clauses that Ambition has generated, + # and ultimately doing a Ultrasphinx::Search based on them class Query < Base def kick Ultrasphinx::Search.new(to_hash).results lib/ambition/adapters/ambitious_sphinx/query.rb 68437f4becda9392b8f50e7011a1d4f6505230ab Josh Nichols josh@technicalpickles.com http://github.com/technicalpickles/ambitious-sphinx/commit/2f1350285f55c6ea69b6dae00294d14fc183a1da 2f1350285f55c6ea69b6dae00294d14fc183a1da 2008-02-18T17:04:54-08:00 2008-02-18T17:04:54-08:00 Better docs. 2935c6296a5cd7dcd7d834a2a56a8dd95cd77c34 Josh Nichols josh@technicalpickles.com