usefull_scopes

KO | EN

gitlite — search

#javascript #python #hacktoberfest #machine-learning #docker #nodejs #java #vue #awesome-list #pytorch #security #mcp #openai #open-source

(★ 18)

This gem provides additional scopes for your ActiveRecord models.

usefull_scopes Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# UsefullScopes
[![Build Status](https://travis-ci.org/kaize/usefull_scopes.png?branch=master)](https://travis-ci.org/kaize/usefull_scopes)
[![Coverage
status](https://coveralls.io/repos/kaize/usefull_scopes/badge.png?branch=master)](https://coveralls.io/r/kaize/usefull_scopes)

This gem provides additional scopes for your ActiveRecord models.

## Installation

Add this line to your application's Gemfile:

gem 'usefull_scopes'

Or install it yourself as:

$ gem install usefull_scopes

## Usage

In order to access these scopes, include `UsefullScopes` module in your model.

For example:

class User < ActiveRecord::Base
      include UsefullScopes
    end

### Global scopes

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>random</td>
    <td>Random record</td>
  </tr>
  <tr>
    <td>exclude</td>
    <td>Records who are not in a given array (you could also provide a single object as an argument)</td>
  </tr>
  <tr>
    <td>with</td>
    <td>Records, where attributes' values are corresponding to a given hash.</td>
  </tr>
  <tr>
    <td>without</td>
    <td>Records, where attributes' values are `NULL` or aren't equal to values from a given hash.</td>
  </tr>
  <tr>
    <td>asc_by</td>
    <td>Records sorted in ascending order using provided attributes.</td>
  </tr>
  <tr>
    <td>desc_by</td>
    <td>Records sorted in descending order using provided attributes.</td>
  </tr>
  <tr>
    <td>more_than</td>
    <td>FIXME</td>
  </tr>
  <tr>
    <td>less_than</td>
    <td>FIXME</td>
  </tr>
  <tr>
    <td>more_or_equal</td>
    <td>FIXME</td>
  </tr>
  <tr>
    <td>less_or_equal</td>
    <td>FIXME</td>
  </tr>
</table>

### Scopes per attribute

These are the scopes created for each of the model attribute.

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>by_{attribute}</td>
    <td>Records ordered by attribute in descending order.</td>
  </tr>
  <tr>
    <td>asc_{by_attribute}</td>
    <td>Records ordered by attribute in ascending order.</td>
  </tr>
  <tr>
    <td>like_by_{attribute}</td>
    <td>Records, where attribute's value LIKE a given term.</td>
  </tr>
  <tr>
    <td>ilike_by_{attribute}</td>
    <td>Сase insensitive implementation of `like_by_{attribute}`.</td>
  </tr>
  <tr>
    <td>{attribute}_more</td>
    <td>Records with attribute's value greater than a given value.</td>
  </tr>
  <tr>
    <td>{attribute}_less</td>
    <td>Records with attribute's value less than a given value.</td>
  </tr>
  <tr>
    <td>{attribute}_more_or_equal</td>
    <td>Records with attribute's value greater or equal than a given value.</td>
  </tr>
  <tr>
    <td>{attribute}_less_or_equal</td>
    <td>Records with attribute's value less or equal than a given value.</td>
  </tr>
</table>

### Examples

Now, it is time to play with our model!

User.create([{name: 'Mike'}, {name: 'Paul'}])

user = User.random
    user.name
      => 'Mike'

User.asc_by_name.map(&:name)
      => ['Mike', 'Paul']

User.by_name.map(&:name)
      => ['Paul', 'Mike']

users = User.with_name('Mike')
    users.map(&:name)
      => ['Mike']

users = User.with(name: 'Mike')
      => SELECT "users".* FROM "users" WHERE ("users"."name" = 'Mike')
    users.map(&:name)
      => ['Mike']

users = User.without(name: ['Mike', 'Paul'])
      => SELECT "users".* FROM "users" WHERE ("users"."name" NOT IN ('Mike','Paul'))
    users
      => []

users = User.without(:name, :id)
      => SELECT "users".* FROM "users" WHERE ("users"."name" IS NULL AND "users"."id" IS NULL)
    users.count
      => 2

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## Credits

Maintained by kaize.

Thank you to all our amazing [contributors](http://github.com/kaize/usefull_scopes/contributors)!

## License

usefull_scopes

usefull_scopes Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

usefull_scopes

usefull_scopes Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README