Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khiav223577/rails_or
Cleaner syntax for writing OR Query in Rails 5, 6. And also add #or support to Rails 3 and 4.
https://github.com/khiav223577/rails_or
activerecord orm-extension rails rubygems syntax-sugar
Last synced: 5 days ago
JSON representation
Cleaner syntax for writing OR Query in Rails 5, 6. And also add #or support to Rails 3 and 4.
- Host: GitHub
- URL: https://github.com/khiav223577/rails_or
- Owner: khiav223577
- License: mit
- Created: 2016-12-28T17:54:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T18:12:15.000Z (4 months ago)
- Last Synced: 2024-12-29T13:10:13.477Z (12 days ago)
- Topics: activerecord, orm-extension, rails, rubygems, syntax-sugar
- Language: Ruby
- Homepage:
- Size: 153 KB
- Stars: 94
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RailsOr
[](https://rubygems.org/gems/rails_or)
[](https://github.com/khiav223577/rails_or/actions)
[](https://rubygems.org/gems/rails_or)
[](https://codeclimate.com/github/khiav223577/rails_or)
[](https://codeclimate.com/github/khiav223577/rails_or/coverage)
`rails_or` is a Ruby Gem for you to write cleaner `OR` query.
It will use built-in `or` method, which was added in Rails 5, when possible, so that you don't need to worry about that it will polulate `active_model`. Otherwise, it implements `or` method for Rails 3 and Rails 4.
## Supports
- Ruby 2.3 ~ 2.7, 3.0 ~ 3.2
- Rails 3.2, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1, 7.0, 7.2
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rails_or'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install rails_or
## Usage
### Same as Rails 5's #or method
```rb
Person.where(name: 'Pearl').or(Person.where(age: 24))
# is the same as
Person.where("name = ? OR age = ?", 'Pearl', 24)
```
### Clearer Syntax
```rb
# Before
user = User.where(account: account).or(User.where(email: account)).take
# After
user = User.where(account: account).or(email: account).take
```
```rb
# Before
class Post < ActiveRecord::Base
scope :not_expired, ->{ where(end_time: nil).or(Post.where('end_time > ?', Time.now)) }
end
# After
class Post < ActiveRecord::Base
scope :not_expired, ->{ where(end_time: nil).or('end_time > ?', Time.now) }
end
```
No need to repeat writing `Model.joins(XXX).where(...)`
```rb
# Before
User.joins(:posts).where(id: 2)
.or(User.joins(:posts).where('posts.title = ?',"title"))
.or(User.joins(:posts).where('posts.created_at > ?', 1.day.ago))
# After
User.joins(:posts).where(id: 2)
.or('posts.title': "title")
.or('posts.created_at > ?', 1.day.ago)
```
Support passing `Hash` / `Array` / `String` as parameters
```rb
Person.where(name: 'Pearl').or(age: 24)
Person.where(name: 'Pearl').or(['age = ?', 24])
Person.where(name: 'Pearl').or('age = ?', 24)
Person.where(name: 'Pearl').or('age = 24')
```
## Other convenient methods
### or_not
(Only supports in Rails 4+)
```rb
Company.where.not(logo_image1: nil)
.or_not(logo_image2: nil)
.or_not(logo_image3: nil)
.or_not(logo_image4: nil)
```
### or_having
```rb
Order.group('user_id')
.having('SUM(price) > 1000')
.or_having('COUNT(*) > 10')
```
## Examples
Let `A = { id: 1 }`, `B = { account: 'tester' }`, and `C = { email: '[email protected]' }`
### A && (B || C)
```rb
u = User.where(A)
u.where(B).or(u.where(C))
# =>
# SELECT `users`.* FROM `users`
# WHERE `users`.`id` = 1 AND (`users`.`account` = 'tester' OR `users`.`email` = '[email protected]')
```
### (B || C) && A
```rb
User.where(B).or(C).where(A)
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`account` = 'tester' OR `users`.`email` = '[email protected]') AND `users`.`id` = 1
```
### A && B || A && C
```rb
User.where(A).where(B).or(User.where(A).where(C))
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`id` = 1 AND `users`.`account` = 'tester' OR `users`.`id` = 1 AND `users`.`email` = '[email protected]')
```
### A && B || C
```rb
User.where(A).where(B).or(C)
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`id` = 1 AND `users`.`account` = 'tester' OR `users`.`email` = '[email protected]')
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/rails_or. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).