0.0
No commit activity in last 3 years
No release in over 3 years
Arel based search gem
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies
 Project Readme

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