Advanced key-based searching for ActiveRecord objects.
You can install Pursuit using the following command:
$ gem install pursuit
Or, by adding the following to your
You can use the convenient DSL syntax to declare which attributes and relationships are searchable:
class Product < ActiveRecord::Base searchable do |o| o.relation :variations, :title, :stock_status # Attributes can be used for both keyed and unkeyed searching by default, but you can pass either `keyed: false` or # `unkeyed: false` to restrict when the attribute is searched. o.attribute :title o.attribute :description o.attribute :rating, unkeyed: false # You can shorten the search keyword by passing the desired search term first, and then the real attribute name # as the second argument. # => "category*=shirts" o.attribute :category, :category_id # It's also possible to query entirely custom Arel nodes by passing a block which returns the Arel node to query. # You could use this to query a person's full name by concatenating their first and last name columns, for example. o.attribute :title_length, unkeyed: false do Arel::Nodes::NamedFunction.new('LENGTH', [ arel_table[:title] ]) end end end
This creates a
.search method on your record class which accepts a single query argument:
Product.search('plain shirt rating>=3')
After checking out the repo, run
bundle exec rake spec to run the tests.
To install this gem onto your machine, run
bundle exec rake install.