Senro

Installation

Add this line to your application's Gemfile:

gem 'senro'

And then execute:

$ bundle

Or install it yourself as:

$ gem install senro

Usage

in Rails

format sort

class ApplicationController < ActionController::Base # or ::API class
  include Senro::Controller
  before_action :query_params_formatter_sort
end


pp params['sort']
# => { id: 'asc', name: 'desc' }
pp params['original_sort']
# => 'id,-name'

# e.g. in ActiveRecord
@items = Item.all.order(params['sort'])

# e.g. in Mongoid
@items = Item.all.order_by(params['sort'])

format query

class ApplicationController < ActionController::Base # or ::API class
  include Senro::Controller
  before_action :query_params_formatter_query
end


pp params['q']
# => { 'query' => 'senro gem', 'status' => { 'type' => ['pr'], 'is' => ['open'], 'label' => ['bug', 'ready'] } }
pp params['original_q']
# => 'type:pr is:open label:bug label:ready senro gem'

# e.g.
@items = Item.where(title: params['q']['query'],
                    type: params['q']['status']['type'],
                    status: params['q']['status']['is'])

Development

Run docker-compose up --build to set up.
Run docker-compose run ruby bundle exec rake spec to run the tests.
You can also run docker-compose run ruby bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/senro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.