Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monade/active_queryable
A light and simple gem for sorting / filtering / paginating a model in Rails.
https://github.com/monade/active_queryable
activerecord gem rails ransack
Last synced: about 2 months ago
JSON representation
A light and simple gem for sorting / filtering / paginating a model in Rails.
- Host: GitHub
- URL: https://github.com/monade/active_queryable
- Owner: monade
- License: mit
- Created: 2019-12-17T17:02:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T08:41:00.000Z (5 months ago)
- Last Synced: 2024-07-04T08:11:54.924Z (3 months ago)
- Topics: activerecord, gem, rails, ransack
- Language: Ruby
- Homepage: https://monade.io
- Size: 37.1 KB
- Stars: 4
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/active_queryable)
# Active Queryable
Active Queryable is a lightweight Ruby gem designed to simplify sorting, filtering, and paginating models in Rails applications. Its intuitive API and seamless integration with ActiveModel make building complex queries a breeze.
## Features
* Easy integration with Rails models.
* Support for dynamic sorting, filtering, and pagination.
* Compatible with JSON:API specification for pagination parameters.
* Extensible through custom scopes for advanced filtering needs.
## Installation
Ensure you have Rails >= 5.2 (or specify another version if needed) and then add Active Queryable to your Gemfile:
```ruby
gem 'active_queryable'
```
or alternatively `bundle add active_queryable`
## Usage
First, include the `as_queryable` method in your model to enable the gem.
```ruby
class Person < ActiveModel::Base
# Add this line to enable the gem
as_queryable
end
```
Then, configure the order and filters you want to use:
```ruby
class Person < ActiveModel::Base
# Add this line to enable the gem
as_queryable
# Configure order and filters
queryable order: { name: :asc },
filter: [:name]
end
```
This will allow you to query your model using the `query_by` method:
```ruby
Person.query_by(order: '-name') # SELECT * FROM people ORDER BY name DESC LIMIT 25
Person.query_by(filter: { name: 'john'}) # SELECT * FROM people WHERE people.name = 'john' LIMIT 25
```
### Pagination
You can also use pagination, using [kaminari](https://github.com/kaminari/kaminari) under the hood:
```ruby
Person.query_by(per: 20, page: 2) # SELECT * FROM people LIMIT 20 OFFSET 20
# Accepts also JSON:API-styled parameters
Person.query_by(page: { number: 2, size: 20 }) # SELECT * FROM people LIMIT 20 OFFSET 20
```
### Custom scopes and orders
You can also use custom scopes to extend the filtering and ordering capabilities.
The gem will look for a scope with the same name as the filter, and a method with the same name as the order.
```ruby
class Person < ActiveModel::Base
# Add this line to enable the gem
as_queryable
# Configure order and filters
queryable order: { fullname: :asc },
filter: [:name_like]
# the `of_name_like` scope will be used when filtering by `name_like`
scope :of_name_like, ->(name) { where('name LIKE ?', "%#{name}%") }
# the `by_name` method will be used when ordering by `name`
order :by_name, ->(direction) { order(firstname: direction, lastname: direction) }
end
```
About Monade
----------------
active_queryable is maintained by [mònade srl](https://monade.io).
We <3 open source software. [Contact us](https://monade.io/en/contact-us/) for your next project!