RailsOr
rails_or
is a Ruby Gem for adding the #or
method in Rails 3+,
allowing use of the OR operator to combine WHERE or HAVING clauses.
Though this method is available in Rails 5+,
rails_or
make it easier to use by adding syntax sugar to #or
method.
Installation
Add this line to your application's Gemfile:
gem 'rails_or'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rails_or
Usage
Same as Rails 5's #or method
Person.where(name: 'Pearl').or(Person.where(age: 24))
# is the same as
Person.where("name = ? OR age = ?", 'Pearl', 24)
Easier to use
No need to repeat writing Model.joins(XXX).where(...)
# 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
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+)
Company.where.not(logo_image1: nil)
.or_not(logo_image2: nil)
.or_not(logo_image3: nil)
.or_not(logo_image4: nil)
or_having
Order.group('user_id')
.having('SUM(price) > 1000')
.or_having('COUNT(*) > 10')
Examples
Let A = {id: 1}
, B = {account: 'a'}
, and C = {email: 'b'}
A && (B || C)
u = User.where(A)
u.where(B).or(u.where(C))
# =>
# SELECT `users`.* FROM `users`
# WHERE `users`.`id` = 1 AND (`users`.`account` = 'a' OR `users`.`email` = 'b')
(B || C) && A
User.where(B).or(C).where(A)
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`account` = 'a' OR `users`.`email` = 'b') AND `users`.`id` = 1
A && B || A && C
User.where(A).where(B).or(User.where(A).where(C))
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`id` = 1 AND `users`.`account` = 'a' OR `users`.`id` = 1 AND `users`.`email` = 'b')
A && B || C
User.where(A).where(B).or(C)
# =>
# SELECT `users`.* FROM `users`
# WHERE (`users`.`id` = 1 AND `users`.`account` = 'a' OR `users`.`email` = 'b')
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.
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 code of conduct.
License
The gem is available as open source under the terms of the MIT License.