Browse the Ruby on Rails Community.

You are here: Browse Railsplugins Tractis Acts As Ferret

Tractis Acts As Ferret

= 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

=== System-wide installation with Rubygems

sudo gem install acts_as_ferret

To use acts_as_ferret in your project, add the following line to your project’s config/environment.rb:

require ‘acts_as_ferret’

== Usage

include the following in your model class (specifiying the fields you want to get indexed):

acts_as_ferret :fields => [ :title, :description ]

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> (current maintainer)

NOTE: This description has been extracted from the Plugin README and so the formatting may need updating to make browser friendly

Users


See all details


Membership

+ Join this railsplugin

Record Maintainer

'None'