README
1.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
= acts_as_ferret
This ActiveRecord mixin adds full text search capabilities to any Rails model.
It is heavily based on the original acts_as_ferret plugin done by
Kasper Weibel and a modified version done by Thomas Lockney, which
both can be found on http://ferret.davebalmain.com/trac/wiki/FerretOnRails
== Installation
=== Installation inside your Rails project via script/plugin
script/plugin install svn://projects.jkraemer.net/acts_as_ferret/trunk/plugin/acts_as_ferret
Aaf is is also available via git from Rubyforge:
git clone git://rubyforge.org/actsasferret.git
=== System-wide installation with Rubygems
<tt>sudo gem install acts_as_ferret</tt>
To use acts_as_ferret in your project, add the following line to your
project's config/environment.rb:
<tt>require 'acts_as_ferret'</tt>
Call the aaf_install script inside your project directory to install the sample
config file and the drb server start/stop script.
== Usage
include the following in your model class (specifiying the fields you want to get indexed):
<tt>acts_as_ferret :fields => [ :title, :description ]</tt>
now you can use ModelClass.find_by_contents(query) to find instances of your model
whose indexed fields match a given query. All query terms are required by default,
but explicit OR queries are possible. This differs from the ferret default, but
imho is the more often needed/expected behaviour (more query terms result in
less results).
Please see ActsAsFerret::ActMethods#acts_as_ferret for more information.
== License
Released under the MIT license.
== Authors
* Kasper Weibel Nielsen-Refs (original author)
* Jens Kraemer <jk@jkraemer.net> (current maintainer)