Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opengems/rails_scopy
Generate automatically scopes in your model (PostgreSQL, SQLite, MySQL, etc...)
https://github.com/opengems/rails_scopy
activerecord activerecord-extension activerecord-models activerecord-pattern activerecord-queries rails
Last synced: about 1 month ago
JSON representation
Generate automatically scopes in your model (PostgreSQL, SQLite, MySQL, etc...)
- Host: GitHub
- URL: https://github.com/opengems/rails_scopy
- Owner: OpenGems
- License: mit
- Created: 2020-02-27T23:15:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T14:09:25.000Z (over 1 year ago)
- Last Synced: 2024-04-24T15:10:04.143Z (8 months ago)
- Topics: activerecord, activerecord-extension, activerecord-models, activerecord-pattern, activerecord-queries, rails
- Language: Ruby
- Homepage:
- Size: 26.4 KB
- Stars: 8
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RailsScopy
[](https://badge.fury.io/rb/rails_scopy)
[](https://codeclimate.com/github/OpenGems/rails_scopy/maintainability)
[](https://travis-ci.org/OpenGems/rails_scopy)
[](https://hakiri.io/github/OpenGems/rails_scopy/master)
[](https://coveralls.io/github/OpenGems/rails_scopy?branch=master)
Generate automatically scopes in your model (PostgreSQL, SQLite, MySQL, etc...)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rails_scopy'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install rails_scopy
## Usage
Include ```RailsScopy``` in each models
```ruby
class User < ApplicationRecord
include RailsScopy
end
```
or in the parent model
```ruby
class ApplicationRecord < ActiveRecord::Base
include RailsScopy
end
```
and
```ruby
User.not_admin
User.first_name_contains('Test')
```
### Scopes available
| SQL type | Scope method | Description |
| ------------- | ------------- | ------------- |
| All | `#{column}_eq(value)` | equal |
| All | `#{column}_not_eq(value)` | not equal |
| All | `#{column}_null` | is null |
| All | `#{column}_not_null` | is not null |
| All | `#{column}_present` | not null and not empty |
| All | `#{column}_blank` | null or empty |
| All | `ascend_by_#{column}` | ascending order |
| All | `descend_by_#{column}` | descending order |
| boolean | `#{column}` | true |
| boolean | `not_#{column}` | false |
| json | `#{column}_has_key(value)` | key present in json |
| json | `not_#{column}_has_not_key(value)` | key doesn't present in json |
| boolean | `#{column}` | true |
| boolean | `not_#{column}` | false |
| date, datetime, time | `#{column}_to(value)` | <= to |
| date, datetime, time | `#{column}_from(value)` | from >= |
| date, datetime, time | `#{column}_after(value)` | after > |
| date, datetime, time | `#{column}_before(value)` | < before |
| date, datetime, time | `#{column}_between(value)` | from >= <= to |
| string, text | `#{column}_contains(value)` | contains |
| string, text | `#{column}_not_contains(value)` | doesn't contains |
| string, text | `#{column}_starts_with(value)` | start with |
| string, text | `#{column}_not_starts_with(value)` | doesn't start with |
| string, text | `#{column}_ends_with(value)` | end with |
| string, text | `#{column}_not_ends_with(value)` | doesn't end with |
| string, text | `#{column}_length(value)` | length eql |
| string, text | `#{column}_between_length(value)` | from >= <= to (length) |
| integer, float | `#{column}_to(value)` | <= to |
| integer, float | `#{column}_from(value)` | from >= |
| integer, float | `#{column}_above(value)` | above > |
| integer, float | `#{column}_below(value)` | < below |
| integer, float | `#{column}_between(value)` | from >= <= to |
| float | `#{column}_scale(value)` | scale eql (Number of decimal digits) |
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/rails_scopy. 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.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).