Open Source Ecosystems

Please Note: This project is no longer supported. It only works with Thinking Sphinx v1/v2, whereas the v3+ releases are what has been actively supported since 2012. Patches are welcome to rewrite this for v3 support if anyone's feeling particularly keen to modernise this gem.

h1. Thinking Sphinx with Raspell

This library adds Aspell/Raspell support to "Thinking Sphinx":http://pat.github.io/thinking-sphinx

h2. Installation

You'll need "the Aspell library":http://www.aspell.net (easily compiled by source, or installed via Homebrew or MacPorts). Don't forget to install the English library as well - there's instructions for both in Evan Weaver's "Raspell README":http://github.com/evan/raspell.

Once that's set up, grab the gem:

You'll want to add the gem to your @Gemfile@:

Or, if using older versions of Rails, your @config/environment.rb@ file:

Or, if you wish to do a manual require yourself:

h2. Usage

By default, Thinking Sphinx will not overwrite your search query, but you can view suggestions:

You can also choose to redo the search using the provided suggestion:

h2. Configuration

You can customise the following settings - either in your @config/environment.rb@ file, or perhaps in an initializer. Example syntax below highlights the current defaults.

You can look at the available options using the following two collections:

If you require more control over the Aspell options you can also pass in your own instance:

If you need more documentation, you can check out the YARD files "on rdoc.info":http://rdoc.info/projects/freelancing-god/thinking-sphinx-raspell. This isn't a big library, though - what you see in this readme is pretty much what you get.

h2. Limitations