Sift

A declarative DSL for building filters and sorts with Rails and Active Record.

Include Sift in your controllers and define filters and sorts:

class PostsController < ApplicationController
  include Sift

  filter_on :title, type: :string
  filter_on :priority, type: :int
  filter_on :published_at, type: :datetime
  filter_on :with_body, type: :scope

  sort_on :title, type: :string
  sort_on :priority, type: :int

  before_action :render_filter_errors, unless: :filters_valid?

  def index
    render json: filtrate(Post.all)
  end

  private

  def render_filter_errors
    render json: { errors: filter_errors }, status: :bad_request
  end
end

Consumers can then filter and sort via query parameters:

GET /posts?filters[title]=hello&filters[priority]=1...5&sort=-published_at,title

Add this line to your application's Gemfile:

gem 'procore-sift'

And then execute:

$ bundle

• Filters - Filter types, scopes, ranges, JSONB, defaults, validation
• Sorts - Sort types and scope-based sorting
• Consumer API - Query parameter format for API consumers
• Contributing - Development setup and publishing

See CHANGELOG.md for release notes.

The gem is available as open source under the terms of the MIT License.

The Procore Gem is maintained by Procore Technologies.

Procore - building the software that builds the world.

Learn more about the #1 most widely used construction management software at procore.com