FindWithOrder

Provides a simple way to find records in the same order of input array. Has better performance than manually sorting. (Support both PostgreSQL and MySQL)

Description

Find records in the same order of input array.

Code Quality Rank: L5

Monthly Downloads: 1,830

Programming language: Ruby

License: MIT License

Tags: Misc     ORM/ODM Extensions     Active Record    

Latest version: v1.3.0

README

FindWithOrder

Find records in the same order of input array.

Supports

• Ruby 2.2 ~ 2.7
• Rails 3.2, 4.2, 5.0, 5.1, 5.2, 6.0
• MySQL, PostgreSQL

Installation

Add this line to your application's Gemfile:

gem 'find_with_order'

And then execute:

$ bundle

Or install it yourself as:

$ gem install find_with_order

Usage

Find records with the order of IDs: find_with_order

ids = [3, 1, 5]

User.find(ids).map(&:id)
# => [1, 3, 5]

User.find_with_order(ids).map(&:id)
# => [3, 1, 5]

Support ordering by other columns: where_with_order

names = %w(Pearl John Doggy)

User.where(name: names).pluck(:name)
# => ['John', 'Pearl', 'Doggy']

User.where_with_order(:name, names).pluck(:name)
# => ['Pearl', 'John', 'Doggy']

Support ordering only part of results: with_order

names = %w(Pearl John)

User.leader.with_order(:name, names).pluck(:name)
# => ['Pearl', 'John', 'Doggy']

User.leader.with_order(:name, names, null_first: true).pluck(:name)
# => ['Doggy', 'Pearl', 'John']

Benchmark

Compare with manually sorting in rails

                                       user     system      total        real
Find with order                    0.050000   0.010000   0.060000 (  0.074975)
Find then sort by index            2.520000   0.120000   2.640000 (  3.238615)
Find then sort by hash mapping     1.410000   0.070000   1.480000 (  1.737176)

test script

Compare with order_as_specified

                                       user     system      total        real
order_as_specified                 0.020000   0.000000   0.020000 (  0.703773)
where_with_order                   0.020000   0.000000   0.020000 (  0.031723)

test script

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test DB=mysql / rake test DB=pg 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/find_with_order. 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.