Query params based searching for MongoDB
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
ransack_mongo.gemspec

README.md

Ransack Mongo

Build Status

Ransack Mongo is based on Ransack, but for MongoDB.

With Ransack Mongo you can convert query params into Mongo queries.

Why another gem?

Given that Ransack is built on top of ARel and that ARel only works with relational databases, I don't see how we could add Mongoid support without dramatically changing everything.

Installation

Add this line to your application's Gemfile:

gem 'ransack_mongo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ransack_mongo

Usage

# GET /customers?q[name_eq]=Pablo&q[middle_name_or_last_name_cont]=Cantero

# params[:q]
# => { name_eq: 'Pablo', middle_name_or_last_name_cont: 'Cantero' }

# RansackMongo::Query.parse(params[:q])
# => { name: 'Pablo', '$or' => { middle_name: /Cantero/i, last_name: /Cantero/i } }

# GET /customers
def index
  selector = RansackMongo::Query.parse(params[:q])

  # Mongo Ruby Driver
  @customers = db['customers'].find(selector)

  # Moped
  @customers = session[:customers].find(selector)

  # Mongoid
  @customers = Customer.where(selector)
end

Available predicates

  • eq
  • not_eq
  • cont
  • in
  • start
  • mstart
  • gt
  • lt
  • gteq
  • lteq

OR operator

You can also combine predicates for OR queries.

query_param = { name_eq: 'Pablo', middle_name_or_last_name_cont: 'Cantero' }

RansackMongo::Query.parse(params[:q])
# => { name: 'Pablo', '$or' => { middle_name: /Cantero/i, last_name: /Cantero/i } }

parse!

You can use parse! for stricter validations. This method will raise an exception if a query cannot be produced.

 # xpto isn't a valid predicate

RansackMongo::Query.parse(name_xpto: 'Pablo')
# => {}

RansackMongo::Query.parse!(name_xpto: 'Pablo')
# => RansackMongo::MatcherNotFound: No matchers found. To allow empty queries use .parse instead

Contributing

  1. Fork it ( https://github.com/phstc/ransack_mongo/fork )
  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