Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
arel_search.gemspec

README.md

ArelSearch

Work in progress, use at your own risk but feel free to contribute :)

Installation

Add this line to your application's Gemfile:

gem 'arel_search'

And then execute:

$ bundle

Or install it yourself as:

$ gem install arel_search

Usage

Basic

params = {'orders.status.eq' => 50}
ArelSearch::Base.new(Order, params).search

Query by association

params = {'orders.status.eq' => 50, 'customer.name.matches' => 'Marcus'}
ArelSearch::Base.new(Order, params).search

Nested associations

ArelSearch doens't support nested associations yet but since a scope is returned, you can always append more conditions and associations.

params = {'orders.status.eq' => 50, 'customer.name.matches' => 'Marcus'}
scope = ArelSearch::Base.new(Order, params).search
scope.joins(:order_items).where("order_items.sku = ?", '123')

Paginate (3rd party)

params = {'orders.status.eq' => 50, 'customer.name.matches' => 'Marcus'}
ArelSearch::Base.new(Order, params).search(page: 1, per_page: 10)

TODO

  • Work with namespace
  • Allow 'OR' conditions

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.